SpringBoot核⼼注解
@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();
}
}
@ConponentScan
做过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);
}
}
@Conditional
@Conditional是Spring4新提供的注解,通过@Conditional注解可以根据代码中设置的条件装载不同的bean,在设置条件注解之前,先要把装载的bean类去实现Condition接⼝,然后对该实现接⼝的类设置是否装载的条件。Spring Boot注解中的
@ConditionalOnProperty、@ConditionalOnBean等以@Conditional*开头的注解,都是通过集成了@Conditional来实现相应功能的。
@Import
spring ioc注解通过导⼊的⽅式实现把实例加⼊springIOC容器中。可以在需要时将没有被Spring容器管理的类导⼊⾄Spring容器中。
//类定义
public class Square {}
public class Circular {}
//导⼊
@Import({Square.class,Circular.class})
@Configuration
public class MainConfig{}
@ImportResource
和@Import类似,区别就是@ImportResource导⼊的是配置⽂件.
@ImportResource("l") //导⼊xml配置
public class CheckApiApplication {
public static void main(String[] args) {
SpringApplication.run(CheckApiApplication.class, args);
}
}
@Component
@Component是⼀个元注解,意思是可以注解其他类注解,如@Controller @Service @Repository。带此注解的类被看作组件,当使⽤基于注解的配置和类路径扫描的时候,这些类就会被实例化。其他类级别的注解也可以被认定为是⼀种特殊类型的组件,⽐如@Controller 控制器(注⼊服务)、@Service服务(注⼊dao)、@Repository dao(实现dao访问)。@Component泛指组件,当组件不好归类的时候,我们可以使⽤这个注解进⾏标注,作⽤就相当于 XML配置,<bean id="" class=""/>。
SpringBoot最核⼼的20个注解
@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);
}
}
@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 = "ableautoconfiguration";
Class<?>[] exclude() default {};
String[] excludeName() default {};
}
@SpringBootConfiguration
这个注解就是 @Configuration 注解的变体,只是⽤来修饰是 Spring Boot 配置⽽已,或者可利于 Spring Boot 后续的扩展。
@ConditionalOnBean
@ConditionalOnBean(A.class)仅仅在当前上下⽂中存在A对象时,才会实例化⼀个Bean,也就是说只有当A.class 在spring的applicationContext中存在时,这个当前的bean才能够创建。
@Bean
//当前环境上下⽂存在DefaultMQProducer实例时,才能创建RocketMQProducerLifecycle这个Bean
@ConditionalOnBean(DefaultMQProducer.class)
public RocketMQProducerLifecycle rocketMQLifecycle() {
return new RocketMQProducerLifecycle();
}
@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());
}
}
@ConditionalOnMissingClass
组合@Conditional注解,和@ConditionalOnMissingClass注解相反,当classpath中没有指定的 Class才开启配置。
@ConditionalOnWebApplication
组合@Conditional 注解,当前项⽬类型是 WEB 项⽬才开启配置。当前项⽬有以下 3 种类型:ANY(任何Web项⽬都匹配)、SERVLET(仅但基础的Servelet项⽬才会匹配)、REACTIVE(只有基于响应的web应⽤程序才匹配)。
@ConditionalOnNotWebApplication
组合@Conditional注解,和@ConditionalOnWebApplication 注解相反,当前项⽬类型不是 WEB 项⽬才开启配置。
@ConditionalOnProperty
组合 @Conditional 注解,当指定的属性有指定的值时才开启配置。具体操作是通过其两个属性name以及havingValue来实现的,其中name⽤来从application.properties中读取某个属性值,如果该值为空,则返回false;如果值不为空,则将该值与havingValue 指定的值进⾏⽐较,如果⼀样则返回true;否则返回false。如果返回值为false,则该configuration不⽣效;为true则⽣效。
@Bean
//匹配属性abled值是否为true
@ConditionalOnProperty(value = "abled", havingValue = "true", matchIfMissing = true)
public RocketMQProducer mqProducer() {
return new RocketMQProducer();
}
@ConditionalOnExpression
组合 @Conditional 注解,当 SpEL 表达式为 true 时才开启配置.
@Configuration
@ConditionalOnExpression("${enabled:false}")
public class BigpipeConfiguration {
@Bean
public OrderMessageMonitor orderMessageMonitor(ConfigContext configContext) {
return new OrderMessageMonitor(configContext);
}
}
@ConditionalOnJava
组合@Conditional 注解,当运⾏的 Java JVM 在指定的版本范围时才开启配置。
@ConditionalOnResource
组合 @Conditional 注解,当类路径下有指定的资源才开启配置。
@Bean
@ConditionalOnResource(resources="classpath:shiro.ini")
protected Realm iniClasspathRealm(){
return new Realm();
}
@ConditionalOnJndi
组合 @Conditional 注解,当指定的 JNDI 存在时才开启配置。
@ConditionalOnCloudPlatform
组合 @Conditional 注解,当指定的云平台激活时才开启配置。
@ConditionalOnSingleCandidate
组合 @Conditional 注解,当指定的 class 在容器中只有⼀个 Bean,或者同时有多个但为⾸选时才开启配置。
@ConfigurationProperties
Spring Boot可使⽤注解的⽅式将⾃定义的properties⽂件映射到实体bean中,⽐如config.properties⽂件
@Data
@ConfigurationProperties("sumer")
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;
}
@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;
}
@AutoConfigureAfter
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论