AI专业者开发社区 1 号成员
  •  0 回帖  •  3 浏览  •  4 个月前
   

Spring Boot最核心的27个注解，你了解多少？

 

导读

 

Spring Boot 方式的项目开发已经逐步成为 Java 应用开发领域的主流框架，它不仅可以方便地创建生产级的 Spring 应用程序，还能轻松地通过一些注解配置与目前比较火热的微服务框架 SpringCloud 集成。

 

而 Spring Boot 之所以能够轻松地实现应用的创建及与其他框架快速集成，最核心的原因就在于它极大地简化了项目的配置，最大化地实现了“约定大于配置”的原则。然而基于 Spring Boot 虽然极大地方便了开发，但是也很容易让人“云里雾里”，特别是各种注解很容易让人“知其然而不知其所以然。

 

所以，要想用好 Spring Boot 就必须对其提供的各类功能注解有一个全面而清晰地认识和理解。一方面可以提高基于 Spring Boot 的开发效率，另一方面也是面试中被问及框架原理时所必需要掌握的知识点。在接下来的内容中，小编就带大家一起来探究下 Spring Boot 的一些常用注解吧！

 

Spring 相关 6 个注解

 

Spring Boot 的有些注解也需要与 Spring 的注解搭配使用，这里小编梳理了在项目中与 Spring Boot 注解配合最为紧密的 6 个 Spring 基础框架的注解。如👇

 

1、@Configuration

 

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

 

@Configuration
public class TaskAutoConfiguration {

    @Bean
    @Profile("biz-electrfence-controller")
    public BizElectrfenceControllerJob bizElectrfenceControllerJob() {
        return new BizElectrfenceControllerJob();
    }


    @Bean
    @Profile("biz-consume-1-datasync")
    public BizBikeElectrFenceTradeSyncJob bizBikeElectrFenceTradeSyncJob() {
        return new BizBikeElectrFenceTradeSyncJob();
    }
}

 

2、@ComponentScan

 

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

 

@ComponentScan(value = "com.abacus.check.api")
public class CheckApiApplication {
    public static void main(String[] args) {
        SpringApplication.run(CheckApiApplication.class, args);
    }
}

 

@SpringBootApplication 注解也包含了 @ComponentScan 注解，所以在使用中我们也可以通过 @SpringBootApplication 注解的 scanBasePackages 属性进行配置。

 

@SpringBootApplication(scanBasePackages = {"com.abacus.check.api", "com.abacus.check.service"})
public class CheckApiApplication {
    public static void main(String[] args) {
        SpringApplication.run(CheckApiApplication.class, args);
    }
}

 

3、@Conditional

 

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

 

4、@Import

 

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

 

// 类定义
public class Square {}

public class Circular {}


// 导入
@Import({Square.class,Circular.class})
@Configuration
public class MainConfig{}

 

5、@ImportResource

 

和 @Import 类似，区别就是 @ImportResource 导入的是配置文件。

 

@ImportResource("classpath:spring-redis.xml")      // 导入 xml 配置

public class CheckApiApplication {
    public static void main(String[] args) {
        SpringApplication.run(CheckApiApplication.class, args);
    }
}

 

6、@Component

 

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

 

Spring Boot 最核心的 20 个注解

 

说完与 Spring Boot 密切相关的几个 Spring 基础注解后，下面我们就再一起看看 Spring Boot 提供的核心注解的内容吧！

 

1、@SpringBootApplication

 

这个注解是 Spring Boot 最核心的注解，用在 Spring Boot 的主类上，标识这是一个 Spring Boot 应用，用来开启 Spring Boot 的各项能力。实际上这个注解是@Configuration,@EnableAutoConfiguration,@ComponentScan三个注解的组合。由于这些注解一般都是一起使用，所以 Spring Boot 提供了一个统一的注解 @SpringBootApplication。

 

@SpringBootApplication(exclude = {
        MongoAutoConfiguration.class,
        MongoDataAutoConfiguration.class,
        DataSourceAutoConfiguration.class,
        ValidationAutoConfiguration.class,
        MybatisAutoConfiguration.class,
        MailSenderAutoConfiguration.class,
})
public class API {
    public static void main(String[] args) {
        SpringApplication.run(API.class, args);
    }
}

 

2、@EnableAutoConfiguration

 

允许 Spring Boot 自动配置注解，开启这个注解之后，Spring Boot 就能根据当前类路径下的包或者类来配置 Spring Bean。

 

如：当前类路径下有 Mybatis 这个 JAR 包，MybatisAutoConfiguration 注解就能根据相关参数来配置 Mybatis 的各个 Spring Bean。

 

@EnableAutoConfiguration 实现的关键在于引入了 AutoConfigurationImportSelector，其核心逻辑为 selectImports 方法，逻辑大致如下：

  • 从配置文件 META-INF/spring.factories 加载所有可能用到的自动配置类；

  • 去重，并将 exclude 和 excludeName 属性携带的类排除；

  • 过滤，将满足条件（@Conditional）的自动配置类返回；

 

 

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
// 导入 AutoConfigurationImportSelector 的子类
@Import({EnableAutoConfigurationImportSelector.class})
public @interface EnableAutoConfiguration {
    String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";

    Class<?>[] exclude() default {};


    String[] excludeName() default {};
}

 

3、@SpringBootConfiguration

 

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

 

4、@ConditionalOnBean

 

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

 

@Bean
// 当前环境上下文存在 DefaultMQProducer 实例时，才能创建 RocketMQProducerLifecycle 这个 Bean
@ConditionalOnBean(DefaultMQProducer.class)
public RocketMQProducerLifecycle rocketMQLifecycle() {
     return new RocketMQProducerLifecycle();
}

   

5、@ConditionalOnMissingBean

 

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

 

  @Bean
  // 仅当当前环境上下文缺失 RocketMQProducer 对象时，才允许创建 RocketMQProducer Bean 对象
  @ConditionalOnMissingBean(RocketMQProducer.class)
  public RocketMQProducer mqProducer() {
      return new RocketMQProducer();
  }

 

6、@ConditionalOnClass

 

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

 

  @Bean
  // 当 classpath 中存在类 HealthIndicator 时，才创建 HealthIndicator Bean 对象
  @ConditionalOnClass(HealthIndicator.class)
  public HealthIndicator rocketMQProducerHealthIndicator(Map<String, DefaultMQProducer> producers) {
      if (producers.size() == 1) {
          return new RocketMQProducerHealthIndicator(producers.values().iterator().next());
      }
  }

 

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 则生效。

 

 @Bean
 // 匹配属性 rocketmq.producer.enabled 值是否为 true
 @ConditionalOnProperty(value = "rocketmq.producer.enabled", havingValue = "true", matchIfMissing = true)
 public RocketMQProducer mqProducer() {
     return new RocketMQProducer();
 }

 

11、@ConditionalOnExpression

 

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

 

@Configuration
@ConditionalOnExpression("${enabled:false}")
public class BigpipeConfiguration {
    @Bean
    public OrderMessageMonitor orderMessageMonitor(ConfigContext configContext) {
        return new OrderMessageMonitor(configContext);
    }
}

 

12、@ConditionalOnJava

 

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

 

13、@ConditionalOnResource

 

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

 

@Bean
@ConditionalOnResource(resources="classpath:shiro.ini")
protected Realm iniClasspathRealm(){
  return new Realm();
}

 

14、@ConditionalOnJndi

 

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

 

15、@ConditionalOnCloudPlatform

 

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

 

16、@ConditionalOnSingleCandidate

 

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

 

17、@ConfigurationProperties

 

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

 

@Data
@ConfigurationProperties("rocketmq.consumer")
public class RocketMQConsumerProperties extends RocketMQProperties {
    private boolean enabled = true;

    private String consumerGroup;


    private MessageModel messageModel = MessageModel.CLUSTERING;


    private ConsumeFromWhere consumeFromWhere = ConsumeFromWhere.CONSUME_FROM_LAST_OFFSET;


    private int consumeThreadMin = 20;


    private int consumeThreadMax = 64;


    private int consumeConcurrentlyMaxSpan = 2000;


    private int pullThresholdForQueue = 1000;


    private int pullInterval = 0;


    private int consumeMessageBatchMaxSize = 1;


    private int pullBatchSize = 32;
}

 

18、@EnableConfigurationProperties

 

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

 

@Configuration
@EnableConfigurationProperties({
    RocketMQProducerProperties.class,
    RocketMQConsumerProperties.class,
})
@AutoConfigureOrder
public class RocketMQAutoConfiguration {
    @Value("${spring.application.name}")
    private String applicationName;
}

 

19、@AutoConfigureAfter

 

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

如 Mybatis 的自动配置类，需要在数据源自动配置类之后。

@AutoConfigureAfter(DataSourceAutoConfiguration.class)
public class MybatisAutoConfiguration {
}

 

20、@AutoConfigureBefore

 

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

 

21、@AutoConfigureOrder

 

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

 

  @AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE) // 自动配置里面的最高优先级
  @Configuration
  @ConditionalOnWebApplication // 仅限于 web 应用
  @Import(BeanPostProcessorsRegistrar.class) // 导入内置容器的设置
  public class EmbeddedServletContainerAutoConfiguration {
      @Configuration
      @ConditionalOnClass({ Servlet.class, Tomcat.class })
      @ConditionalOnMissingBean(value = EmbeddedServletContainerFactory.class, search = SearchStrategy.CURRENT)
      public static class EmbeddedTomcat {
         // ...
      }

      @Configuration
      @ConditionalOnClass({ Servlet.class, Server.class, Loader.class, WebAppContext.class })
      @ConditionalOnMissingBean(value = EmbeddedServletContainerFactory.class, search = SearchStrategy.CURRENT)
      public static class EmbeddedJetty {
         // ...
      }
}