SpringBoot-自动配置原理

• SpringBoot-自动配置原理
• • • 六、自动配置原理
    • • 1、分许自动装配原理、
      • 2、了解@Conditional
      • • 扩展：
        • 生效：
      • 3、总结

以**HttpEncodingAutoConfiguration（Http编码自动配置）**为例解释自动配置原理：

//表示这是一个配置类，可以给容器添加组件；
@Configuration(proxyBeanMethods = false)

//启动指定类的configurationProperties功能；
	//进入HttpProperties查看，将配置文件中对应的值和HttpProperties绑定起来；
	//并把HttpProperties加入ioc容器中
@EnableConfigurationProperties(ServerProperties.class)

//@Conditional ：Spring底层注解
	//根据不同的条件判断，如果满足指定的条件，整个配置类里面的配置就会生效；
	//@ConditionalOnWebApplication是判断应用是否属于web应用，如果是，当前配置类生效
@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET)

//判断当前项目有没有这个类CharacterEncodingFilter.class：Springmvc中·进行乱码解决的过滤器
@ConditionalOnClass(CharacterEncodingFilter.class)
//判断配置文件中是否存在某个配置：server.servlet.encoding：
	//如果不存在，判断也是成立的；
	//即使我们配置文件中不配置server.servlet.encoding.nabled=true，也是默认生效的；
@ConditionalOnProperty(prefix = "server.servlet.encoding", value = "enabled", matchIfMissing = true)
public class HttpEncodingAutoConfiguration {
	//映射SpringBoot的配置文件
	private final Encoding properties;
	//只有一个有参构造的情况下，参数的值就会从容器中获取
	public HttpEncodingAutoConfiguration(ServerProperties properties) {
		this.properties = properties.getServlet().getEncoding();
	}
	//给容器中添加一个组件，这个组件的某个值需要从Properties中获取
	@Bean
	@ConditionalOnMissingBean//判断容器中有没有这个组件
	public CharacterEncodingFilter characterEncodingFilter() {
		CharacterEncodingFilter filter = new OrderedCharacterEncodingFilter();
		filter.setEncoding(this.properties.getCharset().name());
		filter.setForceRequestEncoding(this.properties.shouldForce(Encoding.Type.REQUEST));
		filter.setForceResponseEncoding(this.properties.shouldForce(Encoding.Type.RESPONSE));
		return filter;
	}
    //...
}

根据当前不同的条件判断，决定这个配置类是否生效！

• 一旦这个配置类生效，这个配置类就会给容器中添加各种组件；
• 这些组件中属性是从对应的Properties类中获取的，这些类里面的每个属性又是和配置文件绑定的；
• 所有在配置文件中能配置的属性都是在xxxProperties类中封装着；
• 配置文件能配置什么就可以参照某个功能对应的这个属性类；

//从配置文件中获取指定的值和bean的属性进行绑定
@ConfigurationProperties(prefix = "server", ignoreUnknownFields = true)
public class ServerProperties {
    //...
}

可以在配置文件里面赋值试试：

---
server:
  servlet:
    encoding:
      charset: UTF-8

自动配置类必须在一定的条件下才能生效；

@Conditional派生注解（spring注解版原生的Conditonal作用）

作用：必须是@Conditional指定的条件成立，才给容器中添加组件，配置配里面的所有内容才生效；

@ConditionalOnBean：仅仅在当前上下文中存在某个对象时，才会实例化一个Bean。
@ConditionalOnClass：某个class位于类路径上，才会实例化一个Bean。
@ConditionalOnexpression：当表达式为true的时候，才会实例化一个Bean。
@ConditionalOnMissingBean：仅仅在当前上下文中不存在某个对象时，才会实例化一个Bean。
@ConditionalOnMissingClass：某个class类路径上不存在的时候，才会实例化一个Bean。
@ConditionalOnNotWebApplication：不是web应用，才会实例化一个Bean。
@ConditionalOnBean：当容器中有指定Bean的条件下进行实例化。
@ConditionalOnMissingBean：当容器里没有指定Bean的条件下进行实例化。
@ConditionalOnClass：当classpath类路径下有指定类的条件下进行实例化。
@ConditionalOnMissingClass：当类路径下没有指定类的条件下进行实例化。
@ConditionalOnWebApplication：当项目是一个Web项目时进行实例化。
@ConditionalOnNotWebApplication：当项目不是一个Web项目时进行实例化。
@ConditionalOnProperty：当指定的属性有指定的值时进行实例化。
@ConditionalOnexpression：基于SpEL表达式的条件判断。
@ConditionalOnJava：当JVM版本为指定的版本范围时触发实例化。
@ConditionalOnResource：当类路径下有指定的资源时触发实例化。
@ConditionalOnJndi：在JNDI存在的条件下触发实例化。
@ConditionalOnSingleCandidate：当指定的Bean在容器中只有一个，或者有多个但是指定了首选的Bean时触发实例化。

那么多的自动配置类，必须在一定的条件下才能生效；也就是说，我们加载了这么多的配置类，但不是所有的都生效了。

我们怎么知道哪些自动配置类生效？

我们可以通过启用 debug=true属性；来让控制台打印自动配置报告，这样我们就可以很方便的知道哪些自动配置类生效；

#开启springboot的调试类
debug=true

Positive matches:（自动配置类启用的：正匹配）

Negative matches:（没有启动，没有匹配成功的自动配置类：负匹配）

Unconditional classes: （没有条件的类）

• spirngboot启动会加载大量的自动配置类；
• 查看我们需要的功能是否在springboot默认写好的自动配置类中；
• 查看这个自动配置类中到底配置了哪些组件：只要我们需要的组件存在其中，就不需要手动配置了；
• 给容器中自动配置类添加组件的时候，会从Properties类中获取某些属性，我们只需要在配置文件中指定这些属性的值即可；

**xxxxAutoConfigurartion：自动配置类；**给容器中添加组件

xxxxProperties:封装配置文件中相关属性；