一句话概况看完本文你将有的收获
- 掌握 Spring Boot 自动配置的基本操作与原理，学会如何开发被 spring 容器管理的开发工具包（SDK)。
带着问题找答案
- 众所周知，自定义类被 Spring 管理的两个基本条件是：
- 类被
@Service等注解标注 - 类被 Spring 容器扫描
- 在 Spring Boot 体系下开发，我们都会将需要 Spring 管理的对象进行注解标注，并且我们知道 Spring Boot 中默认扫描路径是
Spring Boot主应用所在包及其子包下。 - Spring Boot 的扫描规则在我们的项目中很好用，但是我们现在想开发一个被 Spring 管理的
SDK该怎么办呢？显然限制 SDK 的包名和指定扫描路径都不是最优解，都会增加项目的负担和耦合。
如何解决问题？
- 显然这个需求与 Spring Cloud 中一些组件的使用是一致的，于是很容易就能想到解决问题的办法肯定在 Spring Boot 的自动配置上，下文将分为两部分讲解，如何使用自动配置来开发 SDK（知其然）和原理解析（知其所以然）
知其然篇
举个需求栗子:)
- 想为应用服务来监控每个请求（请求地址、状态、耗时）
- 请求数据记录到数据库
- 需要组件化，有多个应用服务有同样需求
- 要求尽量让应用服务使用起来简单方便
HOW TO DO？
- 开发一个 SDK，其中有
Filter并且具备操作数据库的能力 --> 在应用服务中开发，这两个功能再简单不过了，那么问题来了，在 SDK 中开发，如何才能让 spring 容器接管SqlSession和业务处理 Service 层呢？ - 使用 Spring Boot 自动配置功能加载需要被 Spring 容器管理的类
主要类对象简介
-
class MetricsService--> Service 层，处理逻辑及 DAO -
interface MetricsHttpRequestMapper--> Spring + Mybatis 的mapper，相当于 DAO 层 -
class MetricsHttpRequestContainerFilter implements ContainerRequestFilter, ContainerResponseFilter--> Jersey框架中的自定义Filter，具有请求前过滤和请求后过滤作用。如果没用过Jersey的不用太在意这个类的使用，毕竟这只是个举个栗子的需求，如果真的有这个需求的同学，可以用各自框架的Filter定义来替换，就想知道这个Filter更多细节的同学可以私聊，这里不展开说了。 -
class BeanConfiguration--> SDK 中Bean对象定义类，建议将需要 Spring 管理的类分类到此种类中控制定义，等会讲清楚此类的使用就知其然了 -
class SqlSessionFactoryConfig--> Spring + Mybatis 定义SqlSessionFactoryBean的类，在此文中此类不展开说了
部分代码展示说明
1. Service关键代码展示
public class MetricsServiceImpl implements MetricsService{
// 此处说明该类需要被 Spring 容器管理
@Autowired
MetricsHttpRequestMapper httpRequestMapper;
/**
* @Param Filter解析请求后的需要处理对象
*/
@Override
public void addHttpRequest(MetricsHttpRequest model) {
// 处理逻辑
}
}
2. BeanConfiguration关键代码展示
public class BeanConfiguration {
// 建议Service层Bean分类后统一交由此种类配置
@Bean
public MetricsService metricsService(){
return new MetricsServiceImpl();
}
}
3. 如何加载 BeanConfiguration 关键部分
3.1 resources 文件夹下建立该文件 META-INF/spring.factories
3.2 内容：
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.需要自动配置的类1,\
需要自动配置的类包名.BeanConfiguration
4. 结构如图所示
SDK自动配置文件展示.png
知其然总结
- 配置完成后，应用主类只要开启自动配置就可以完成 SDK 中类被 Spring 容器管理的目标了
- 关键部分还是在
spring.factories文件的定义上，只要了解到这点，使用已经不是问题了。 - 下部分将简单讲述原理，有兴趣的可以继续
知其所以然篇
如何寻找答案
- 自动配置的答案肯定要在 Spring Boot 如何实现自动配置的源码里找答案啦:)
源码分析
- 注解开始：
@EnableAutoConfiguration为开启 Spring Boot 自动配置的注解 - 查看该注解：
//省略部分代码
@AutoConfigurationPackage
@Import(EnableAutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {
//省略部分代码
}
- 注解会加载
EnableAutoConfigurationImportSelector
public class EnableAutoConfigurationImportSelector
implements DeferredImportSelector, BeanClassLoaderAware, ResourceLoaderAware,
BeanFactoryAware, EnvironmentAware, Ordered {
//省略部分代码
@Override
public String[] selectImports(AnnotationMetadata metadata) {
if (!isEnabled(metadata)) {
return NO_IMPORTS;
}
try {
AnnotationAttributes attributes = getAttributes(metadata);
List<String> configurations = getCandidateConfigurations(metadata,
attributes);
configurations = removeDuplicates(configurations);
Set<String> exclusions = getExclusions(metadata, attributes);
configurations.removeAll(exclusions);
configurations = sort(configurations);
recordWithConditionEvaluationReport(configurations, exclusions);
return configurations.toArray(new String[configurations.size()]);
}
catch (IOException ex) {
throw new IllegalStateException(ex);
}
}
//获取META-INF/spring.factories文件中定义类的方法
protected List<String> getCandidateConfigurations(AnnotationMetadata metadata,
AnnotationAttributes attributes) {
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;
}
}
该类通过 SpringFactoriesLoader.loadFactoryNames 获取到 META-INF/spring.factories 中定义的类，组成 List<String>
传递给 Spring 处理
- 可以看到是在
SpringFactoriesLoader解析META-INF/spring.factories类的
public abstract class SpringFactoriesLoader {
public static final String FACTORIES_RESOURCE_LOCATION = "META-INF/spring.factories";
//省略部分代码
public static List<String> loadFactoryNames(Class<?> factoryClass, ClassLoader classLoader) {
String factoryClassName = factoryClass.getName();
try {
Enumeration<URL> urls = (classLoader != null ? classLoader.getResources(FACTORIES_RESOURCE_LOCATION) :
ClassLoader.getSystemResources(FACTORIES_RESOURCE_LOCATION));
List<String> result = new ArrayList<String>();
while (urls.hasMoreElements()) {
URL url = urls.nextElement();
Properties properties = PropertiesLoaderUtils.loadProperties(new UrlResource(url));
String factoryClassNames = properties.getProperty(factoryClassName);
result.addAll(Arrays.asList(StringUtils.commaDelimitedListToStringArray(factoryClassNames)));
}
return result;
}
catch (IOException ex) {
throw new IllegalArgumentException("Unable to load [" + factoryClass.getName() +
"] factories from location [" + FACTORIES_RESOURCE_LOCATION + "]", ex);
}
}
//省略部分代码
}
该类展示了为什么是从 resource文件夹 中的 META-INF/spring.factories 文件中解析
总结
- 通过此文可以基本掌握自动配置是如何运作的，其中还有些细节在这里就没有展开说了，比如
@Bean,@ConditionalOnClass介绍这种注解的文章很多很多，就不重复说了。 - 文中我举的需求例子不是随意举的，在此想向广大同学们询问一下有没有较好的处理该需求的开源组件，如有非常希望能够告知。在此谢谢大家！
