ServiceLoader : JAVA SPI 机制

最新推荐文章于 2025-11-18 11:20:34 发布

原创最新推荐文章于 2025-11-18 11:20:34 发布 · 8k 阅读

7 ·

CC 4.0 BY-SA版权

文章标签：

#ServiceLoader SPI

J2SE 专栏收录该内容

45 篇文章

订阅专栏

本文介绍了 Java SPI 机制的基本概念及其实现原理。通过示例展示了如何定义接口、创建实现类并通过配置文件指定这些实现类，最后通过 ServiceLoader 加载并实例化这些服务实现。

SPI的全名为Service Provider Interface.普通开发人员可能不熟悉，因为这个是针对厂商或者插件的。在java.util.ServiceLoader的文档里有比较详细的介绍。

简单来说就是通过配置文件指定接口的实现类。

当我们开发一套框架、一套机制、一个插件或一套API时候，如果需要第三方的服务支持，可以直接写死到代码里面，但这种方式耦合太强，不利于切换到其它服务，好的方法是写一个配置文件指定服务的实现方，幸运的是java的spi机制已经帮我们做好了，示例用法如下：

一个接口：

package testws;

public interface TestEJB {
    void test(String data) throws Exception;
    void test0(String data) throws Exception;
}

第一个实现类：

package testws;

public class MyTest implements TestEJB {
    public void test(String data) throws Exception {
        System.out.println("my test:" + data);
    }

    public void test0(String data) throws Exception {
        System.out.println("test0:" + data);
    }
}

第二个实现类：

package testws;

public class MyTest2 implements TestEJB {
    public void test(String data) throws Exception {
        System.out.println("my test2222:" + data);
    }

    public void test0(String data) throws Exception {
        System.out.println("test02222222:" + data);
    }
}

建立 META-INF 文件夹，在其里面建立 services 文件夹，在services文件夹下建立一个文件，名称为我们需要实现的服务的全类名，即：testws.TestEJB

文件testws.TestEJB的内容如下：（PS:如果我们只需要一个实现类，下面可以只写一个，每一个实现类占一行）

testws.MyTest
testws.MyTest2

最后一个步骤：将三个java类和META-INF 文件夹打包到一个jar中，就可以使用了，使用方式：

import java.util.ServiceLoader;

public class TestSPI {
    public static void main(String[] args) {
        ServiceLoader<TestEJB> loadedImpl = ServiceLoader.load(TestEJB.class);
        for (TestEJB testEJB : loadedImpl) {
            System.out.println(testEJB.getClass());
            try {
                testEJB.test("a");
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
    }
}

打印如下：

class testws.MyTest
my test:a
class testws.MyTest2
my test2222:a