• 深入理解springboot的自动配置「源码分析/图文详解」

    目录

    一、前言

    二、原理分析

    1、spring.factories的扫描

    2、配置信息定义

    3、pom依赖

    4、tomcat的自动配置

    5、Conditional注解

    6、tomcat启动

    7、结论分析

    三、自定义组件

    1、自定义spring.factories

    2、自定义MyAutoConfiguration

    3、自定义属性信息

    4、自定义工厂类

    5、创建触发条件

    6、启动测试

    7、控制台信息

    一、前言

    在使用springboot时，有一个大的原则：约定大于配置。

    springboot内置了很多常用的组件，比如tomcat、jdbc、redis等，接下来从根本上分析自动配置的原理及集成过程。

    为更好的理解，先提出这几个疑问，也是我们后续分析的思路：

    1、tomcat作为默认的服务容器，springboot是如何自动找到的tomcat；

    2、jdbc、redis都需要配置链接信息，链接错误服务启动会报错，但没有配置则正常启动

    3、我们如何按照自动配置的原则，实现自定义的组件进行装配。

    二、原理分析

    1、spring.factories的扫描

    在《深入理解为什么nacos配置信息要放到bootstrap.properties「源码分析/图文详解」》一文中有详细分析：项目启动的时候，先加载系统信息，所有pom依赖jar包中的META-INF/spring.factories都会在这时进行扫描并缓存。

    项目启动的debug调试信息如下，可以看出扫描spring.factories的优先级非常靠前：

    2、配置信息定义

    springboot自动配置的信息，在系统所示的jar包中的spring.factoires中都进行的定义。

    部分spring.factoryes内容如下：

    1. # Auto Configure
    2. org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
    3. ...省略...
    4. org.springframework.boot.autoconfigure.data.elasticsearch.ElasticsearchRepositoriesAutoConfiguration,\
    5. org.springframework.boot.autoconfigure.data.mongo.MongoDataAutoConfiguration,\
    6. org.springframework.boot.autoconfigure.data.solr.SolrRepositoriesAutoConfiguration,\
    7. org.springframework.boot.autoconfigure.data.redis.RedisAutoConfiguration,\
    8. org.springframework.boot.autoconfigure.data.web.SpringDataWebAutoConfiguration,\
    9. org.springframework.boot.autoconfigure.web.servlet.ServletWebServerFactoryAutoConfiguration,\
    10. org.springframework.boot.autoconfigure.websocket.reactive.WebSocketReactiveAutoConfiguration,\
    11. org.springframework.boot.autoconfigure.websocket.servlet.WebSocketServletAutoConfiguration,\
    12. org.springframework.boot.autoconfigure.websocket.servlet.WebSocketMessagingAutoConfiguration,\
    13. org.springframework.boot.autoconfigure.webservices.WebServicesAutoConfiguration,\
    14. org.springframework.boot.autoconfigure.webservices.client.WebServiceTemplateAutoConfiguration

    这里配置了es、redis、solr、mongodb等，其中也包含Tomcat的嵌入配置。

    3、pom依赖

    当springboot应用作为web项目进行启动时，需要添加pom依赖：

    1. <dependency>
    2.     <groupId>org.springframework.bootgroupId>
    3.     <artifactId>spring-boot-starter-webartifactId>
    4. dependency>

    其中就包含了tomcat的依赖信息，依赖关系如下：

    这里就开始体现springboot约定大于配置的思想，指定tomcat作为默认服务容器。

    4、tomcat的自动配置

    在spring.factories中web容器的初始化在ServletWebServerFactoryAutoConfiguration进行。

    源码：

    源码第一句注释：

    Auto-configuration for servlet web servers. 

    从这里可以看出，这是自动配置web服务的地方，同时也出现了Tomcat 的信息。 

    5、Conditional注解

    关于@Conditional注解：

    @Conditional注解是一个条件装配注解，主要用于限制@Bean注解在什么时候才生效，以指定的条件形式控制bean的创建


    @Conditional可以自定义条件进行装配或者不装配


    @Conditional本身是一个父注解，派生出很多子注解：

    @ConditionalOnClass和@ConditionalOnWebApplication就是其中的子项！

    ServletWebServerFactoryAutoConfiguration上使用的注解较多，其它注解作用分别如下：

    @EnableConfigurationProperties：

            使配置文件中配置的信息生效，如端口配置 server.port=8081

    @Import

            通过快速导入的方式实现把实例加入spring的IOC容器中

    重点是这里

    1. @Bean
    2. @ConditionalOnClass(name = "org.apache.catalina.startup.Tomcat")
    3. public TomcatServletWebServerFactoryCustomizer tomcatServletWebServerFactoryCustomizer(
    4. 		ServerProperties serverProperties) {
    5. 	return new TomcatServletWebServerFactoryCustomizer(serverProperties);
    6. }

    意思是当org.apache.catalina.startup.Tomcat这个class类存在时，注入bean信息。

    从pom依赖关系中，已经倒入了tomcat相关依赖，所以这个@Bean自然会被注入到spring容器中。

    6、tomcat启动

    从Tomcat创建到启动的代码跟踪流程如下：

    TomcatServletWebServerFactory#getWebServer源码：

    1. @Override
    2. public WebServer getWebServer(ServletContextInitializer... initializers) {
    3. 	if (this.disableMBeanRegistry) {
    4. 		Registry.disableRegistry();
    5. 	}
    6. 	Tomcat tomcat = new Tomcat();
    7. 	File baseDir = (this.baseDirectory != null) ? this.baseDirectory : createTempDir("tomcat");
    8. 	tomcat.setBaseDir(baseDir.getAbsolutePath());
    9. 	Connector connector = new Connector(this.protocol);
    10. 	connector.setThrowOnFailure(true);
    11. 	tomcat.getService().addConnector(connector);
    12. 	customizeConnector(connector);
    13. 	tomcat.setConnector(connector);
    14. 	tomcat.getHost().setAutoDeploy(false);
    15. 	configureEngine(tomcat.getEngine());
    16. 	for (Connector additionalConnector : this.additionalTomcatConnectors) {
    17. 		tomcat.getService().addConnector(additionalConnector);
    18. 	}
    19. 	prepareContext(tomcat.getHost(), initializers);
    20. 	return getTomcatWebServer(tomcat);
    21. }

    TomcatWebServer#initialize()源码：

    1. TomcatWebServer#initialize();
    2. private void initialize() throws WebServerException {
    3. 	logger.info("Tomcat initialized with port(s): " + getPortsDescription(false));
    4. 	synchronized (this.monitor) {
    5. 		try {
    6. 			addInstanceIdToEngineName();
    7.  
    8. 			Context context = findContext();
    9. 			context.addLifecycleListener((event) -> {
    10. 				if (context.equals(event.getSource()) && Lifecycle.START_EVENT.equals(event.getType())) {
    11. 					// Remove service connectors so that protocol binding doesn't
    12. 					// happen when the service is started.
    13. 					removeServiceConnectors();
    14. 				}
    15. 			});
    16.  
    17. 			// Start the server to trigger initialization listeners
    18. 			this.tomcat.start();
    19.  
    20. 			// We can re-throw failure exception directly in the main thread
    21. 			rethrowDeferredStartupExceptions();
    22.  
    23. 			try {
    24. 				ContextBindings.bindClassLoader(context, context.getNamingToken(), getClass().getClassLoader());
    25. 			}
    26. 			catch (NamingException ex) {
    27. 				// Naming is not enabled. Continue
    28. 			}
    29.  
    30. 			// Unlike Jetty, all Tomcat threads are daemon threads. We create a
    31. 			// blocking non-daemon to stop immediate shutdown
    32. 			startDaemonAwaitThread();
    33. 		}
    34. 		catch (Exception ex) {
    35. 			stopSilently();
    36. 			destroySilently();
    37. 			throw new WebServerException("Unable to start embedded Tomcat", ex);
    38. 		}
    39. 	}
    40. }

    注意是这里：

    // Start the server to trigger initialization listeners
    this.tomcat.start();

    然后tomcat已经被内嵌到springboot中并且启动。

    7、结论分析

    到这里再重新梳理下流程：

    • springboot扫描spring.factories中的配置信息；
    • 根据@Conditional条件选择性注入；
    • 加载属性信息，创建组件对象，并启动或应用

    三、自定义组件

    了解了自动装备的原理，我们自己实现一个。

    1、自定义spring.factories

    创建自定义的spring.factories文件

    1. # Auto Configuration
    2. org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
    3.     com.zhufeng.demo.config.MyAutoConfiguration

    2、自定义MyAutoConfiguration

    1. package com.zhufeng.demo.config;
    2.  
    3. import com.zhufeng.demo.factory.HelloWorldFactory;
    4. import com.zhufeng.demo.prop.ZhufengProperties;
    5. import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
    6. import org.springframework.boot.context.properties.EnableConfigurationProperties;
    7. import org.springframework.context.annotation.Bean;
    8. import org.springframework.context.annotation.Configuration;
    9.  
    10. /**
    11.  * @ClassName: MyAutoConfiguration
    12.  * @Description TODO
    13.  * @author 月夜烛峰
    14.  * @date 2022/9/8 15:32
    15.  */
    16. @Configuration(proxyBeanMethods = false)
    17. @EnableConfigurationProperties(ZhufengProperties.class)
    18. public class MyAutoConfiguration {
    19.  
    20.     public MyAutoConfiguration(){
    21.         System.out.println("MyAutoConfiguration 已经自动装配。。。");
    22.     }
    23.  
    24.     @Bean
    25.     @ConditionalOnClass(name = "com.zhufeng.demo.HelloWorld")
    26.     public HelloWorldFactory showHelloWorld(
    27.             ZhufengProperties zhufengProperties) {
    28.         return new HelloWorldFactory(zhufengProperties);
    29.     }
    30. }

    3、自定义属性信息

    1. package com.zhufeng.demo.prop;
    2.  
    3. import org.springframework.boot.context.properties.ConfigurationProperties;
    4.  
    5. /**
    6.  * @ClassName: ZhufengProperties
    7.  * @Description 自定义配置文件
    8.  * @author 月夜烛峰
    9.  * @date 2022/9/8 15:25
    10.  */
    11.  
    12. @ConfigurationProperties(prefix = "com.zhufeng")
    13. public class ZhufengProperties {
    14.  
    15.     private final ZhufengProperties.User user = new ZhufengProperties.User();
    16.     private final ZhufengProperties.Msg msg = new ZhufengProperties.Msg();
    17.  
    18.     public User getUser() {
    19.         return user;
    20.     }
    21.  
    22.     public Msg getMsg() {
    23.         return msg;
    24.     }
    25.  
    26.     public static class User{
    27.         private String id;
    28.  
    29.         private String name;
    30.  
    31.         public String getId() {
    32.             return id;
    33.         }
    34.  
    35.         public void setId(String id) {
    36.             this.id = id;
    37.         }
    38.  
    39.         public String getName() {
    40.             return name;
    41.         }
    42.  
    43.         public void setName(String name) {
    44.             this.name = name;
    45.         }
    46.  
    47.         @Override
    48.         public String toString() {
    49.             return "User{" +
    50.                     "id='" + id + '\'' +
    51.                     ", name='" + name + '\'' +
    52.                     '}';
    53.         }
    54.     }
    55.  
    56.     public static class Msg {
    57.  
    58.         private String type;
    59.         private long length;
    60.  
    61.         public String getType() {
    62.             return type;
    63.         }
    64.  
    65.         public void setType(String type) {
    66.             this.type = type;
    67.         }
    68.  
    69.         public long getLength() {
    70.             return length;
    71.         }
    72.  
    73.         public void setLength(long length) {
    74.             this.length = length;
    75.         }
    76.  
    77.         @Override
    78.         public String toString() {
    79.             return "Msg{" +
    80.                     "type='" + type + '\'' +
    81.                     ", length=" + length +
    82.                     '}';
    83.         }
    84.     }
    85. }

    在application.properties中添加：

    1. com.zhufeng.user.id=user1001
    2. com.zhufeng.user.name=月夜烛峰
    3.  
    4. com.zhufeng.msg.type=json
    5. com.zhufeng.msg.length=1024

    4、自定义工厂类

    1. package com.zhufeng.demo.factory;
    2.  
    3. import com.zhufeng.demo.prop.ZhufengProperties;
    4.  
    5. /**
    6.  * @ClassName: MyFactory
    7.  * @Description 工厂类
    8.  * @author 月夜烛峰
    9.  * @date 2022/9/8 15:43
    10.  */
    11. public class HelloWorldFactory {
    12.  
    13.     private final ZhufengProperties zhufengProperties;
    14.  
    15.     public HelloWorldFactory(ZhufengProperties zhufengProperties){
    16.  
    17.         this.zhufengProperties = zhufengProperties;
    18.     }
    19.  
    20.     public void showUserInfo(){
    21.         System.out.println("用户信息："+zhufengProperties.getUser());
    22.     }
    23.  
    24.     public void showMsgInfo(){
    25.         System.out.println("消息信息："+zhufengProperties.getMsg());
    26.     }
    27. }

    5、创建触发条件

    1. package com.zhufeng.demo;
    2.  
    3. /**
    4.  * @ClassName: HelloWorld
    5.  * @Description 用于触发自动装配
    6.  * @author 月夜烛峰
    7.  * @date 2022/9/8 15:51
    8.  */
    9. public class HelloWorld {
    10.  
    11. }

    6、启动测试

    1. package com.zhufeng.demo;
    2.  
    3. import org.springframework.boot.SpringApplication;
    4. import org.springframework.boot.autoconfigure.SpringBootApplication;
    5.  
    6. /**
    7.  * @ClassName: MainTest
    8.  * @Description 启动测试
    9.  * @author 月夜烛峰
    10.  * @date 2022/9/7 16:15
    11.  */
    12. @SpringBootApplication
    13. public class MainTest  {
    14.     public static void main(String[] args) {
    15.         SpringApplication.run(MainTest.class);
    16.     }
    17. }

    创建测试Controller

    1. package com.zhufeng.demo.controller;
    2.  
    3. import com.zhufeng.demo.factory.HelloWorldFactory;
    4. import org.springframework.web.bind.annotation.RequestMapping;
    5. import org.springframework.web.bind.annotation.RestController;
    6.  
    7. import javax.annotation.Resource;
    8.  
    9. /**
    10.  * @ClassName: UserController
    11.  * @Description TODO
    12.  * @author 月夜烛峰
    13.  * @date 2022/9/7 16:12
    14.  */
    15. @RestController
    16. public class UserController {
    17.  
    18.     @Resource
    19.     HelloWorldFactory showHelloWorld;
    20.  
    21.     @RequestMapping("view")
    22.     public String view(){
    23.         showHelloWorld.showUserInfo();
    24.         showHelloWorld.showMsgInfo();
    25.         return "success";
    26.     }
    27. }

     启动项目运行。

    7、控制台信息

    浏览器访问http://127.0.0.1:8080/view

    控制台打印：

    1. MyAutoConfiguration 已经自动装配。。。
    2. showUserInfo:com.zhufeng.demo.service.impl.UserServiceImpl@63fd4873
    3. ......
    4. 用户信息：User{id='user1001', name='月夜烛峰'}
    5. 消息信息：Msg{type='json', length=1024}

    说明我们自定义的功能已经被自动装配，再把HelloWorld.java删除，使之不满足以下条件：

    @ConditionalOnClass(name = "com.zhufeng.demo.HelloWorld")

    1. ***************************
    2. APPLICATION FAILED TO START
    3. ***************************
    4.  
    5. Description:
    6.  
    7. A component required a bean of type 'com.zhufeng.demo.factory.HelloWorldFactory' that could not be found.
    8.  
    9. The following candidates were found but could not be injected:
    10. 	- Bean method 'showHelloWorld' in 'MyAutoConfiguration' not loaded because @ConditionalOnClass did not find required class 'com.zhufeng.demo.HelloWorld'
    11.  
    12.  
    13. Action:
    14.  
    15. Consider revisiting the entries above or defining a bean of type 'com.zhufeng.demo.factory.HelloWorldFactory' in your configuration.

    项目启动报错，自动装备失败。

  • 相关阅读:
    计算机考研 | 2016年 | 计算机组成原理真题
    【leetcode热题】杨辉三角 II
    只会grpc一把梭，可以开车上路吗？
    Nginx 面试 40 连问，顶不顶得住~~
    SSM出租车查询系统 毕业设计-附源码220915
    【操作系统导论】机制：受限直接执行 | 中断处理 | 陷阱 | 协作方式 | 非协作方式 | 上下文切换
    java进出口食品安全信息管理系统计算机毕业设计MyBatis+系统+LW文档+源码+调试部署
    面试-Redis-缓存雪崩
    [附源码]SSM计算机毕业设计社区医院管理系统JAVA
    世界港口数据获取
  • 原文地址：https://blog.csdn.net/yueyezhufeng/article/details/126766937