深入理解Java的SPI机制，使用auto-service库优化SPI

一、简介

SPI 即 Service Provider Interface ，字面意思就是：“服务提供者的接口”，是JDK内置的一种服务提供发现机制，可以用来启用框架扩展和替换组件，主要是被框架的开发人员使用，比如java.sql.Driver接口，其他不同厂商可以针对同一接口做出不同的实现，MySQL和PostgreSQL都有不同的实现提供给用户，而Java的SPI机制可以为某个接口寻找服务实现。Java中SPI机制主要思想是将装配的控制权移到程序之外，在模块化设计中这个机制尤其重要，其核心思想就是解耦。

SPI 将服务接口和具体的服务实现分离开来，将服务调用方和服务实现者解耦，能够提升程序的扩展性、可维护性。修改或者替换服务实现并不需要修改调用方。

二、使用

1、服务提供者（或者第三方公共）：定义接口

public interface HelloSPI {void sayHello();
}

2、服务提供者：定义实现类

public class ImageHello implements HelloSPI {public void sayHello() {System.out.println("Image Hello");}
}public class TextHello implements HelloSPI {public void sayHello() {System.out.println("Text Hello");}
}

3、服务提供者：注册服务

META-INF/services/目录里创建一个以org.example.spi.HelloSPI的文件，这个文件里的内容就是这个接口的具体的实现类。

org.example.spi.ImageHello
org.example.spi.TextHello

4、构建服务提供者jar包

将服务提供者构建为jar包，客户端需要引入

5、客户端：使用 ServiceLoader 来加载服务

import org.example.spi.HelloSPI;import java.util.ServiceLoader;
public class SPIDemo {public static void main(String[] args) {ServiceLoader<HelloSPI> serviceLoader = ServiceLoader.load(HelloSPI.class);// 执行不同厂商的业务实现，具体根据业务需求配置for (HelloSPI helloSPI : serviceLoader) {helloSPI.sayHello();}}
}

我们可以看到，服务正常加载了。

三、源码分析

1、源码

// ServiceLoader实现了Iterable接口，可以遍历所有的服务实现者
public final class ServiceLoader<S> implements Iterable<S>
{// 查找配置文件的目录private static final String PREFIX = "META-INF/services/";// 表示要被加载的服务的类或接口private final Class<S> service;// 这个ClassLoader用来定位，加载，实例化服务提供者private final ClassLoader loader;// 访问控制上下文private final AccessControlContext acc;// 缓存已经被实例化的服务提供者，按照实例化的顺序存储private LinkedHashMap<String,S> providers = new LinkedHashMap<>();// 迭代器private LazyIterator lookupIterator; 
}
// 服务提供者查找的迭代器
public Iterator<S> iterator() {return new Iterator<S>() {Iterator<Map.Entry<String,S>> knownProviders= providers.entrySet().iterator();// hasNext方法public boolean hasNext() {if (knownProviders.hasNext())return true;return lookupIterator.hasNext();}// next方法public S next() {if (knownProviders.hasNext())return knownProviders.next().getValue();return lookupIterator.next();}};
}
// 服务提供者查找的迭代器
private class LazyIterator implements Iterator<S> {// 服务提供者接口Class<S> service;// 类加载器ClassLoader loader;// 保存实现类的urlEnumeration<URL> configs = null;// 保存实现类的全名Iterator<String> pending = null;// 迭代器中下一个实现类的全名String nextName = null;public boolean hasNext() {if (nextName != null) {return true;}if (configs == null) {try {String fullName = PREFIX + service.getName();if (loader == null)configs = ClassLoader.getSystemResources(fullName);elseconfigs = loader.getResources(fullName);} catch (IOException x) {fail(service, "Error locating configuration files", x);}}while ((pending == null) || !pending.hasNext()) {if (!configs.hasMoreElements()) {return false;}pending = parse(service, configs.nextElement());}nextName = pending.next();return true;}public S next() {if (!hasNext()) {throw new NoSuchElementException();}String cn = nextName;nextName = null;Class<?> c = null;try {c = Class.forName(cn, false, loader);} catch (ClassNotFoundException x) {fail(service,"Provider " + cn + " not found");}if (!service.isAssignableFrom(c)) {fail(service, "Provider " + cn  + " not a subtype");}try {S p = service.cast(c.newInstance());providers.put(cn, p);return p;} catch (Throwable x) {fail(service, "Provider " + cn + " could not be instantiated: " + x, x);}throw new Error();          // This cannot happen}
}

首先，ServiceLoader实现了Iterable接口，所以它有迭代器的属性，这里主要都是实现了迭代器的hasNext和next方法。这里主要都是调用的lookupIterator的相应hasNext和next方法，lookupIterator是懒加载迭代器。

其次，LazyIterator中的hasNext方法，静态变量PREFIX就是”META-INF/services/”目录，这也就是为什么需要在classpath下的META-INF/services/目录里创建一个以服务接口命名的文件。

最后，通过反射方法Class.forName()加载类对象，并用newInstance方法将类实例化，并把实例化后的类缓存到providers对象中，(LinkedHashMap<String,S>类型） 然后返回实例对象。

2、缺点

1.不能按需加载，需要遍历所有的实现，并实例化，然后在循环中才能找到我们需要的实现。如果不想用某些实现类，或者某些类实例化很耗时，它也被载入并实例化了，这就造成了浪费。
2.获取某个实现类的方式不够灵活，只能通过 Iterator 形式获取，不能根据某个参数来获取对应的实现类。
3.多个并发多线程使用 ServiceLoader 类的实例是不安全的。
4.没有使用缓存，每次调用load方法都需要重新加载

四、auto-service库

1、简介

auto-service 是 Google 提供的一个 Java 注解处理器库，主要用于简化 Java 服务提供者接口（Service Provider Interface, SPI）的实现。它通过注解自动生成 SPI 配置文件，避免了手动编写 META-INF/services 目录下配置文件的繁琐工作。

它可以：
自动生成 SPI 配置文件
编译时检查 SPI 实现的有效性
简化模块化项目中的服务注册

使用需要先引入依赖包（服务提供者）：

        <dependency><groupId>com.google.auto.service</groupId><artifactId>auto-service</artifactId><version>1.1.1</version></dependency>

2、有变化的点

只需要在需要暴露的实现类中，添加注解即可。
并不需要添加 META-INF/services 目录下配置文件了！

import com.google.auto.service.AutoService;// 如果多个接口，value是可以添加数组的
@AutoService(HelloSPI.class)
public class ImageHello implements HelloSPI {public void sayHello() {System.out.println("Image Hello");}
}

我们发现，打出来的服务提供者的jar包，是自带配置文件的：

这里用的就是Java 的 APT（Annotation Processing Tool）机制

参考资料

https://zhuanlan.zhihu.com/p/84337883