详解SpringBoot的自动装配原理：如何手写一个starter组件?

约定不等于承诺〃 2024-03-22 10:01 36阅读 0赞

`springboot`作为java开发者不得不提的一个框架，其中也是有许多配置可以减轻开发者的工作量。

简化了Bean对象注入到IoC容器中的流程（自动装配），配置文件的统一管理。

比如自动装配，引入一个starter就可以实现了，大大减少了代码量，使得coder专注于业务代码。

### 自动装配原理 ###

首先你需要去熟悉SPI机制

具体的逻辑就不展示了，这里只展现关键代码。

**springboot自动装配的流程**

就是随着A项目的启动，会扫描到`@SpringBootApplication`注解

该注解里面存在一个`@EnableAutoConfiguration`注解

在`EnableAutoConfiguration`注解里面又存在一个`Import`注解

执行`selectImports`方法，`selectImports`返回的是配置类的全路径名

配置类从何而来，是基于**SPI**机制，去classpath下的`META-INF`目录下找所有的`spring.factories`文件，然后将所有的spring.factories文件进行解析

自动将我所需要的Bean对象注入到IoC容器里面去，`@Configuration`和`@Bean`，自动体现在我没有对任何类加前面的两个注解

### 手写一个starter ###

1.我们先新建一个springboot项目，这里的application.properties和Application启动类都是不需要的

![format_png][]

2.定义一个简单的Boy类

/**
     * @author suncong
     * @Date 2023/2/3 17:24
     */
    public class Boy{
    
        public static Boy create(String name){
            return new Boy(name);
        }
    
        private String name;
    
        public Boy(String name) {
            this.name = name;
        }
    
        public String getName() {
            return name;
        }
    
        public void setName(String name) {
            this.name = name;
        }
    
        public String say(){
            return name+"，Hello World！";
        }
    }
    复制代码

3.定义自动配置类

/**
     * @author suncong
     * @Date 2023/2/3 17:26
     */
    @ConditionalOnClass(Boy.class) // 加载到Boy这个类的话，就自动装配
    @EnableConfigurationProperties(BoyProperties.class)
    @Configuration
    @Data
    @ComponentScan
    public class BoyAutoConfiguration {
    
        /**
         * 将对象交给IOC管理
         * @param boyProperties
         * @return
         */
       @Bean
        Boy boy(BoyProperties boyProperties){
           return new Boy(boyProperties.getName());
       }
    
    }
    复制代码

4.定义`ConfigurationProperties`类，从配置文件（引用这个starter的项目的配置文件）中读取配置

/**
     * @author suncong
     * @Date 2023/2/3 17:28
     */
    @ConfigurationProperties(prefix = "demo.boy")
    public class BoyProperties {
        private String name;
    
        public String getName() {
            return name;
        }
    
        public void setName(String name) {
            this.name = name;
        }
    }
    复制代码

5.META-INF文件

**注意这里的每个包名都要正确！！**

比如`META_INF`和`spring,factories`就是错的（别问我怎么知道的...）

`additional-spring-configuration-metadata.json`

这个文件可写可不写，主要是定义配置信息的内容（指定demo.boy.name必须是String类型）

{
      "properties": [
        {
          "name":  "demo.boy.name",
          "type":"java.lang.String",
          "description": "想跳舞的人",
          "defaultValue": "sc"
        }
      ]
    }
    复制代码

`spring.factories` 这个文件必须写，配置自动装配的类的路径

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
        com.sc.demo.BoyAutoConfiguration
    复制代码

6.打包

![format_png 1][]

这样的话，本地的maven仓库就有了这个jar包（后续可以上传仓库或者直接发jar给别人用）

7.再新建一个springboot项目

定义启动类和配置类

/**
     * @author SunCong
     */
    @RestController
    @SpringBootApplication
    public class Demo1Application {
    
        public static void main(String[] args) {
            SpringApplication.run(Demo1Application.class, args);
        }
    
        @Autowired
        private com.sc.demo.Boy boy;
    
        @GetMapping("/say")
        public String say(){
    
            return boy.say();
        }
    
    }
    复制代码

application.properties:

# 应用名称
    spring.application.name=demo1
    
    server.port=8081
    
    demo.boy.name="scscsc"
    复制代码

pom.xml:

<dependency>
            <groupId>com.sc</groupId>
            <artifactId>demo</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>
    
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
    
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    复制代码

![format_png 2][]

8.测试

![format_png 3][]

我们也可以修改配置文件

# 应用名称
    spring.application.name=demo1
    
    server.port=8081
    
    demo.boy.name="shuaige"
    复制代码

![format_png 4][]

搞定!!!

### 两类starter的区别 ###

我们注意到有这么两个starter：

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
        <version>2.2.2</version>
    </dependency>
    复制代码

一个是xxx-starter， 一个是stater-xxx

区别： 1.starter命名规则不一样（如上） 2.xxx-starter是第三方的，自动配置类在

![format_png 5][]

starter-xxx是官方的，自动配置类在

![format_png 6][]

[format_png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/2493718502ab45fd8949215055bbf0fe.png
[format_png 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/2ba72278d5904beea4671a7a5c0cbaa4.png
[format_png 2]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/ea16238ca5ac44bcb79c180f6cee46a5.png
[format_png 3]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/a9c063da9971408fbd1dc2a82ca3eb9d.png
[format_png 4]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/7a611c0e074b465ea6c834f8c630c20b.png
[format_png 5]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/aa5dda07194f4a15ba5c29d6ba779d1e.png
[format_png 6]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/22/616b41359fb642b5b5e142dd23b319fe.png