Java中的SPI机制使用解析

2023-10-07 08:57:05 作者：cloneme01

这篇文章主要介绍了Java中的SPI机制使用解析,SPI意思是"服务提供者的接口",专门提供给服务提供者或者扩展框架功能的开发者去使用的接口,SPI 将服务接口和服务实现分离开来,将服务调用方和服务实现方进行解耦,需要的朋友可以参考下

SPI机制简述

SPI（Service Provider Interface的缩写）意思是：“服务提供者的接口”，专门提供给服务提供者或者扩展框架功能的开发者去使用的接口。SPI 将服务接口和服务实现分离开来，将服务调用方和服务实现方进行解耦，能够提升程序的扩展性和可维护性，当修改或替换服务实现并不需要修改调用方。 SPI 是JDK内置的一种动态加载扩展点的实现。

场景

很多框架都使用了JAVA 的 SPI 机制，如：数据库加载驱动、日志接口以及DUBBO的扩展实现等。

SPI与API的区别

（1）API（Application Programming Interface的缩写），一般都是由实现方制定接口并完成对接口的实现，调用方仅依赖接口调用，并无法选择不同实现。

（2）SPI（Service Provider Interface的缩写），一般都是由调用方来制定接口规范，将接口规范提供给外部厂商来实现，调用方在调用时可以选择不同的实现。

在这里插入图片描述

SPI的实现

（1）定义一个公共接口（一般定义在一个公共的模块中，实现方和调用方都会引用该模块）；

（2）实现方需要实现刚刚定义的公共接口；

（3）实现方在“META-INF/services”目录下新建一个名称为接口的全限定名的文本文件，文件内容为接口实现类的全限定名（一般会在resources目录下创建如上文件）；

（4）调用方通过ServiceLoader#load方法加载接口的实现类实例。

SPI的示例代码

在“模块1”中定义一个公共接口“Hello”，分别在“模块2”和“模块2”两个模块中实现刚刚定义的接口作为两个实现方，在“模块4”中通过ServiceLoader进行测试并作为调用方。

// 1. 公共接口(模块1)：
package com.hadoopx.common.util;
public interface Hello {
    void say();
}
// 2. 具体实现1(模块2)：
package com.hadoopx.m1.test;
import com.hadoopx.common.util.Hello;
public class Chinese implements Hello {
    @Override
    public void say() {
        System.out.println("你好！");
    }
}
// 3. 创建文件： resources/META-INF/services/com.hadoopx.common.util.Hello，内容如下：
com.hadoopx.m1.test.Chinese
// 4. 具体实现2(模块3)：
package com.hadoopx.m2.test;
import com.hadoopx.common.util.Hello;
public class English implements Hello {
    @Override
    public void say() {
        System.out.println("HELLO WORLD！");
    }
}
// 5. 创建文件： resources/META-INF/services/com.hadoopx.common.util.Hello，内容如下：
com.hadoopx.m2.test.English
// 6. 调用方(模块4)：
package com.hadoopx.test;
import com.hadoopx.common.util.Hello;
import java.util.Iterator;
import java.util.ServiceLoader;
public class Test {
    public static void main(String[] args) {
        ServiceLoader<Hello> loader = ServiceLoader.load(Hello.class);
        Iterator<Hello> iterator = loader.iterator();
        while (iterator.hasNext()) {
            Hello hello = iterator.next();
            hello.say();
        }
    }
}

JAVA与SPRING关于SPI的区别

SPRING SPI对JAVA SPI进行了封装和增强，调用方可以使用SpringFactoriesLoader.loadFactories方法得到配置文件中写的实现类的集合，其要求如下：

（1）配置文件必须在resources/META-INF/目录下，文件名必须为spring.factories；

（2）文件内容为键值对形式，一个键可以有多个值（需要用逗号分割），键值都要求是类的全限定名，键名为接口的全限定名。

在SPRING BOOT的自动装配过程中，最终会加载META-INF/spring.factories文件，加载的过程是由SpringFactoriesLoader加载的，它会从CLASSPATH下的每个JAR包中搜寻所有META-INF/spring.factories配置文件并解析，然后将其中定义的BEAN注入到SPRING容器。

// 1. 公共接口(模块1)：
package com.hadoopx.common.util;
public interface Hello {
    void say();
}
// 2. 具体实现1(模块2)：
package com.hadoopx.m1.test;
import com.hadoopx.common.util.Hello;
public class Chinese implements Hello {
    @Override
    public void say() {
        System.out.println("你好！");
    }
}
// 3. 创建/修改文件： resources/META-INF/spring.factories，内容如下：
com.hadoopx.common.util.Hello = \
com.hadoopx.m1.test.Chinese
// 4. 具体实现2(模块3)：
package com.hadoopx.m2.test;
import com.hadoopx.common.util.Hello;
public class English implements Hello {
    @Override
    public void say() {
        System.out.println("HELLO WORLD！");
    }
}
// 5. 创建/修改文件： resources/META-INF/spring.factories，内容如下：
com.hadoopx.common.util.Hello = \
com.hadoopx.m2.test.English
// 6. 调用方(模块4)：
package com.hadoopx.test;
import com.hadoopx.common.util.Hello;
import java.util.Iterator;
import java.util.ServiceLoader;
public class Test {
    public static void main(String[] args) {
        List<Hello> hellos = SpringFactoriesLoader.loadFactories(Hello.class, null);
        for(Hello hello: hellos) {
            hello.say();
        };
    }
}

SPI的缺点

（1）ServiceLoader会遍历加载所有的实现类，效率相对较低；

（2）当由多个ServiceLoader同时加载时，会存在并发的问题。

到此这篇关于Java中的SPI机制使用解析的文章就介绍到这了,更多相关SPI机制使用详解内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！