自定义SpringBoot的Starter启动器

超、凢脫俗 2022-05-15 05:36 380阅读 0赞

## **创建模式：** ##

创建两个模块：一个是启动器模块，一个是自动配置模块，启动器依赖自动配置模块；别人只需要引入启动器（Starter）就可以了。

启动器命名规则：mybatis-spring-boot-starter；自定义启动器名-spring-boot-starter

![70][]

## 步骤： ##

### 1). 启动器模块：对应的pom配置文件 ###

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 </td> 
 <td> &lt;?xml&nbsp;version="1.0"&nbsp;encoding="UTF-8"?&gt; &lt;project&nbsp;xmlns="<a href="http://maven.apache.org/POM/4.0.0" rel="nofollow">http://maven.apache.org/POM/4.0.0</a>" &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;xmlns:xsi="<a href="http://www.w3.org/2001/XMLSchema-instance" rel="nofollow">http://www.w3.org/2001/XMLSchema-instance</a>" &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;xsi:schemaLocation="<a href="http://maven.apache.org/POM/4.0.0%C2%A0http://maven.apache.org/xsd/maven-4.0.0.xsd" rel="nofollow">http://maven.apache.org/POM/4.0.0&nbsp;http://maven.apache.org/xsd/maven-4.0.0.xsd</a>"&gt; &nbsp;&nbsp;&nbsp;&nbsp;&lt;modelVersion&gt;4.0.0&lt;/modelVersion&gt; &nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&lt;!--启动器--&gt; &nbsp;&nbsp;&nbsp;&nbsp;&lt;groupId&gt;com.newpart.starter&lt;/groupId&gt; &nbsp;&nbsp;&nbsp;&nbsp;&lt;artifactId&gt;newpart-spring-boot-starter&lt;/artifactId&gt; &nbsp;&nbsp;&nbsp;&nbsp;&lt;version&gt;1.0-SNAPSHOT&lt;/version&gt; &nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&lt;!--自动配置--&gt; &nbsp;&nbsp;&nbsp;&nbsp;&lt;dependencies&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;dependency&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;groupId&gt;com.newpart.starter&lt;/groupId&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;artifactId&gt;newpart-spring-boot-starter-autoconfigurer&lt;/artifactId&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;version&gt;1.0-SNAPSHOT&lt;/version&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;/dependency&gt; &nbsp;&nbsp;&nbsp;&nbsp;&lt;/dependencies&gt; &nbsp; &lt;/project&gt; </td> 
 </tr> 
 </tbody> 
</table>

### 2). 自动配置模块的pom文件 ###

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 </td> 
 <td> &lt;?xml&nbsp;version="1.0"&nbsp;encoding="UTF-8"?&gt; &lt;project&nbsp;xmlns="<a href="http://maven.apache.org/POM/4.0.0" rel="nofollow">http://maven.apache.org/POM/4.0.0</a>" &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;xmlns:xsi="<a href="http://www.w3.org/2001/XMLSchema-instance" rel="nofollow">http://www.w3.org/2001/XMLSchema-instance</a>" &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;xsi:schemaLocation="<a href="http://maven.apache.org/POM/4.0.0%C2%A0http://maven.apache.org/xsd/maven-4.0.0.xsd" rel="nofollow">http://maven.apache.org/POM/4.0.0&nbsp;http://maven.apache.org/xsd/maven-4.0.0.xsd</a>"&gt; &nbsp;&nbsp;&nbsp;&nbsp;&lt;modelVersion&gt;4.0.0&lt;/modelVersion&gt; &nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&lt;groupId&gt;com.newpart.starter&lt;/groupId&gt; &nbsp;&nbsp;&nbsp;&nbsp;&lt;artifactId&gt;newpart-spring-boot-starter-autoconfigurer&lt;/artifactId&gt; &nbsp;&nbsp;&nbsp;&nbsp;&lt;version&gt;1.0-SNAPSHOT&lt;/version&gt; &nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&lt;parent&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;groupId&gt;org.springframework.boot&lt;/groupId&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;artifactId&gt;spring-boot-starter-parent&lt;/artifactId&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;version&gt;2.0.4.RELEASE&lt;/version&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;relativePath/&gt;&nbsp;&lt;!--&nbsp;lookup&nbsp;parent&nbsp;from&nbsp;repository&nbsp;--&gt; &nbsp;&nbsp;&nbsp;&nbsp;&lt;/parent&gt; &nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&lt;properties&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;project.build.sourceEncoding&gt;UTF-8&lt;/project.build.sourceEncoding&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;project.reporting.outputEncoding&gt;UTF-8&lt;/project.reporting.outputEncoding&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;java.version&gt;1.8&lt;/java.version&gt; &nbsp;&nbsp;&nbsp;&nbsp;&lt;/properties&gt; &nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&lt;dependencies&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;!--引入spring‐boot‐starter；所有starter的基本配置--&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;dependency&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;groupId&gt;org.springframework.boot&lt;/groupId&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;artifactId&gt;spring-boot-starter&lt;/artifactId&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;/dependency&gt; &nbsp;&nbsp;&nbsp;&nbsp;&lt;/dependencies&gt; &nbsp; &nbsp; &lt;/project&gt; </td> 
 </tr> 
 </tbody> 
</table>

### 3).创建自动配置类对应的Properties类，这个类中定义所有可以在配置文件中配置的属性 ###

### 4).定义一个自定义测试的服务类 ###

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 </td> 
 <td> public&nbsp;class&nbsp;NewPartService&nbsp;{ &nbsp; &nbsp;&nbsp;&nbsp;&nbsp;NewPartProperties&nbsp;newPartProperties; &nbsp; &nbsp;&nbsp;&nbsp;&nbsp;public&nbsp;NewPartProperties&nbsp;getNewPartProperties()&nbsp;{ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return&nbsp;newPartProperties; &nbsp;&nbsp;&nbsp;&nbsp;} &nbsp; &nbsp;&nbsp;&nbsp;&nbsp;public&nbsp;void&nbsp;setNewPartProperties(NewPartProperties&nbsp;newPartProperties)&nbsp;{ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;this.newPartProperties&nbsp;=&nbsp;newPartProperties; &nbsp;&nbsp;&nbsp;&nbsp;} &nbsp; &nbsp;&nbsp;&nbsp;&nbsp;public&nbsp;String&nbsp;sayName(String&nbsp;name){ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return&nbsp;newPartProperties.getFirstName()+name+newPartProperties.getLastName()+"&nbsp;age:&nbsp;"&nbsp;+&nbsp;newPartProperties.getAge(); &nbsp;&nbsp;&nbsp;&nbsp;} } </td> 
 </tr> 
 </tbody> 
</table>

### 5).定义自定义自动配置类 ###

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 </td> 
 <td> @Configuration @EnableConfigurationProperties(NewPartProperties.class)&nbsp;//指明指定配置类的属性类并注册到IOC容器中 public&nbsp;class&nbsp;NewServiceAutoConfiguratioin&nbsp;{ &nbsp; &nbsp;&nbsp;&nbsp;&nbsp;@Autowired &nbsp;&nbsp;&nbsp;&nbsp;NewPartProperties&nbsp;newPartProperties; &nbsp; &nbsp;&nbsp;&nbsp;&nbsp;@Bean &nbsp;&nbsp;&nbsp;&nbsp;public&nbsp;NewPartService&nbsp;newPartService(){ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;NewPartService&nbsp;partService&nbsp;=&nbsp;new&nbsp;NewPartService(); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;partService.setNewPartProperties(newPartProperties); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return&nbsp;partService; &nbsp;&nbsp;&nbsp;&nbsp;} &nbsp; } </td> 
 </tr> 
 </tbody> 
</table>

### 6). 在自动配置模块中创建spring.factories并把自动配置类配置到配置文件中 ###

![70 1][]

**Starter启动器创建完成可以通过maven安装到本地库中在对应项目中的pom文件中引用就可以使用在自定义的定义的组件**

[70]: /images/20220515/10ae2c47fe8f4af9a0980c44cc1eae2e.png
[70 1]: /images/20220515/ff8c61acb20c49708c6d04911c887cd1.png