Java SPI 详解

# 什么是SPI

SPI 全称 Service Provider Interface，是Java提供的一套用来被第三方实现或者扩展的接口，它可以用来启用框架扩展和替换组件。 SPI的作用就是为这些被扩展的API寻找服务实现，一种服务发现机制。

SPI是专门提供给服务提供者或者扩展框架功能的开发者去使用的一个接口。

SPI 将服务接口和具体的服务实现分离开来，将服务调用方和服务实现者解耦，能够提升程序的扩展性、可维护性。修改或者替换服务实现并不需要修改调用方。

SPI 最典型的应用是JDBC接口，但并未提供具体实现类，而是在不同厂商提供的数据库实现包。

SPI实现服务接口与服务实现的解耦：

服务提供者（如 springboot starter）提供出 SPI 接口，让客户端去自定义实现。
客户端（普通的 springboot 项目）即可通过本地注册的形式，将实现类注册到服务端，轻松实现可插拔。

# API 和 SPI 区别

API：大多数情况下，都是实现方制定接口并完成对接口的实现，调用方仅仅依赖接口调用。

SPI ：是调用方来制定接口规范，提供给外部来实现，调用方在调用时则选择自己需要的外部实现。

# 简单实现

# 定义接口

package com.test.service;

public interface ISpi {
    void say();
}

1
2
3
4
5
6

# 定义接口实现

第一个实现类：

package com.test.service.impl;

import com.test.service.ISpi;

public class FirstSpiImpl implements ISpi {

    @Override
    public void say() {
        System.out.println("我是第一个SPI实现类");
    }
}

1
2
3
4
5
6
7
8
9
10
11
12

第二个实现类：

package com.test.service.impl;

import com.test.service.ISpi;

public class SecondSpiImpl implements ISpi {

    @Override
    public void say() {
        System.out.println("我是第二个SPI实现类");
    }
}

1
2
3
4
5
6
7
8
9
10
11
12

# 编写配置文件

在resources目录下新建META-INF/services目录，并且在这个目录下新建一个与上述接口的全限定名一致的文件，在这个文件中写入接口的实现类的全限定名，并写上需要动态加载的实现类的全路径名。

#com.test.service.impl.FirstSpiImpl
com.test.service.impl.SecondSpiImpl

1
2

# 实现原理

从上面的例子，可以看到最关键的实现就是ServiceLoader这个类，看下这个类的源码：

public final class ServiceLoader<S> implements Iterable<S> {
 
 
    //扫描目录前缀
    private static final String PREFIX = "META-INF/services/";
 
    // 被加载的类或接口
    private final Class<S> service;
 
    // 用于定位、加载和实例化实现方实现的类的类加载器
    private final ClassLoader loader;
 
    // 上下文对象
    private final AccessControlContext acc;
 
    // 按照实例化的顺序缓存已经实例化的类
    private LinkedHashMap<String, S> providers = new LinkedHashMap<>();
 
    // 懒查找迭代器
    private java.util.ServiceLoader.LazyIterator lookupIterator;
 
    // 私有内部类，提供对所有的service的类的加载与实例化
    private class LazyIterator implements Iterator<S> {
        Class<S> service;
        ClassLoader loader;
        Enumeration<URL> configs = null;
        String nextName = null;
 
        //...
        private boolean hasNextService() {
            if (configs == null) {
                try {
                    //获取目录下所有的类
                    String fullName = PREFIX + service.getName();
                    if (loader == null)
                        configs = ClassLoader.getSystemResources(fullName);
                    else
                        configs = loader.getResources(fullName);
                } catch (IOException x) {
                    //...
                }
                //....
            }
        }
 
        private S nextService() {
            String cn = nextName;
            nextName = null;
            Class<?> c = null;
            try {
                //反射加载类
                c = Class.forName(cn, false, loader);
            } catch (ClassNotFoundException x) {
            }
            try {
                //实例化
                S p = service.cast(c.newInstance());
                //放进缓存
                providers.put(cn, p);
                return p;
            } catch (Throwable x) {
                //..
            }
            //..
        }
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

应用程序通过迭代器接口获取对象实例，这里首先会判断 providers 对象中是否有实例对象：