一文搞懂Java的SPI机制(推荐)

什么是SPI？

SPI全称为Service Provider Interface，是Java提供的一种服务发现机制。简单来说，就是一种动态加载的方式，让开发者在不同的实现中选择所需要的服务。

SPI的作用

在实际开发中，我们希望引入一个框架或者接口，但是这个框架或者接口有很多不同的实现。SPI机制就是用来解决这个问题的，让开发者可以在不修改框架或者接口的情况下，通过META-INF/services下的配置文件引入一个具体的实现。

SPI的使用

SPI的使用需要遵循一定的规范，具体步骤如下：

定义接口或抽象类

定义一个接口或抽象类，并且在注释中定义好能够通过SPI机制被发现的实现类需要实现的规范，例如：

public interface MyService {
    /**
     * 通过SPI机制发现的实现类需要实现该方法
     */
    void doSomething();
}

编写接口或抽象类的实现类

实现接口或抽象类，例如：

public class MyServiceImplA implements MyService {
    @Override
    public void doSomething() {
        System.out.println("MyServiceImplA do something.");
    }
}

创建specification配置文件

在classpath下创建META-INF/services文件夹，在该文件夹下创建以接口或抽象类全限定名为名字的文件，例如：

META-INF/services/com.example.MyService

在文件中写入实现类的全限定名，例如：

com.example.MyServiceImplA

加载并使用接口或抽象类的实现类

通过SPI机制加载实现类，例如：

ServiceLoader<MyService> loader = ServiceLoader.load(MyService.class);
for (MyService service : loader) {
    service.doSomething();
}

SPI的示例

下面以使用Java自带的JDBC实现为例，来演示SPI的使用。

定义数据源层的接口DataSource

public interface DataSource {
    /**
     * 获取数据库连接
     */
    Connection getConnection() throws SQLException;
}

使用Java自带的JDBC实现数据源层的接口

public class JdbcDataSource implements DataSource {
    private Properties properties;

    public JdbcDataSource(Properties properties) {
        this.properties = properties;
    }

    @Override
    public Connection getConnection() throws SQLException {
        String url = properties.getProperty("url");
        String username = properties.getProperty("username");
        String password = properties.getProperty("password");
        return DriverManager.getConnection(url, username, password);
    }
}

配置META-INF/services下的配置文件

在META-INF/services下创建javax.sql.DataSource文件，并在文件中写入实现类的全限定名：

com.example.JdbcDataSource

使用SPI机制加载实现类

public class Main {
    public static void main(String[] args) throws SQLException {
        ServiceLoader<DataSource> loader = ServiceLoader.load(DataSource.class);
        Properties properties = new Properties();
        properties.load(Main.class.getClassLoader().getResourceAsStream("jdbc.properties"));
        DataSource dataSource = loader.iterator().next();
        Connection connection = dataSource.getConnection();
        // do something
    }
}