在Spring Boot中spring mvc常见注解解析及部分源码

在Spring Boot中spring web mvc常见注解解析及部分源码

1. ***Spring Web MVC ***
   1-1、Spring MVC 注解
   （1）@RequestMapping
   @RequestMapping注解的主要用途是将Web请求与请求处理类中的方法进行 映射。Spring MVC和Spring WebFlux都通过RquestMappingHandlerMapping和RequestMappingHndlerAdapter两个类来提供对@RequestMapping注解的支持。

   @RequestMapping注解对请求处理类中的请求处理方法进行标注；
   @RequestMapping注解拥有以下的六个配置属性：
   

   params:指定request中必须包含某些参数值是，才让该方法处理。
   headers:指定request中必须包含某些指定的header值，才能让该方法处理请求。
   value:指定请求的实际地址，指定的地址可以是URI Template 模式
   method:指定请求的method类型， GET、POST、PUT、DELETE等
   consumes:指定处理请求的提交内容类型（Content-Type），如application/json,text/html;
   produces:指定返回的内容类型，仅当request请求头中的(Accept)类型中包含该指定类型才返回

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

//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//

package org.springframework.web.bind.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.springframework.core.annotation.AliasFor;

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Mapping
public @interface RequestMapping {
    String name() default "";

    @AliasFor("path")
    String[] value() default {};

    @AliasFor("value")
    String[] path() default {};

    RequestMethod[] method() default {};

    String[] params() default {};

    String[] headers() default {};

    String[] consumes() default {};

    String[] produces() default {};
}

下面是使用@RequestMapping的两个示例：

@RequestMapping(value="/") method 不写的话，默认GET、POST都支持，根据前端方式自动适应

@RequestMapping还可以对类进行标记，这样类中的处理方法在映射请求路径时，会自动将类上@RequestMapping设置的value拼接到方法中映射路径之前，如下：

（2）@RequestBody
@RequestBody在处理请求方法的参数列表中使用，它可以将请求主体中的参数绑定到一个对象中，请求主体参数是通过HttpMessageConverter传递的，根据请求主体中的参数名与对象的属性名进行匹配并绑定值。此外，还可以通过@Valid注解对请求主体中的参数进行校验。下面是一个使用@RequestBody的示例：

（3）@GetMapping
@GetMapping注解用于处理HTTP GET请求，并将请求映射到具体的处理方法中。具体来说，@GetMapping是一个组合注解，
它相当于是@RequestMapping(method=RequestMethod.GET)的快捷方式。
下面是@GetMapping的一个使用示例：

@Controller
public class ThymeleafController {
    @RequestMapping("/user")
    public String indexController(Model model) {
        List<User> users = new ArrayList<>();
        users.add(new User(1, "毛阿毛", "admin"));
        users.add(new User(2, "毛mao", "admin123"));
        model.addAttribute("users", users);
        return "user";
    }
}

（4）@PostMapping
@PostMapping注解用于处理HTTP POST请求，并将请求映射到具体的处理方法中。@PostMapping与@GetMapping一样，也是一个组合注解，
相当于是@RequestMapping(method=HttpMethod.POST)的快捷方式。
（5）@PutMapping
@PutMapping注解用于处理HTTP PUT请求，并将请求映射到具体的处理方法中，
@PutMapping是一个组合注解，
相当于是@RequestMapping(method=HttpMethod.PUT)的快捷方式。
（6）@PutMapping
@PutMapping注解用于处理HTTP PUT请求，并将请求映射到具体的处理方法中，
@PutMapping是一个组合注解，
相当于是@RequestMapping(method=HttpMethod.PUT)的快捷方式。
（7）@DeleteMapping
@DeleteMapping注解用于处理HTTP DELETE请求，并将请求映射到删除方法中。@DeleteMapping是一个组合注解，
相当于是@RequestMapping(method=HttpMethod.DELETE)的快捷方式。
（8）@PatchMapping
@PatchMapping注解用于处理HTTP PATCH请求，并将请求映射到对应的处理方法中。@PatchMapping相当于是@RequestMapping(method=HttpMethod.PATCH)的快捷方式。

（9）@ResponseBody
@ResponseBody会自动将控制器中方法的返回值写入到HTTP响应中。
特别的，@ResponseBody注解只能用在被 @Controller注解标记的类中。
如果在被 @RestController标记的类中，则方法不需要使用 @ResponseBody注解进行标注。@RestController相当于是 @Controller和 @ResponseBody的组合注解。
下面是使用该注解的一个示例：
IDEA中源码

//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//

package org.springframework.web.bind.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.springframework.core.annotation.AliasFor;
import org.springframework.stereotype.Controller;

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Controller
@ResponseBody
public @interface RestController {
    @AliasFor(
        annotation = Controller.class
    )
    String value() default "";
}

（10）@PathVariable
@PathVariable注解是将方法中的参数绑定到请求URI中的模板变量上。可以通过@RequestMapping注解来指定URI的模板变量，然后使用@PathVariable注解将方法中的参数绑定到模板变量上。
特别地，@PathVariable注解允许我们使用value或name属性来给参数取一个别名。
下面是使用此注解的一个示例：

模板变量名需要使用“{ }”进行包裹，如果方法的参数名与URI模板变量名一致，则在@PathVariable中就可以省略别名的定义。下面是一个简写的示例：

提示：如果参数是一个非必须的，可选的项，则可以在@PathVariable中设置require= false
@PathVariable 源码
@PathVariable注解允许我们使用value或name属性来给参数取一个别名

//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//

package org.springframework.web.bind.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.springframework.core.annotation.AliasFor;

@Target({ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface PathVariable {
    @AliasFor("name")
    String value() default "";

    @AliasFor("value")
    String name() default "";

    boolean required() default true;
}

（11）@RequestParam
@RequestParam注解用于将方法的参数与Web请求的传递的参数进行绑定。
使用@RequestParam可以轻松的访问HTTP请求参数的值。
下面是使用该注解的代码示例：

该注解的其他属性配置与@PathVariable的配置相同，特别的，如果传递的参数为空，还可以通过defaultValue设置一个默认值。示例代码如下：

@RequestParam源码

//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//

package org.springframework.web.bind.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.springframework.core.annotation.AliasFor;

@Target({ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface RequestParam {
    @AliasFor("name")
    String value() default "";

    @AliasFor("value")
    String name() default "";

    boolean required() default true;

    String defaultValue() default "\n\t\t\n\t\t\n\ue000\ue001\ue002\n\t\t\t\t\n";
}

（12）@Controller
@Controller是@Component注解的一个延伸，Spring会自动扫描并配置被该注解标注的类。
此注解用于标注Spring MVC的控制器。
下面是使用此注解的示例代码：

(13)@RestController
@RestController是在Spring 4.0开始引入的，这是一个特定的控制器注解。
此注解相当于@Controller和@ResponseBody的快捷方式。
当使用此注解时，不需要再在方法上使用@ResponseBody注解。
下面是使用此注解的示例代码：

(14)@ModelAttribute
通过此注解，可以通过模型索引名称来访问已经存在于控制器中的model。下面是使用此注解的一个简单示例：

与@PathVariable和@RequestParam注解一样，如果参数名与模型具有相同的名字，则不必指定索引名称，简写示例如下：

特别地，如果使用@ModelAttribute对方法进行标注，Spring会将方法的返回值绑定到具体的Model上。示例如下：

在Spring调用具体的处理方法之前，被@ModelAttribute注解标注的所有方法都将被执行。

(15)@InitBinder
@InitBinder注解用于标注初始化WebDataBinider的方法，该方法用于对Http请求传递的表单数据进行处理，如时间格式化、字符串处理等。下面是使用此注解的示例：