java中的SPI机制

Posted 2021-01-05 psy-code

1.定义

SPI 全称为 (Service Provider Interface) ,是JDK内置的一种服务提供发现机制。

一个服务(Service)通常指的是已知的接口或者抽象类，服务提供方就是对这个接口或者抽象类的实现，然后按照SPI 标准存放到资源路径META-INF/services目录下，文件的命名为该服务接口的全限定名。

2.SPI机制的约定

• 在META-INF/services/目录中创建以Service接口全限定名命名的文件，该文件内容为Service接口具体实现类的全限定名，文件编码必须为UTF-8。
• 使用ServiceLoader.load(Class class); 动态加载Service接口的实现类。
• 如SPI的实现类为jar，则需要将其放在当前程序的classpath下。
• Service的具体实现类必须有一个不带参数的构造方法。
• 许多开发框架都使用了Java的SPI机制，如java.sql.Driver的SPI实现（mysql驱动、oracle驱动等）、common-logging的日志接口实现、dubbo的扩展实现等等。

3.示例

3.1pom

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.zy</groupId>
    <artifactId>java-spi-demo</artifactId>
    <version>1.0-SNAPSHOT</version>

    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>RELEASE</version>
            <scope>compile</scope>
        </dependency>
    </dependencies>

</project>

3.2接口

package com.zy;

public interface SpiServiceI {

    void sayHello(String s);
}

3.3两个实现类

package com.zy;

public class SpiServiceEnglishImpl implements SpiServiceI {
    @Override
    public void sayHello(String s) {
        System.out.println(s+": hello world");
    }
}

 

package com.zy;

public class SpiServiceChinaImpl implements SpiServiceI {
    @Override
    public void sayHello(String s) {
        System.out.println(s+": 你好,世界");
    }
}

3.4测试类

package com.zy;

import org.junit.Test;
import java.util.Iterator;
import java.util.ServiceLoader;

public class SpiTest {

    @Test
    public void fn(){
　　　　 // 通过ServiceLoader.load(Class class); 来动态加载Service的实现类
        ServiceLoader<SpiServiceI> serviceLoader = ServiceLoader.load(SpiServiceI.class);
        Iterator<SpiServiceI> iterator = serviceLoader.iterator();
        while(iterator != null  && iterator.hasNext()){
            SpiServiceI serviceI = iterator.next();
            serviceI.sayHello("tom");
        }
    }
}

3.5META-INF/services/配置

在src/main/resources 下创建META-INF/services/目录,然后新建文件:
文件名为接口的全限定名,接口中的内容按行分开,每一行是实现类的全限定名