Spring MVC常用注解汇总

小灰灰 2023-09-27 16:13 11阅读 0赞

@Controller

@Controller注解在类上，表明这个类是Spring MVC里的Controller，将其声明为Spring的一个Bean，Dispatch Servlet会自动扫描注解了此注解的类，并将Web请求映射到注解了@RequestMapping的方法上，需要注意的是，在Spring MVC声明控制器Bean的时候，只能使用@Controller。

@RequestMapping

@RequestMapping注解是用来映射Web请求（访问路径和参数）、处理类和方法的。它可以注解在类和方法上。注解在方法上的@RequestMapping路径会继承注解在类上的路径，@RequestMapping支持Servlet的request和response作为参数，也支持对它们的媒体类型进行配置。

@RequestBody

@RequestBody允许request的参数在request体中，而不是在直接链接在地址后面。此注解放在参数前。

@RestController

@RestController是一个组合注解，组合了@Controller和@ResponseBody，意味着当只开发一个和页面交互数据的控制的时候，需要使用此注解。 若没有此注解，要想实现上述功能，则需自己在代码中加@Controller和@ResponseBody两个注解。

## @Autowired ##

@Autowired为Spring提供的注解，需要导入包org.springframework.beans.factory.annotation.Autowired;只按照byType注入。

public class HelloWorld{
        // 下面两种@Autowired只要使用一种即可
        @Autowired
        private UserDao userDao; // 用于字段上
        
        @Autowired
        public void setUserDao(UserDao userDao) { // 用于属性的方法上
            this.userDao = userDao;
        }
    }

![ff8fc6b905472b9aca10fb5e7f645e56.gif][]

![7f65e9d3f5f607a5e38963258e68bcb4.gif][]

@Autowired注解是按照类型（byType）装配依赖对象，默认情况下它要求依赖对象必须存在，如果允许null值，可以设置它的required属性为false。如果我们想使用按照名称（byName）来装配，可以结合@[Qualifier][]注解一起使用。如下：

public class HelloWorld{ 
    　　@Autowired 
    　　@Qualifier("userDao") 
    　　private UserDao userDao; 
    }

![c9db0082744a4a426f50bc85fb4c3433.gif][]

![f648910e6fc3763981c765f5e3c8faae.gif][]

@Resource

@Resource默认按照ByName自动注入，由J2EE提供，需要导入包javax.annotation.Resource。@Resource有两个重要的属性：name和type，而Spring将@Resource注解的name属性解析为bean的名字，而type属性则解析为bean的类型。所以，如果使用name属性，则使用byName的自动注入策略，而使用type属性时则使用byType自动注入策略。如果既不制定name也不制定type属性，这时将通过反射机制使用byName自动注入策略。

public class HelloWorld{
        // 下面两种@Resource只要使用一种即可
        @Resource(name="userDao")
        private UserDao userDao; // 用于字段上
        
        @Resource(name="userDao")
        public void setUserDao(UserDao userDao) { // 用于属性的setter方法上
            this.userDao = userDao;
        }
    }

![dc0cb8315a9b7c849617ad8f4dddf411.gif][]

![afb7e3f6e984e6d5fd7202be7a46af0d.gif][]

注：最好是将@Resource放在setter方法上，因为这样更符合面向对象的思想，通过set、get去操作属性，而不是直接去操作属性。

## @PathVariable ##

用于将请求URL中的模板变量映射到功能处理方法的参数上，即取出uri模板中的变量作为参数。如：

@Controller  
    public class TestController {  
         @RequestMapping(value="/user/{userId}/roles/{roleId}",method = RequestMethod.GET)  
         public String getLogin(@PathVariable("userId") String userId,  
             @PathVariable("roleId") String roleId){  
             System.out.println("User Id : " + userId);  
             System.out.println("Role Id : " + roleId);  
             return "hello";  
         }  
         @RequestMapping(value="/product/{productId}",method = RequestMethod.GET)  
         public String getProduct(@PathVariable("productId") String productId){  
               System.out.println("Product Id : " + productId);  
               return "hello";  
         }  
         @RequestMapping(value="/javabeat/{regexp1:[a-z-]+}",  
               method = RequestMethod.GET)  
         public String getRegExp(@PathVariable("regexp1") String regexp1){  
               System.out.println("URI Part 1 : " + regexp1);  
               return "hello";  
         }  
    }

![fa7b85d9a725f0cdde9299ce7d73fc66.gif][]

![ac9ad9ed39f71ce41352351105a523a6.gif][]

## @CookieValue ##

作用：用来获取Cookie中的值；

参数： value：参数名称 required：是否必须 defaultValue：默认值

使用案例：

/**
         * 获取 Session
         * JSESSIONID=411A032E02A2594698F6E3F4458B9CE4
         */
        @RequestMapping("/testCookieValue")
        public String testCookieValue(@CookieValue("JSESSIONID") String sessionId) {
            System.out.println("JSESSIONID = " + sessionId);
            return "success";
        }

![c5a9620026b539c041461a3ceada897c.gif][]

![bc8fa31eb005a84fcf463d366458d787.gif][]

## @RequestParam ##

@RequestParam用于将请求参数区数据映射到功能处理方法的参数上，用例：

/**
         * @RequestParam("id") 带参映射
         * @param id
         * @return
         */
        @RequestMapping("/testRequestParam")
        public String testRequestParam(@RequestParam("id") int id) {
            System.out.println("testRequestParam  " + id);
            return "success";
        }

![4706ca07f4f95c9d5ca7cf28c61721da.gif][]

![6d8e624f318f061255b180e41948bdb7.gif][]

@ResponseBody

作用： 该注解用于将Controller的方法返回的对象，通过适当的HttpMessageConverter转换为指定格式后，写入到Response对象的body数据区。

使用时机：返回的数据不是html标签的页面，而是其他某种格式的数据时（如json、xml等）使用。

[ff8fc6b905472b9aca10fb5e7f645e56.gif]: https://img-blog.csdnimg.cn/img_convert/ff8fc6b905472b9aca10fb5e7f645e56.gif
[7f65e9d3f5f607a5e38963258e68bcb4.gif]: https://img-blog.csdnimg.cn/img_convert/7f65e9d3f5f607a5e38963258e68bcb4.gif
[Qualifier]: https://so.csdn.net/so/search?q=Qualifier&spm=1001.2101.3001.7020
[c9db0082744a4a426f50bc85fb4c3433.gif]: https://img-blog.csdnimg.cn/img_convert/c9db0082744a4a426f50bc85fb4c3433.gif
[f648910e6fc3763981c765f5e3c8faae.gif]: https://img-blog.csdnimg.cn/img_convert/f648910e6fc3763981c765f5e3c8faae.gif
[dc0cb8315a9b7c849617ad8f4dddf411.gif]: https://img-blog.csdnimg.cn/img_convert/dc0cb8315a9b7c849617ad8f4dddf411.gif
[afb7e3f6e984e6d5fd7202be7a46af0d.gif]: https://img-blog.csdnimg.cn/img_convert/afb7e3f6e984e6d5fd7202be7a46af0d.gif
[fa7b85d9a725f0cdde9299ce7d73fc66.gif]: https://img-blog.csdnimg.cn/img_convert/fa7b85d9a725f0cdde9299ce7d73fc66.gif
[ac9ad9ed39f71ce41352351105a523a6.gif]: https://img-blog.csdnimg.cn/img_convert/ac9ad9ed39f71ce41352351105a523a6.gif
[c5a9620026b539c041461a3ceada897c.gif]: https://img-blog.csdnimg.cn/img_convert/c5a9620026b539c041461a3ceada897c.gif
[bc8fa31eb005a84fcf463d366458d787.gif]: https://img-blog.csdnimg.cn/img_convert/bc8fa31eb005a84fcf463d366458d787.gif
[4706ca07f4f95c9d5ca7cf28c61721da.gif]: https://img-blog.csdnimg.cn/img_convert/4706ca07f4f95c9d5ca7cf28c61721da.gif
[6d8e624f318f061255b180e41948bdb7.gif]: https://img-blog.csdnimg.cn/img_convert/6d8e624f318f061255b180e41948bdb7.gif