手写自定义springboot-starter，感受框架的魅力和原理

刺骨的言语ヽ痛彻心扉 2024-04-01 09:06 25阅读 0赞

### 一、前言 ###

Springboot的自动配置原理，面试中经常问到，一直看也记不住，不如手写一个starter，加深一下记忆。  
看了之后发现大部分的starter都是这个原理，实践才会记忆深刻。  
核心思想：`约定大于配置`。

### 二、初探starter启动原理 ###

我们直接看看官网的`starter`是怎么设计的，仿照这写一个就行了！

我们`Ctrl`点击`<artifactId>spring-boot-starter-web</artifactId>`，进入内部pom，我们发现里面有个

<dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter</artifactId>
      <version>2.5.3</version>
      <scope>compile</scope>
    </dependency>

在此`Ctrl`点击`<artifactId>spring-boot-starter</artifactId>`进入starter内部pom：  
我们发现之后干活的就是这个包依赖：

<dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-autoconfigure</artifactId>
      <version>2.5.3</version>
      <scope>compile</scope>
    </dependency>

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

我们现在创建两个项目即可：

*  spring-boot-starter（启动器）
 *  spring-boot-starter-autoconfigure（自动配置包）

小编看到官方这么写的提醒，大家可以按照官网的进行起名称，不要学小编哈！！

> 您应该确保为您的启动器提供适当的命名空间。不要以 . 开头的模块名称spring-boot，即使您使用不同的 Maven groupId。我们将来可能会为您自动配置的内容提供官方支持。  
> 根据经验，您应该在启动器之后命名组合模块。例如，假设您正在为“acme”创建一个启动器，并且您命名自动配置模块acme-spring-boot和启动器acme-spring-boot-starter。如果您只有一个模块将两者结合起来，请将其命名为acme-spring-boot-starter.

### 三、项目搭建 ###

#### 1. 新建空白项目 ####

![在这里插入图片描述][65191093e44e4e73bc6f2f8b34653199.png]  
输入总的项目名称  
![在这里插入图片描述][00f478adbfb2443d96453d59336737e9.png]  
在空白项目里新建两个，这里可以分开单独建立，这里小编跟着雷神一样了，就不单独建立项目了！！

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

#### 2. 新建maven项目 ####

![在这里插入图片描述][762880eeb5304a90ba5f1215dde323de.png]  
包名和名称：

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

#### 3. 新建springboot项目 ####

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

#### 4. 项目架构 ####

这里把没有用的都删除了！！可以不删  
![在这里插入图片描述][01df0174c5924d40bca85bf6f69ebd42.png]

### 四、配置 ###

#### 1. 在starter项目中引入自己的autoconfigure依赖 ####

就是上面建立项目的设置的

<dependencies>
        <dependency>
            <groupId>com.wang</groupId>
            <artifactId>spring-boot-autoconfigure</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>
    </dependencies>

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

#### 2. spring-boot-autoconfigure pom配置 ####

<properties>
        <java.version>1.8</java.version>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <spring-boot.version>2.3.7.RELEASE</spring-boot.version>
    </properties>
    
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
            <version>${spring-boot.version}</version>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.24</version>
        </dependency>
    </dependencies>

还是把没用的东西删除了，剩余如下图：

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

### 五、编写autoconfigure项目 ###

#### 1. 配置一个bean ####

首先删除了自动启动类，咱们用不到，  
在`spring-boot-autoconfigure`项目中新建一个bean，此时不需要让这个bean在容器中，我们写一个自己配置，让他自动加入到容器中。  
这就是自动配置的思想

/**
     * 这里不需要让在容器中，我们写一个自己配置，让他自动加入到容器中
     * @author wangzhenjun
     * @date 2022/10/14 16:26
     */
    public class HelloService {
    
        @Autowired
        private MyProperties myProperties;
    
        public String HelloWord (String username){
            return myProperties.getPrefix() + username + myProperties.getSuffix();
        }
    }

#### 2. 编写一个配置文件 ####

这里为了获取配置文件中的属性值，springboot自动配置源码里大部分都是，这样实现在一个配置文件中书写，其他的可以按照开头获取到`属性和值`！！

/**
     * @author wangzhenjun
     * @date 2022/10/14 16:28
     */
    @Data
    @ConfigurationProperties("wang.name")
    public class MyProperties {
    
        private String prefix;
        private String suffix;
    }

#### 3. 编写自动配置 ####

import com.wang.springbootautoconfigure.properties.MyProperties;
    import com.wang.springbootautoconfigure.service.HelloService;
    import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
    import org.springframework.boot.context.properties.EnableConfigurationProperties;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    
    /**
     * @author wangzhenjun
     * @date 2022/10/14 16:33
     */
    @Configuration
    //没有这个bean的时候才会生效
    @ConditionalOnMissingBean(HelloService.class)
    // 加载配置文件，让它成为容器中的bean
    @EnableConfigurationProperties(MyProperties.class)
    public class ServiceAutoConfiguration {
    	
    	
    	/**
    	 * 把刚刚写的服务，加入到容器中
    	 */
        @Bean
        public HelloService helloService (){
        	
            return new HelloService();
        }
    }

主要就是`condition`下的几个注解，来完成`bean`是否加入到容器中：  
常用的：

*  @ConditionalOnClass
 *  @ConditionalOnMissingClass
 *  @ConditionalOnBean
 *  @ConditionalOnMissingBean
 *  @ConditionalOnProperty  
    ![在这里插入图片描述][d08636f6106b43ddbc8ed81c195d07cd.png]

#### 4. 新建spring.factories ####

我们看到源码里自动配置，就是从这个文件获取加载，所以我们模仿这新建一个，这样就可以扫描加入容器中！！

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

如果是springboot2.7以上就是：  
文件夹名称：`META-INF.spring`  
文件名称：`org.springframework.boot.autoconfigure.AutoConfiguration.imports`

![在这里插入图片描述][b1376be9f02a49768d5d68788bbbe194.png]  
里面直接写全类名即可！

#### 5. 打包 ####

先把`spring-boot-autoconfigure`打包到本地库，在打包`spring-boot-starter`，顺序一定要有，不然找不到前者的包！！

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

### 六、测试 ###

我们那一个新项目进行测试，新项目小编就不带大家建了！

#### 1. 导入咱们的starter依赖 ####

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

#### 2. 添加配置文件 ####

wang:
     name:
      prefix: hello
      suffix: 886

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

#### 3. 新建controller测试类 ####

@RestController
    @RequestMapping("/test")
    public class TestController {
    
        @Autowired
        private HelloService helloService;
    
        @GetMapping("/starter")
        public String starter(){
    
            return helloService.HelloWord("tom");
        }
    }

#### 4. 测试访问 ####

成功访问，不过中文是有乱码的，小编找不到解决方法，有懂的还请留言告知！！  
主流程通了就行，慢慢理解了自动配置的魅力！  
总流程应该就是这样的：

**引入starter --- xxxAutoConfiguration --- 容器中放入组件 ---- 绑定xxxProperties ---- 配置项**

![在这里插入图片描述][d156d091d6c34788bab98b8eb2ad8f72.png]  
中文是乱码，可能是servlet没有吧，有懂的可以留言告诉小编方案，谢谢大家！！

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

### 七、总结 ###

一看会就，一动手就废！大家还是要做自己实操，不要眼高手低，这样才会有收获，根本就是`约定大于配置+SPI发现机制`！  
还有就是一些经常出现在源码里的注解，大家记住就可以自己写starter了！

[f1057da069474fc3bc85e80d339af5ed.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/d64105256a4440a08d5a4f44d4a2fdf9.png
[65191093e44e4e73bc6f2f8b34653199.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/1e7bf69ac5714ac1b3db8bc8bd716e40.png
[00f478adbfb2443d96453d59336737e9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/6ab7e092c7824aa0b2733d29139a11a2.png
[bb281dcac4e749a184e4dda4f32e0dc2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/07f400baa1364952a539399375bf184a.png
[762880eeb5304a90ba5f1215dde323de.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/a4af7b87df1d4030a374a3729c1d8253.png
[907d2117055c4e71acff6f91efbf74bd.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/d05fca3f72be49a482521fb82c5dc25b.png
[58d0d59c18574677abbb2a73d1f08010.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/a2334362233c41b38ebceaa6db1cdcf3.png
[01df0174c5924d40bca85bf6f69ebd42.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/44c2d3aceea242cabeda208269577338.png
[0743a7af4ac74a60bee2ac378e81559a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/77a6c40625114927ab68706243222b68.png
[47ebe08fa8f24bb88a99c8c8c9b9dbb7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/c70df0bef76d48488ef5541cc24a9706.png
[d08636f6106b43ddbc8ed81c195d07cd.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/1d625d7d0bd84a2099c94f9569a1116e.png
[2ad5fa3581b745dd86fc8231c5580ba8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/9a8a5a8451744cdf85794cef19364c75.png
[b1376be9f02a49768d5d68788bbbe194.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/02536e14950e46f2b4f559f7103bd6ac.png
[192a29b59b2041deb3af4406554e578d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/2fd45e18f46a4f358aec64714a960ba9.png
[5bbebba25dd74e16a8d53484908d561f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/54afc95489ad4a2ea54a7be7504b3ecb.png
[d156d091d6c34788bab98b8eb2ad8f72.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/5b8c3413dd8c4e789a87c5a1042d0a8f.png
[e93c382d663d4d4d9f96ae33fea58e41.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/64b35fbc2a6746bc808e9396e7bf1a24.png