Java常用机制 - SPI机制详解

Java常用机制 - SPI机制详解

---

前言

SPI（Service Provider Interface），是JDK内置的一种 服务提供发现机制，可以用来启用框架扩展和替换组件，主要是被框架的开发人员使用，比如java.sql.Driver接口，其他不同厂商可以针对同一接口做出不同的实现，MySQL和PostgreSQL都有不同的实现提供给用户，而Java的SPI机制可以为某个接口寻找服务实现。Java中SPI机制主要思想是将装配的控制权移到程序之外，在模块化设计中这个机制尤其重要，其核心思想就是 解耦。

---

什么是SPI机制

SPI（Service Provider Interface），是JDK内置的一种 服务提供发现机制，可以用来启用框架扩展和替换组件，主要是被框架的开发人员使用，比如java.sql.Driver接口，其他不同厂商可以针对同一接口做出不同的实现，MySQL和PostgreSQL都有不同的实现提供给用户，而Java的SPI机制可以为某个接口寻找服务实现。Java中SPI机制主要思想是将装配的控制权移到程序之外，在模块化设计中这个机制尤其重要，其核心思想就是 解耦。

SPI整体机制图如下：

当服务的提供者提供了一种接口的实现之后，需要在classpath下的META-INF/services/目录里创建一个以服务接口命名的文件，这个文件里的内容就是这个接口的具体的实现类。当其他的程序需要这个服务的时候，就可以通过查找这个jar包（一般都是以jar包做依赖）的META-INF/services/中的配置文件，配置文件中有接口的具体实现类名，可以根据这个类名进行加载实例化，就可以使用该服务了。JDK中查找服务的实现的工具类是：java.util.ServiceLoader。

工程demo

github

工程目录结构

接口定义

package com.naocun.leoj.jdk.common.api;
import java.util.List;
public interface Search {
    List<String> searchDoc(String keyword);
}

接口实现

package com.naocun.leoj.jdk.common.demo.spi;
import com.naocun.leoj.jdk.common.api.Search;
import java.util.List;

public class DatabaseSearch implements Search {
    @Override
    public List<String> searchDoc(String keyword) {
        System.out.println("数据库搜索: " + keyword);
        return null;
    }
}

package com.naocun.leoj.jdk.common.demo.spi;
import com.naocun.leoj.jdk.common.api.Search;
import java.util.List;

public class FileSearch implements Search {
    @Override
    public List<String> searchDoc(String keyword) {
        System.out.println("文件搜索: " + keyword);
        return null;
    }
}

resource资源配置

META-INF/services

com.naocun.leoj.jdk.common.demo.spi.FileSearch
com.naocun.leoj.jdk.common.demo.spi.DatabaseSearch

Example演示

package com.naocun.leoj.jdk.common.demo;
import com.naocun.leoj.jdk.common.api.Search;
import java.util.Iterator;
import java.util.ServiceLoader;

public class SPIExample {
    public static void main(String[] args) {
        ServiceLoader<Search> services = ServiceLoader.load(Search.class);
        Iterator<Search> iterator = services.iterator();
        while (iterator.hasNext()) {
            Search search = iterator.next();
            search.searchDoc("hello world");
        }
    }
}
/** 输出结果
文件搜索: hello world
数据库搜索: hello world
**/

References

1. Java常用机制 - SPI机制详解 https://www.pdai.tech/md/java/advanced/java-advanced-spi.html
2. Java SPI机制及实现: https://rgb-24bit.github.io/blog/2019/java-spi.html
3. Java SPI 原理及运用: https://www.cnblogs.com/oskyhg/p/10800051.html
4. Java SPI 详解: https://www.cnblogs.com/jy107600/p/11464985.html