本文介绍Java原生的SPI机制

概述

SPI（Service Provider Interface）是Java提供的一种服务发现机制。通常由服务使用者定义某个服务的接口，不同厂商可以对该接口自行进行实现。此时借助于SPI机制的服务查找就可以动态替换该接口的具体实现。避免服务使用者与服务提供者内部的具体实现发生耦合

实践

首先，作为服务的使用者，即调用方定义一个接口

package com.aaron.SPIDemo;

public interface People {
    void sayHello();

    void sayBye();
}

对于服务的提供者而言，其需要实现该接口

package com.aaron.SPIDemo;

public class Man implements People{
    @Override
    public void sayHello() {
        System.out.println("I'm a Man");
    }

    @Override
    public void sayBye() {
        System.out.println("[Man]: Bye");
    }

}

...

package com.aaron.SPIDemo;

public class Woman implements People{
    @Override
    public void sayHello() {
        System.out.println("I'm a Woman");
    }

    @Override
    public void sayBye() {
        System.out.println("[Woman]: Bye ~~~");
    }
}

与此同时，在服务提供者 src/main/resources 目录下新建 META-INF/services 文件夹，然后在该文件夹下添加SPI配置文件。文件名为其所实现接口的全限定名，这里People接口的全限定名为com.aaron.SPIDemo.People。文件内容为实现类的全限定名，这里Man、Woman两个实现类的全限定名分别为：com.aaron.SPIDemo.Man、com.aaron.SPIDemo.Woman。多个实现类的全限定名按行分隔即可。如下所示

此时对于服务使用者而言，即可使用java.util.ServiceLoader进行服务查找。服务使用者的实例代码如下所示

package com.aaron.SPIDemo;

import java.util.ServiceLoader;

public class SPITest {
    public static void main(String[] args) {
        ServiceLoader<People> peoples = ServiceLoader.load(People.class);
        for (People people : peoples) {
            System.out.println("------------------");
            people.sayHello();
            people.sayBye();
        }
    }

}

效果如下所示

原理

Java的SPI机制原理也很简单，其会扫描classpath下所有jar包中的META-INF/services目录下指定文件名的配置文件。通过按行解析文件内容，获取指定接口的所有实现类的全限定名。然后利用反射通过Class.forName方法来实例化相应的实现类，以供服务调用者使用。故对于实现类而言，其必须提供无参构造器，否则反射进行实例化时会失败。当然SPI机制的缺点也很明显，由于其会加载所有指定接口的SPI配置文件中的实现类，所以无法按需加载指定实现类

当然，Java原生SPI机制的用途非常广泛。典型地，JDBC加载不同类型的数据库驱动、SLF4J加载不同类型的日志实现。下图即是MySQL、PG驱动的SPI配置文件

xyZGHio

浅谈Java SPI 机制

概述

实践

原理