SpringBoot 常用注解

男娘i 2022-08-29 10:42 247阅读 0赞

### SpringBoot 常用注解 ###

*  一、Spring Web MVC 与 Spring Bean 注解
 *   *  Spring Web MVC 注解
     *   *  @RequestMapping
         *  @RequestBody
         *  @GetMapping
         *  @PostMapping
         *  @DeleteMapping
         *  @PatchMapping
         *  @ControllerAdvice
         *  @ResponseBody
         *  @ExceptionHandler
         *  @ResponseStatus
         *  @PathVariable
         *  @RequestParam
         *  @Controller @RestController
         *  @ModelAttribute
         *  @CrossOrigin
         *  @InitBinder
 *  二、Spring Bean 注解
 *   *   *  @ComponentScan
         *  @Component
         *  @Service
         *  @Repository
 *  三、Spring Dependency Inject 与 Bean Scops注解
 *   *  Spring DI注解
     *   *  @DependsOn
         *  @Bean
     *  Scops注解
     *   *  @Scope
         *  @Scope 单例模式
 *  四、容器配置注解
 *   *   *  @Autowired
         *  @Primary
         *  @PostConstruct与@PreDestroy
         *  @Qualifier
 *  五、Spring Boot注解
 *   *   *  @SpringBootApplication
         *  @EnableAutoConfiguration
         *  @ConditionalOnClass与@ConditionalOnMissingClass
         *  @ConditionalOnBean与@ConditionalOnMissingBean
         *  @ConditionalOnProperty
         *  @ConditionalOnResource
         *  @ConditionalOnWebApplication与@ConditionalOnNotWebApplication
         *  @ConditionalExpression
         *  @Conditional

# 一、Spring Web MVC 与 Spring Bean 注解 #

## Spring Web MVC 注解 ##

### @RequestMapping ###

@RequestMapping注解的主要用途是将Web请求与请求处理类中的方法进行映射。  
![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NzZG41NjU5NzM4NTA_size_16_color_FFFFFF_t_70][]  
@RequestMapping注解对请求处理类中的请求处理方法进行标注；@RequestMapping注解拥有以下的六个配置属性：

*  value:映射的请求URL或者其别名
 *  method:兼容HTTP的方法名
 *  params:根据HTTP参数的存在、缺省或值对请求进行过滤
 *  header:根据HTTP Header的存在、缺省或值对请求进行过滤
 *  consume:设定在HTTP请求正文中允许使用的媒体类型
 *  product:在HTTP响应体中允许使用的媒体类型

提示：在使用@RequestMapping之前，请求处理类还需要使用@Controller或@RestController进行标记。  
@RequestMapping可以对类和方法进行标记，这样类中的处理方法在映射请求路径时，会自动将类上@RequestMapping设置的value拼接到方法中映射路径之前。  
![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NzZG41NjU5NzM4NTA_size_16_color_FFFFFF_t_70 1][]

### @RequestBody ###

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

### @GetMapping ###

@GetMapping注解用于处理HTTP GET请求，并将请求映射到具体的处理方法中。具体来说，@GetMapping是一个组合注解，它相当于是@RequestMapping(method=RequestMethod.GET)的快捷方式。  
![5fe5b5426d6e41f981ad7e1b1401f73e.png][]

### @PostMapping ###

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

### @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注解，就可以快速的创建统一的，自定义的异常处理类。  
![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NzZG41NjU5NzM4NTA_size_16_color_FFFFFF_t_70 2][]

### @ResponseBody ###

@ResponseBody会自动将控制器中方法的返回值写入到HTTP响应中。特别的，@ResponseBody注解只能用在被@Controller注解标记的类中。如果在被@RestController标记的类中，则方法不需要使用@ResponseBody注解进行标注。@RestController相当于是@Controller和@ResponseBody的组合注解。  
![0cddb45bc3034554bee4c80d49103e67.png][]

### @ExceptionHandler ###

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

### @ResponseStatus ###

@ResponseStatus注解可以标注请求处理方法。使用此注解，可以指定响应所需要的HTTP STATUS。特别地，我们可以使用HttpStauts类对该注解的value属性进行赋值。

### @PathVariable ###

@PathVariable注解是将方法中的参数绑定到请求URI中的模板变量上。可以通过@RequestMapping注解来指定URI的模板变量，然后使用@PathVariable注解将方法中的参数绑定到模板变量上。

特别地，@PathVariable注解允许我们使用value或name属性来给参数取一个别名。模板变量名需要使用\{ \}进行包裹，如果方法的参数名与URI模板变量名一致，则在@PathVariable中就可以省略别名的定义。  
![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NzZG41NjU5NzM4NTA_size_16_color_FFFFFF_t_70 3][]

### @RequestParam ###

@RequestParam注解用于将方法的参数与Web请求的传递的参数进行绑定。使用@RequestParam可以轻松的访问HTTP请求参数的值。  
该注解的其他属性配置与@PathVariable的配置相同，特别的，如果传递的参数为空，还可以通过defaultValue设置一个默认值。  
![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NzZG41NjU5NzM4NTA_size_16_color_FFFFFF_t_70 4][]

### @Controller @RestController ###

@Controller是@Component注解的一个延伸。  
@RestController是在Spring 4.0开始引入的，这是一个特定的控制器注解。此注解相当于@Controller和@ResponseBody的快捷方式。当使用此注解时，不需要再在方法上使用@ResponseBody注解。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NzZG41NjU5NzM4NTA_size_16_color_FFFFFF_t_70 5][]

### @ModelAttribute ###

通过此注解，可以通过模型索引名称来访问已经存在于控制器中的model。与@PathVariable和@RequestParam注解一样，如果参数名与模型具有相同的名字，则不必指定索引名称。  
特别地，如果使用@ModelAttribute对方法进行标注，Spring会将方法的返回值绑定到具体的Model上。  
在Spring调用具体的处理方法之前，被@ModelAttribute注解标注的所有方法都将被执行。

### @CrossOrigin ###

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

### @InitBinder ###

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

# 二、Spring Bean 注解 #

### @ComponentScan ###

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

### @Component ###

@Component注解用于标注一个普通的组件类，它没有明确的业务范围，只是通知Spring被此注解的类需要被纳入到Spring Bean容器中并进行管理。  
![2ec5d184ab9a4f3db27860987bba6e36.png][]

### @Service ###

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

### @Repository ###

@Repository注解也是@Component注解的延伸，与@Component注解一样，被此注解标注的类会被Spring自动管理起来，@Repository注解用于标注DAO层的数据持久化类。  
![323cd2ec5b0746e1828f138f9716ca75.png][]

# 三、Spring Dependency Inject 与 Bean Scops注解 #

## Spring DI注解 ##

### @DependsOn ###

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

### @Bean ###

@Bean注解主要的作用是告知Spring，被此注解所标注的类将需要纳入到Bean管理工厂中。  
![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NzZG41NjU5NzM4NTA_size_16_color_FFFFFF_t_70 9][]

## Scops注解 ##

### @Scope ###

@Scope注解可以用来定义@Component标注的类的作用范围以及@Bean所标记的类的作用范围。@Scope所限定的作用范围有：singleton、prototype、request、session、globalSession或者其他的自定义范围。这里以prototype为例子进行讲解。  
当一个Spring Bean被声明为prototype（原型模式）时，在每次需要使用到该类的时候，Spring IoC容器都会初始化一个新的改类的实例。在定义一个Bean时，可以设置Bean的scope属性为prototype：scope=“prototype”,也可以使用@Scope注解设置。

### @Scope 单例模式 ###

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

# 四、容器配置注解 #

### @Autowired ###

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

### @Primary ###

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

### @PostConstruct与@PreDestroy ###

这两个注解不属于Spring,它们是源于JSR-250中的两个注解，位于common-annotations.jar中。@PostConstruct注解用于标注在Bean被Spring初始化之前需要执行的方法。@PreDestroy注解用于标注Bean被销毁前需要执行的方法。  
![58ce80d39b1b460f936b8b52cd4c884a.png][]

### @Qualifier ###

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

# 五、Spring Boot注解 #

### @SpringBootApplication ###

@SpringBootApplication注解是一个快捷的配置注解，在被它标注的类中，可以定义一个或多个Bean，并自动触发自动配置Bean和自动扫描组件。此注解相当于@Configuration、@EnableAutoConfiguration和@ComponentScan的组合。  
![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NzZG41NjU5NzM4NTA_size_16_color_FFFFFF_t_70 10][]

### @EnableAutoConfiguration ###

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

### @ConditionalOnClass与@ConditionalOnMissingClass ###

这两个注解属于类条件注解，它们根据是否存在某个类作为判断依据来决定是否要执行某些配置。

### @ConditionalOnBean与@ConditionalOnMissingBean ###

这两个注解属于对象条件注解，根据是否存在某个对象作为依据来决定是否要执行某些配置方法。

### @ConditionalOnProperty ###

@ConditionalOnProperty注解会根据Spring配置文件中的配置项是否满足配置要求，从而决定是否要执行被其标注的方法。

### @ConditionalOnResource ###

此注解用于检测当某个配置文件存在时，则触发被其标注的方法。

### @ConditionalOnWebApplication与@ConditionalOnNotWebApplication ###

这两个注解用于判断当前的应用程序是否是Web应用程序。如果当前应用是Web应用程序，则使用Spring WebApplicationContext,并定义其会话的生命周期。

### @ConditionalExpression ###

此注解可以让我们控制更细粒度的基于表达式的配置条件限制。当表达式满足某个条件或者表达式为真的时候，将会执行被此注解标注的方法。

### @Conditional ###

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

参考文献：[40 个 SpringBoot 常用注解][40 _ SpringBoot]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NzZG41NjU5NzM4NTA_size_16_color_FFFFFF_t_70]: /images/20220829/951809c1291f44a283cef061534df45d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NzZG41NjU5NzM4NTA_size_16_color_FFFFFF_t_70 1]: /images/20220829/a0620c5c22f34fb1ba19137a3095528f.png
[5fe5b5426d6e41f981ad7e1b1401f73e.png]: /images/20220829/3be5ba3db3384981b2b881839aa7a1ee.png
[3f66027fe2774a028726ae35031e7d0e.png]: /images/20220829/cc0a3c5a038b45aa98c58bf1e01e9796.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NzZG41NjU5NzM4NTA_size_16_color_FFFFFF_t_70 2]: /images/20220829/845a58b26dc24264bfebbb2c827bbb31.png
[0cddb45bc3034554bee4c80d49103e67.png]: /images/20220829/f6d225a9982445488a7d9b33333b971a.png
[7aa35aa13f5a4237abf3a763798c6e76.png]: /images/20220829/b872d8e75b8a45d48356993f06736ad6.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NzZG41NjU5NzM4NTA_size_16_color_FFFFFF_t_70 3]: /images/20220829/1b96b2677c4b4bae8769d4e1f0ef63c9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NzZG41NjU5NzM4NTA_size_16_color_FFFFFF_t_70 4]: /images/20220829/8d21d960f24e4a9185d76cb9387420d1.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NzZG41NjU5NzM4NTA_size_16_color_FFFFFF_t_70 5]: /images/20220829/2c929c9dbbc241d7bf33150cf61f40b7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NzZG41NjU5NzM4NTA_size_16_color_FFFFFF_t_70 6]: /images/20220829/3a1621e99a214885aeabcd03fca31491.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NzZG41NjU5NzM4NTA_size_16_color_FFFFFF_t_70 7]: /images/20220829/c28696de9ddd40e0a7e586136570d839.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NzZG41NjU5NzM4NTA_size_16_color_FFFFFF_t_70 8]: /images/20220829/a580bbd405c0449793c2a8ab083d5489.png
[2ec5d184ab9a4f3db27860987bba6e36.png]: /images/20220829/54c721a99d0c4e5e9acf63afac3719fc.png
[b56cefa13e274bbd96cdf941f8f38fbe.png]: /images/20220829/c7e3b02ce3ce40c78643cb76020526a0.png
[323cd2ec5b0746e1828f138f9716ca75.png]: /images/20220829/2ac79887284247099cb91eafb50f0560.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NzZG41NjU5NzM4NTA_size_16_color_FFFFFF_t_70 9]: /images/20220829/c562861ac5d349c99f739f323396bd93.png
[58ce80d39b1b460f936b8b52cd4c884a.png]: /images/20220829/6a26f3017bec4b76b8f9c6ccdb77746f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NzZG41NjU5NzM4NTA_size_16_color_FFFFFF_t_70 10]: /images/20220829/b42737fdf6564106b5325c295f4fbf6e.png
[40 _ SpringBoot]: https://mp.weixin.qq.com/s/6KO1Y6_SE-soB-HTFZoq8Q