Java SPI机制实战详解及源码分析
背景介绍
提起SPI机制,可能很多人不太熟悉,它是由JDK直接提供的,全称为:Service Provider Interface。而在平时的使用过程中也很少遇到,但如果你阅读一些框架的源码时,会发现它的有点无处不在的感觉。比如我们经常使用的spring框架,其spring-web包下就在使用该机制。
还有我们每个项目都离不开的日志框架log4j和数据库驱动框架中也同样的使用着SPI机制。
这么看来,SPI机制可谓无处不在,那么今天这篇文章就带大家揭开它的神秘面纱。
什么是SPI机制
SPI机制,全称 Service Provider Interface,是Java提供的一套用来被第三方实现或者扩展的API,可以用来启用框架扩展和替换组件,它的核心类是java.util.ServiceLoader。
在大型系统设计中,开闭原则和解耦是必不可少的,而SPI机制的核心便是解耦合。通过SPI机制,将实现类隐藏在接口后面,根据需要寻找服务实现,SPI就提供了这样的服务发现机制。
Effective Java中也提到SPI是一种将服务接口与服务实现分离以达到解耦、大大提升了程序可扩展性的机制。引入服务提供者就是引入了SPI接口的实现者,通过本地的注册发现获取到具体的实现类,轻松可插拔。
使用场景
在最开始的背景介绍中,我们已经在不同的框架中发现SPI的身影。可以说在针对“调用者根据实际需要,使用不同框架的实现策略”中非常有用。
比如,我们日常使用是数据库驱动,会提供统一的规范(java.sql.Driver),各数据库服务商提供对应数据库的逻辑实现。当使用到该数据库时,直接引入不同的SPI服务实现即可。
常见场景:
- Spring框架中有大量实现,如上图中Spring对servlet3.0规范的ServletContainerInitializer的实现。
- 数据库驱动程序加载不同数据库的实现,如上图中java.sql.Driver接口的实现。
- 日志框架log4j中的实现。
- Dubbo中实现框架扩展的实现。
使用规范
下面了解一下使用SPI的基本规范步骤:
- 服务提供者定义对外接口及方法,比如数据库驱动会提供一个java.sql.Driver的接口。
- 针对定义的接口,提供一个实现类。
- 在项目或jar包的META-INF/services目录下,创建一个文本文件:名称为接口的“全限定名”,内容为实现类的全限定名。上面的截图中其实已经可以发现,统一都是如此。
- 服务调用者引入该项目的jar包,并将其放置于classpath下。
- 服务调用者通过核心API java.util.ServiceLoader来动态加载该实现,主要就是扫描classpath下所有jar包内META-INF/services目录下,按照指定格式定义的文件,并把其中类进行加载。
- 由于SPI机制使用的过程中无法进行传递构造参数,因此需提供一个无参的构造方法。
具体实例
下面以订阅公众号为例,来演示SPI机制的使用。为了方便起见,服务使用者和服务提供者放在了同一个项目内,正常来说,服务提供者单独定义接口及实现,然后通过jar包的形式引入到服务调用者项目中。
首先,创建项目,定义接口Subscribe,并提供一个follow方法。
public interface Subscribe {
void follow();
}
然后,定义两个实现类:MySubscribe和OtherSubscribe。
public class MySubscribe implements Subscribe {
@Override
public void follow() {
System.out.println("关注了公众号:程序新视界!");
}
}
public class OtherSubscribe implements Subscribe {
@Override
public void follow() {
System.out.println("关注了其他公众号!");
}
}
然后,在resources目录下依次创建META-INF/services目录,并在目录下创建名称为:com.secbro2.Subscribe的文件。文件内容为:
com.secbro2.impl.MySubscribe
com.secbro2.impl.OtherSubscribe
最后,编写main方法进行调用,main方法相当于SPI机制中的调用者。
public class Call {
public static void main(String[] args) {
ServiceLoader<Subscribe> services = ServiceLoader.load(Subscribe.class);
for (Subscribe sub : services) {
sub.follow();
}
}
}
执行main方法,打印如下内容:
关注了公众号:程序新视界!
关注了其他公众号!
ServiceLoader源码解析
顺便我们看一下ServiceLoader的源码信息,首先通过常量的定义,我们可以看到为什么要将文件配置在META-INF/services下了。
public final class ServiceLoader<S> implements Iterable<S>{
private static final String PREFIX = "META-INF/services/";
}
整个类的源码就不全部贴出了,简单介绍一下该类的基本操作流程。
- 通过ServiceLoader的load(Class<S> service)方法进入程序内部;
- 上面load方法内获得到ClassLoader,并再此调用内部的load(Class<S> service,lassLoader loader)方法,该方法内会创建ServiceLoader对象,并初始化一些常量。
- ServiceLoader的构造方法内会调用reload方法,来清理缓存,初始化LazyIterator,注意此处是Lazy,也就懒加载。此时并不会去加载文件下的内容。
- 当遍历器被遍历时,才会去读取配置文件。
关于读取META-INF/services下配置文件的核心代码如下:
try {
String fullName = PREFIX + service.getName();
if (loader == null)
configs = ClassLoader.getSystemResources(fullName);
else
configs = loader.getResources(fullName);
} catch (IOException x) {
fail(service, "Error locating configuration files", x);
}
同过以上代码我们会发现,其实ServiceLoader扫描了所有jar包下的配置文件。然后通过解析全限定名获得,并在遍历时通过Class.forName进行实例化。
小结
经过上面的讲解和示例,大家已经了解整个SPI机制的使用,但SPI机制并不是万能的,它也有自身的缺点。比如,虽然它采用了懒加载,在真正遍历使用的时候才会去加载类,但每次基本上都是将全部的类遍历一遍并进行实例化,这也造成了不必要的浪费。另外,它是非线程安全的。
原文链接:《Java SPI机制实战详解及源码分析》
Java SPI机制实战详解及源码分析的更多相关文章
- Android应用AsyncTask处理机制详解及源码分析
1 背景 Android异步处理机制一直都是Android的一个核心,也是应用工程师面试的一个知识点.前面我们分析了Handler异步机制原理(不了解的可以阅读我的<Android异步消息处理机 ...
- 【转载】Android应用AsyncTask处理机制详解及源码分析
[工匠若水 http://blog.csdn.net/yanbober 转载烦请注明出处,尊重分享成果] 1 背景 Android异步处理机制一直都是Android的一个核心,也是应用工程师面试的一个 ...
- Spring Boot启动命令参数详解及源码分析
使用过Spring Boot,我们都知道通过java -jar可以快速启动Spring Boot项目.同时,也可以通过在执行jar -jar时传递参数来进行配置.本文带大家系统的了解一下Spring ...
- 线程池底层原理详解与源码分析(补充部分---ScheduledThreadPoolExecutor类分析)
[1]前言 本篇幅是对 线程池底层原理详解与源码分析 的补充,默认你已经看完了上一篇对ThreadPoolExecutor类有了足够的了解. [2]ScheduledThreadPoolExecut ...
- SpringMVC异常处理机制详解[附带源码分析]
目录 前言 重要接口和类介绍 HandlerExceptionResolver接口 AbstractHandlerExceptionResolver抽象类 AbstractHandlerMethodE ...
- 【转载】Android异步消息处理机制详解及源码分析
PS一句:最终还是选择CSDN来整理发表这几年的知识点,该文章平行迁移到CSDN.因为CSDN也支持MarkDown语法了,牛逼啊! [工匠若水 http://blog.csdn.net/yanbob ...
- SpringMVC视图机制详解[附带源码分析]
目录 前言 重要接口和类介绍 源码分析 编码自定义的ViewResolver 总结 参考资料 前言 SpringMVC是目前主流的Web MVC框架之一. 如果有同学对它不熟悉,那么请参考它的入门bl ...
- Servlet容器Tomcat中web.xml中url-pattern的配置详解[附带源码分析]
目录 前言 现象 源码分析 实战例子 总结 参考资料 前言 今天研究了一下tomcat上web.xml配置文件中url-pattern的问题. 这个问题其实毕业前就困扰着我,当时忙于找工作. 找到工作 ...
- Hadoop RCFile存储格式详解(源码分析、代码示例)
RCFile RCFile全称Record Columnar File,列式记录文件,是一种类似于SequenceFile的键值对(Key/Value Pairs)数据文件. 关键词:Reco ...
随机推荐
- Java中dimension类详解
Java中dimension类详解 https://blog.csdn.net/hrw1234567890/article/details/81217788
- ubuntu vscode 写一个C++程序
博客转载:https://blog.csdn.net/weixin_43374723/article/details/84064644 Visual studio code是微软发布的一个运行于 Ma ...
- Java内存分析工具MAT
MAT是一个强大的内存分析工具,可以快捷.有效地帮助我们找到内存泄露,减少内存消耗分析工具.内存中堆的使用情况是应用性能监测的重点,而对于堆的快照,可以dump出来进一步分析,总的来说,一般我们对于堆 ...
- Vue 03
目录 组件 组件的分类 组件的特点 组件的使用 组件传参-父传子 组件传参-子传父 组件 组件就是html, css和js文件的集合体, 实现对代码的复用, 组件就是vue对象 组件的分类 根组件 & ...
- C#基础知识1-深入理解值类型和引用类型
C#值类型和引用类型这个概念在刚学习的时候应该就知道了.但是我们并没有深入的去理解它.越是基础知识其实才是最有用的.对代码的优化,代码质量的提升都有帮助.通过整理本文章,对很多知识也起到了巩固的作用吧 ...
- ASP.NET MVC IOC依赖注入之Autofac系列(二)- WebForm当中应用
上一章主要介绍了Autofac在MVC当中的具体应用,本章将继续简单的介绍下Autofac在普通的WebForm当中的使用. PS:目前本人还不知道WebForm页面的构造函数要如何注入,以下在Web ...
- C#中 EF 性能优化
https://www.cnblogs.com/chenwolong/p/7531955.html EF使用AsNoTracking(),无跟踪查询技术(查询出来的数据不可以修改,如果你做了修改,你会 ...
- BurpSuite的基础使用,这个教程有“坑”?
BurpSuite简介 BurpSuite是一款辅助渗透的工具,可以给我们带来许多便利.Burp给我们提供了简单的HTTP抓包改包,数据枚举模块,以及各种安全漏洞的手动式扫描与爬虫式扫描,还有很多经常 ...
- Cesium专栏-热力图(附源码下载)
Cesium Cesium 是一款面向三维地球和地图的,世界级的JavaScript开源产品.它提供了基于JavaScript语言的开发包,方便用户快速搭建一款零插件的虚拟地球Web应用,并在性能,精 ...
- ABP入门教程4 - 初始化运行
点这里进入ABP入门教程目录 编译解决方案 重新生成解决方案,确保生成成功. 连接数据库 打开JD.CRS.Web.Host / appsettings.json,修改数据库连接设置Connectio ...