• 欢迎访问 winrains 的个人网站!
  • 本网站主要从互联网整理和收集了与Java、网络安全、Linux等技术相关的文章,供学习和研究使用。如有侵权,请留言告知,谢谢!

自定义Spring Boot Starter

Spring Boot winrains 来源:Ccww 12个月前 (11-11) 55次浏览
SpringBoot的方便快捷主要体现之一starter pomSpring Boot为我们提供了简化企业级开发绝大多数场景的 starter pom, 只要使用了应用场景所需要的starter pom,只需要引入对应的starter即可,即可以得到Spring Boot为我们提供的自动配置的Bean
然而,可能在很多情况下,我们需要自定义stater,这样可以方便公司内部系统调用共同的配置模块的时候可以自动进行装载配置。比如,很多公司将生产数据库的密码托管在公司的另外一个专门管理生产密码的系统上,公司每个系统需要使用的时候都需要调用其方法进行使用,现在可以通过starter自动配置的形式进行配置。

1. SpringBoot Starter源码分析

Q:@SpringBootApplication 注解中核心注解@EnableAutoConfiguration注解在starter起什么作用呢?
@EnableAutoConfiguration源码分析:

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {
    String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";
    Class<?>[] exclude() default {};
    String[] excludeName() default {};
}

可以从源码看出关键功能是@import注解导入自动配置功能类AutoConfigurationImportSelector类,主要方法getCandidateConfigurations()使用了SpringFactoriesLoader.loadFactoryNames()方法加载META-INF/spring.factories的文件(spring.factories声明具体自动配置)。

protected List<String> getCandidateConfigurations(AnnotationMetadata metadata,
            AnnotationAttributes attributes) {
    List<String> configurations = SpringFactoriesLoader.loadFactoryNames(
            getSpringFactoriesLoaderFactoryClass(), getBeanClassLoader());
    Assert.notEmpty(configurations,
            "No auto configuration classes found in META-INF/spring.factories. If you "
                    + "are using a custom packaging, make sure that file is correct.");
    return configurations;
}

Q:通常情况下,starter会根据条件进行操作处理,比如根据不同条件创建不同Bean。在SpringBoot有哪些注解可用呢?
可使用org.springframwork.boot.autoconfigure.condition的条件注解,具体如下所示:

注解 解析
@ConditionalOnBean 当容器里有指定的Bean的条件下。
@ConditionalOnClass 当类路径下有指定的类的条件下。
@ConditionalOnExpression 基于SpEL表达式作为判断条件。
@ConditionalOnJava 基于JVM版本作为判断条件。
@ConditionalOnJndi 在JNDI存在的条件下查找指定的位置。
@ConditionalOnMissingBean 当容器里没有指定Bean的情况下。
@ConditionalOnMissingClass 当类路径下没有指定的类的条件下。
@ConditionalOnNotWebApplication 当前项目不是Web项目的条件下。
@ConditionalOnProperty 指定的属性是否有指定的值。
@ConditionalOnResource 类路径是否有指定的值。
@ConditionalOnSingleCandidate 当指定Bean在容器中只有一个, 或者虽然有多个但是指定首选的Bean。
@ConditionalOnWebApplicatio 当前项目是Web项目的条件下。

2. 自定starter

在此将模拟公司获取生产密码模块进行自定义starter demo

2.1 核心依赖

<dependencyManagement>
    <dependencies>
        <dependency>
            <!-- Import dependency management from Spring Boot -->
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-dependencies</artifactId>
            <version>2.1.5.RELEASE</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>
<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-autoconfigure</artifactId>
    </dependency>
</dependencies>

2.2 服务类service以及属性配置注入

PasswordService服务类:

public class PasswordService {
    // 第三方系统获取密码所需的key
    private String objectKey;
    @Autowired
    // 模拟的第三方系统service
    private ThirdPartySystemService thirdPartySystemService;
    public String getSystemPassword(String objectKey, String originalPassord) {
        if (StringUtils.isEmpty(objectKey)) {
            return originalPassord;
        }
        // 从第三方系统获取密码
        String password = thirdPartySystemService.getPassword(objectKey);
        // 返回密码
        return password != null ? password : originalPassord;
    }
}
// 模拟第三方系统service
public class ThirdPartySystemService {
    public String getPassword(String objectKey) {
        // 返回一个32位随机数
        return UUID.randomUUID().toString();
    }
}

属性配置类:

//通过@ConfigurationProperties注解获取属性值
@ConfigurationProperties(prefix = "project.starter")
public class BaseServiceProperties {
    private String serviceName;
    private String serviceVersion;
    public String getServiceName() {
        return serviceName;
    }
    public void setServiceName(String serviceName) {
        this.serviceName = serviceName;
    }
    public String getServiceVersion() {
        return serviceVersion;
    }
    public void setServiceVersion(String serviceVersion) {
        this.serviceVersion = serviceVersion;
    }
}

配置属性使用类:

public class BaseStarterService {
    public void addServiceName(BaseServiceProperties baseServiceProperties) {
        System.out.println("serviceName:" + baseServiceProperties.getServiceName() + "----" + "serviceVersion"
                + baseServiceProperties.getServiceVersion());
    }
}

其他类:

//判断是否windows系统
public class WindowsCondition implements Condition {
    private final static String WINDOWS = "Windows";
    /**
     * ConditionContext:判断条件能使用的上下文(环境) AnnotatedTypeMetadata:注释信息
     */
    public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) {
        // 获取当前环境变量
        Environment environment = conditionContext.getEnvironment();
        // 获取bean注册器
        BeanDefinitionRegistry registry = conditionContext.getRegistry();
        // 能获取到ioc使用的beanfactory
        ConfigurableListableBeanFactory beanFactory = conditionContext.getBeanFactory();
        // 获取环境变量中操作系统
        String property = environment.getProperty("os.name");
        // 判断操作系统是否为windows
        if (property.contains(WINDOWS)) {
            // 判断是否存在baseWindowsSevice类,不存在则进行bean注册
            boolean isWindowsSevice = registry.containsBeanDefinition("baseStarterService");
            if (!isWindowsSevice) {
                // 指定Bean定义信息;(Bean的类型,Bean的一系列信息)
                RootBeanDefinition beanDefinition = new RootBeanDefinition(BaseStarterService.class);
                // 注册一个Bean,指定bean名
                registry.registerBeanDefinition("baseStarterService", beanDefinition);
                BaseStarterService windowsSevice = (BaseStarterService) beanFactory.getBean("baseStarterService");
            }
            return true;
        }
        return false;
    }
}

2.3自动配置类

代码解读:

  • @EnableConfigurationProperties:读取配置文件的属性
  • @Import:导入其他配置类或者自定义类
  • @Conditional:判断当前环境是否为windows,是则注册该类
  • @ConditionalOnProperty:判断属性spring.project.ThirdPartySystemService.isPassword是否等于true,不为true则不注册该类
  • @ConditionalOnClass:判断IOC容器中是否存在ThirdPartySystemService类,存在则创建PasswordService bean
@Configuration
//自动加载配置文件属性值
@EnableConfigurationProperties(BaseServiceProperties.class)
@Import(BeanConfiguration.class)
//判断当前环境是否为windows
@Conditional(WindowsCondition.class):
//判断属性spring.project.ThirdPartySystemService.isPassword是否等于true
@ConditionalOnProperty(prefix = "spring.project.ThirdPartySystemService",value = "enablePassword", havingValue = "true",matchIfMissing = true)
public class AutoConfigurationPassoword {
    @Autowired
    private BaseServiceProperties baseServiceProperties;
    @Autowired
    private BaseStarterService baseWindowsService;
    //加载第三方系统service
    @Bean("thirdPartySystemService")
    public ThirdPartySystemService thirdPartySystemService(){
        baseWindowsService.addServiceName(baseServiceProperties);
        return new ThirdPartySystemService();
    }
    @Bean
    //判断IOC容器中是否存在ThirdPartySystemService类,存在则创建PasswordService bean
    @ConditionalOnClass(ThirdPartySystemService.class)
    public PasswordService passwordService(){
        baseWindowsService.addServiceName(baseServiceProperties);
        return new PasswordService();
    }
}
//

2.4 注册配置

想自动配置生效, 需要注册自动配置类,即在src/main/resources下新建METAINF/spring.factories。在spring.factorie配置如下:

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  com.cn.ccww.configuration.AutoConfigurationPassoword

若有多个自动配置, 则用“”隔开, 此处“\”是为了换行后还能够读取到属性。

3. 测试自定义starter

3.1 import 依赖

 <dependencies>
    <dependency>
        <artifactId>spring-boot-starter-base-service</artifactId>
        <groupId>com.cn.ccww</groupId>
        <version>1.0-SNAPSHOT</version>
    </dependency>
</dependencies>

3.2 application.properties属性

application.properties文件有对应的字段是否启动自定义starter,还可以设置starter所需的属性。如下所示:

//自定义Starter配置
//当该属性的值不为true时,才不会启动自定义starter
spring.project.ThirdPartySystemService.enablePassword=true
project.starter.serviceName=ccww
project.starter.serviceVersion=1.0

4.总结

由上所述, starter的大体的工作流程:

  • SpringBoot启动时会自动搜索包含spring.factories文件的JAR包;
  • 根据spring.factories文件加载自动配置类AutoConfiguration
  • 通过AutoConfiguration类,加载满足条件(@ConditionalOnXxx)beanSpring IOC容器中;
  • 使用者可以直接使用自动加载到IOCbean

作者:Ccww

来源:https://juejin.im/post/5d944202f265da5ba532a1d1


版权声明:文末如注明作者和来源,则表示本文系转载,版权为原作者所有 | 本文如有侵权,请及时联系,承诺在收到消息后第一时间删除 | 如转载本文,请注明原文链接。
喜欢 (0)