spring boot-自动配置原理和实战

我就是我 2022-02-19 02:39 147阅读 0赞

## spring boot-自动配置原理和实战 ##

**spring boot 自动配置原理**  
以spring配置的数据源源码为例，DataSourceAutoConfiguration分析原理。  
当我们需要配置一个数据源连接时，时常如下配置完成数据源连接。

spring:
          application:
              name: auth-server
          datasource:
              url: jdbc:mysql://192.168.3.167:3306/test
              username: xx
              driver-class-name: com.mysql.jdbc.Driver
              password: xx

spring boot就会在容器中按照我们的配置信息注入一个datasource，那么Spring boot是怎么知道 DataSourceAutoConfiguration是自动配置类？其实很简单：

我们找到DataSourceAutoConfiguration类，如图所示：使用了一些注解，  
ConditionalOnClass：某个class存在的请求下生效。  
// 注：当存在DataSource.class 和 EmbeddedDatabaseType.class 存在的情况下，该配置路径才生效

EnableConfigurationProperties：配置信息。即一些数据源的配置属性，比如：用户名，密码，连接url等信息。  
@Import：引入其他配置类，  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dmbG92ZWphdmE_size_16_color_FFFFFF_t_70]  
在spring-boot-autoconfigure.jar的META-INF/spring.factories中可以看到springboot自带的自动配置类,可以看到DataSourceAutoConfiguration类在此文件上配置了  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dmbG92ZWphdmE_size_16_color_FFFFFF_t_70 1]

然后我们跟踪代码，@EnableAutoConfiguration（开启自动配置类，spring boot的精华所在）  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dmbG92ZWphdmE_size_16_color_FFFFFF_t_70 2]  
进入import引入的AutoConfigurationImportSelector类找到getCandidateConfigurations方法

protected List<String> getCandidateConfigurations(AnnotationMetadata metadata,
    		AnnotationAttributes attributes) {
    		//加载类路径下以及所有jar包下的META-INF/spring.factories配置文件中的自动配置的类
    	List<String> configurations = SpringFactoriesLoader.loadFactoryNames(
    			getSpringFactoriesLoaderFactoryClass(), getBeanClassLoader());
    	Assert.notEmpty(configurations,
    			"No auto configuration classes found in META-INF/spring.factories. If you "
    					+ "are using a custom packaging, make sure that file is correct.");
    	return configurations;
    }

然后我们进入loadFactoryNames（）方法，可以看

private static Map<String, List<String>> loadSpringFactories(@Nullable ClassLoader classLoader) {
    		MultiValueMap<String, String> result = cache.get(classLoader);
    		if (result != null) {
    			return result;
    		}
    
    		try {
    		//找到类路径下以及所有jar包下的META-INF/spring.factories
    			Enumeration<URL> urls = (classLoader != null ?
    					classLoader.getResources(FACTORIES_RESOURCE_LOCATION) :
    					ClassLoader.getSystemResources(FACTORIES_RESOURCE_LOCATION));
    			result = new LinkedMultiValueMap<>();
    			while (urls.hasMoreElements()) {
    				URL url = urls.nextElement();
    				UrlResource resource = new UrlResource(url);
    				Properties properties = PropertiesLoaderUtils.loadProperties(resource);
    				for (Map.Entry<?, ?> entry : properties.entrySet()) {
    					List<String> factoryClassNames = Arrays.asList(
    							StringUtils.commaDelimitedListToStringArray((String) entry.getValue()));
    					result.addAll((String) entry.getKey(), factoryClassNames);
    				}
    			}
    			cache.put(classLoader, result);
    			return result;
    		}
    		catch (IOException ex) {
    			throw new IllegalArgumentException("Unable to load factories from location [" +
    					FACTORIES_RESOURCE_LOCATION + "]", ex);
    		}
    	}

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dmbG92ZWphdmE_size_16_color_FFFFFF_t_70 3]  
加载类路径下以及所有jar包下的META-INF/spring.factories配置文件中的自动配置的类，  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dmbG92ZWphdmE_size_16_color_FFFFFF_t_70 4]  
一共加载了211个自动配置类。

spring boot自动配置原理总结：添加自己的配置类，然后在META-INF/spring.factories上添加配置，当spring boot 项目启动的时候，会找到META-INF/spring.factories文件，然后加载自动配置，创建bean放入容器进行管理。

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

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dmbG92ZWphdmE_size_16_color_FFFFFF_t_70]: /images/20220219/377a97a98ee64386ba9c3ef8a361e947.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dmbG92ZWphdmE_size_16_color_FFFFFF_t_70 1]: /images/20220219/f2d36cbe043345ce8e0ab732f9707a8c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dmbG92ZWphdmE_size_16_color_FFFFFF_t_70 2]: /images/20220219/3d6c8876309c4c87b19e07b349261ba2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dmbG92ZWphdmE_size_16_color_FFFFFF_t_70 3]: /images/20220219/0a4eff4a97234c00a75c053265dfbb6a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dmbG92ZWphdmE_size_16_color_FFFFFF_t_70 4]: /images/20220219/557191bbd3a94dc496d6cc410bcd66d2.png
[20190415164821254.png]: /images/20220219/0baeb051f8e84727a792d020caf8ed48.png