1.概述
??????在使用spring-boot的过程中,可以把通用功能封装成一个stater给其它的项目引用以提高效率,降低成本。本文分享如何封装spring-boot starter。
2.封装starter的步骤
??????封装一个starter总共需要四个步骤
- 引入pom依赖。
- 写自己的业务逻辑。
- 将需要暴露的业务写到配置文件中。
- 打包项目成为一个starter。
我们分别看一下
2.1 引入pom依赖
??????封装starter一共需要两个依赖,一个是核心依赖:spring-boot-autoconfigure,是必须的,它提供了自动装配功能;一个是非核心依赖:spring-boot-configuration-processor,非必须的,它是用来给自定义的配置类生成元数据的,这样在用IDEA编写配置文件时会有代码提示。
<!--封装Starter核心依赖 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-autoconfigure</artifactId>
<version>2.1.3.RELEASE</version>
</dependency>
<!--非必需,生成配置元数据-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<version>2.1.3.RELEASE</version>
</dependency>
2.2 写自己的业务逻辑
??????这一部分就是完成业务逻辑,并把它们注册成一个bean,类似这样。
@Service
@Slf4j
public class Service {
@Autowired
private ServiceA serviceA;
public void doService(String ...params) {
serviceA.doSomething(params);
}
}
2.3. 将需要暴露的业务写到配置文件中
??????业务写完后,想要把它打包到starter中,供别的项目使用,就需要把它写到配置文件中。spring-boot约定要写到resources/META-INF下的spring.factories文件中,文件位置如下图所示: ??????文件内容如下图所示:
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.XXX.service.ServiceA,\
com.XXX.service.ServiceB,\
com.XXX.service.ServiceC,\
com.XXX.service.ServiceD,\
com.XXX.service.ServiceE,\
com.XXX.service.ServiceF
??????有三点需要注意的地方
- 文件内容中的第一行是固定的,并且第一行以=\结尾。
- 每一个类需要写类的全名,独占一行,并且以,\结尾。
- 最后一行不需要,\结尾符。
2.4.打包项目成为一个starter
??????打包到本地库使用的maven命令:mvn clean install -Dmaven.test.skip=true ??????打包到远程库使用的maven命令:mvn clean deploy -Dmaven.test.skip=true ??????打包时需要注意,千万不要将其打包成一个spring-boot项目,否则引用starter会报错。spring-boot项目的话,一般会使用这个打包插件,如果出现错误,将其注释掉在打包试试。
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration><!-- 指定该Main Class为全局的唯一入口 -->
<mainClass>com.XXX.XXXApplication</mainClass>
<layout>ZIP</layout>
</configuration>
<executions>
<execution>
<goals>
<goal>repackage</goal><!--可以把依赖的包都打包到生成的Jar包中-->
</goals>
</execution>
</executions>
</plugin>
??????打包成starter后,就可以在别的项目里引用了。
3. 总结
??????本文分享了如何封装一个自己的spring-boot-starter及封装过程中的注意事项。
|