Spring Boot 注解

Posted 2022-08-28 流楚丶格念

Spring Boot 注解

所有注解

总结了下Spring Boot 的所有注解

常用注解：

@SpringBootApplication注解：
在Spring Boot入口类中，唯一的一个注解就是@SpringBootApplication。它是Spring Boot项目的核心注解，用于开启自动配置，准确说是通过该注解内组合的@EnableAutoConfiguration开启了自动配置。

@EnableAutoConfiguration注解：
@EnableAutoConfiguration的主要功能是启动Spring应用程序上下文时进行自动配置，它会尝试猜测并配置项目可能需要的Bean。自动配置通常是基于项目classpath中引入的类和已定义的Bean来实现的。在此过程中，被自动配置的组件来自项目自身和项目依赖的jar包中。

@Import注解：
@EnableAutoConfiguration的关键功能是通过@Import注解导入的ImportSelector来完成的。从源代码得知@Import(AutoConfigurationImportSelector.class)是@EnableAutoConfiguration注解的组成部分，也是自动配置功能的核心实现者。

@Conditional注解：
@Conditional注解是由Spring 4.0版本引入的新特性，可根据是否满足指定的条件来决定是否进行Bean的实例化及装配，比如，设定当类路径下包含某个jar包的时候才会对注解的类进行实例化操作。总之，就是根据一些特定条件来控制Bean实例化的行为。

@Conditional衍生注解：
在Spring Boot的autoconfigure项目中提供了各类基于@Conditional注解的衍生注解，它们适用不同的场景并提供了不同的功能。通过阅读这些注解的源码，你会发现它们其实都组合了@Conditional注解，不同之处是它们在注解中指定的条件（Condition）不同。

• @ConditionalOnBean：在容器中有指定Bean的条件下。
• @ConditionalOnClass：在classpath类路径下有指定类的条件下。
• @ConditionalOnCloudPlatform：当指定的云平台处于active状态时。
• @ConditionalOnExpression：基于SpEL表达式的条件判断。
• @ConditionalOnJava：基于JVM版本作为判断条件。
• @ConditionalOnJndi：在JNDI存在的条件下查找指定的位置。
• @ConditionalOnMissingBean：当容器里没有指定Bean的条件时。
• @ConditionalOnMissingClass：当类路径下没有指定类的条件时。
• @ConditionalOnNotWebApplication：在项目不是一个Web项目的条件下。
• @ConditionalOnProperty：在指定的属性有指定值的条件下。
• @ConditionalOnResource：类路径是否有指定的值。
• @ConditionalOnSingleCandidate：当指定的Bean在容器中只有一个或者有多个但是指定了首选的Bean时。
• @ConditionalOnWebApplication：在项目是一个Web项目的条件下。