自定义spring boot starter

小灰灰 2021-05-12 11:55 480阅读 0赞

Spring Boot由众多Starter组成，随着版本的推移Starter家族成员也与日俱增。在传统Maven项目中通常将一些层、组件拆分为模块来管理，以便相互依赖复用，在Spring Boot项目中我们则可以创建自定义Spring Boot Starter来达成该目的。

接下来，我们演示如何创建一个spring boot starter。

先创建一个Maven项目并引入依赖，`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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
        <groupId>com.example</groupId>
        <artifactId>example-spring-boot-starter</artifactId>
        <version>1.0-SNAPSHOT</version>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-autoconfigure</artifactId>
            </dependency>
        </dependencies>
        <dependencyManagement>
            <dependencies>
                <dependency>
                    
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-dependencies</artifactId>
                    <version>1.5.2.RELEASE</version>
                    <type>pom</type>
                    <scope>import</scope>
                </dependency>
            </dependencies>
        </dependencyManagement>
    </project>

这里说下`artifactId`的命名问题，Spring 官方 Starter通常命名为`spring-boot-starter-{name}`如 `spring-boot-starter-web`， [Spring官方建议][Spring]非官方Starter命名应遵循`{name}-spring-boot-starter`的格式。

这里讲一下我们的Starter要实现的功能，很简单，提供一个`Service`，包含一个能够将字符串加上前后缀的方法`String wrap(String word)`。

public class ExampleService {
    
        private String prefix;
        private String suffix;
    
        public ExampleService(String prefix, String suffix) {
            this.prefix = prefix;
            this.suffix = suffix;
        }
        public String wrap(String word) {
            return prefix + word + suffix;
        }
    }

前缀、后缀通过读取`application.properties(yml)`内的参数获得

@ConfigurationProperties("example.service")
    public class ExampleServiceProperties {
        private String prefix;
        private String suffix;
        //省略 getter setter

**重点**，编写`AutoConfigure`类

@Configuration
    @ConditionalOnClass(ExampleService.class)
    @EnableConfigurationProperties(ExampleServiceProperties.class)
    public class ExampleAutoConfigure {
    
        @Autowired
        private ExampleServiceProperties properties;
    
        @Bean
        @ConditionalOnMissingBean
        @ConditionalOnProperty(prefix = "example.service",value = "enabled",havingValue = "true")
        ExampleService exampleService (){
            return  new ExampleService(properties.getPrefix(),properties.getSuffix());
        }
    
    }

解释下用到的几个和Starter相关的注解：

*  `@ConditionalOnClass`，当`classpath`下发现该类的情况下进行自动配置。
 *  `@ConditionalOnMissingBean`，当`Spring Context`中不存在该`Bean`时。
 *  `@ConditionalOnProperty(prefix = "example.service",value = "enabled",havingValue = "true")`，当配置文件中`example.service.enabled=true`时。

更多相关注解，建议阅读[官方文档该部分][Link 1]。

最后一步，在`resources/META-INF/`下创建`spring.factories`文件，内容供参考下面~

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.example.autocinfigure.ExampleAutoConfigure

OK，完事，运行 `mvn:install`打包安装，一个Spring Boot Starter便开发完成了。

创建一个Spring Boot项目来 试试~

引入`example-spring-boot-starter`依赖

<dependency>
        <groupId>com.example</groupId>
        <artifactId>example-spring-boot-starter</artifactId>
        <version>1.0-SNAPSHOT</version>
     </dependency>

创建`application.properties`，进行配置

example.service.enabled=true
    example.service.prefix=####
    example.service.suffix=@@@@

创建一个简单的Spring Web Application，注入Starter提供的`ExampleService`看它能否正常工作~

@SpringBootApplication
    @RestController
    public class Application {
    
        public static void main(String[] args) {
            SpringApplication.run(Application.class, args);
        }
    
        @Autowired
        private ExampleService exampleService;
    
        @GetMapping("/input")
        public String input(String word){
            return exampleService.wrap(word);
        }
    
    }

启动Application，访问`/input`接口试试看~

![20190228204928365.png][]

总结下`Starter`的工作原理

1.  `Spring Boot`在启动时扫描项目所依赖的JAR包，寻找包含`spring.factories`文件的JAR包
2.  根据`spring.factories`配置加载`AutoConfigure`类
3.  根据 `@Conditional`注解的条件，进行自动配置并将`Bean`注入`Spring Context`

最后，列一些常用的starter：

<table> 
 <tbody> 
  <tr> 
   <td>应用启动器</td> 
   <td>&nbsp;</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>1</td> 
   <td>spring-boot-starter</td> 
   <td>这是Spring Boot的核心启动器，包含了自动配置、日志和YAML。</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>spring-boot-starter-actuator</td> 
   <td>帮助监控和管理应用。</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td>spring-boot-starter-amqp</td> 
   <td>通过spring-rabbit来支持AMQP协议（Advanced Message Queuing Protocol）。</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>spring-boot-starter-aop</td> 
   <td>支持面向方面的编程即AOP，包括spring-aop和AspectJ。</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>5</td> 
   <td>spring-boot-starter-artemis</td> 
   <td>通过Apache Artemis支持JMS的API（Java Message Service API）。</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>6</td> 
   <td>spring-boot-starter-batch</td> 
   <td>支持Spring Batch，包括HSQLDB数据库。</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>7</td> 
   <td>spring-boot-starter-cache</td> 
   <td>支持Spring的Cache抽象。</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>8</td> 
   <td>spring-boot-starter-cloud-connectors</td> 
   <td>支持Spring Cloud Connectors，简化了在像Cloud Foundry或Heroku这样的云平台上连接服务。</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>9</td> 
   <td>spring-boot-starter-data-elasticsearch</td> 
   <td>支持ElasticSearch搜索和分析引擎，包括spring-data-elasticsearch。</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>10</td> 
   <td>spring-boot-starter-data-gemfire</td> 
   <td>支持GemFire分布式数据存储，包括spring-data-gemfire。</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>11</td> 
   <td>spring-boot-starter-data-jpa</td> 
   <td>支持JPA（Java Persistence API），包括spring-data-jpa、spring-orm、Hibernate。</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>12</td> 
   <td>spring-boot-starter-data-mongodb</td> 
   <td> <p>支持MongoDB数据，包括spring-data-mongodb。</p> </td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>13</td> 
   <td>spring-boot-starter-data-rest</td> 
   <td>通过spring-data-rest-webmvc，支持通过REST暴露Spring Data数据仓库。</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>14</td> 
   <td>spring-boot-starter-data-solr</td> 
   <td>支持Apache Solr搜索平台，包括spring-data-solr。</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>15</td> 
   <td>spring-boot-starter-freemarker</td> 
   <td>支持FreeMarker模板引擎。</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>16</td> 
   <td>spring-boot-starter-groovy-templates</td> 
   <td>支持Groovy模板引擎。</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>17</td> 
   <td>spring-boot-starter-hateoas</td> 
   <td>通过spring-hateoas支持基于HATEOAS的RESTful Web服务。</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>18</td> 
   <td>spring-boot-starter-hornetq</td> 
   <td> <p>通过HornetQ支持JMS。</p> </td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>19</td> 
   <td>spring-boot-starter-integration</td> 
   <td>支持通用的spring-integration模块。</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>20</td> 
   <td>spring-boot-starter-jdbc</td> 
   <td> <p>支持JDBC数据库。</p> </td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>21</td> 
   <td>spring-boot-starter-jersey</td> 
   <td>支持Jersey RESTful Web服务框架。</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>22</td> 
   <td>spring-boot-starter-jta-atomikos</td> 
   <td>通过Atomikos支持JTA分布式事务处理。</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>23</td> 
   <td>spring-boot-starter-jta-bitronix</td> 
   <td>通过Bitronix支持JTA分布式事务处理。</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>24</td> 
   <td>spring-boot-starter-mail</td> 
   <td> <p>支持javax.mail模块。</p> </td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>25</td> 
   <td>spring-boot-starter-mobile</td> 
   <td>支持spring-mobile。</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>26</td> 
   <td>spring-boot-starter-mustache</td> 
   <td> <p>支持Mustache模板引擎。</p> </td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>27</td> 
   <td>spring-boot-starter-redis</td> 
   <td>支持Redis键值存储数据库，包括spring-redis。</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>28</td> 
   <td>spring-boot-starter-security</td> 
   <td>支持spring-security。</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>29</td> 
   <td>spring-boot-starter-social-facebook</td> 
   <td>支持spring-social-facebook</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>30</td> 
   <td>spring-boot-starter-social-linkedin</td> 
   <td>支持pring-social-linkedin</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>31</td> 
   <td>spring-boot-starter-social-twitter</td> 
   <td>支持pring-social-twitter</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>32</td> 
   <td>spring-boot-starter-test</td> 
   <td>支持常规的测试依赖，包括JUnit、Hamcrest、Mockito以及spring-test模块。</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>33</td> 
   <td>spring-boot-starter-thymeleaf</td> 
   <td>支持Thymeleaf模板引擎，包括与Spring的集成。</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>34</td> 
   <td>spring-boot-starter-velocity</td> 
   <td>支持Velocity模板引擎。</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>35</td> 
   <td>spring-boot-starter-web</td> 
   <td>支持全栈式Web开发，包括Tomcat和spring-webmvc。</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>36</td> 
   <td>spring-boot-starter-websocket</td> 
   <td>支持WebSocket开发。</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>37</td> 
   <td>spring-boot-starter-ws</td> 
   <td>支持Spring Web Services。</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>&nbsp;</td> 
   <td>应用启动器面向生产环境</td> 
   <td>&nbsp;</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>1</td> 
   <td>spring-boot-starter-actuator</td> 
   <td> <p>增加了面向产品上线相关的功能，比如测量和监控。</p> </td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>spring-boot-starter-remote-shell</td> 
   <td>增加了远程ssh shell的支持。</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>&nbsp;</td> 
   <td>应用启动器还有一些替换技术的启动器</td> 
   <td>&nbsp;</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>1</td> 
   <td>spring-boot-starter-jetty</td> 
   <td>引入了Jetty HTTP引擎（用于替换Tomcat）。</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>spring-boot-starter-log4j</td> 
   <td>支持Log4J日志框架。</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td>spring-boot-starter-logging</td> 
   <td>引入了Spring Boot默认的日志框架Logback。</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>spring-boot-starter-tomcat</td> 
   <td>引入了Spring Boot默认的HTTP引擎Tomcat。</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>5</td> 
   <td>spring-boot-starter-undertow</td> 
   <td> <p>引入了Undertow HTTP引擎（用于替换Tomcat）</p> </td> 
  </tr> 
 </tbody> 
</table>

[Spring]: https://link.jianshu.com?t=http://docs.spring.io/spring-boot/docs/1.5.2.RELEASE/reference/htmlsingle/#boot-features-custom-starter-naming
[Link 1]: https://link.jianshu.com?t=http://docs.spring.io/spring-boot/docs/1.5.2.RELEASE/reference/htmlsingle/#boot-features-bean-conditions
[20190228204928365.png]: /images/20210511/303cc741b847491199f4c24e63c43480.png