SpringMVC常用注解分类解析

SpringMVC常用注解分类解析

便捷级别

1. 种类

   1. @Data

      对象类免去get set方法

   2. @Slf4j

      用作日志输出，免去定义private final Logger logger = LoggerFactory.getLogger(当前类名.class);

2. 注意点

   1. 引入

   <dependency>
       <groupId>org.projectlombok</groupId>
       <artifactId>lombok</artifactId>
       <optional>true</optional>
   </dependency>
   

   2. 安装

      lombok插件

类级别

1. @RestController

   @Controllrt 和 @ResponseBody 的组合

   1. @Controller

      1. 解析为跳转路径

         @Controller
         public class Test {
         
             @RequestMapping("/test1")
             public String test() {
                 return "test";
             }
         }
         

         此时的url 路径为 /test1/test，会跳转到test.html/jsp页面

      2. 可以看到上面users方法的返回值是字符串类型的，这个就是处理器在处理完任务后将要跳转的页面。如果想要方法直接返回结果，而不是跳转页面，这就要用到@ResponseBody注解了。

   2. ResponseBody

      1. @ResponseBody表示方法的返回值直接以指定的格式写入Http response body中，而不是解析为跳转路径。
      2. 格式的转换是通过HttpMessageConverter中的方法实现的，因为它是一个接口，因此由其实现类完成转换。
      3. 如果要求方法返回的是json格式数据，而不是跳转页面，可以直接在类上标注@RestController，而不用在每个方法中标注@ResponseBody，简化了开发过程。

2. @RequestMapping

   1. 配置url映射
   2. 可以作用在控制器的某个方法上，也可以作用在此控制器类上。
   3. 当控制器在类级别上添加@RequestMapping注解时，这个注解会应用到控制器的所有处理器方法上。
   4. 处理器方法上的@RequestMapping注解会对类级别上的@RequestMapping的声明进行补充。

方法级别

1. GetMapping - 请求资源应该使用GET
2. PostMapping - 添加资源应该使用POST
3. PutMapping - 更新资源应该使用PUT
4. DeleteMapping - 删除资源应该使用DELETE

参数级别

1. @RequestBody

   1. 注解@RequestBody接收的参数是来自requestBody中，即请求体。
   2. 处理非 Content-Type: application/x-www-form-urlencoded编码格式的数据，比如：application/json、application/xml等类型的数据。
   3. 使用注解@RequestBody可以将body里面所有的json数据传到后端，后端再进行解析。
   4. 适用于PostMapping

2. @RequestParam

   1. 注解@RequestParam接收的参数是来自requestHeader中，即请求头。

   2. RequestParam可以接受简单类型的属性，也可以接受对象类型。

   3. @RequestParam有三个配置参数：

      • required 表示是否必须，默认为 true，必须。
      • defaultValue 可设置请求参数的默认值。
      • value 为接收url的参数名（相当于key值）。

   4. @RequestParam用来处理 Content-Type 为 application/x-www-form-urlencoded 编码的内容，Content-Type默认为该属性。

   5. 适用于GetMapping

3. 区别

   1. 注解@RequestParam接收的参数是来自requestHeader中，即请求头。通常用于GET请求，像POST、DELETE等其它类型的请求也可以使用。但是这样不支持批量插入数据啊，如果改用 json 字符串来传值的话，类型设置application/json，点击发送的话，会报错，后台接收不到值，为null
   2. 注解@RequestBody接收的参数是来自requestBody中，即请求体。一般用于处理非 Content-Type: application/x-www-form-urlencoded编码格式的数据，比如：application/json、application/xml等类型的数据。通常用于接收POST、DELETE等类型的请求数据，GET类型也可以适用。