Java SPI的使用

1. 定义

SPI是Service Provider Interface，是厂商提供定义，供第三方扩展的定义。

实现原理

• 第三方在jar包的META-INF/services下定义文件名为接口全限定名称的文件
• java.util.ServiceLoader会根据接口全限定名获取配置文件，比如: META-INFO/services/com.xxx.YxxInterface
• java.util.ServiceLoader读取文件，获取实现类名称，Class.forName加载类，通clazz.newInstance()创建实例

2. Helloworld

1. 定义接口

public interface HandlerInterface {
    default String handler() {
        return "";
    }
}

2. 第三方提供实现

• 提供Java类实现

public class LwsCustomHandler implements HandlerInterface {
    @Override
    public String handler() {
        return "lws-custom-handler";
    }
}

• 在jar中提供配置 MET-INFO/services/com.spi.HandlerInterface，文件内容:

com.spi.LwsCustomHandler

3. 使用ServiceLoader，加载第三方扩展

public class App {
    public static void main(String[] args) {
        ServiceLoader<HandlerInterface> loader = ServiceLoader.load(HandlerInterface.class);
        for (HandlerInterface hi : loader) {
            System.out.println(hi.handler());
        }
    }
}

3. 系统的划分

• 一般spi的接口定义需要单独成为一个jar，对应上面Helloworld的第一步里的文件
• 第三方扩展是一个jar，依赖上面的jar，对应上面Helloworld第二步里的文件
• 实际使用spi的是否是一个单独JVM进程，依赖spi接口以及第三方扩展，对应上面Helloworld的第三步里的文件

4. 一个思考

在uber jar大行其道的时候，存在多个扩展冲突的情况，因为META-INFO/services/com.xxx.Interface重名，需要打包的时候合并文件