Java常用机制 - SPI机制详解

SPI（Service Provider Interface），是JDK内置的一种 服务提供发现机制，可以用来启用框架扩展和替换组件，主要是被框架的开发人员使用。

在使用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。

SPI机制的简单示例

我们现在需要使用一个数据库接口，数据库的实现可能是基于mysql连接，orcle连接

先定义接口

public interface Database{
    public String connect(String dataSource);   
}
1
2
3

Mysql连接

public class MysqlDatabase implements Database{
    @Override
    public String connect(String dataSource){
        System.out.println("msyql连接 "+dataSource);
        return null;
    }
}
1
2
3
4
5
6
7

Oracle连接

public class OracleDatabase implements Database{
    @Override
    public String connect(String dataSource){
        System.out.println("Oracle连接 "+dataSource);
        return null;
    }
}
1
2
3
4
5
6
7

接下来可以在resources下新建META-INF/services/目录，然后新建接口全限定名的文件：org.erosframework.boot.Database，里面加上我们需要用到的实现类

接下来我们进行测试下

public class TestDatabase {
    public static void main(String[] args) {
        ServiceLoader<Database> s = ServiceLoader.load(Database.class);
        Iterator<Database> iterator = s.iterator();
        while (iterator.hasNext()) {
           Database database=  iterator.next();
           database.connect("mysql run");
        }
    }
}
1
2
3
4
5
6
7
8
9
10

可以看到输出结果：mysql 输出 mysql run如果在org.erosframework.boot.Database文件里写上两个实现类，那最后的输出结果就是两行了。 这就是因为ServiceLoader.load(Database.class)在加载某接口时，会去META-INF/services下找接口的全限定名文件，再根据里面的内容加载相应的实现类。 这就是spi的思想，接口的实现由provider实现，provider只用在提交的jar包里的META-INF/services下根据平台定义的接口新建文件，并添加进相应的实现类内容就好。

SPI机制的应用场景

JDBC接口定义 首先在java中定义了接口java.sql.Driver，并没有具体的实现，具体的实现都是由不同厂商来提供的。

mysql实现

在mysql的jar包mysql-connector-java-6.0.6.jar中，可以找到META-INF/services目录，该目录下会有一个名字为java.sql.Driver的文件，文件内容是com.mysql.cj.jdbc.Driver，这里面的内容就是针对Java中定义的接口的实现。

postgresql实现

同样在postgresql的jar包postgresql-42.0.0.jar中，也可以找到同样的配置文件，文件内容是org.postgresql.Driver，这是postgresql对Java的java.sql.Driver的实现。
我们在Java中写连接数据库的代码的时候，不需要再使用Class.forName(“com.mysql.jdbc.Driver”)来加载驱动了

大家有兴趣得可以去看下源码，这里就不对源码做详细整理了，后续教程会出更加详细得教程。