Spring SPI 机制总结
1、概念:
SPI(Service Provider Interface)服务提供接口,简单来说就是用来解耦,实现插件的自由插拔,具体实现方案可参考JDK里的ServiceLoader
(加载classpath下所有META-INF/services/目录下的对应给定接口包路径的文件,然后通过反射实例化配置的所有实现类,以此将接口定义和逻辑实现分离)
Spring在3.0.x的时候就已经引入了spring.handlers,很多博客讲Spring SPI的时候并没有提到spring.handlers,但是通过我自己的分析对比,其实spring.handlers也是一种SPI的实现,只不过它是基于xml的,而且在没有boot的年代,它几乎是所有三方框架跟spring整合的必选机制。
在3.2.x又新引入了spring.factories,它的实现跟JDK的SPI就基本是相似的了。
spring.handlers和spring.factories我都把它归纳为Spring为我们提供的SPI机制,通过这两种机制,我们可以在不修改Spring源码的前提下,非常轻松的做到对Spring框架的扩展开发。
2、实现:
2.1 先看看spring.handlers SPI
在Spring里有个接口NamespaceHandlerResolver
,只有一个默认的实现类DefaultNamespaceHandlerResolver
,而它的作用就是加载classpath下可能分散在各个jar包中的META-INF/spring.handlers文件,resolve方法中关键代码如下:
//加载所有jar包中的META-INF/spring.handlers文件
Properties mappings=
PropertiesLoaderUtils.loadAllProperties(this.handlerMappingsLocation, this.classLoader);
//把META-INF/spring.handlers中配置的namespaceUri对应实现类实例化
NamespaceHandler namespaceHandler =
(NamespaceHandler) BeanUtils.instantiateClass(handlerClass);
DefaultNamespaceHandlerResolver.resolve()主要被用在BeanDefinitionParserDelegate的parseCustomElement和decorateIfRequired,所以spring.handlers SPI机制主要也是被用在bean的扫描和解析过程中。
2.2 再来看spring.factories SPI
// 获取某个已定义接口的实现类,跟JDK的ServiceLoader SPI相似度为90%
List<BeanInfoFactory> beanInfoFactories = SpringFactoriesLoader.loadFactories(BeanInfoFactory.class, classLoader);
// spring.factories文件的格式为:key=value1,value2,value3
// 从所有jar文件中找到MET-INF/spring.factories文件(注意是:classpath下的所有jar包,所以可插拔、扩展性超强)
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 propertyValue = properties.getProperty(factoryClassName);
for (String factoryName : StringUtils.commaDelimitedListToStringArray(propertyValue)) {
result.add(factoryName.trim());
}
}
return result;
更多细节,大家可以参考SpringFactoriesLoader
类,Spring自3.2.x引入spring.factories SPI后其实一直没怎么利用起来,只有CachedIntrospectionResults(初始化bean的过程中)用到了,而且在几大核心jar包里,也只有bean包里才有用到。
真正把spring.factories发扬光大的,是到了Spring Boot,可以看到boot包里配置了非常多的接口实现类。大家跟踪boot的启动类SpringApplication
可以发现,有很多地方都调用了getSpringFactoriesInstances()方法,这些就是spring boot开给我们的扩展机会,就像一座宝藏一样,大家可以自己去发掘。
3、应用:
先来看看mybatis和dubbo早期跟Spring整合的实现,他们无一例外都用到了spring.handlers SPI机制,以此来向IOC容器注入自己的Bean。
进入boot时代后,spring.factories SPI机制应用得更加广泛,我们可以在容器启动、环境准备、初始化、上下文加载等等环节轻轻松松的对Spring做扩展开发(例如:我们项目中用到spring.factories SPI机制对配置文件中的变量实现动态解密,以及前篇博文中提到的@Replace注解等)。
4、实践(加载application.xyz配置文件):
Spring里有两种常见的配置文件类型:application.properties 和 application.yml,其中yml是近年兴起的,但说实话同事也包括我自己是被它坑过,没有合适的编辑器时很容易把格式写错,导致上线出问题。所以我就在想有没有办法让Spring支持一种新的配置文件格式,既保留yml的简洁优雅,有能够有强制的格式校验,暂时我想到了json格式。
# 这是spring.factories中的配置
org.springframework.boot.env.PropertySourceLoader=top.hiccup.json.MyJsonPropertySourceLoader
public class MyJsonPropertySourceLoader implements PropertySourceLoader {
@Override
public String[] getFileExtensions() {
return new String[]{"xyz"};
}
@Override
public List<PropertySource<?>> load(String name, Resource resource) throws IOException {
BufferedReader reader = new BufferedReader(new InputStreamReader(resource.getInputStream()));
StringBuilder sb = new StringBuilder();
String line;
while ((line = reader.readLine()) != null) {
sb.append(line);
}
// 这里只是做了简单解析,没有做嵌套配置的解析
JSONObject json = JSONObject.parseObject(sb.toString());
List<PropertySource<?>> propertySources = new ArrayList<>();
MapPropertySource mapPropertySource = new MapPropertySource(resource.getFilename(), json);
propertySources.add(mapPropertySource);
return propertySources;
}
}
ConfigurableApplicationContext ctx = SpringApplication.run(BootTest.class, args);
Custom custom = ctx.getBean(Custom.class);
System.out.println(custom.name);
System.out.println(custom.age);
具体代码可以参考(https://github.com/hiccup234/web-advanced/tree/master/configFile) ,运行得到结果如下:
可见我们在不修改Spring源码的前提下,轻松通过Spring开放给我们的扩展性实现了对新的配置文件类型的加载和解析。
这就是Spring SPI的魅力吧。
Spring SPI 机制总结的更多相关文章
- 聊聊Java SPI机制
一.Java SPI机制 SPI(Service Provider Interface)是JDK内置的服务发现机制,用在不同模块间通过接口调用服务,避免对具体服务服务接口具体实现类的耦合.比如JDBC ...
- 一文搞懂Java/Spring/Dubbo框架中的SPI机制
几天前和一位前辈聊起了Spring技术,大佬突然说了SPI,作为一个熟练使用Spring的民工,心中一紧,咱也不敢说不懂,而是在聊完之后赶紧打开了浏览器,开始的学习之路,所以也就有了这篇文章.废话不多 ...
- java 的SPI机制
今天看到spring mvc 使用Java Validation Api(JSR-303)进行校验,需要加载一个 其具体实现(比如Hibernate Validator), 本来没有什么问题,但是突然 ...
- Dubbo 源码分析 - SPI 机制
1.简介 SPI 全称为 Service Provider Interface,是 Java 提供的一种服务发现机制.SPI 的本质是将接口实现类的全限定名配置在文件中,并由服务加载器读取配置文件,加 ...
- dubbo源码分析4——SPI机制_ExtensionFactory类的作用
ExtensionFactory的源码: @SPI public interface ExtensionFactory { /** * Get extension. * * @param type o ...
- dubbo源码分析1——SPI机制的概要介绍
插件机制是Dubbo用于可插拔地扩展底层的一些实现而定制的一套机制,比如dubbo底层的RPC协议.注册中心的注册方式等等.具体的实现方式是参照了JDK的SPI思想,由于JDK的SPI的机制比较简单, ...
- JDK源码解析之Java SPI机制
1. spi 是什么 SPI全称Service Provider Interface,是Java提供的一套用来被第三方实现或者扩展的API,它可以用来启用框架扩展和替换组件. 系统设计的各个抽象,往往 ...
- dubbo的spi机制
SPI SPI是一种扩展机制,在java中SPI机制被广泛应用,比如Spring中的SpringServletContainerInitializer 使得容器启动的时候SpringServletCo ...
- 【Java】深入理解Java中的spi机制
深入理解Java中的spi机制 SPI全名为Service Provider Interface是JDK内置的一种服务提供发现机制,是Java提供的一套用来被第三方实现或者扩展的API,它可以用来启用 ...
随机推荐
- ThinVnc-身份验证绕过(CVE-2019-17662)
ThinVnc-身份验证绕过(CVE-2019-17662) 简介 ThinVNC是一款以网页浏览器为基础设计的远端桌面连接工具,不局限用户端使用那种作业平台,都可以通过采用HTML5为标准的浏览器来 ...
- Java volatile关键字详解
Java volatile关键字详解 volatile是java中的一个关键字,用于修饰变量.被此关键修饰的变量可以禁止对此变量操作的指令进行重排,还有保持内存的可见性. 简言之它的作用就是: 禁止指 ...
- Lzzy高级语言程序设计之for循环
public class Mq { public static void main(String[]args){ int a = 3 ; a++;// do{ System.out.println(& ...
- MyBatis(十一):MyBatis架构流程浅析
架构分层 我们将MyBatis架构分为三层,分别为接口层.数据处理层和框架支撑层 接口层:提供外部接口调用的API,使用端通过这些API来操作数据库,接口层收到请求后会调用数据处理层完成具体的数据处理 ...
- python-实现双链表
双链表和单链表进行比较的优点与不同 节点多了一个前驱指针域 在很多基本操作上,多了一种选择,因为双链表可以向前进行移动寻位 如果给每个节点添加一个对应的下标,那么在寻找节点时,我们可以使用二分发来进行 ...
- 学习Python的书籍——入门到进阶
入门读物 <Python基础教程>(Beginning Python From Novice to Professional) <Python学习手册>(Learning Py ...
- 【RocketMQ源码分析】深入消息存储(2)
前文回顾 CommitLog篇 --[RocketMQ源码分析]深入消息存储(1) MappedFile篇 --[RocketMQ源码分析]深入消息存储(3) 前文说完了一条消息如何被持久化到本地磁盘 ...
- 使用 nodejs 中的 http 模块实现几个超实用的工具
nodejs 方便了我们前端开发者进行一些服务端上的操作,可以进行无缝地衔接.像其他一些后端语言,如 php, golang, java 等,都需要一定的学习成本,而 nodejs 则就是为前端开发者 ...
- Java集合--Java核心面试知识整理(二)
目前CSDN,博客园,简书同步发表中,更多精彩欢迎访问我的gitee pages 目录 JAVA集合 2.1 接口继承关系和实现 2.2 List 2.2.1 ArrayList(数组) 2.2.2 ...
- 报错:Method definition shorthands are not supported by current JavaScript version
当你在html中使用调用js中的方法时,会出现这行报错: method definition shorthands are not supported by current JavaScript ve ...