腾讯域名怎么建设网站,网站关键字设置,电商平台制作公司,建e网室内设计网官网全景图库一、什么是自动配置 bean
自动配置类通过添加 AutoConfiguration 注解实现。
因为 AutoConfiguration 注解本身是以 Configuration 注解的#xff0c;所以自动配置类可以算是一个标准的基于 Configuration 注解的类。
Conditional 注解可以用于声明自动配置启用条件#x…一、什么是自动配置 bean
自动配置类通过添加 AutoConfiguration 注解实现。
因为 AutoConfiguration 注解本身是以 Configuration 注解的所以自动配置类可以算是一个标准的基于 Configuration 注解的类。
Conditional 注解可以用于声明自动配置启用条件通常我们可以使用 ConditionalOnClass、ConditionalOnMissingBean 注解。
二、自动配置发现
Spring Boot 通过检查【META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports】配置文件获取自动配置类。
文件内包含自定义的自动配置类全限定名每行一个。
示例如下 1 2 com.mycorp.libx.autoconfigure.LibXAutoConfiguration com.mycorp.libx.autoconfigure.LibXWebAutoConfiguration
1、关于约定
自动配置类必须通过如上配置文件引入。
合理规划其放置包位置避免被自动包扫描。
内部不要配置自动包扫描如需要可以使用 Import 引入。
2、关于顺序
明确的对象先后顺序可以通过配置 AutoConfiguration 的 before、beforeName、after、afterName 属性或者使用 AutoConfigurationBefore、AutoConfigurationAfter 注解实现。例如 web 服务类配置需要置于 WebMvcAutoConfiguration 注解之后。
如果没有明确的先后顺序也可以使用 AutoConfigureOrder 注解声明顺序。类似 Order 注解不同之处在于其只作用于自动配置类。
三、条件注解
1、类条件
ConditionalOnClass、ConditionalOnMissingClass 1 2 3 4 5 6 7 8 9 Target({ElementType.TYPE, ElementType.METHOD}) Retention(RetentionPolicy.RUNTIME) Documented Conditional({OnClassCondition.class}) public interface ConditionalOnClass { Class?[] value() default {}; String[] name() default {}; }
注解元数据是通过 ASM 处理的所以可以通过 value 属性传递 Class 类型参数或者也可以通过 name 传递类全限定名作为参数。
无效情景
Bean 注解的方法其返回值类型为类目标条件类本身。在方法上的条件判正之前JVM 已经加载了相关的类并且很可能会执行相关的方法引用如果类不存在的话就会导致失败。
为了处理此类情景需要添加额外的 Configuration 注解使用如下 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 import org.springframework.boot.autoconfigure.AutoConfiguration; import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; AutoConfiguration // Some conditions ... public class MyAutoConfiguration { // Auto-configured beans ... Configuration(proxyBeanMethods false) // ConditionalOnClass(SomeService.class) public static class SomeServiceConfiguration { Bean ConditionalOnMissingBean public SomeService someService() { return new SomeService(); } } } 2、Bean 条件
ConditionalOnBean、ConditionalOnMissingBean 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 Target({ElementType.TYPE, ElementType.METHOD}) Retention(RetentionPolicy.RUNTIME) Documented Conditional({OnBeanCondition.class}) public interface ConditionalOnBean { Class?[] value() default {}; String[] type() default {}; Class? extends Annotation[] annotation() default {}; String[] name() default {}; SearchStrategy search() default SearchStrategy.ALL; Class?[] parameterizedContainer() default {}; }
search 属性用于限定搜寻范围。
作用于 Bean 注解的方法时默认的目标 Bean 类型为方法的返回值类型。如下 1 2 3 4 5 6 7 8 9 10 11 12 13 14 import org.springframework.boot.autoconfigure.AutoConfiguration; import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; import org.springframework.context.annotation.Bean; AutoConfiguration public class MyAutoConfiguration { Bean ConditionalOnMissingBean public SomeService someService() { return new SomeService(); } }
条件注解的判正会受 Bean 定义的注册、处理顺序影响这点需要特别关注。通常建议只在自动配置类上使用条件注解。
ConditionalOnBean、ConditionalOnMissingBean 条件注解的 Configuration 类依然会被创建只不是不会被注册。
当使用 Bean 注解方法时返回值最好使用具体的类而不要使用接口。这一点对于使用基于 Bean 类型判定的条件注解时尤为重要。
3、属性条件
ConditionalOnProperty 基于 Spring 的环境变量判正。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 Retention(RetentionPolicy.RUNTIME) Target({ElementType.TYPE, ElementType.METHOD}) Documented Conditional({OnPropertyCondition.class}) public interface ConditionalOnProperty { String[] value() default {}; String prefix() default ; String[] name() default {}; String havingValue() default ; boolean matchIfMissing() default false; } 可以基于前缀或者特定名称来判断。 4、资源条件
ConditionalOnResource 基于是否存在特定的资源来判正如判定资源“file:/home/user/test.dat”。
5、Web 应用条件
ConditionalOnWebApplication、ConditionalOnNotWebApplication
基于当前是否为 Web 应用。
ConditionalOnWarDeployment、ConditionalOnNotWarDeployment 判定当前应用是否为传统的部署到 servlet 容器的 WAR 包应用区别于内嵌的 web 服务器应用。
四、构建 starter
一个典型的 Spring Boot starter 包括如下两点 autoconfigure 模块包含自动配置相关代码。 starter 模块提供 autoconfigure 模块所需的依赖及其它附属依赖。
1、命名
不要以 spring-boot 做前缀这是官方保留使用。
以自有工程名做前缀并附加信息体现其用途。
2、配置键
配置键需要提供专门的命名空间不要使用 Spring Boot 官方命名空间
3、autoconfigure 模块
包含使用依赖的所有配置也可以包括配置键定义及自定义组件初始化的回调接口。
所有引入应该做成可配置的并且默认为不使用。
Spring Boot 使用注解处理器来收集位于配置文件META-INF/spring-autoconfigure-metadata.properties中的自动配置条件快速过滤掉不需要自动配置的以加快启动速度。
如果使用 Maven 管理项目则需要加入如下依赖来处理启用自动配置功能 1 2 3 4 5 dependency groupIdorg.springframework.boot/groupId artifactIdspring-boot-autoconfigure-processor/artifactId optionaltrue/optional /dependency
4、starter 模块
提供依赖。显示声明所有必需的依赖对于可选的不要声明。
