SPI(服务发现机制)

什么是SPI

SPI ，全称为 Service Provider Interface，是一种服务发现机制。它通过在ClassPath路径下的META-INF/services文件夹查找文件，自动加载文件里所定义的类。

这一机制为很多框架扩展提供了可能，比如在Dubbo、JDBC中都使用到了SPI机制。

例子

ServiceLoader.load或者Service.providers加载META-INF/services配置中的实现类

1.首先定义一个接口maven项目
pom.xml

<?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.wzq</groupId>
    <artifactId>mySpi</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>

</project>

接口:

package com.wzq;

public interface MySpi {
    void execute();
}

2.实现类maven项目
pom.xml

<?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>org.example</groupId>
    <artifactId>mySpiDemo</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>

    <dependencies>
        <!--接口项目-->
        <dependency>
            <groupId>com.wzq</groupId>
            <artifactId>mySpi</artifactId>
           <version>1.0-SNAPSHOT</version>
        </dependency>
    </dependencies>
</project>

实现类1:

package com.mySpiDemo.spi.impl;


import com.wzq.MySpi;

public class MySpi1 implements MySpi {
    @Override
    public void execute() {
        System.out.println("hi MySpi1!");
    }
}

实现类2:

package com.mySpiDemo.spi.impl;


import com.wzq.MySpi;

public class MySpi2 implements MySpi {
    @Override
    public void execute() {
        System.out.println("hi MySpi2!");
    }
}

META-INF配置:
路径:src/main/resources/META-INF/services/com.wzq.MySpi

名称:com.wzq.mySpi为接口项目中接口的路径
里面的值(实现类的路径):

com.mySpiDemo.spi.impl.MySpi1
com.mySpiDemo.spi.impl.MySpi2

3.其他项目使用
pom.xml

<dependency>
    <groupId>org.example</groupId>
    <artifactId>mySpiDemo</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

main.java

package com.wzq.demoftl.spi;

import com.wzq.MySpi;
import sun.misc.Service;

import java.util.Iterator;
import java.util.ServiceLoader;

public class MySpiMain {
    public static void main(String[] args) {
        //方法一
        //ServiceLoader.load
        ServiceLoader<MySpi> load = ServiceLoader.load(MySpi.class);
        for (MySpi mySpi : load) {
            mySpi.execute();
        }

        /* --------------------------------------- */

        //方法二
        //Service.providers
        Iterator<MySpi> providers = Service.providers(MySpi.class);
        while (providers.hasNext()){
            MySpi mySpi = providers.next();
            mySpi.execute();
        }
    }
}

线程上下文类加载器

　　这些 SPI 的接口由 Java 核心库来提供，而这些 SPI 的实现代码则是作为 Java 应用所依赖的 jar 包被包含进类路径(CLASSPATH)里。SPI接口中的代码经常需要加载具体的实现类。那么问题来了，SPI的接口是Java核心库的一部分，是由启动类加载器来加载的；SPI的实现类是由系统类加载器来加载的。启动类加载器是无法找到 SPI 的实现类的，因为它只加载 Java 的核心库。它也不能委派给系统类加载器，因为它是系统类加载器的祖先类加载器。

线程上下文类加载器正好解决了这个问题。如果不做任何的设置，Java 应用的线程的上下文类加载器默认就是系统上下文类加载器。在 SPI 接口的代码中使用线程上下文类加载器，就可以成功的加载到 SPI 实现的类。线程上下文类加载器在很多 SPI 的实现中都会用到。

线程上下文类加载器破坏了“双亲委派模型”，可以在执行线程中抛弃双亲委派加载链模式，使程序可以逆向使用类加载器。