【Spring Boot】自定义starter

末蓝、 2023-06-08 06:50 34阅读 0赞

**【引言】**

Spring Boot应用中，Starter给我们开发带来了很大的便利，通常情况下，我们增加一个依赖就可以实现与第三方的集成，比如mybatis的集成，只需增加依赖：

<dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
        <version>2.0.1</version>
    </dependency>

那么，starter是如何实现的呢？我们能否自定义一个starter？下面就从官方文档分析。

**【[starter][]】**

### **- 定义** ###

A full Spring Boot starter for a library may contain the following components:

*  The autoconfigure module that contains the auto-configuration code.
 *  The starter module that provides a dependency to the autoconfigure module as well as the library and any additional dependencies that are typically useful. In a nutshell, adding the starter should provide everything needed to start using that library.

以上是文档中对starter的一个说明，大致含义就是：

*  将自动装配代码存放在autoconfigure模块中；
 *  starter模块依赖autoconfigure模块，并且附加其他需要的依赖。

也就是说starter需要提供完整的功能和配套资源。

You may combine the auto-configuration code and the dependency management in a single module if you do not need to separate those two concerns.

虽然autoconfigure和starter属于两个不同的概念，但开发人员完全可以将两者合并到单模块（一个jar）中。

### \- 命名 ###

当starter部署结构确定后，首先需要给它取一个名字。文档中也有详细的命名规则：

As a rule of thumb, you should name a combined module after the starter. For example, assume that you are creating a starter for “acme” and that you name the auto-configure module acme-spring-boot-autoconfigure and the starter acme-spring-boot-starter. If you only have one module that combines the two, name it acme-spring-boot-starter.

官方推荐使用 m o d u l e − s p r i n g − b o o t − s t a r t e r 的 s t a r t e r 命 名 模 式 ， 其 中 \{module\}-spring-boot-starter的starter命名模式，其中 module−spring−boot−starter的starter命名模式，其中\{module\}为功能模块的名称。采用此命名的Spring Boot Starter属于第三方Starter，而Spring Boot官方的Starter则采用spring-boot-starter- m o d u l e 的 命 名 模 式 ， 比 如 s p r i n g − b o o t − s t a r t e r − l o g g i n g 。 同 时 开 发 人 员 可 以 将 S t a r t e r 发 布 为 \{module\}的命名模式，比如spring-boot-starter-logging。同时开发人员可以将Starter发布为 module的命名模式，比如spring−boot−starter−logging。同时开发人员可以将Starter发布为\{module\}-spring-boot-autoconfigure和$\{module\}-spring-boot-starter两个jar。

### \- 实现Spring Boot Starter ###

(1） 新建Spring Boot Starter工程 —— first-spring-boot-starter。完整的pom.xml文件如下：

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.2.0.RELEASE</version>
            <relativePath/> 
        </parent>
        <groupId>com.example</groupId>
        <artifactId>first-spring-boot-starter</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>firststarter</name>
        <description>Demo project for Spring Boot Custom Starter</description>
    
        <properties>
            <java.version>1.8</java.version>
        </properties>
    
        <dependencies>
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter</artifactId>
                <optional>true</optional>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
                <exclusions>
                    <exclusion>
                        <groupId>org.junit.vintage</groupId>
                        <artifactId>junit-vintage-engine</artifactId>
                    </exclusion>
                </exclusions>
            </dependency>
        </dependencies>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    </project>

(2） 实现一个简单的转换功能，接口及实现如下：

// 格式化接口定义
    public interface Formatter {
        String format(Object object);
    }
    
    //格式化实现
    public class DefaultFormatter implements Formatter {
        @Override
        public String format(Object object) {
            return String.valueOf(object);
        }
    }

(3） 实现DefaultFormatter自动装配 —— FormatterAutoConfiguration。

通过@Bean方式将DefaultFormatter声明为Spring Bean：

@Configuration
    public class FormatterAutoConfiguration {
    
        @Bean
        public Formatter defaultFormatter(){
            return new DefaultFormatter();
        }
    }

(4）在resources目录文件下新建META-INF文件夹，并新建spring.factories文件，添加FormatterAutoConfiguration的配置声明：

# FormatterAutoConfiguration自动装配声明
    org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
    com.example.firststarter.formatter.FormatterAutoConfiguration

(5）构建Spring Boot Starter

直接在IDEA中执行maven下的install即可：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMwMzQyMjM_size_16_color_FFFFFF_t_70]  
(6）新建一个test-spring-boot-starter模块，添加自定义的first-spring-boot-starter依赖，验证上述自定义的starter是否可用，依赖如下：

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.2.0.RELEASE</version>
            <relativePath/> 
        </parent>
        <groupId>com.example</groupId>
        <artifactId>teststarter</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>teststarter</name>
        <description>Demo project for Spring Boot Test Starter</description>
    
        <properties>
            <java.version>1.8</java.version>
        </properties>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter</artifactId>
            </dependency>
    
            
            <dependency>
                <groupId>com.example</groupId>
                <artifactId>first-spring-boot-starter</artifactId>
                <version>0.0.1-SNAPSHOT</version>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
                <exclusions>
                    <exclusion>
                        <groupId>org.junit.vintage</groupId>
                        <artifactId>junit-vintage-engine</artifactId>
                    </exclusion>
                </exclusions>
            </dependency>
        </dependencies>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    </project>

(7）启动类运行测试

//非web应用
    ConfigurableApplicationContext context = new SpringApplicationBuilder(TeststarterApplication.class).web(WebApplicationType.NONE).run(args);
    //待格式化对象
    Map<String,Object> data = new HashMap<>();
    data.put("date","1024");
    //获取Formatter
    Formatter formatter = context.getBean(Formatter.class);
    System.out.printf("formatter.format(data) : %s\n",formatter.format(data));
    //关闭当前上下文
    context.close();

**【总结】**

以上就是一个Starter的简单实现，其实过程和之前的Spring整合其他的第三方框架类似，Spring Boot做了这样的集成，很大程度上方便了开发人员，简单快速构建；但如果不清楚一些原理和过程的话，遇到问题可能就很难排查。

[starter]: https://docs.spring.io/spring-boot/docs/2.1.6.RELEASE/reference/htmlsingle/#boot-features-custom-starter
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTMwMzQyMjM_size_16_color_FFFFFF_t_70]: /images/20230531/071a3b05e88747f88757b9d6614a9379.png