java spi service provider interface

如何使用Java的SPI？

我们先来看看如何使用Java自带的SPI。先定义一个Developer接口

// Developer.java
 
package com.ymbj.spi;
 
public interface Developer {
    void sayHi();
}

1. 再定义两个Developer接口的两个实现类：

// JavaDeveloper.java
 
package com.ymbj.spi;
 
public class JavaDeveloper implements Developer {
 
    @Override
    public void sayHi() {
        System.out.println("Hi, I am a Java Developer.");
    }
}


// PythonDeveloper.java
 
package com.ymbj.spi;
 
public class PythonDeveloper implements Developer {
 
    @Override
    public void sayHi() {
        System.out.println("Hi, I am a Python Developer.");
    }
}

然后再在项目resources目录下新建一个META-INF/services文件夹，然后再新建一个以Developer接口的全限定名命名的文件，文件内容为：

// com.ymbj.spi.Developer文件
 
com.ymbj.spi.JavaDeveloper
com.ymbj.spi.PythonDeveloper

最后我们再新建一个测试类JdkSPITest：

// JdkSPITest.java
 
public class JdkSPITest {
 
    @Test
    public void testSayHi() throws Exception {
        ServiceLoader<Developer> serviceLoader = ServiceLoader.load(Developer.class);
        serviceLoader.forEach(Developer::sayHi);
    }
}

运行上面那个测试类，运行成功结果如下截图所示：

 

这里涉及一个问题就是，如果有多个第三方jar都提供了实现，并且都有META-INF/services的文件，系统加载到的列表的优先顺序如何呢？

默认情况下，系统会按照jar包加载的顺序来排序，也就是先发现的排在最前面（这里大致提一下jar包的加载顺序，默认情况下是： 系统/应用本身的类文件以及classpath --> 系统/应用本身引用的jar包 --> 应用服务器的jar包），如果有2个jar包，01.jar和02.jar，默认情况下01.jar会优先于02.jar的加载（其实也就是默认按照文件管理器里的排序顺序来加载的）。

如果希望优先加载02.jar，只要在启动应用时，手动指定classpath里jar的顺序就可以了，或者把02.jar改名为00.jar。也就是说可以通过修改jar包的名称来改变加载顺序。

然后我们在实现系统时，大多数情况下，只需要取得第一个实现就可以了。

Jaxb里在实例化XmlOutputFactory时，就使用这种方式，使用抽象工厂的方式加载对应的Xml工厂类，只是在查找方式上更加多样化一些，实际项目实施时可以考虑。

那里面有一个FactoryFinder，在寻找具体实现的工厂类时，按照以下顺序查找：

1. 查找SystemProperty里有没有指定，有则返回

2. 查找指定目录下的某个配置文件，如果有指定，则返回

3. 使用Java Service Provider机制查找