【SprintBoot】以HttpEncodingAutoConfiguration为例，深度分析自动装配

本文以HttpEncodingAutoConfiguration为例子，深度分析SpringBoot的自动装配原理。

@Configuration(proxyBeanMethods = false)
@EnableConfigurationProperties(ServerProperties.class)
@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET)
@ConditionalOnClass(CharacterEncodingFilter.class)
@ConditionalOnProperty(prefix = "server.servlet.encoding", value = "enabled", matchIfMissing = true)
public class HttpEncodingAutoConfiguration {

	private final Encoding properties;

	public HttpEncodingAutoConfiguration(ServerProperties properties) {
		this.properties = properties.getServlet().getEncoding();
	}

	@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;
	}

	@Bean
	public LocaleCharsetMappingsCustomizer localeCharsetMappingsCustomizer() {
		return new LocaleCharsetMappingsCustomizer(this.properties);
	}
}

首先我们先看一下这个类上面的这一大堆注解。

@Configuration(proxyBeanMethods = false)

意思是：表示这个一个配置类，和以前编写的配置文件一样，也可以给容器中添加组件。

@EnableConfigurationProperties(ServerProperties.class)

这个注解的含义是：启用ConfigurationProperties功能。因为后面的括号中有一个类，所以是指定某个类的ConfigurationProperties功能。

点击进去括号中的类，发现有一个@ConfigurationProperties注解。这个注解的含义就是：从配置文件中 “server“ 中获取指定的值与该Bean进行绑定。

@ConfigurationProperties(prefix = "server", ignoreUnknownFields = true)
public class ServerProperties {
	//代码部分省略
}

所有 @EnableConfigurationProperties(ServerProperties.class) 的作用就是将配置文件中的内容和ServerProperties进行绑定。

@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET)

• 作用：Spring底层的@Conditional注解，根据不同的条件，如果满足知道指定的条件，整个配置类才会生效。
• 所以：
  • 就是判断当前应用是否是Web应用，如果是
    • 当前配置类生效
    • 否则当前配置类不生效。

@ConditionalOnClass(CharacterEncodingFilter.class)

• 作用：判断当前项目有没有这个类，
• CharacterEncodingFilter.class : SpringMVC中进行乱码解决的过滤器
  
  

@ConditionalOnProperty(prefix = “server.servlet.encoding”, value = “enabled”, matchIfMissing = true)

作用：

• 判断配置文件是否存在某个配置
• 哪个配置呢？server.servlet.encoding.enabled
• matchIfMissing = true: 不配置默认也是true

所以最终结合上面的注解，如果生效了，就将该Bean添加到IOC容器中。

public class HttpEncodingAutoConfiguration {
	//已经和IOC容器进行了绑定
	private final Encoding properties;

	
	public HttpEncodingAutoConfiguration(ServerProperties properties) {
		this.properties = properties.getServlet().getEncoding();
	}


	@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;
	}
	
	//后续代码省略。。。
}

• @Bean会将给JavaBean放到IOC容器中
• 又因为只有一个构造器，所以默认会通过这个唯一的构造器，进行创建。