Spring Boot - 手把手教小师妹自定义Spring Boot Starter

港控/mmm° 2022-10-15 00:39 185阅读 0赞

### 文章目录 ###

*  Pre
 *  自定义starter的套路
 *   *  步骤
 *  命名规范
 *   *  官方命名空间
     *  自定义命名空间
 *  实战
 *   *  创建一个父maven项目:springboot\_custome\_starter
     *  创建 两个Module: artisan-spring-boot-starter 和 artisan-spring-boot-starter-autoconfigurer
     *  artisan-spring-boot-starter (空的jar文件，仅仅提供辅助性依赖管理)
     *   *  pom
     *  artisan-spring-boot-starter-autoconfigurer
     *   *  pom
         *  CustomProperties
         *  IndexController
         *  CustomAutoConfiguration 自动配置类
         *  spring.factories
         *  打包发布
         *  引用自定义starter测试

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70]

--------------------

# Pre #

SpringBoot 最强大的功能就是把我们常用的场景抽取成了一个个starter（场景启动器），我们通过引入springboot 为我提供的这些场景启动器，再进行少量的配置就能使用相应的功能。

但有些时候，springboot也不能囊括我们所有的使用场景，往往我们需要自定义starter，来简化我们对springboot的使用。

那怎么搞呢？

--------------------

# 自定义starter的套路 #

参照@WebMvcAutoConfiguration ， 看看们需要准备哪些东西

@Configuration(proxyBeanMethods = false)
    @ConditionalOnWebApplication(type = Type.SERVLET)
    @ConditionalOnClass({  Servlet.class, DispatcherServlet.class, WebMvcConfigurer.class })
    @ConditionalOnMissingBean(WebMvcConfigurationSupport.class)
    @AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE + 10)
    @AutoConfigureAfter({  DispatcherServletAutoConfiguration.class, TaskExecutionAutoConfiguration.class,
    		ValidationAutoConfiguration.class })
    public class WebMvcAutoConfiguration { 
    .......
    }

抽取以下

@Configuration  //指定这个类是一个配置类
    @ConditionalOnXXX  //指定条件成立的情况下自动配置类生效
    @AutoConfigureOrder  //指定自动配置类的顺序
    @Bean  //向容器中添加组件
    @ConfigurationProperties  //结合相关xxxProperties来绑定相关的配置
    @EnableConfigurationProperties  //让xxxProperties生效加入到容器中

自动配置类要能加载需要将自动配置类，配置在META-INF/spring.factories中

我们参考下 spring-boot-starter

![在这里插入图片描述][20210522225300858.png]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 1]

点击maven进去  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 2]  
有个 spring-boot-autoconfigure的依赖

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 3]

--------------------

## 步骤 ##

所以总结下

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 4]

*  **启动器（starter）是一个空的jar文件，仅仅提供辅助性依赖管理，这些依赖可能用于自动装配或其他类库。**
 *  **需要专门写一个类似spring-boot-autoconfigure的配置模块**
 *  **用的时候只需要引入启动器starter，就可以使用自动配置了**

--------------------

# 命名规范 #

## 官方命名空间 ##

前缀：spring-boot-starter-  
模式：spring-boot-starter-模块名  
举例：spring-boot-starter-web、spring-boot-starter-jdbc

## 自定义命名空间 ##

后缀：-spring-boot-starter  
模式：模块-spring-boot-starter  
举例：mybatis-spring-boot-starter

--------------------

# 实战 #

## 创建一个父maven项目:springboot\_custome\_starter ##

新建一个maven工程， 父工程，pom类型 ， src 目录 和 IDEA自动创建的.md文件，删除掉

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 5]

pom 如下

<?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.3.6.RELEASE</version>
            <relativePath/> 
        </parent>
        <packaging>pom</packaging>
        <groupId>com.artisan.customstarter</groupId>
        <artifactId>starter</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>starter</name>
        <description>SpringBoot自定义starter</description>
        <properties>
            <java.version>1.8</java.version>
        </properties>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter</artifactId>
            </dependency>
    
        </dependencies>
    
        <build>
            <plugins>
                
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-source-plugin</artifactId>
                    <configuration>
                        <attach>true</attach>
                    </configuration>
                    <executions>
                        <execution>
                            <phase>compile</phase>
                            <goals>
                                <goal>jar</goal>
                            </goals>
                        </execution>
                    </executions>
                </plugin>
            </plugins>
        </build>
    
    </project>

--------------------

## 创建 两个Module: artisan-spring-boot-starter 和 artisan-spring-boot-starter-autoconfigurer ##

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 6]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 7]  
同样的方式创建  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 8]

--------------------

## artisan-spring-boot-starter (空的jar文件，仅仅提供辅助性依赖管理) ##

### pom ###

**如果使用spring Initializr创建的需要删除 启动类、resources下的文件，test文件。**

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 9]

--------------------

## artisan-spring-boot-starter-autoconfigurer ##

### pom ###

关于自动提示的jar ,引入spring-boot-configuration-processor之后， 编译之后就会在META-INF文件夹下面生成一个**spring-configuration-metadata.json**的文件。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 10]

内容如下

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 11]

--------------------

【工程结构】

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 12]

--------------------

### CustomProperties ###

package com.artisan;
    
    import org.springframework.boot.context.properties.ConfigurationProperties;
    
    /** * @author 小工匠 * @version 1.0 * @description: 属性配置文件 * @date 2021/5/22 18:56 * @mark: show me the code , change the world */
    
    @ConfigurationProperties("artisan.custom")
    public class CustomProperties { 
        private String name;
    
        public String getName() { 
            return name;
        }
    
        public void setName(String name) { 
            this.name = name;
        }
    }

![在这里插入图片描述][20210522231627949.jpg_pic_center]

--------------------

### IndexController ###

package com.artisan;
    
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    /** * @author 小工匠 * @version 1.0 * @description: TODO * @date 2021/5/22 18:58 * @mark: show me the code , change the world */
    
    @RestController
    public class IndexController { 
    
        private CustomProperties customProperties;
    
        public IndexController(CustomProperties customProperties) { 
            this.customProperties = customProperties;
        }
    
        @RequestMapping("/")
        public String index() { 
            return customProperties.getName();
        }
    
    }

--------------------

### CustomAutoConfiguration 自动配置类 ###

package com.artisan;
    
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
    import org.springframework.boot.context.properties.EnableConfigurationProperties;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    
    /** * @author 小工匠 * @version 1.0 * @description: 模拟给web应用自动添加一个首页 * @date 2021/5/22 18:55 * @mark: show me the code , change the world */
    
    
    @Configuration
    @ConditionalOnProperty(value = "artisan.custom.name")
    @EnableConfigurationProperties(CustomProperties.class)
    public class CustomAutoConfiguration { 
    
    
        @Autowired
        CustomProperties cus;
    
        @Bean
        public IndexController indexController() { 
            return new IndexController(cus);
        }
    
    
    }

![在这里插入图片描述][20210522231617519.jpg_pic_center]

--------------------

### spring.factories ###

在 resources 下创建文件夹 META-INF 并在 META-INF 下创建文件 spring.factories ，内容如下：

![在这里插入图片描述][20210522231050274.png]

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
      com.artisan.CustomAutoConfiguration

--------------------

### 打包发布 ###

到这儿，我们的配置自定义的starter就写完了 ，我们artisan-spring-boot-starter 和 artisan-spring-boot-starter-autoconfigurer 安装成本地jar包。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 13]

--------------------

### 引用自定义starter测试 ###

新建个spring boot 项目 ，引用刚才的starter

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 14]  
访问 http://localhost:8080/  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 15]

咦 ，别忘了你自定义的属性

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 16]  
重启后，重新访问

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 17]

因为我们开启了debug=true .找找我们自动装配的类看看

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 18]  
![在这里插入图片描述][20210522231600986.gif_pic_center]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70]: /images/20221014/d30f76c7ecd44d0a905a2346bc5c3148.png
[20210522225300858.png]: /images/20221014/58de8abfb605419aa0ad5f707a1d5525.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 1]: /images/20221014/10b545b9ad644b288dcf4e33725f5af4.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 2]: /images/20221014/e03b2d47a8ea4f8e98b2d751d4dc12bb.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 3]: /images/20221014/e896f15109154b86b920deeacf610a7d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 4]: /images/20221014/ff02765d065f4f46813aa0812c7654ff.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 5]: /images/20221014/c354cb8042674ffea67543e68dff222f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 6]: /images/20221014/2bbe3f80266c483199fb46cb97a46a36.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 7]: /images/20221014/47ee72c132954b36a64d4f919059372d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 8]: /images/20221014/918745486c4746f3ac20f841ce48e0c7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 9]: /images/20221014/4660c8fe9cf94f8db25e4d698db7e418.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 10]: /images/20221014/02c1dc97f7a146e681d584fb677411cd.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 11]: /images/20221014/103a734e7450414da14ea9c006c910ea.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 12]: /images/20221014/17ec3781cd52454a844a94704d44792f.png
[20210522231627949.jpg_pic_center]: /images/20221014/3b632a8a2bda46818b40652a9dc5ef6e.png
[20210522231617519.jpg_pic_center]: /images/20221014/318e52194de444c5a29fac7960cb19a3.png
[20210522231050274.png]: /images/20221014/b0a59b40837d4b069e95dcdd3b3e16e8.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 13]: /images/20221014/3cbd09f80f7b4a5b9e2670a046a47a19.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 14]: /images/20221014/cfc9956de93e43e68491c7d58b56c754.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 15]: /images/20221014/c9182924069742b1bf9af4d93db6e1cc.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 16]: /images/20221014/aeb930c04f01437aa9689bdecea549b2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 17]: /images/20221014/c60d8dbcb52d44d1809cffb73537f397.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lhbmdzaGFuZ3dlaQ_size_16_color_FFFFFF_t_70 18]: /images/20221014/e04ef6e3edb543f0a94e8e7e08f8c036.png
[20210522231600986.gif_pic_center]: /images/20221014/53e9b2fe95ed4e9a9e56b135bd2c09a2.png