SpringBoot常用注解

Spring Web MVC 注解

单注解

@Controller
它是@Component注解的一个延伸，Spring会自动扫描并配置被该注解标注的类。此注解用于标注Spring MVC的控制器。

@RequestBody
在处理请求方法的参数列表中使用，它可以将请求主体中的参数绑定到一个对象中，请求主体参数是通过HttpMessageConverter传递的，根据请求主体中的参数名与对象的属性名进行匹配并绑定值。

@ResponseBody
自动将控制器中方法的返回值写入到HTTP响应中。它只能用在被@Controller注解标记的类中。

如果在被@RestController标记的类中，则方法不需要使用@ResponseBody注解进行标注。

@ResponseStatus
可以标注请求处理方法。使用此注解，可以指定响应所需要的HTTP STATUS。

可以使用HttpStauts类对该注解的value属性进行赋值。

@RequestMapping
将Web请求与请求处理类中的方法进行映射。Spring MVC和Spring WebFlux都通过RquestMappingHandlerMapping和RequestMappingHndlerAdapter两个类来提供对@RequestMapping注解的支持。
配置属性：
value:映射的请求URL或者其别名
method:兼容HTTP的方法名
params:根据HTTP参数的存在、缺省或值对请求进行过滤
header:根据HTTP Header的存在、缺省或值对请求进行过滤
consume:设定在HTTP请求正文中允许使用的媒体类型
product:在HTTP响应体中允许使用的媒体类型

使用该注解的时候需要使用@Controller或@RestController进行标记。

@ControllerAdvice
它是@Component注解的一个延伸注解，Spring会自动扫描并检测被@ControllerAdvice所标注的类。@ControllerAdvice需要和@ExceptionHandler、@InitBinder以及@ModelAttribute注解搭配使用，主要是用来处理控制器所抛出的异常信息。首先，我们需要定义一个被@ControllerAdvice所标注的类，在该类中，定义一个用于处理具体异常的方法，并使用@ExceptionHandler注解进行标记。

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

@ExceptionHandler
用于标注处理特定类型异常类所抛出异常的方法。当控制器中的方法抛出异常时，Spring会自动捕获异常，并将捕获的异常信息传递给被@ExceptionHandler标注的方法。

@PathVariable
将方法中的参数绑定到请求URI中的模板变量上。可以通过@RequestMapping注解来指定URI的模板变量，然后使用@PathVariable注解将方法中的参数绑定到模板变量上。它允许我们使用value或name属性来给参数取一个别名。
模板变量名需要使用“{ }”进行包裹，如果方法的参数名与URI模板变量名一致，则在@PathVariable中就可以省略别名的定义。

    @GetMapping("/delete/{id}")
    public R delete(@PathVariable("id") Long id) {
        pipeService.deleteById(id);
        return R.ok().put("data", "");
    }

如果参数是一个非必须的，可选的项，则可以在@PathVariable中设置require = false。

@RequestParam
用于将方法的参数与Web请求的传递的参数进行绑定。使用@RequestParam可以轻松的访问HTTP请求参数的值。

    /**
     * 列表
     */
    @GetMapping("/list")
    public R list(@RequestParam Map<String, Object> params) {
        PageUtils page = pipeService.queryPage(params);
        return R.ok().put("data", page);
    }

@ModelAttribute
通过模型索引名称来访问已经存在于控制器中的model。如果使用@ModelAttribute对方法进行标注，Spring会将方法的返回值绑定到具体的Model上。在Spring调用具体的处理方法之前，被@ModelAttribute注解标注的所有方法都将被执行。

@CrossOrigin
将为请求处理类或请求处理方法提供跨域调用支持。如果将此注解标注类，那么类中的所有方法都将获得支持跨域的能力。使用它可以微调跨域行为。

@InitBinder
用于标注初始化WebDataBinider的方法，该方法用于对Http请求传递的表单数据进行处理，如时间格式化、字符串处理等。

组合注解

@RestController
等同于同时加上了@Controller和@ResponseBody。当使用此注解时，不需要再在方法上使用@ResponseBody注解。

@GetMapping
用于处理HTTP GET请求，并将请求映射到具体的处理方法中。它相当于是@RequestMapping(method=RequestMethod.GET)的快捷方式。

@PostMapping
用于处理HTTP POST请求，并将请求映射到具体的处理方法中。它相当于是@RequestMapping(method=HttpMethod.POST)的快捷方式。

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

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

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

Spring Bean 注解

@ComponentScan
用于配置Spring需要扫描的被组件注解注释的类所在的包。可以通过配置其basePackages属性或者value属性来配置需要扫描的包路径。value属性是basePackages的别名。

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
@Documented
@Repeatable(ComponentScans.class)
public @interface ComponentScan {
}

@Service
@Component的一个延伸（特例），它用于标注业务逻辑类。与@Component注解一样，被此注解标注的类，会自动被Spring所管理。

@Repository
@Component注解的延伸，与@Component注解一样，被此注解标注的类会被Spring自动管理起来，@Repository注解用于标注DAO层的数据持久化类。

Spring Dependency Inject注解

@DependsOn
可以配置Spring IoC容器在初始化一个Bean之前，先初始化其他的Bean对象。

@Bean
告知Spring，被此注解所标注的类将需要纳入到Bean管理工厂中。

Scops注解

@Scope
用来定义@Component标注的类的作用范围以及@Bean所标记的类的作用范围。@Scope所限定的作用范围有：singleton、prototype、request、session、globalSession或者其他的自定义范围。

@Scope 单例模式
当@Scope的作用范围设置成Singleton时，被此注解所标注的类只会被Spring IoC容器初始化一次。在默认情况下，Spring IoC容器所初始化的类实例都为singleton。

容器配置注解

@Autowired
用于标记Spring将要解析和注入的依赖项。此注解可以作用在构造函数、字段和setter方法上。

@Primary
当系统中需要配置多个具有相同类型的bean时，@Primary可以定义这些Bean的优先级。

@Qualifier
当系统中存在同一类型的多个Bean时，@Autowired在进行依赖注入的时候就不知道该选择哪一个实现类进行注入。此时，可以使用@Qualifier注解来微调，帮助@Autowired选择正确的依赖项。

Spring Boot注解

@SpringBootApplication
Sprnig Boot项目的核心注解，目的是开启自动配置。它是一个组合注解，此注解相当于@Configuration、@EnableAutoConfiguration和@ComponentScan的组合。源码如下：

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(
    excludeFilters = {@Filter(
    type = FilterType.CUSTOM,
    classes = {TypeExcludeFilter.class}
), @Filter(
    type = FilterType.CUSTOM,
    classes = {AutoConfigurationExcludeFilter.class}
)}
)

@EnableAutoConfiguration
用于通知Spring，根据当前类路径下引入的依赖包，自动配置与这些依赖包相关的配置项。

@Conditional
控制更为复杂的配置条件。在Spring内置的条件控制注解不满足应用需求的时候，可以使用此注解定义自定义的控制条件，以达到自定义的要求。

@ImportResource
导入Spring的配置文件，让配置文件里面的内容生效。

@ConfigurationProperties
将属性注入到bean中，通过Component注解将bean注解到spring容器中。