为你的组件开发Spring Boot Starter

如果你开发了一个组件/模块，提供给其他项目使用，那你还需要附带一份配置说明: 依赖哪些jar、设置哪些配置参数、如何初始化入口类、以及ComponentScan和MapperScan需要加入哪些路径... 无疑增加了上手门槛。如何能让组件/模块自身完成自动配置呢？开发对应的Spring Boot Starter。

开发Starter的步骤

1. 新建一个Maven项目

• 指定你的starter相关的groupId,artifactId,version等
• 指定pom的parent为spring-boot-starter-parent
• 添加你的starter依赖的jar

pom主体内容示例如下：

    <!-- 指定pom的parent为spring-boot-starter-parent -->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.6.RELEASE</version>
        <relativePath/>
    </parent>
    
    <!-- 指定你的starter相关的groupId,artifactId,version -->
    <groupId>com.diboot</groupId>
    <artifactId>diboot-core-boot-starter</artifactId><!-- artifactId中你的标识前置，如xx-spring-boot-starter，以免跟Spring官方starter冲突 -->
    <version>2.0.1</version>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <!-- 添加你的starter依赖的jar -->
        <dependency>
            <groupId>com.diboot</groupId>
            <artifactId>diboot-core</artifactId>
            <version>2.0.1</version>
        </dependency>
        
    </dependencies>

2. 开发自己的配置类

就像你在项目中使用组件/模块的配置一样，你需要的相关配置部分可以配置在你的starter中。

@Configuration
public class CustomAutoConfiguration{
    //...
}

比如我需要配置@ComponentScan和@MapperScan扫描我的组件中的package，那自动配置类就类似如下样例：

@Configuration
//@ConditionalOnWebApplication //可以指定环境条件
@ComponentScan(basePackages={"com.diboot.core"}) //你的组件/模块需要扫描的Component包
@MapperScan(basePackages = {"com.diboot.core.mapper"}) //你的组件/模块需要扫描的Mapper包
public class CustomAutoConfiguration{

}

然后我可以初始化某个Bean，如

...
public class CustomAutoConfiguration{
  
    @Bean
    @ConditionalOnMissingBean(MyService.class)
    public MyService myService() {
       ... //初始化MyService类
    }
}

在自动装配中初始化的Bean，一般情况下需要依赖特定的条件（比如配置参数），这就需要我们创建ConfigurationProperties类。（如果不需要配置参数可直接跳过步骤3）

3. 创建ConfigurationProperties类

示例：

@ConfigurationProperties(prefix = "diboot.core") //配置参数前缀
public class MyModuleProperties {
    // 对应配置参数项为: diboot.core.xx-enabled
    private boolean xxEnabled = true;
    // getter, setter ...
}

配置类中使用：

...
@EnableConfigurationProperties(MyModuleProperties.class) //启用配置
public class CustomAutoConfiguration{
    // 注入配置
    @Resource
    private MyModuleProperties properties;
    
    @Bean
    @ConditionalOnMissingBean(MyService.class)
    public MyService myService() {
       boolean enabled = properties.isXxEnabled();
       ... //初始化MyService类
    }
}

4. 创建 spring.factories 配置文件

配置文件放置于resources/META-INF/下，将EnableAutoConfiguration指向你的自动配置类，示例如下：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.xx.starter.CustomAutoConfiguration

5. 执行Maven install，将starter安装至本地库

6. 新建一个Maven项目，pom里加入你的starter依赖，

如：

<dependency>
    <groupId>com.diboot</groupId>
    <artifactId>diboot-core-boot-starter</artifactId>
    <version>2.0.1</version>
</dependency>

启动项目，验证你的组件中初始化是否正常。

---

diboot - 为开发人员打造的低代码开发平台