什么是SPI
SPI(Service Provider Interface),是JDK内置的一种服务提供发现机制,可以用来启用框架扩展和替换组件,主要是被框架的开发人员使用,比如java.sql.Driver接口,其他不同厂商可以针对同一接口做出不同的实现,MySQL和PostgreSQL都有不同的实现提供给用户,而Java的SPI机制可以为某个接口寻找服务实现。Java中SPI机制主要思想是将装配的控制权移到程序之外,在模块化设计中这个机制尤其重要,其核心思想就是解耦。
SPI和API
stackoverflow原文:
- The API is the description of classes/interfaces/methods/… that you call and use to achieve a goal;
- The SPI is the description of classes/interfaces/methods/… that you extend and implement to achieve a goal.
翻译过来就是:
- API是调用并用于达到目标的类、接口、方法等的描述;
- SPI是扩展和实现以达到目标的类、接口、方法等的描述;
SPI机制
SPI流程:
- 有关组织和公式定义接口标准
- 第三方提供具体实现: 实现具体方法, 配置 META-INF/services/${interface_name} 文件
- 开发者使用
当服务的提供者提供了一种接口的实现之后,需要在classpath
下的META-INF/services/
目录里创建一个以服务接口命名的文件,这个文件里的内容就是这个接口的具体的实现类。当其他的程序需要这个服务的时候,就可以通过查找这个jar包(一般都是以jar包做依赖)的META-INF/services/
中的配置文件,配置文件中有接口的具体实现类名,可以根据这个类名进行加载实例化,就可以使用该服务了。JDK中查找服务的实现的工具类是:java.util.ServiceLoader
。
应用场景
你有个工程A,有个接口A,接口A在工程A是没有实现类的,那么问题来了,系统运行时,怎么给接口A选择一个实现类呢?你可以自己搞一个jar包,META-INF/services/
,放上一个文件,文件名即接口名–接口A,文件内容就是你的实现类:
com.xxx.service.实现类A2
com.xxx.service.实现类A3
让工程A来依赖你的jar包,然后在系统运行时,工程A跑起来,对于接口A,就会扫描依赖的jar包,看看有没有META-INF/services
文件夹,如果有,看再看有没有名为接口A
的文件,如果有,在里面找一下指定的接口A
的实现是你的jar包里的哪个类!
当然,也可以设置多个实现类,如果配置多个实现类,需要我们自己来选择使用哪一个实现类的实例。
比如JDBC场景下:
首先在Java中定义了接口java.sql.Driver,并没有具体的实现,具体的实现都是由不同厂商提供。
在MySQL的jar包mysql-connector-java-6.0.6.jar中,可以找到META-INF/services目录,该目录下会有一个名字为java.sql.Driver的文件,文件内容是com.mysql.cj.jdbc.Driver,这里面的内容就是针对Java中定义的接口的实现。
同样在PostgreSQL的jar包PostgreSQL-42.0.0.jar中,也可以找到同样的配置文件,文件内容是org.postgresql.Driver,这是PostgreSQL对Java的java.sql.Driver的实现。
分析
ServiceLoader实现了Iterable接口,所以它有迭代器的属性,这里主要都是实现了迭代器的hasNext和next方法。这里主要都是调用的lookupIterator的相应hasNext和next方法,lookupIterator是懒加载迭代器。
LazyIterator中的hasNext方法,静态变量PREFIX就是”META-INF/services/”目录,这也就是为什么需要在classpath下的META-INF/services/目录里创建一个以服务接口命名的文件。
通过反射方法Class.forName()加载类对象,并用newInstance方法将类实例化,并把实例化后的类缓存到providers对象中,(LinkedHashMap<String,S>类型) 然后返回实例对象。
JDK原生SPI存在的问题
- 不能按需加载,需要遍历所有实现类并实例化,然后在循环中才能找到我们需要的实现。这里所有实现类都要实例化,浪费资源。
- 获取某个实现类的方式不够灵活,只能通过Iterator来遍历。
- ServiceLoader线程不安全。
Dubbo中的SPI
Dubbo没有使用Java SPI,而是自己实现了一套功能更强的SPI机制,Dubbo称为扩展
。Dubbo SPI 的相关逻辑被封装在了 ExtensionLoader
类中,通过 ExtensionLoader
,我们可以加载指定的实现类。Dubbo SPI 所需的配置文件需放置在 META-INF/dubbo
路径下。
下面是Dubbo协议的扩展:
src
|-main
|-java
|-com
|-xxx
|-XxxProtocol.java (实现Protocol接口)
|-XxxExporter.java (实现Exporter接口)
|-XxxInvoker.java (实现Invoker接口)
|-resources
|-META-INF
|-dubbo
|-org.apache.dubbo.rpc.Protocol (纯文本文件,内容为:xxx=com.xxx.XxxProtocol)
Dubbo的扩展
就可以通过key来确认实现类了。