SpringBoot自定义starter

老白的释然

1，如何自定义

①，我们首先要有一个意识，springboot自己适配的一般以：spring-boot-starter-xxx命名，比如：spring-boot-starter-amqp

②，自己去适配springboot一般以：xxx-spring-boot-starter命名，比如：mybatis-spring-boot-starter

③，springboot自动适配的在依赖时一般不用加版本号，自动适配springboot 的需要版本号。因为sprinboot根本就不知道它的版本

③，通过观察mybatis-spring-boot-starter，我们发现mybatis-spring-boot-starter并没有java代码，通过观察其pom.xml我们发现，它引入了mybatis-spring-boot-autoconfigure

④，所以我们可以仿照mybatis自定义我们的starter

2，创建工程

①，创建一个空的mystart工程，新建两个模块，1，mystart；2，autoconfigurable

3，mystart模块配置

①，mystart依赖于autoconfigurable模块

1. <groupId>com.spring.start</groupId>
   
2.     <artifactId>mystart</artifactId>
   
3.     <version>1.0-SNAPSHOT</version>
   
4. 
   
5.     <dependencies>
   
6.         <dependency>
   
7.             <groupId>com.spring.start.autoconfigurable</groupId>
   
8.             <artifactId>autoconfigurable</artifactId>
   
9.             <version>0.0.1-SNAPSHOT</version>
   
10.         </dependency>
    
11.     </dependencies>

复制代码

4，autoconfigurable工程代码

①，pom.xml

1. <groupId>com.spring.start.autoconfigurable</groupId>
   
2.         <artifactId>autoconfigurable</artifactId>
   
3.         <version>0.0.1-SNAPSHOT</version>
   
4.         <packaging>jar</packaging>
   
5. 
   
6.         <name>autoconfigurable</name>
   
7.         <description>Demo project for Spring Boot</description>
   
8. 
   
9.         <parent>
   
10.                 <groupId>org.springframework.boot</groupId>
    
11.                 <artifactId>spring-boot-starter-parent</artifactId>
    
12.                 <version>2.0.0.RELEASE</version>
    
13.         </parent>
    
14. 
    
15.         <dependencies>
    
16.         <--依赖于springboot starter-->
    
17.                 <dependency>
    
18.                         <groupId>org.springframework.boot</groupId>
    
19.                         <artifactId>spring-boot-starter</artifactId>
    
20.                 </dependency>
    
21.         </dependencies>

复制代码

②，编写xxxProperties类，类似于ServerProperties

1. import org.springframework.boot.context.properties.ConfigurationProperties;
   
2. 
   
3. //这样才能读取到application.properties 中的相应配置
   
4. @ConfigurationProperties("spring.su")
   
5. public class SuProperties {
   
6. 
   
7.     private String prefix;
   
8.     private String suffix;
   
9. 
   
10.     public String getPrefix() {
    
11.         return prefix;
    
12.     }
    
13. 
    
14.     public void setPrefix(String prefix) {
    
15.         this.prefix = prefix;
    
16.     }
    
17. 
    
18.     public String getSuffix() {
    
19.         return suffix;
    
20.     }
    
21. 
    
22.     public void setSuffix(String suffix) {
    
23.         this.suffix = suffix;
    
24.     }
    
25. }

复制代码

③，编写功能类

1. public class SuService {
   
2.     //这里不用@Autowired注入，会在自动配置类注入时给设置，所以才有setSuProperties 方法
   
3.     private SuProperties suProperties;
   
4. 
   
5.     public String hello(String name){
   
6.         return suProperties.getPrefix()+"--"+name+"=="+suProperties.getSuffix();
   
7.     }
   
8. 
   
9. 
   
10.     public SuProperties getSuProperties() {
    
11.         return suProperties;
    
12.     }
    
13. 
    
14.     public void setSuProperties(SuProperties suProperties) {
    
15.         this.suProperties = suProperties;
    
16.     }
    
17. }

复制代码

④，编写自动配置类

1. import org.springframework.beans.factory.annotation.Autowired;
   
2. import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
   
3. import org.springframework.boot.context.properties.EnableConfigurationProperties;
   
4. import org.springframework.context.annotation.Bean;
   
5. import org.springframework.context.annotation.Configuration;
   
6. 
   
7. //是个配置类
   
8. @Configuration
   
9. //在web应用中起效
   
10. @ConditionalOnWebApplication
    
11. //指明配置类，这样SuProperties 才能被注入
    
12. @EnableConfigurationProperties({SuProperties.class})
    
13. public class SuAutoConfiguration {
    
14. 
    
15.     @Autowired
    
16.     private SuProperties suProperties;
    
17. 
    
18.     @Bean
    
19.     public SuService suService(){
    
20.         SuService suService = new SuService();
    
21.         suService.setSuProperties(suProperties);
    
22.         return suService;
    
23.     }
    
24. }

复制代码

⑤，添加对应的 META-INF/spring.factories

⑥，spring.factories 内容，这样springboot在启动时会就扫描对应的AutoConfiguration

1. org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.spring.start.autoconfigurable.SuAutoConfiguration

复制代码

5，mystart工程代码

①，pom.xml 依赖于autoConfiguration 工程即可

1. <groupId>com.spring.start</groupId>
   
2.     <artifactId>mystart</artifactId>
   
3.     <version>1.0-SNAPSHOT</version>
   
4. 
   
5.     <dependencies>
   
6.         <dependency>
   
7.             <groupId>com.spring.start.autoconfigurable</groupId>
   
8.             <artifactId>autoconfigurable</artifactId>
   
9.             <version>0.0.1-SNAPSHOT</version>
   
10.         </dependency>
    
11.     </dependencies>

复制代码

6，测试工程代码编写

①，pom.xml

1. <parent>
   
2.                 <groupId>org.springframework.boot</groupId>
   
3.                 <artifactId>spring-boot-starter-parent</artifactId>
   
4.                 <version>2.0.0.RELEASE</version>
   
5.         </parent>
   
6. 
   
7.         <dependencies>
   
8.                 <dependency>
   
9.                         <groupId>org.springframework.boot</groupId>
   
10.                         <artifactId>spring-boot-starter-web</artifactId>
    
11.                 </dependency>
    
12.         <--依赖mystart 即可，mystart 会依赖autoconfigurable 工程，注意这里要指定版本号-->
    
13.                 <dependency>
    
14.                         <groupId>com.spring.start</groupId>
    
15.                         <artifactId>mystart</artifactId>
    
16.                         <version>1.0-SNAPSHOT</version>
    
17.                 </dependency>
    
18. 
    
19.                 <dependency>
    
20.                         <groupId>org.springframework.boot</groupId>
    
21.                         <artifactId>spring-boot-starter-test</artifactId>
    
22.                         <scope>test</scope>
    
23.                 </dependency>
    
24.         </dependencies>

复制代码

②，application.properties

1. spring.su.prefix=小美女
   
2. spring.su.suffix=错过了

复制代码

③，测试类

1. import com.spring.start.autoconfigurable.SuService;
   
2. import org.springframework.beans.factory.annotation.Autowired;
   
3. import org.springframework.web.bind.annotation.RequestMapping;
   
4. import org.springframework.web.bind.annotation.RestController;
   
5. 
   
6. @RestController
   
7. public class HomeController {
   
8. 
   
9.     @Autowired
   
10.     private SuService suService;
    
11. 
    
12.     @RequestMapping("/")
    
13.     public String index(){
    
14.         return suService.hello("小苏");
    
15.     }
    
16. }

复制代码

④，启动工程，然后测试即可，

⑤，遗留问题，在application.properties 写的中文会乱码，暂时没有找到解决的办法，知道如何的同学欢迎留言，感谢！！！