SpringMVC 常用注解
一、SpringMVC常用注解
1. @Controller
在SpringMVC 中，控制器Controller 负责处理由DispatcherServlet 分发的请求，它把用户请求的数据经过业务处理层处理之后封装成一个Model ，然后再把该Model 返回给对应的View 进行展示。在SpringMVC 中提供了一个非常简便的定义Controller 的方法，你无需继承特定的类或实现特定的接口，只需使用@Controller 标记一个类是Controller ，然后使用@RequestMapping 和@RequestParam 等一些注解用以定义URL 请求和Controller 方法之间的映射，这样的Controller 就能被外界访问到。此外Controller 不会直接依赖于HttpServletRequest 和HttpServletResponse 等HttpServlet 对象，它们可以通过Controller 的方法参数灵活的获取到。
@Controller 用于标记在一个类上，使用它标记的类就是一个SpringMVC Controller 对象。 分发处理器将会扫描使用了该注解的类的方法，并检测该方法是否使用了@RequestMapping 注解。@Controller 只是定义了一个控制器类，而使用@RequestMapping 注解的方法才是真正处理请求的处理器。单单使用@Controller 标记在一个类上还不能真正意义上的说它就是SpringMVC 的一个控制器类，因为这个时候Spring 还不认识它。那么要如何做Spring 才能认识它呢？这个时候就需要我们把这个控制器类交给Spring 来管理。有两种方式：
<!--springmvc.xml-->
<!--方式一: 定义MyController 的bean 对象。-->
<bean class="cn.ea.controller.MyController"/>
<!--方式二: 告诉Spring 该到哪里去找标记为@Controller 的Controller 控制器。-->
<context:component-scan base-package = "cn.ea.controller" />
2. @RequestMapping
@RequestMapping是一个用来处理请求地址映射的注解，可用于类或方法上。用于类上，表示类中的所有响应请求的方法都是以该地址作为父路径。RequestMapping注解有六个属性：
- value：指定请求的实际地址，指定的地址可以是URI Template 模式；
- method：指定请求的method类型， GET、POST、PUT、DELETE等；
- consumes：指定处理请求的提交内容类型（Content-Type），例如application/json, text/html;
- produces：指定返回的内容类型，仅当request请求头中的(Accept)类型中包含该指定类型才返回；
- params：指定request中必须包含某些参数值是，才让该方法处理。
- headers：指定request中必须包含某些指定的header值，才能让该方法处理请求。
2.1 @GetMapping
@RequestMapping(value = “/hello”, method = RequestMethod.GET) = @GetMapping("/hello")
常用于获取资源。
GET请求：
- 安全且幂等
- 获取表示
- 变更时获取表示（缓存）
2.2 @PostMapping
@RequestMapping(value = “/hello”, method = RequestMethod.POST) = @PostMapping("/hello")
常用于创建资源。更新也行。
POST请求：
- 不安全且不幂等
- 使用服务端管理的（自动产生）的实例号创建资源
- 创建子资源
- 部分更新资源
- 如果没有被修改，则不过更新资源（乐观锁）
2.3 @PutMapping
@RequestMapping(value = “/hello”, method = RequestMethod.PUT) = @PutMapping("/hello")
常用于更新资源。
PUT请求：
- 不安全但幂等
- 用客户端管理的实例号创建一个资源
- 通过替换的方式更新资源
- 如果未被修改，则更新资源（乐观锁）
2.4 @DeleteMapping
@RequestMapping(value = “/hello”, method = RequestMethod.DELETE) = @DeleteMapping("/hello")
DELETE请求：
- 不安全但幂等
- 删除资源
参考 RESTful 架构详解 | 菜鸟教程 。
3. @RequestParam
@RequestParam主要用于在SpringMVC后台控制层获取参数，类似一种是request.getParameter(“name”)。
@RequestParam用于将请求参数区数据映射到功能处理方法的参数上。
它有三个常用参数：
· defaultValue = “0” //表示设置默认值
· required = false //通过boolean设置是否是必须要传入的参数
· value = “isApp” //表示接受的传入的参数类型。
@GetMapping("/index") // http://localhost:8080/city?id=123
public String index(@RequestParam String id){
System.out.println("index()========================" + id);
return "index";
}
4. @PathVariable
用于将请求URL中的模板变量映射到功能处理方法的参数上，即取出URI模板中的变量作为参数。
使用方法如下例：
@GetMapping("/index/{a}/{b}") // http://localhost:8080/index/123/abc
public String index(@PathVariable String a, @PathVariable String b){
System.out.println("index()========================" + a + " " +b);
return "index";
}
@GetMapping("/index/{a}/hello/{b}") // http://localhost:8080/index/123/hello/abc
public String index(@PathVariable("a") String a, @PathVariable(value = "b") String b){
System.out.println("index()========================" + a + " " +b);
return "index";
}
@GetMapping("/index/{a:[a-z-]+}") //传入的a必须时a~z的字符串
public String index(@PathVariable String a){
System.out.println("index()========================" + a);
return "index";
}
5. @ResponseBody
作用： 该注解用于将Controller的方法返回的对象，通过适当的HttpMessageConverter转换为指定格式后，写入到Response对象的body数据区。
使用时机：返回的数据不是html标签的页面，而是其他某种格式的数据时（如json、xml等）使用；
@ResponseBody
@RequestMapping(value = "/city", method = RequestMethod.GET)
public String getCity(){
return JSON.toJSONString(worldService.getCity());
}
6. @Resource和@Autowired
@Resource和@Autowired都是做bean的注入时使用，其实@Resource并不是Spring的注解，它的包是javax.annotation.Resource，但是Spring支持该注解的注入。
@Resource的作用相当于@Autowired，只不过@Autowired按照byType自动注入。
-
共同点
两者都可以写在字段和setter方法上。两者如果写在字段上，就不需要再写setter方法。 -
不同点
-
@Autowired 是spring提供的注解，是 按照类型（byType）装配依赖对象，默认情况下它要求依赖的对象必须存在，如果相应允许null值，可以设置它的required属性为false。如果我们想使用按照名称（byName）来装配，可以结合@Qualifier注解一起使用。
@Service public class UserServiceImpl { @Autowired @Qualifier("userDao") //当有@Qualifier时，是byName，没有时为byType。 private UserDao userDao; } -
@Resource默认按照ByName自动注入，由J2EE提供，需要导入包javax.annotation.Resource。@Resource有两个重要的属性：name和type，而Spring将@Resource注解的name属性解析为bean的名字，而type属性则解析为bean的类型。所以，如果使用name属性，则使用byName的自动注入策略，而使用type属性时则使用byType自动注入策略。如果既不制定name也不制定type属性，这时将通过反射机制使用byName自动注入策略。
· 最好是将@Resource放在setter方法上，因为这样更符合面向对象的思想，通过set、get去操作属性，而不是直接去操作属性。
· @Resource装配顺序：- 如果同时指定了name和type，则从Spring上下文中找到唯一匹配的bean进行装配，找不到则抛出异常。
- 如果指定了name，则从上下文中查找名称（id）匹配的bean进行装配，找不到则抛出异常。
- 如果指定了type，则从上下文中找到类似匹配的唯一bean进行装配，找不到或是找到多个，都会抛出异常。
- 如果既没有指定name，又没有指定type，则自动按照byName方式进行装配；如果没有匹配，则回退为一个原始类型进行匹配，如果匹配则自动装配。
@Service public class UserServiceImpl { private UserDao userDao; @Resource(name="userDao") public void setUserDao(UserDao userDao) { // 用于属性的setter方法上 this.userDao = userDao; } }
-
7. @Component
相当于通用的注解，当不知道一些类归到哪个层时使用，但是不建议。
8. @Repository
用于注解dao层
9. @SessionAttributes
@SessionAttributes 表示 将值放到session作用域中，写在class上面。
@SessionAttributes 除了可以通过属性名指定需要放到会话中的属性外（value 属性值），还可以通过模型属性的对象类型指定哪些模型属性需要放到会话中（types 属性值）。
@SessionAttributes(value = {"user"}, types = {String.class})
@Controller
public class SessionAttributesTest {
@RequestMapping("/testSessionAttributes")
public String testSessionAttributes(Map<String, Object> map) {
User user = new User(1, "me", "18");
map.put("user", user);
map.put("age", "25");
return "success";
}
}
10. @ModelAttribute
使用@ModelAttribute表示，该Controller的所有方法在调用前，先执行此@ModelAttribute方法，可用于注解和方法参数中，可以把这个@ModelAttribute特性，应用在BaseController当中，所有的Controller继承BaseController，即可实现在调用Controller时，先执行@ModelAttribute方法。
- 有 @ModelAttribute 标记的方法，会在每个目标方法执行之前被 SpringMVC 调用；
- @ModelAttribute注解也可以修饰目标方法POJO类形的入参，其value的属性值有如下作用：
1）SpringMVC会使用value属性值在implicitModel中查找对应的对象，若存在则直接传入到目标方法的入参中；
2）SpringMVC会以value为key,POJO类型的对象为value，存入的request中。@ModelAttribute public void getUser(@RequestParam(value = "id", required = false) int id, Map<String, Object> map) { //模拟数据库中获取对象 User user = new User(1, "刘邦", "123", "023", "重庆"); System.out.println("从数据库中获取一个对象：" + user); map.put("abc", user); }
运行流程：
- 执行@ModelAttribute注解修饰的方法，从数据库中取出对象，把对象放入Map中，键为：user；
- SpringMVC从Map中取出User对象，并把表单的请求参数赋值给该User对象的对应属性；
- SpringMVC把上述对象传入目标方法的参数。
注意：在@ModelAttribute修饰的方法中，放入到Map时的键需要和目标方法入参类型的第一个字母小写的字符串一致@RequestMapping("/testModelAttribute") public String testModelAttribute(@ModelAttribute("abc") User user) { System.out.println("修改：" + user); return "success"; }
11. @CookieValue
作用：用来获取Cookie中的值；
参数：value：参数名称；required：是否必须；defaultValue：默认值。
/**
* 获取 Session
* JSESSIONID=411A032E02A2594698F6E3F4458B9CE4
*/
@RequestMapping("/testCookieValue")
public String testCookieValue(@CookieValue("JSESSIONID") String sessionId) {
System.out.println("JSESSIONID = " + sessionId);
return "success";
}
未完待续~
喜欢就一键三连支持下哩！
1496
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
