java 的 SPI 机制

简介

SPI 全称是 Service Provider Interface， 原本是JDK内置的一种服务发现机制，它主要是用来做服务的扩展实现。

应用场景

SPI在很多场景中都有使用，比如数据库连接，JDK提供的java.sql.Driver接口，这个接口的实现在jdk中并没有实现，而是由不同厂商来实现，比如oracle、mysql等，这些数据库驱动都会实现这个接口，然后jdk利用spi机制从classpath下找到相应的驱动来获得指定的数据库的连接。这种插拔式的扩展加载方式，遵循一定的约定：

所有的扩展点必须要放在resources/META-INF/services目录下，SPI机制默认会扫描这个路径下的属性文件以完成加载。

实操使用

package com.luoq.spi;

public interface Driver{
  String connect();
}

package com.luoq.spi.impl;

public class MysqlDriver implements Driver{

    @Override
    public String connect(){
        
        return "连接Mysql"
    }
}

在resources/META-INF/services目录下创建一个以Driver接口全路径命名的文件com.luoq.spi.Driver，在里面填写接口的实现类:

com.luoq.spi.impl.MysqlDriver

创建一个测试类进行测试

import java.util.ServerLoader;

public class TestMain{

    public static void main(String[] args){

        ServiceLoader<Driver> serviceLoader = ServiceLoader.load(Driver.class);
        serviceLoader.forEach(driver -> System.out.println(driver.connect()));

    }
}

扩展

Dubbo或SpringFactoriesLoader并没有使用JDK内置的SPI机制，只是利用了SPI的思想，根据实际情况做了一些优化和调整。Dubbo SPI的相关逻辑封装在ExtensionLoader类中，通过它我们可以加载指定的实现类。

Dubbo的SPI扩展有两个规则：

• 和Jdk的SPI一样，需要在resouces目录下创建任一目录结构：META-INF/dubbo、META-INF/dubbo/internal、META-INF/services，在对应的目录下，以接口全路径名命名的文件，Dubbo会去这三个目录下加载相应的扩展点。
• 文件内容和JDK内置的SPI不一样，内容是一种key和value形式的数据。key是一个字符串，value是对用扩展点的实现，这样的方式可以按照需要加载指定的实现类。

实现步骤：

• 定义一个扩展点

package com.luoq.dubbo.spi;

@SPI
public interface Driver{
    String connect();
}

• 定义扩展点的实现 

package com.luoq.dubbo.spi.impl;

public class MysqlDriver implements Driver{

    @Override
    public String connect(){
        
        return "连接Mysql"
    }
}

• 在resouces/META-INF/dubbo目录下创建SPI接口命名的文件com.luoq.dubbo.spi.Driver，内容

mysqlDriver=com.luoq.dubbo.spi.impl.MysqlDriver

• 创建测试类，测试

@Test
public void testDubboSpi(){

    ExtensionLoader<Dirver> loader = ExtensionLoader.getExtensionLoader(Driver.class);
    Driver driver = loader.getExtension("mysqlDriver");
    System.out.println(driver.connect());
}