一口气带你吃透40个常用的Spring Boot注解

# Spring Web MVC注解

@RequestMapping

完整版Java笔记白嫖：大家可以扫二维码免费领取
@RequestMapping注解的主要用途是将Web请求与请求处理类中的方法进行映射。

Spring MVC和Spring WebFlux都通过RquestMappingHandlerMapping和RequestMappingHndlerAdapter两个类来提供对@RequestMapping注解的支持。

@RequestMapping注解对请求处理类中的请求处理方法进行标注；

@RequestMapping注解拥有以下的六个配置属性：

• value: 映射的请求URL或者其别名
  指定请求的实际地址，指定的地址可以是URI Template 模式；
• method: 兼容HTTP的方法名
  指定请求的method类型， GET、POST、PUT、DELETE等；
• params: 根据HTTP参数的存在、缺省或值对请求进行过滤
  指定request中必须包含某些参数值时，才让该方法处理。
• header: 根据HTTP Header的存在、缺省或值对请求进行过滤
  指定request中必须包含某些指定的header值，才能让该方法处理请求。
• consume: 设定在HTTP请求正文中允许使用的媒体类型
  指定处理请求的提交内容类型（Content-Type），例如application/json, text/html;
• product: 在HTTP响应体中允许使用的媒体类型
  指定返回的内容类型，仅当request请求头中的(Accept)类型中包含该指定类型才返回；

提示：在使用@RequestMapping之前，请求处理类还需要使用@Controller或@RestController进行标记

示例

@RestControllerpublic class ControllerTest {
   
    @RequestMapping(value = "/demo/home", method = RequestMethod.GET)    public String home() {
           return "home";    }
    // controller–限制接收post 请求以及consumes="application/json"。    @RequestMapping(value = "/testMethod", method = RequestMethod.POST,consumes="application/json")    public String testMethod() {        System.out.println("testMethod");        return "SUCCESS";    }
    // 返回值类型是json格式    // text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8    // 其中最后一项 ：*/*;q=0.8。    // 该项表明可以接收任何类型的，权重系数0.8表明如果前面几种类型不能正常接收。则使用该项进行自动分析。    // application/json 几种主流浏览器都可以自动解析。    @RequestMapping(value = "/testMethod", method = RequestMethod.POST,produces="application/json")    @ResponseBody    public RestMessage testMethod2(Model model) throws IOException {
   

        return new RestMessage("SUCCESS");    }
    // 设定必须包含username 和age两个参数，且age参数不为10 (可以有多个参数)。    @RequestMapping(value = "testParams", params = { "username","age!=10" })    public String testParams() {        System.out.println("testParamsAndHeaders");        return "SUCCESS";    }
    // 设定请求头中第一语言必须为US。    // 必须包含username 和age两个参数，且age参数不为10 (可以有多个参数)。    @RequestMapping(value = "testParamsAndHeaders", params = { "username","age!=10" }, headers = { "Accept-Language=US,zh;q=0.8" })    public String testParamsAndHeaders() {        System.out.println("testParamsAndHeaders");        return "SUCCESS";    }}

@RequestBody

@RequestBody在处理请求方法的参数列表中使用，它可以将请求主体中的参数绑定到一个对象中，请求主体参数是通过HttpMessageConverter传递的，

根据请求主体中的参数名与对象的属性名进行匹配并绑定值。

此外，还可以通过@Valid注解对请求主体中的参数进行校验。

示例

@PostMapping("/user")public User createUser(@Valid @RequestBody User user) {
       return sava(user);}

@GetMapping

@GetMapping注解用于处理HTTP GET请求，并将请求映射到具体的处理方法中。

具体来说，@GetMapping是一个组合注解，它相当于是@RequestMapping(method=RequestMethod.GET)的快捷方式。

@PostMapping

@PostMapping注解用于处理HTTP POST请求，并将请求映射到具体的处理方法中。@PostMapping与@GetMapping一样，也是一个组合注解，它相当于是@RequestMapping(method=HttpMethod.POST)的快捷方式。

@PutMapping

@PutMapping注解用于处理HTTP PUT请求，并将请求映射到具体的处理方法中，@PutMapping是一个组合注解，相当于是@RequestMapping(method=HttpMethod.PUT)的快捷方式。

@DeleteMapping

@DeleteMapping注解用于处理HTTP DELETE请求，并将请求映射到删除方法中。@DeleteMapping是一个组合注解，它相当于是@RequestMapping(method=HttpMethod.DELETE)的快捷方式。

@PatchMapping

@PatchMapping注解用于处理HTTP PATCH请求，并将请求映射到对应的处理方法中。@PatchMapping相当于是@RequestMapping(method=HttpMethod.PATCH)的快捷方式。

@ControllerAdvice

@ControllerAdvice是@Component注解的一个延伸注解，Spring会自动扫描并检测被@ControllerAdvice所标注的类。

@ControllerAdvice需要和@ExceptionHandler、@InitBinder以及@ModelAttribute注解搭配使用，主要是用来处理控制器所抛出的异常信息。

首先，我们需要定义一个被@ControllerAdvice所标注的类，在该类中，定义一个用于处理具体异常的方法，并使用@ExceptionHandler注解进行标记。

此外，在有必要的时候，可以使用@InitBinder在类中进行全局的配置，还可以使用@ModelAttribute配置与视图相关的参数。

使用@ControllerAdvice注解，就可以快速的创建统一的，自定义的异常处理类。

示例

@ControllerAdvice(basePackages = {
   "com.xie.controller"})public class UserControllerAdvice {
   
    @InitBinder    public void binder(WebDataBinder binder) {
           SimpleDateFormat dateFormat = new SimpleDateFormat