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来实现相应功能的。

@Conditional的定义：

//此注解可以标注在类和方法上 @Target({ElementType.TYPE, ElementType.METHOD}) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface Conditional { Class[] value(); }

从代码中可以看到，需要传入一个Class数组，并且需要继承Condition接口：

public interface Condition { boolean matches(ConditionContext var1, AnnotatedTypeMetadata var2); }

Condition是个接口，需要实现matches方法，返回true则注入bean，false则不注入。

示例：

首先，创建Person类：

public class Person { 
private String name; 
private Integer age; 
public String getName() { return name; }
 public void setName(String name) { this.name = name; } 
public Integer getAge() { return age; } 
public void setAge(Integer age) { this.age = age; } 
public Person(String name, Integer age) { this.name = name; this.age = age; }
 @Override 
public String toString() { return "Person{" + "name='" + name + '\'' + ", age=" + age + '}'; } }

创建BeanConfig类，用于配置两个Person实例并注入，一个是比尔盖茨，一个是林纳斯。

@Configuration 
public class BeanConfig {
@Bean(name = "bill") 
public Person person1(){ return new Person("Bill Gates",62); } 
@Bean("linus") 
public Person person2(){ return new Person("Linus",48); } 
}

接着写一个测试类进行验证这两个Bean是否注入成功。

public class ConditionalTest { 
AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(BeanConfig.class); 
@Test 
public void test1(){ 
Map map = applicationContext.getBeansOfType(Person.class); System.out.println(map); 
    } 
}

 运行，输出结果是这样的，两个Person实例被注入进容器。

运行，输出结果是这样的，两个Person实例被注入进容器。

 

 

这是一个简单的例子，现在问题来了，如果我想根据当前操作系统来注入Person实例，windows下注入bill，linux下注入linus，怎么实现呢？

 

这就需要我们用到@Conditional注解了，前言中提到，需要实现Condition接口，并重写方法来自定义match规则。

 

首先，创建一个WindowsCondition类：

public class WindowsCondition implements Condition { 
/**
 * @param conditionContext:判断条件能使用的上下文环境 
 * @param annotatedTypeMetadata:注解所在位置的注释信息 
 * */ 
@Override public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) { 
//获取ioc使用的beanFactory 
ConfigurableListableBeanFactory beanFactory = conditionContext.getBeanFactory(); 
//获取类加载器 
ClassLoader classLoader = conditionContext.getClassLoader(); 
//获取当前环境信息 
Environment environment = conditionContext.getEnvironment(); 
//获取bean定义的注册类 
BeanDefinitionRegistry registry = conditionContext.getRegistry();
 //获得当前系统名 
String property = environment.getProperty("os.name"); 
//包含Windows则说明是windows系统，返回true
 if (property.contains("Windows")){ 
        return true; 
    } 
return false; 
    } 
}

matches方法的两个参数的意思在注释中讲述了，值得一提的是，conditionContext提供了多种方法，方便获取各种信息，也是SpringBoot中 @ConditonalOnXX注解多样扩展的基础。

接着，创建LinuxCondition类：

public class LinuxCondition implements Condition { 
@Override 
public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) { 
Environment environment = conditionContext.getEnvironment(); 
String property = environment.getProperty("os.name"); 
if (property.contains("Linux")){
         return true; 
        } 
        return false; 
    } 
}

接着就是使用这两个类了，因为此注解可以标注在方法上和类上，所以分开测试：

标注在方法上：

修改BeanConfig：

@Configuration 
public class BeanConfig { 
//只有一个类时，大括号可以省略 
//如果WindowsCondition的实现方法返回true，则注入这个bean @Conditional({WindowsCondition.class}) 
@Bean(name = "bill")
 public Person person1(){ 
        return new Person("Bill Gates",62); 
    } 
//如果LinuxCondition的实现方法返回true，则注入这个bean 
@Conditional({LinuxCondition.class})
 @Bean("linus") 
public Person person2(){ 
        return new Person("Linus",48);
     } 
}

修改测试方法，使其可以打印当前系统名：

运行结果如下：

 

我是运行在windows上的所以只注入了bill，嗯，没毛病。

接着实验linux下的情况，不能运行在linux下，但可以修改运行时参数：

 

 

修改后启动测试方法：

 

 一个方法只能注入一个bean实例，所以@Conditional标注在方法上只能控制一个bean实例是否注入。

标注在类上：

一个类中可以注入很多实例，@Conditional标注在类上就决定了一批bean是否注入。

我们试一下，将BeanConfig改写，这时，如果WindowsCondition返回true，则两个Person实例将被注入(注意：上一个测试将os.name改为linux，这是我将把这个参数去掉)：

@Conditional({WindowsCondition.class}) 
@Configuration 
public class BeanConfig { 
@Bean(name = "bill") 
public Person person1(){ 
        return new Person("Bill Gates",62); 
    } 
@Bean("linus") 
public Person person2(){ 
        return new Person("Linus",48); 
    } 
}

结果两个实例都被注入： 

 

如果将类上的WindowsCondition.class改为LinuxCondition.class，结果应该可以猜到：

 

结果就是空的，类中所有bean都没有注入。

多个条件类：

前言中说，@Conditional注解传入的是一个Class数组，存在多种条件类的情况。

这种情况貌似判断难度加深了，测试一波，新增新的条件类，实现的matches返回false（这种写死返回false的方法纯属测试用，没有实际意义O(∩_∩)O）

public class ObstinateCondition implements Condition {
 @Override 
public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) { 
        return false; 
    } 
}

BeanConfig修改一下：

@Conditional({WindowsCondition.class,ObstinateCondition.class}) 
@Configuration 
public class BeanConfig { 
@Bean(name = "bill") 
public Person person1(){ 
        return new Person("Bill Gates",62);
     } 
@Bean("linus") 
public Person person2(){ 
        return new Person("Linus",48); 
    } 
}

结果：

 

 

 

现在如果将ObstinateCondition的matches方法返回值改成true，两个bean就被注入进容器：

 

 

 

结论得：

 

第一个条件类实现的方法返回true，第二个返回false，则结果false，不注入进容器。

 

第一个条件类实现的方法返回true，第二个返回true，则结果true，注入进容器中。

 

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配置，。

 

Spring Boot最核心的20个注解

 

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 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_OFFSE; 

    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 {          // ...       
    } 
}