Java-SPI机制详解

Java之SPI机制详解

1: SPI机制简介

SPI 全称是 Service Provider Interface，是一种 JDK 内置的动态加载实现扩展点的机制，通过 SPI 技术我们可以动态获取接口的实现类，不用自己来创建。这个不是什么特别的技术，只是 一种设计理念。
2: SPI原理


Java SPI 实际上是基于接口的编程＋策略模式＋配置文件组合实现的动态加载机制。
系统设计的各个抽象，往往有很多不同的实现方案，在面向的对象的设计里，一般推荐模块之间基于接口编程，模块之间不对实现类进行硬编码。一旦代码里涉及具体的实现类，就违反了可拔插的原则，如果需要替换一种实现，就需要修改代码。为了实现在模块装配的时候能不在程序里动态指明，这就需要一种服务发现机制。
Java SPI就是提供这样的一个机制：为某个接口寻找服务实现的机制。有点类似IOC的思想，就是将装配的控制权移到程序之外，在模块化设计中这个机制尤其重要。所以SPI的核心思想就是解耦。
3: 使用场景

调用者根据实际使用需要 启用、扩展、或者替换框架的实现策略
下面是一些使用了该机制的场景

• JDBC驱动，加载不同数据库的驱动类
  
• Spring中大量使用了SPI,比如：对servlet3.0规范对ServletContainerInitializer的实现、自动类型转换Type Conversion SPI(Converter SPI、Formatter SPI)等
  
• Dubbo中也大量使用SPI的方式实现框架的扩展, 不过它对Java提供的原生SPI做了封装，允许用户扩展实现Filter接口
  
• Tomcat 加载 META-INF/services下找需要加载的类
  
• SpringBoot项目中 使用@SpringBootApplication注解时，会开始自动配置，而启动配置则会去扫描META-INF/spring.factories下的配置类
  

4: 源码论证

4.1 应用程序调用ServiceLoader.load方法
ServiceLoader.load方法内先创建一个新的ServiceLoader，并实例化该类中的成员变量

1.     private static final String PREFIX = "META-INF/services/";
4.   private ServiceLoader(Class<S> svc, ClassLoader cl) {
5.         service = Objects.requireNonNull(svc, "Service interface cannot be null");
6.         loader = (cl == null) ? ClassLoader.getSystemClassLoader() : cl;
7.         acc = (System.getSecurityManager() != null) ? AccessController.getContext() : null;
8.         reload();
9.     }
11.         /**
12.      *
13.      * 在调用该方法之后，迭代器方法的后续调用将延迟地从头开始查找和实例化提供程序，就像新创建的加载程序所做的                  那样
14.      */
15.    public void reload() {
16.         providers.clear(); //清除此加载程序的提供程序缓存，以便重新加载所有提供程序。
17.         lookupIterator = new LazyIterator(service, loader);
18.     }
20.         private class LazyIterator implements Iterator<S>{
22.         Class<S> service;
23.         ClassLoader loader;
24.         Enumeration<URL> configs = null;
25.         Iterator<String> pending = null;
26.         String nextName = null;
29.         private boolean hasNextService() {
30.             if (nextName != null) {
31.                 return true;
32.             }
33.             if (configs == null) {
34.                 try {
35.                     //找到配置文件
36.                     String fullName = PREFIX + service.getName();
37.                     //加载配置文件中的内容
38.                     if (loader == null)
39.                         configs = ClassLoader.getSystemResources(fullName);
40.                     else
41.                         configs = loader.getResources(fullName);
42.                 } catch (IOException x) {
43.                     fail(service, "Error locating configuration files", x);
44.                 }
45.             }
46.             while ((pending == null) || !pending.hasNext()) {
47.                 if (!configs.hasMoreElements()) {
48.                     return false;
49.                 }
50.                 //解析配置文件
51.                 pending = parse(service, configs.nextElement());
52.             }
53.             //获取配置文件中内容
54.             nextName = pending.next();
55.             return true;
56.         }
57.     }
59.                 /**
60.              *
61.              *  通过反射 实例化配置文件中的具体实现类
62.              */
63.                 private S nextService() {
64.             if (!hasNextService())
65.                 throw new NoSuchElementException();
66.             String cn = nextName;
67.             nextName = null;
68.             Class<?> c = null;
69.             try {
70.                 c = Class.forName(cn, false, loader);
71.             } catch (ClassNotFoundException x) {
72.                 fail(service,
73.                      "Provider " + cn + " not found");
74.             }
75.             if (!service.isAssignableFrom(c)) {
76.                 fail(service,
77.                      "Provider " + cn  + " not a subtype");
78.             }
79.             try {
80.                 S p = service.cast(c.newInstance());
81.                 providers.put(cn, p);
82.                 return p;
83.             } catch (Throwable x) {
84.                 fail(service,
85.                      "Provider " + cn + " could not be instantiated",
86.                      x);
87.             }
88.             throw new Error();          // This cannot happen
89.         }

复制代码

5: 实战

步骤1 新建以下类

1. public interface IService {
3.     /**
4.      * 获取价格
5.      * @return
6.      */
7.     String getPrice();
9.     /**
10.      * 获取规格信息
11.      * @return
12.      */
13.     String getSpecifications();
14. }

复制代码

1. public class GoodServiceImpl implements IService {
3.     @Override
4.     public String getPrice() {
5.         return "2000.00元";
6.     }
8.     @Override
9.     public String getSpecifications() {
10.         return "200g/件";
11.     }
12. }

复制代码

1. public class MedicalServiceImpl implements IService {
3.     @Override
4.     public String getPrice() {
5.         return "3022.12元";
6.     }
8.     @Override
9.     public String getSpecifications() {
10.         return "30粒/盒";
11.     }
12. }

复制代码

步骤2、在 src/main/resources/ 下建立 /META-INF/services 目录, 新增一个以接口命名的文件 org.example.IService.txt 。内容是要应用的实现类，我这边需要放入的数据如下

1. org.example.GoodServiceImpl
2. org.example.MedicalServiceImpl

复制代码

步骤3、使用 ServiceLoader 来加载配置文件中指定的实现。

1. public class Main {
2.     public static void main(String[] args) {
3.         final ServiceLoader<IService> serviceLoader = ServiceLoader.load(IService.class);
4.         serviceLoader.forEach(service -> {
5.             System.out.println(service.getPrice() + "=" + service.getSpecifications());
6.         });
7.     }
8. }

复制代码

输出:

1. 2000.00元=200g/件
2. 3022.12元=30粒/盒

复制代码

6: 优缺点

6.1 优点

解耦  使得第三方服务模块的装配控制的逻辑与调用者的业务代码分离，而不是耦合在一起，应用程序可以根据实际业务情况启用框架扩展或替换框架组件。相比使用提供接口jar包，供第三方服务模块实现接口的方式，SPI的方式使得源框架，不必关心接口的实现类的路径
6.2 缺点

• 虽然ServiceLoader也算是使用的延迟加载，但是基本只能通过遍历全部获取，也就是接口的实现类全部加载并实例化一遍。如果你并不想用某些实现类，它也被加载并实例化了，这就造成了浪费。获取某个实现类的方式不够灵活，只能通过Iterator形式获取，不能根据某个参数来获取对应的实现类
  
• 多个并发多线程使用ServiceLoader类的实例是不安全的
  

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！