springboot的核心注解详解

springboot的注解详解

Spring Boot 主要优势之一，就是“开箱即用，远离繁琐的配置”。

Spring Boot 架构没有代码生成，也不需要XML配置，有效避免大量的 Maven 导入和各种版本冲突，为 Spring 开发提供一个更快、更广泛的入门体验，掌握 Spring Boot 常用注解，是学习Spring Boot 架构的关键。

SpringBoot是一个框架，一种全新的编程规范，它的产生简化了框架的使用，所谓简化是指简化了Spring众多框架中所需的大量且繁琐的配置，所以SpringBoot是一个服务于框架的框架，服务范围是简化配置文件以及简化我们编写代码的难度, 其中注解起到了非常关键的作用, 能够极地降低我们的代码量, 今天我们就来介绍一下Springboot的最核心的27的注解.

一.常用注解

1.@SpringBootApplication

Spring Boot 最最最核心的注解，用在 Spring Boot 主类上，标识这是一个 Spring Boot 应用，用来开启 Spring Boot 的各项能力。

实际上这个注解是
@Configuration,
@EnableAutoConfiguration ,
@ComponentScan三个注解的组合。

由于这些注解一般都是一起使用，所以Spring Boot提供了一个统一的注解@SpringBootApplication。

2.@Component

@Component是一个元注解，意思是可以注解其他类注解，如@Controller @Service @Repository。带此注解的类被看作组件，当使用基于注解的配置和类路径扫描的时候，这些类就会被实例化。其他类级别的注解也可以被认定为是一种特殊类型的组件，比如@Controller 控制器（注入服务）、@Service服务（注入dao）、@Repository dao（实现dao访问）。@Component泛指组件，当组件不好归类的时候，我们可以使用这个注解进行标注，作用就相当于 XML配置，。

3.@Configuration

从Spring3.0，@Configuration用于定义配置类，可替换xml配置文件，被注解的类内部包含有一个或多个被@Bean注解的方法，这些方法将会被AnnotationConfigApplicationContext或AnnotationConfigWebApplicationContext类进行扫描，并用于构建bean定义，初始化Spring容器。

4.@ComponentScan

Spring组件扫描功能，让spring Boot扫描到Configuration类并把它加入到程序上下文。

做过web开发的同学一定都有用过@Controller，@Service，@Repository注解，查看其源码你会发现，他们中有一个共同的注解@Component，没错@ComponentScan注解默认就会装配标识了
@Controller，
@Service，
@Repository，
@Component注解的类到spring容器中。

5.@EnableAutoConfiguration

打开自动配置的功能，也可以关闭某个自动配置的选项，允许 Spring Boot 自动配置注解，开启这个注解之后，Spring Boot 就能根据当前类路径下的包或者类来配置 Spring Bean。

如关闭数据源自动配置功能： @SpringBootApplication(exclude = { DataSourceAutoConfiguration.class })；

4.@SpringBootConfiguration

这个注解只是用来修饰是 Spring Boot 配置而已，或者可利于 Spring Boot 后续的扩展。

（一）.配置导入功能

1.1 @Configuration
等同于spring的XML配置文件，使用Java代码可以检查类型安全。指出该类是 Bean 配置的信息源，相当于XML中的，一般加在主类上。

1.2 @Bean

相当于XML中的，放在方法的上面，而不是类，意思是产生一个bean,并交给spring管理；

1.3 @Import

用来导入其他配置类；

1.4 @ImportResource

用来加载xml配置文件；

1.5 @Autowired

自动导入依赖的bean，自动导入依赖的bean。byType方式。把配置好的Bean拿来用，完成属性、方法的组装，它可以对类成员变量、方法及构造函数进行标注，完成自动装配的工作。当加上（required=false）时，就算找不到bean也不报错；

1.6 @Resource(name=“name”,type=“type”)

没有括号内内容的话，默认byName，与@Autowired干类似的事；

1.7 @Inject

等价于默认的@Autowired，只是没有required属性；

（二）.业务层功能
2.1 @Component
泛指组件，当组件不好归类的时候，我们可以使用这个注解进行标注；

2.2 @Controller

用于定义控制器类，在spring项目中由控制器负责将用户发来的URL请求转发到对应的服务接口（service层），一般这个注解在类中，通常方法需要配合注解@RequestMapping；

2.3 @RestController

用于标注控制层组件(如struts中的action)，是@ResponseBody和@Controller的合集；

2.4 @Service

一般用于修饰service层的组件；

2.5 @Repository

用于标注数据访问组件，即DAO组件；

2.6 @RequestMapping

提供路由信息，负责URL到Controller中的具体函数的映射；

该注解包含以下6个属性：（常用value）

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

表示该方法的返回结果直接写入HTTP response body中，一般在异步获取数据时使用，用于构建RESTful的api。在使用@RequestMapping后，返回值通常解析为跳转路径，加上@esponsebody后返回结果不会被解析为跳转路径，而是直接写入HTTP response body中。比如异步获取json数据，加上@Responsebody后，会直接返回json数据。该注解一般会配合@RequestMapping一起使用；

2.8 @Value

注入 application.properties 或 application.yml 配置的属性的值；

2.9 @PathVariable

路径变量，参数与大括号里的名字一样要相同；

2.10 @Profiles

Spring Profiles 提供了一种隔离应用程序配置的方式，并让这些配置只能在特定的环境下生效。任何@Component或@Configuration都能被@Profile标记，从而限制加载它的时机；

2.11 @ConfigurationProperties

Spring Boot将尝试校验外部的配置，默认使用JSR-303（如果在classpath路径中）。你可以轻松的为你的@ConfigurationProperties 类添加JSR-303 javax.validation约束注解；

（三）.全局异常处理

3.1 @ControllerAdvice
包含@Component，可以被扫描到，统一处理异常；

3.2 @ExceptionHandler（Exception.class）

二.不常用注解

4.@ConditionalOnBean

@ConditionalOnBean(A.class)仅仅在当前上下文中存在A对象时，才会实例化一个Bean，也就是说只有当A.class 在spring的applicationContext中存在时，这个当前的bean才能够创建。

5.@ConditionalOnMissingBean

组合@Conditional注解，和@ConditionalOnBean注解相反，仅仅在当前上下文中不存在A对象时，才会实例化一个Bean。

6.@ConditionalOnClass

组合 @Conditional 注解，可以仅当某些类存在于classpath上时候才创建某个Bean。

7.@ConditionalOnMissingClass

组合@Conditional注解，和@ConditionalOnMissingClass注解相反，当classpath中没有指定的 Class才开启配置。

8.@ConditionalOnWebApplication

组合@Conditional 注解，当前项目类型是 WEB 项目才开启配置。当前项目有以下 3 种类型:ANY(任何Web项目都匹配)、SERVLET（仅但基础的Servelet项目才会匹配）、REACTIVE（只有基于响应的web应用程序才匹配）。

9.@ConditionalOnNotWebApplication

组合@Conditional注解，和@ConditionalOnWebApplication 注解相反，当前项目类型不是 WEB 项目才开启配置。

10.@ConditionalOnProperty

组合 @Conditional 注解，当指定的属性有指定的值时才开启配置。具体操作是通过其两个属性name以及havingValue来实现的，其中name用来从application.properties中读取某个属性值，如果该值为空，则返回false;如果值不为空，则将该值与havingValue指定的值进行比较，如果一样则返回true;否则返回false。如果返回值为false，则该configuration不生效；为true则生效。

10.@ConditionalOnExpression

组合 @Conditional 注解，当 SpEL 表达式为 true 时才开启配置。

12.@ConditionalOnJava

组合@Conditional 注解，当运行的 Java JVM 在指定的版本范围时才开启配置。

13.@ConditionalOnResource
组合 @Conditional 注解，当类路径下有指定的资源才开启配置

14.@ConditionalOnJndi

组合 @Conditional 注解，当指定的 JNDI 存在时才开启配置。

15.@ConditionalOnCloudPlatform

组合 @Conditional 注解，当指定的云平台激活时才开启配置。

16.@ConditionalOnSingleCandidate
组合 @Conditional 注解，当指定的 class 在容器中只有一个 Bean，或者同时有多个但为首选时才开启配置。

17.@ConfigurationProperties

Spring Boot可使用注解的方式将自定义的properties文件映射到实体bean中，比如config.properties文件。

18.@EnableConfigurationProperties

当@EnableConfigurationProperties注解应用到你的@Configuration时，任何被@ConfigurationProperties注解的beans将自动被Environment属性配置。这种风格的配置特别适合与SpringApplication的外部YAML配置进行配合使用。

19.@AutoConfigureAfter

用在自动配置类上面，表示该自动配置类需要在另外指定的自动配置类配置完之后。

20.@AutoConfigureBefore

这个和@AutoConfigureAfter注解使用相反，表示该自动配置类需要在另外指定的自动配置类配置之前。

21.@AutoConfigureOrder

Spring Boot 1.3.0中有一个新的注解@AutoConfigureOrder，用于确定配置加载的优先级顺序。

24.@Conditional

@Conditional是Spring4新提供的注解，通过@Conditional注解可以根据代码中设置的条件装载不同的bean，在设置条件注解之前，先要把装载的bean类去实现Condition接口，然后对该实现接口的类设置是否装载的条件。Spring Boot注解中的@ConditionalOnProperty、@ConditionalOnBean等以@Conditional*开头的注解，都是通过集成了@Conditional来实现相应功能的。

25.@Import

通过导入的方式实现把实例加入springIOC容器中。可以在需要时将没有被Spring容器管理的类导入至Spring容器中。

例如：

在这里插入图片描述