SpringBoot2 | SpringBoot自定义AutoConfiguration | SpringBoot自定义starter（五）

野性酷女 2022-01-20 09:17 278阅读 0赞

> 微信公众号：吉姆餐厅ak 学习更多源码知识，欢迎关注。

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

[**SpringBoot2 | SpringBoot启动流程源码分析（一）**][SpringBoot2 _ SpringBoot]

[**SpringBoot2 | SpringBoot启动流程源码分析（二）**][SpringBoot2 _ SpringBoot 1]

[**SpringBoot2 | @SpringBootApplication注解 自动化配置流程源码分析（三）**][SpringBoot2 _ _SpringBootApplication_]

[**SpringBoot2 | SpringBoot Environment源码分析（四）**][SpringBoot2 _ SpringBoot Environment]

[**SpringBoot2 | SpringBoot自定义AutoConfiguration | SpringBoot自定义starter（五）**][SpringBoot2 _ SpringBoot_AutoConfiguration _ SpringBoot_starter]

[**SpringBoot2 | SpringBoot监听器源码分析 | 自定义ApplicationListener（六）**][SpringBoot2 _ SpringBoot_ _ _ApplicationListener]

[**SpringBoot2 | 条件注解@ConditionalOnBean原理源码深度解析（七）**][SpringBoot2 _ _ConditionalOnBean]

[**SpringBoot2 | Spring AOP 原理源码深度剖析（八）**][SpringBoot2 _ Spring AOP]

[**SpringBoot2 | SpingBoot FilterRegistrationBean 注册组件 | FilterChain 责任链源码分析（九）**][SpringBoot2 _ SpingBoot FilterRegistrationBean _ _ FilterChain]

[**SpringBoot2 | BeanDefinition 注册核心类 ImportBeanDefinitionRegistrar （十）**][SpringBoot2 _ BeanDefinition _ ImportBeanDefinitionRegistrar]

[**SpringBoot2 | Spring 核心扩展接口 | 核心扩展方法总结（十一）**][SpringBoot2 _ Spring _ _]

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

## 概述 ##

**springBoot为我们提供了自动化装配的功能，简单方便。可以像使用插件一样，对各个组件自由组合装配。只需引入定义好的 starter 即可。有点类似于java的SPI机制，只不过SPI机制是为了解决项目与项目之间的解耦，而starter方式实现了模块化完全解耦，实现热插拔功能。**

今天就来自定义一个自动化装配的实现，自定义starter。

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

## 自定义starter ##

**首先定义一个配置类模块：**

/**
     * Created by zhangshukang on 2018/9/20.
     */
    
    @Configuration
    @ConditionalOnProperty(name = "enabled.autoConfituration", matchIfMissing = true)
    public class MyAutoConfiguration {
    
        static {
            System.out.println("myAutoConfiguration init...");
        }
    
        @Bean
        public SimpleBean simpleBean(){
            return new SimpleBean();
        }
    
    }
    复制代码

**然后定义一个starter模块，里面无需任何代码，pom也无需任何依赖，只需在META-INF下面建一个 `spring.factories`文件，添加如下配置**：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
    spring.study.startup.bean.MyAutoConfiguration
    复制代码

如图所示：

**最后只需在启动类项目中引入我们的 starter 模块即可。**

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

## 原理 ##

在[**SpringBoot2 | @SpringBootApplication注解 自动化配置流程源码分析（三）**][SpringBoot2 _ _SpringBootApplication_]中，我们提到了自动化配置的逻辑，入口为spring 刷新容器的方法：

public void refresh() throws BeansException, IllegalStateException {
    		//...
    		invokeBeanFactoryPostProcessors(beanFactory);
    		//...
    	}
    复制代码

最终在`AutoConfigurationImportSelector`解析`spring.factories`文件：

`spring.factories`默认的配置类。如下：

**springBoot为我们提供的配置类有180多个，但是我们不可能会全部引入。所以在自动装配的时候，会去classPath下面寻找，是否有对应的配置类。如果有配置类，则按条件注解 `@Conditional`或者`@ConditionalOnProperty`等相关注解进行判断，决定是否需要装配。如果`classPath`下面没有对应的字节码，则不进行任何处理。** 我们自定义的配置类也是以相同的逻辑进行装配，我们指定了以下注解：

@ConditionalOnProperty(name = "enabled.autoConfituration", matchIfMissing = true)
    复制代码

默认为 true，所以自定义的starter成功执行。

`springBoot`提供了一系列的条件注解：

> @ConditionalOnBean（仅仅在当前上下文中存在某个对象时，才会实例化一个Bean） @ConditionalOnClass（某个class位于类路径上，才会实例化一个Bean） @ConditionalOnExpression（当表达式为true的时候，才会实例化一个Bean） @ConditionalOnMissingBean（仅仅在当前上下文中不存在某个对象时，才会实例化一个Bean） @ConditionalOnMissingClass（某个class类路径上不存在的时候，才会实例化一个Bean） @ConditionalOnNotWebApplication（不是web应用）

**后面会进行条件注解源码分析**。

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

[**SpringBoot2 | SpringBoot启动流程源码分析（一）**][SpringBoot2 _ SpringBoot]

[**SpringBoot2 | SpringBoot启动流程源码分析（二）**][SpringBoot2 _ SpringBoot 1]

[**SpringBoot2 | @SpringBootApplication注解 自动化配置流程源码分析（三）**][SpringBoot2 _ _SpringBootApplication_]

[**SpringBoot2 | SpringBoot Environment源码分析（四）**][SpringBoot2 _ SpringBoot Environment]

[**SpringBoot2 | SpringBoot自定义AutoConfiguration | SpringBoot自定义starter（五）**][SpringBoot2 _ SpringBoot_AutoConfiguration _ SpringBoot_starter]

[**SpringBoot2 | SpringBoot监听器源码分析 | 自定义ApplicationListener（六）**][SpringBoot2 _ SpringBoot_ _ _ApplicationListener]

[**SpringBoot2 | 条件注解@ConditionalOnBean原理源码深度解析（七）**][SpringBoot2 _ _ConditionalOnBean]

[SpringBoot2 _ SpringBoot]: https://link.juejin.im?target=https%3A%2F%2Fblog.csdn.net%2Fwoshilijiuyi%2Farticle%2Fdetails%2F82219585
[SpringBoot2 _ SpringBoot 1]: https://link.juejin.im?target=https%3A%2F%2Fblog.csdn.net%2Fwoshilijiuyi%2Farticle%2Fdetails%2F82350057
[SpringBoot2 _ _SpringBootApplication_]: https://link.juejin.im?target=https%3A%2F%2Fblog.csdn.net%2Fwoshilijiuyi%2Farticle%2Fdetails%2F82388509
[SpringBoot2 _ SpringBoot Environment]: https://link.juejin.im?target=https%3A%2F%2Fblog.csdn.net%2Fwoshilijiuyi%2Farticle%2Fdetails%2F82720478
[SpringBoot2 _ SpringBoot_AutoConfiguration _ SpringBoot_starter]: https://link.juejin.im?target=https%3A%2F%2Fblog.csdn.net%2Fwoshilijiuyi%2Farticle%2Fdetails%2F82792601
[SpringBoot2 _ SpringBoot_ _ _ApplicationListener]: https://link.juejin.im?target=https%3A%2F%2Fblog.csdn.net%2Fwoshilijiuyi%2Farticle%2Fdetails%2F82805649
[SpringBoot2 _ _ConditionalOnBean]: https://link.juejin.im?target=https%3A%2F%2Fblog.csdn.net%2Fwoshilijiuyi%2Farticle%2Fdetails%2F84147483
[SpringBoot2 _ Spring AOP]: https://link.juejin.im?target=https%3A%2F%2Fblog.csdn.net%2Fwoshilijiuyi%2Farticle%2Fdetails%2F83934407
[SpringBoot2 _ SpingBoot FilterRegistrationBean _ _ FilterChain]: https://link.juejin.im?target=https%3A%2F%2Fblog.csdn.net%2Fwoshilijiuyi%2Farticle%2Fdetails%2F85014183
[SpringBoot2 _ BeanDefinition _ ImportBeanDefinitionRegistrar]: https://link.juejin.im?target=https%3A%2F%2Fblog.csdn.net%2Fwoshilijiuyi%2Farticle%2Fdetails%2F85268659
[SpringBoot2 _ Spring _ _]: https://link.juejin.im?target=https%3A%2F%2Fblog.csdn.net%2Fwoshilijiuyi%2Farticle%2Fdetails%2F85396492