解耦利器 - Java中的SPI机制

为什么需要SPI机制

SPI和API的区别是什么

SPI是一种跟API相对应的反向设计头脑：API由实现方确定标准规范和功能，调用方无权做任何干预； 而SPI是由调用方确定标准规范，也就是接口，然后调用方依赖此接口，第三方实现此接口，这样做就可以方便的举行扩展，类似于插件机制，这是SPI出现的需求背景。
SPI ： “接口”位于“调用方”地点的“包”中

• 概念上更依赖调用方。
  
• 组织上位于调用方地点的包中。
  
• 实现位于独立的包中。
  
• 常见的例子是：插件模式的插件。
  

API ： “接口”位于“实现方”地点的“包”中

• 概念上更接近实现方。
  
• 组织上位于实现方地点的包中。
  
• 实现和接口在一个包中。
  

什么是SPI机制

SPI（Service Provider Interface），是JDK内置的一种 服务提供发现机制，可以用来启用框架扩展和替换组件，重要是被框架的开辟人员使用，比方数据库中的java.sql.Driver接口，不同的厂商可以针对同一接口做出不同的实现，如下图所示，MySQL和PostgreSQL都有不同的实现提供给用户。
而Java的SPI机制可以为某个接口寻找服务实现，Java中SPI机制重要头脑是将装配的控制权移到程序之外，在模块化设计中这个机制尤其重要，其核心头脑就是 解耦。
SPI团体机制图如下：

• 当服务的提供者提供了一种接口的实现之后，需要在classpath下的 META-INF/services/ 目录里创建一个文件，文件名是以服务接口命名的，而文件里的内容是这个接口的具体的实现类。
  
• 当其他的程序需要这个服务的时间，就可以通过查找这个jar包（一样寻常都是以jar包做依赖）的META-INF/services/中的设置文件，设置文件中有接口的具体实现类名，再根据这个类名举行加载实例化，就可以使用该服务了。JDK中查找服务的实现的工具类是：java.util.ServiceLoader。
  

SPI机制的简单示例

假设现在需要一个发送消息的服务MessageService，发送消息的实现可能是基于短信、也可能是基于电子邮件、或推送通知发送消息。

• 接口界说：首先界说一个接口 MessageService
  

1. public interface MessageService {
2.     void sendMessage(String message);
3. }

复制代码

• 提供两个实现类：一个通过短信发送消息，一个通过电子邮件发送消息。
  

1. // 短信发送实现
2. public class SmsMessageService implements MessageService {
3.     @Override
4.     public void sendMessage(String message) {
5.         System.out.println("Sending SMS: " + message);
6.     }
7. }
9. // 电子邮件发送实现
10. public class EmailMessageService implements MessageService {
11.     @Override
12.     public void sendMessage(String message) {
13.         System.out.println("Sending Email: " + message);
14.     }
15. }

复制代码

• 设置文件：在 META-INF/services/ 目录下创建一个设置文件，文件名为 MessageService ，全限定名 com.example.MessageService，文件内容为接口的实现类的全限定名。
  

1. # 文件: META-INF/services/com.seven.MessageService
2. com.seven.SmsMessageService
3. com.seven.EmailMessageService

复制代码

• 加载服务实现：在应用程序中，通过 ServiceLoader 动态加载并使用这些实现类。
  

1. public class Application {
2.     public static void main(String[] args) {
3.         ServiceLoader<MessageService> loader = ServiceLoader.load(MessageService.class);
5.         for (MessageService service : loader) {
6.             service.sendMessage("Hello, SPI!");
7.         }
8.     }
9. }

复制代码

运行时，ServiceLoader 会发现并加载设置文件中列出的所有实现类，并依次调用它们的 sendMessage 方法。
由于在 设置文件 写了两个实现类，因此两个实现类都会实行 sendMessage 方法。
这就是由于ServiceLoader.load(Search.class)在加载某接口时，会去 META-INF/services 下找接口的全限定名文件，再根据里面的内容加载相应的实现类。
这就是spi的头脑，接口的实现由provider实现，provider只用在提交的jar包里的META-INF/services下根据平台界说的接口新建文件，并添加进相应的实现类内容就好。
SPI机制的应用

JDBC DriverManager

在JDBC4.0之前，开辟毗连数据库的时间，通常会用Class.forName("com.mysql.jdbc.Driver")这句先加载数据库相干的驱动，然后再举行获取毗连等的操作。而JDBC4.0之后不需要用Class.forName("com.mysql.jdbc.Driver")来加载驱动，直接获取毗连就可以了，原因就是现在使用了Java的SPI扩展机制来实现。

如上图所示：

• 首先在java中界说了接口 java.sql.Driver，并没有具体的实现，具体的实现都是由不同厂商来提供的。
  
• 在mysql的jar包mysql-connector-java-8.0.26.jar中，可以找到 META-INF/services 目录，该目录下会有一个名字为 java.sql.Driver 的文件，文件内容是com.mysql.cj.jdbc.Driver，这里面的内容就是mysql针对Java中界说的接口的实现。
  
• 同样在ojdbc的jar包ojdbc11.jar中，也可以找到同样的设置文件，文件内容是 oracle.jdbc.OracleDriver，这是oracle数据库对Java的java.sql.Driver的实现。
  

使用方法

而现在Java中写毗连数据库的代码的时间，不需要再使用Class.forName("com.mysql.jdbc.Driver")来加载驱动了，直接获取毗连就可以了：

1. String url = "jdbc:xxxx://xxxx:xxxx/xxxx";
2. Connection conn = DriverManager.getConnection(url, username, password);
3. .....

复制代码

这里并没有涉及到spi的使用，看下面源码。
源码实现

上面的使用方法，就是普通的毗连数据库的代码，实际上并没有涉及到 SPI 的东西，但是有一点可以确定的是，我们没有写有关具体驱动的硬编码Class.forName("com.mysql.jdbc.Driver")！
而上面的代码就可以直接获取数据库毗连举行操作，但是跟SPI有啥关系呢？
既然上面代码没有加载驱动的代码，那实际上是怎么去确定使用哪个数据库毗连的驱动呢？
这里就涉及到使用Java的SPI 扩展机制来查找相干驱动的东西了，关于驱动的查找其实都在DriverManager中，DriverManager是Java中的实现，用来获取数据库毗连，源码如下：

1. public class DriverManager {
3.     // 存放注册的jdbc驱动
4.     private final static CopyOnWriteArrayList<DriverInfo> registeredDrivers = new CopyOnWriteArrayList<>();
6.     /**
7.      * Load the initial JDBC drivers by checking the System property
8.      * jdbc.properties and then use the {@code ServiceLoader} mechanism
9.      */
10.     static {
11.         loadInitialDrivers();
12.         println("JDBC DriverManager initialized");
13.     }
14.    
15.     private static void loadInitialDrivers() {
16.         String drivers;
17.         try {
18.             // 从JVM -D参数读取jdbc驱动
19.             drivers = AccessController.doPrivileged(new PrivilegedAction<String>() {
20.                 public String run() {
21.                     return System.getProperty("jdbc.drivers");
22.                 }
23.             });
24.         } catch (Exception ex) {
25.             drivers = null;
26.         }
27.         // If the driver is packaged as a Service Provider, load it.
28.         // Get all the drivers through the classloader
29.         // exposed as a java.sql.Driver.class service.
30.         // ServiceLoader.load() replaces the sun.misc.Providers()
32.         AccessController.doPrivileged(new PrivilegedAction<Void>() {
33.             public Void run() {
35.                 ServiceLoader<Driver> loadedDrivers = ServiceLoader.load(Driver.class);
36.                 Iterator<Driver> driversIterator = loadedDrivers.iterator();
38.                 /* Load these drivers, so that they can be instantiated.
39.                  * It may be the case that the driver class may not be there
40.                  * i.e. there may be a packaged driver with the service class
41.                  * as implementation of java.sql.Driver but the actual class
42.                  * may be missing. In that case a java.util.ServiceConfigurationError
43.                  * will be thrown at runtime by the VM trying to locate
44.                  * and load the service.
45.                  *
46.                  * Adding a try catch block to catch those runtime errors
47.                  * if driver not available in classpath but it's
48.                  * packaged as service and that service is there in classpath.
49.                  */
50.                 try{
51.                     // 加载创建所有Driver
52.                     while(driversIterator.hasNext()) {
53.                         // 触发Driver的类加载->在静态代码块中创建Driver对象并放到DriverManager
54.                         driversIterator.next();
55.                     }
56.                 } catch(Throwable t) {
57.                 // Do nothing
58.                 }
59.                 return null;
60.             }
61.         });
63.         println("DriverManager.initialize: jdbc.drivers = " + drivers);
65.         if (drivers == null || drivers.equals("")) {
66.             return;
67.         }
68.         // 解析JVM参数的jdbc驱动
69.         String[] driversList = drivers.split(":");
70.         println("number of Drivers:" + driversList.length);
71.         for (String aDriver : driversList) {
72.             try {
73.                 println("DriverManager.Initialize: loading " + aDriver);
74.                 // initial为ture
75.                 // 触发Driver的类加载->在静态代码块中创建Driver对象并放到DriverManager
76.                 Class.forName(aDriver, true,
77.                         ClassLoader.getSystemClassLoader());
78.             } catch (Exception ex) {
79.                 println("DriverManager.Initialize: load failed: " + ex);
80.             }
81.         }
82.     }
84. }

复制代码

上面的代码重要步骤是：

• 从系统变量中获取有关驱动的界说。
  
• 使用SPI来获取驱动的实现。
  
• 遍历使用SPI获取到的具体实现，实例化各个实现类。
  
• 根据第一步获取到的驱动列表来实例化具体实现类。
  

• 第二步：使用SPI来获取驱动的实现，对应的代码是：
  

1. ServiceLoader<Driver> loadedDrivers = ServiceLoader.load(Driver.class);

复制代码

这里封装了接口类型和类加载器，并初始化了一个迭代器。

• 第三步：遍历获取到的具体实现，实例化各个实现类，对应的代码如下：
  

1. //获取迭代器
2. Iterator<Driver> driversIterator = loadedDrivers.iterator();
3. //遍历所有的驱动实现
4. while(driversIterator.hasNext()) {
5.     driversIterator.next();
6. }

复制代码

在遍历的时间，首先调用driversIterator.hasNext()方法，这里会搜索classpath下以及jar包中所有的META-INF/services目录下的java.sql.Driver文件，并找到文件中的实现类的名字，此时并没有实例化具体的实现类（ServiceLoader具体的源码实现在下面）。
然后是调用driversIterator.next();方法，此时就会根据驱动名字具体实例化各个实现类了。现在驱动就被找到并实例化了。
Common-Logging

common-logging（也称Jakarta Commons Logging，缩写 JCL）是常用的日志库门面， 使用了SPI的方式来动态加载和设置日志实现。这种机制答应库在运行时找到合适的日志实现，而无需硬编码具体的日志库。
我们看下它是怎么通过SPI解耦的。
首先，日志实例是通过LogFactory的getLog(String)方法创建的：

1. public static getLog(Class clazz) throws LogConfigurationException {
2.     return getFactory().getInstance(clazz);
3. }

复制代码

LogFatory是一个抽象类，它负责加载具体的日志实现，getFactory()方法源码如下：

1. public static org.apache.commons.logging.LogFactory getFactory() throws LogConfigurationException {
2.     // Identify the class loader we will be using
3.     ClassLoader contextClassLoader = getContextClassLoaderInternal();
5.     if (contextClassLoader == null) {
6.         // This is an odd enough situation to report about. This
7.         // output will be a nuisance on JDK1.1, as the system
8.         // classloader is null in that environment.
9.         if (isDiagnosticsEnabled()) {
10.             logDiagnostic("Context classloader is null.");
11.         }
12.     }
14.     // Return any previously registered factory for this class loader
15.     org.apache.commons.logging.LogFactory factory = getCachedFactory(contextClassLoader);
16.     if (factory != null) {
17.         return factory;
18.     }
20.     if (isDiagnosticsEnabled()) {
21.         logDiagnostic(
22.                 "[LOOKUP] LogFactory implementation requested for the first time for context classloader " +
23.                         objectId(contextClassLoader));
24.         logHierarchy("[LOOKUP] ", contextClassLoader);
25.     }
27.     // classpath根目录下寻找commons-logging.properties
28.     Properties props = getConfigurationFile(contextClassLoader, FACTORY_PROPERTIES);
30.     // Determine whether we will be using the thread context class loader to
31.     // load logging classes or not by checking the loaded properties file (if any).
32.     // classpath根目录下commons-logging.properties是否配置use_tccl
33.     ClassLoader baseClassLoader = contextClassLoader;
34.     if (props != null) {
35.         String useTCCLStr = props.getProperty(TCCL_KEY);
36.         if (useTCCLStr != null) {
37.             if (Boolean.valueOf(useTCCLStr).booleanValue() == false) {
38.                 baseClassLoader = thisClassLoader;
39.             }
40.         }
41.     }
43.     // 这里真正开始决定使用哪个factory
44.     // 首先，尝试查找vm系统属性org.apache.commons.logging.LogFactory，其是否指定factory
45.     if (isDiagnosticsEnabled()) {
46.         logDiagnostic("[LOOKUP] Looking for system property [" + FACTORY_PROPERTY +
47.                 "] to define the LogFactory subclass to use...");
48.     }
50.     try {
51.         String factoryClass = getSystemProperty(FACTORY_PROPERTY, null);
52.         if (factoryClass != null) {
53.             if (isDiagnosticsEnabled()) {
54.                 logDiagnostic("[LOOKUP] Creating an instance of LogFactory class '" + factoryClass +
55.                         "' as specified by system property " + FACTORY_PROPERTY);
56.             }
57.             factory = newFactory(factoryClass, baseClassLoader, contextClassLoader);
58.         } else {
59.             if (isDiagnosticsEnabled()) {
60.                 logDiagnostic("[LOOKUP] No system property [" + FACTORY_PROPERTY + "] defined.");
61.             }
62.         }
63.     } catch (SecurityException e) {
64.         if (isDiagnosticsEnabled()) {
65.             logDiagnostic("[LOOKUP] A security exception occurred while trying to create an" +
66.                     " instance of the custom factory class" + ": [" + trim(e.getMessage()) +
67.                     "]. Trying alternative implementations...");
68.         }
69.         // ignore
70.     } catch (RuntimeException e) {
71.         if (isDiagnosticsEnabled()) {
72.             logDiagnostic("[LOOKUP] An exception occurred while trying to create an" +
73.                     " instance of the custom factory class" + ": [" +
74.                     trim(e.getMessage()) +
75.                     "] as specified by a system property.");
76.         }
77.         throw e;
78.     }
80.     // 第二，尝试使用java spi服务发现机制，在META-INF/services下寻找org.apache.commons.logging.LogFactory实现
81.     if (factory == null) {
82.         if (isDiagnosticsEnabled()) {
83.             logDiagnostic("[LOOKUP] Looking for a resource file of name [" + SERVICE_ID +
84.                     "] to define the LogFactory subclass to use...");
85.         }
86.         try {
87.             // META-INF/services/org.apache.commons.logging.LogFactory, SERVICE_ID
88.             final InputStream is = getResourceAsStream(contextClassLoader, SERVICE_ID);
90.             if (is != null) {
91.                 // This code is needed by EBCDIC and other strange systems.
92.                 // It's a fix for bugs reported in xerces
93.                 BufferedReader rd;
94.                 try {
95.                     rd = new BufferedReader(new InputStreamReader(is, "UTF-8"));
96.                 } catch (java.io.UnsupportedEncodingException e) {
97.                     rd = new BufferedReader(new InputStreamReader(is));
98.                 }
100.                 String factoryClassName = rd.readLine();
101.                 rd.close();
103.                 if (factoryClassName != null && !"".equals(factoryClassName)) {
104.                     if (isDiagnosticsEnabled()) {
105.                         logDiagnostic("[LOOKUP]  Creating an instance of LogFactory class " +
106.                                 factoryClassName +
107.                                 " as specified by file '" + SERVICE_ID +
108.                                 "' which was present in the path of the context classloader.");
109.                     }
110.                     factory = newFactory(factoryClassName, baseClassLoader, contextClassLoader);
111.                 }
112.             } else {
113.                 // is == null
114.                 if (isDiagnosticsEnabled()) {
115.                     logDiagnostic("[LOOKUP] No resource file with name '" + SERVICE_ID + "' found.");
116.                 }
117.             }
118.         } catch (Exception ex) {
119.             // note: if the specified LogFactory class wasn't compatible with LogFactory
120.             // for some reason, a ClassCastException will be caught here, and attempts will
121.             // continue to find a compatible class.
122.             if (isDiagnosticsEnabled()) {
123.                 logDiagnostic(
124.                         "[LOOKUP] A security exception occurred while trying to create an" +
125.                                 " instance of the custom factory class" +
126.                                 ": [" + trim(ex.getMessage()) +
127.                                 "]. Trying alternative implementations...");
128.             }
129.             // ignore
130.         }
131.     }
133.     // 第三，尝试从classpath根目录下的commons-logging.properties中查找org.apache.commons.logging.LogFactory属性指定的factory
134.     if (factory == null) {
135.         if (props != null) {
136.             if (isDiagnosticsEnabled()) {
137.                 logDiagnostic(
138.                         "[LOOKUP] Looking in properties file for entry with key '" + FACTORY_PROPERTY +
139.                                 "' to define the LogFactory subclass to use...");
140.             }
141.             String factoryClass = props.getProperty(FACTORY_PROPERTY);
142.             if (factoryClass != null) {
143.                 if (isDiagnosticsEnabled()) {
144.                     logDiagnostic(
145.                             "[LOOKUP] Properties file specifies LogFactory subclass '" + factoryClass + "'");
146.                 }
147.                 factory = newFactory(factoryClass, baseClassLoader, contextClassLoader);
149.                 // TODO: think about whether we need to handle exceptions from newFactory
150.             } else {
151.                 if (isDiagnosticsEnabled()) {
152.                     logDiagnostic("[LOOKUP] Properties file has no entry specifying LogFactory subclass.");
153.                 }
154.             }
155.         } else {
156.             if (isDiagnosticsEnabled()) {
157.                 logDiagnostic("[LOOKUP] No properties file available to determine" + " LogFactory subclass from..");
158.             }
159.         }
160.     }
162.     // 最后，使用后备factory实现，org.apache.commons.logging.impl.LogFactoryImpl
163.     if (factory == null) {
164.         if (isDiagnosticsEnabled()) {
165.             logDiagnostic(
166.                     "[LOOKUP] Loading the default LogFactory implementation '" + FACTORY_DEFAULT +
167.                             "' via the same classloader that loaded this LogFactory" +
168.                             " class (ie not looking in the context classloader).");
169.         }
171.         factory = newFactory(FACTORY_DEFAULT, thisClassLoader, contextClassLoader);
172.     }
174.     if (factory != null) {
175.         cacheFactory(contextClassLoader, factory);
177.         if (props != null) {
178.             Enumeration names = props.propertyNames();
179.             while (names.hasMoreElements()) {
180.                 String name = (String) names.nextElement();
181.                 String value = props.getProperty(name);
182.                 factory.setAttribute(name, value);
183.             }
184.         }
185.     }
187.     return factory;
188. }

复制代码

可以看出，抽象类LogFactory加载具体实现的步骤如下：

• 从vm系统属性org.apache.commons.logging.LogFactory
  
• 使用SPI服务发现机制，发现org.apache.commons.logging.LogFactory的实现
  
• 查找classpath根目录commons-logging.properties的org.apache.commons.logging.LogFactory属性是否指定factory实现
  
• 使用默认factory实现，org.apache.commons.logging.impl.LogFactoryImpl
  

LogFactory的getLog()方法返回类型是org.apache.commons.logging.Log接口，提供了从trace到fatal方法。可以确定，假如日志实现提供者只要实现该接口，并且使用继承自org.apache.commons.logging.LogFactory的子类创建Log，一定可以构建一个松耦合的日志系统。
Spring中SPI机制

在springboot的自动装配过程中，终极会加载META-INF/spring.factories文件，重要通过以下几个步骤实现：

• 服务接口界说： Spring 界说了许多服务接口，如 org.springframework.boot.autoconfigure.EnableAutoConfiguration。
  
• 服务提供者实现： 各种具体的模块和库会提供这些服务接口的实现，如各种自动设置类。
  
• 服务描述文件： 在实现模块的 JAR 包中，会有一个 META-INF/spring.factories 文件，这个文件中列出了该 JAR 包中实现的自动设置类。
  
• 服务加载： Spring Boot 在启动时加载 spring.factories 文件，并实例化这些文件中列出的实现类。
  

Spring Boot 使用 SpringFactoriesLoader 来加载 spring.factories 文件中列出的所有类，并将它们注册到应用上下文中。需要注意的是，其实这里不仅仅是会去ClassPath路径下查找，会扫描所有路径下的Jar包，只不过这个文件只会在Classpath下的jar包中。

1. public static final String FACTORIES_RESOURCE_LOCATION = "META-INF/spring.factories";
2. // spring.factories文件的格式为：key=value1,value2,value3
3. // 从所有的jar包中找到META-INF/spring.factories文件
4. // 然后从文件中解析出key=factoryClass类名称的所有value值
5. public static List<String> loadFactoryNames(Class<?> factoryClass, ClassLoader classLoader) {
6.     String factoryClassName = factoryClass.getName();
7.     // 取得资源文件的URL
8.     Enumeration<URL> urls = (classLoader != null ? classLoader.getResources(FACTORIES_RESOURCE_LOCATION) : ClassLoader.getSystemResources(FACTORIES_RESOURCE_LOCATION));
9.     List<String> result = new ArrayList<String>();
10.     // 遍历所有的URL
11.     while (urls.hasMoreElements()) {
12.         URL url = urls.nextElement();
13.         // 根据资源文件URL解析properties文件，得到对应的一组@Configuration类
14.         Properties properties = PropertiesLoaderUtils.loadProperties(new UrlResource(url));
15.         String factoryClassNames = properties.getProperty(factoryClassName);
16.         // 组装数据，并返回
17.         result.addAll(Arrays.asList(StringUtils.commaDelimitedListToStringArray(factoryClassNames)));
18.     }
19.     return result;
20. }

复制代码

通过 SPI 机制和 spring.factories 文件的配合，Spring Boot 实现了模块化和自动设置的能力。开辟者可以通过界说自动设置类并在 spring.factories 文件中声明它们，从而实现模块的独立和松耦合。这种机制不仅简化了设置和启动过程，还提升了应用的可扩展性和维护性。
SPI 机制通常怎么使用

看完上面的几个例子解析，应该都能知道大概的流程了：

• 界说标准：界说标准，就是界说接口。比如接口java.sql.Driver
  
• 具体厂商大概框架开辟者实现：厂商大概框架开辟者开辟具体的实现：
  在META-INF/services目录下界说一个名字为接口全限定名的文件，比如java.sql.Driver文件，文件内容是具体的实现名字，比如me.cxis.sql.MyDriver。写具体的实现me.cxis.sql.MyDriver，都是对接口Driver的实现。
  
• 具体使用：引用具体厂商的jar包来实现我们的功能：
  

1. ServiceLoader<Driver> loadedDrivers = ServiceLoader.load(Driver.class);//获取迭代器Iterator driversIterator = loadedDrivers.iterator();//遍历while(driversIterator.hasNext()) {    driversIterator.next();    //可以做具体的业务逻辑}

复制代码

• 使用规范：
  

SPI机制实现原理

那么问题来了： 怎么样才气加载这些SPI接口的实现类呢，真正的原因是Java的类加载机制！ SPI接口属于java rt核心包，只能由启动类加载器BootStrap classLoader加载，而第三方jar包是用户classPath路径下，根据类加载器的可见性原则：启动类加载器无法加载这些jar包，也就是没法向下委托，所以spi必须冲破这种传统的双亲委派机制，通过自界说的类加载器来加载第三方jar包下的spi接口实现类！
JDK中ServiceLoader方法的具体实现：

1. //ServiceLoader实现了Iterable接口，可以遍历所有的服务实现者
2. public final class ServiceLoader<S> implements Iterable<S>{
4.     //查找配置文件的目录
5.     private static final String PREFIX = "META-INF/services/";
7.     //表示要被加载的服务的类或接口
8.     private final Class<S> service;
10.     //这个ClassLoader用来定位，加载，实例化服务提供者
11.     private final ClassLoader loader;
13.     // 访问控制上下文
14.     private final AccessControlContext acc;
16.     // 缓存已经被实例化的服务提供者，按照实例化的顺序存储
17.     private LinkedHashMap<String,S> providers = new LinkedHashMap<>();
19.     // 迭代器
20.     private LazyIterator lookupIterator;
22.     //重新加载，就相当于重新创建ServiceLoader了，用于新的服务提供者安装到正在运行的Java虚拟机中的情况。
23.     public void reload() {
24.         //清空缓存中所有已实例化的服务提供者
25.         providers.clear();
26.         //新建一个迭代器，该迭代器会从头查找和实例化服务提供者
27.         lookupIterator = new LazyIterator(service, loader);
28.     }
30.     //私有构造器
31.     //使用指定的类加载器和服务创建服务加载器
32.     //如果没有指定类加载器，使用系统类加载器，就是应用类加载器。
33.     private ServiceLoader(Class<S> svc, ClassLoader cl) {
34.         service = Objects.requireNonNull(svc, "Service interface cannot be null");
35.         loader = (cl == null) ? ClassLoader.getSystemClassLoader() : cl;
36.         acc = (System.getSecurityManager() != null) ? AccessController.getContext() : null;
37.         reload();
38.     }
40.     //解析失败处理的方法
41.     private static void fail(Class<?> service, String msg, Throwable cause)
42.         throws ServiceConfigurationError
43.     {
44.         throw new ServiceConfigurationError(service.getName() + ": " + msg,
45.                                             cause);
46.     }
48.     private static void fail(Class<?> service, String msg)
49.         throws ServiceConfigurationError
50.     {
51.         throw new ServiceConfigurationError(service.getName() + ": " + msg);
52.     }
54.     private static void fail(Class<?> service, URL u, int line, String msg)
55.         throws ServiceConfigurationError
56.     {
57.         fail(service, u + ":" + line + ": " + msg);
58.     }
60.     //解析服务提供者配置文件中的一行
61.     //首先去掉注释校验，然后保存
62.     //返回下一行行号
63.     //重复的配置项和已经被实例化的配置项不会被保存
64.     private int parseLine(Class<?> service, URL u, BufferedReader r, int lc, List<String> names)
65.                 throws IOException, ServiceConfigurationError{
66.         //读取一行
67.         String ln = r.readLine();
68.         if (ln == null) {
69.             return -1;
70.         }
71.         //#号代表注释行
72.         int ci = ln.indexOf('#');
73.         if (ci >= 0) ln = ln.substring(0, ci);
74.         ln = ln.trim();
75.         int n = ln.length();
76.         if (n != 0) {
77.             if ((ln.indexOf(' ') >= 0) || (ln.indexOf('\t') >= 0))
78.                 fail(service, u, lc, "Illegal configuration-file syntax");
79.             int cp = ln.codePointAt(0);
80.             if (!Character.isJavaIdentifierStart(cp))
81.                 fail(service, u, lc, "Illegal provider-class name: " + ln);
82.             for (int i = Character.charCount(cp); i < n; i += Character.charCount(cp)) {
83.                 cp = ln.codePointAt(i);
84.                 if (!Character.isJavaIdentifierPart(cp) && (cp != '.'))
85.                     fail(service, u, lc, "Illegal provider-class name: " + ln);
86.             }
87.             if (!providers.containsKey(ln) && !names.contains(ln))
88.                 names.add(ln);
89.         }
90.         return lc + 1;
91.     }
93.     //解析配置文件，解析指定的url配置文件
94.     //使用parseLine方法进行解析，未被实例化的服务提供者会被保存到缓存中去
95.     private Iterator<String> parse(Class<?> service, URL u) throws ServiceConfigurationError{
96.         InputStream in = null;
97.         BufferedReader r = null;
98.         ArrayList<String> names = new ArrayList<>();
99.         try {
100.             in = u.openStream();
101.             r = new BufferedReader(new InputStreamReader(in, "utf-8"));
102.             int lc = 1;
103.             while ((lc = parseLine(service, u, r, lc, names)) >= 0);
104.         }
105.         return names.iterator();
106.     }
108.     //服务提供者查找的迭代器
109.     private class LazyIterator implements Iterator<S>{
111.         Class<S> service;//服务提供者接口
112.         ClassLoader loader;//类加载器
113.         Enumeration<URL> configs = null;//保存实现类的url
114.         Iterator<String> pending = null;//保存实现类的全名
115.         String nextName = null;//迭代器中下一个实现类的全名
117.         private LazyIterator(Class<S> service, ClassLoader loader) {
118.             this.service = service;
119.             this.loader = loader;
120.         }
122.         private boolean hasNextService() {
123.             if (nextName != null) {
124.                 return true;
125.             }
126.             if (configs == null) {
127.                 try {
128.                     String fullName = PREFIX + service.getName();
129.                     if (loader == null)
130.                         configs = ClassLoader.getSystemResources(fullName);
131.                     else
132.                         configs = loader.getResources(fullName);
133.                 }
134.             }
135.             while ((pending == null) || !pending.hasNext()) {
136.                 if (!configs.hasMoreElements()) {
137.                     return false;
138.                 }
139.                 pending = parse(service, configs.nextElement());
140.             }
141.             nextName = pending.next();
142.             return true;
143.         }
145.         private S nextService() {
146.             if (!hasNextService())
147.                 throw new NoSuchElementException();
148.             String cn = nextName;
149.             nextName = null;
150.             Class<?> c = null;
151.             try {
152.                 c = Class.forName(cn, false, loader);
153.             }
154.             if (!service.isAssignableFrom(c)) {
155.                 fail(service, "Provider " + cn  + " not a subtype");
156.             }
157.             try {
158.                 S p = service.cast(c.newInstance());
159.                 providers.put(cn, p);
160.                 return p;
161.             }
162.         }
164.         public boolean hasNext() {
165.             if (acc == null) {
166.                 return hasNextService();
167.             } else {
168.                 PrivilegedAction<Boolean> action = new PrivilegedAction<Boolean>() {
169.                     public Boolean run() { return hasNextService(); }
170.                 };
171.                 return AccessController.doPrivileged(action, acc);
172.             }
173.         }
175.         public S next() {
176.             if (acc == null) {
177.                 return nextService();
178.             } else {
179.                 PrivilegedAction<S> action = new PrivilegedAction<S>() {
180.                     public S run() { return nextService(); }
181.                 };
182.                 return AccessController.doPrivileged(action, acc);
183.             }
184.         }
186.         public void remove() {
187.             throw new UnsupportedOperationException();
188.         }
190.     }
192.     //获取迭代器
193.     //返回遍历服务提供者的迭代器
194.     //以懒加载的方式加载可用的服务提供者
195.     //懒加载的实现是：解析配置文件和实例化服务提供者的工作由迭代器本身完成
196.     public Iterator<S> iterator() {
197.         return new Iterator<S>() {
198.             //按照实例化顺序返回已经缓存的服务提供者实例
199.             Iterator<Map.Entry<String,S>> knownProviders
200.                 = providers.entrySet().iterator();
202.             public boolean hasNext() {
203.                 if (knownProviders.hasNext())
204.                     return true;
205.                 return lookupIterator.hasNext();
206.             }
208.             public S next() {
209.                 if (knownProviders.hasNext())
210.                     return knownProviders.next().getValue();
211.                 return lookupIterator.next();
212.             }
214.             public void remove() {
215.                 throw new UnsupportedOperationException();
216.             }
218.         };
219.     }
221.     //为指定的服务使用指定的类加载器来创建一个ServiceLoader
222.     public static <S> ServiceLoader<S> load(Class<S> service, ClassLoader loader){
223.         return new ServiceLoader<>(service, loader);
224.     }
226.     //使用线程上下文的类加载器来创建ServiceLoader
227.     public static <S> ServiceLoader<S> load(Class<S> service) {
228.         ClassLoader cl = Thread.currentThread().getContextClassLoader();
229.         return ServiceLoader.load(service, cl);
230.     }
232.     //使用扩展类加载器为指定的服务创建ServiceLoader
233.     //只能找到并加载已经安装到当前Java虚拟机中的服务提供者，应用程序类路径中的服务提供者将被忽略
234.     public static <S> ServiceLoader<S> loadInstalled(Class<S> service) {
235.         ClassLoader cl = ClassLoader.getSystemClassLoader();
236.         ClassLoader prev = null;
237.         while (cl != null) {
238.             prev = cl;
239.             cl = cl.getParent();
240.         }
241.         return ServiceLoader.load(service, prev);
242.     }
244.     public String toString() {
245.         return "java.util.ServiceLoader[" + service.getName() + "]";
246.     }
248. }

复制代码

• 首先，ServiceLoader实现了Iterable接口，所以它有迭代器的属性，这里重要都是实现了迭代器的 hasNext 和 next 方法。这里重要都是调用的lookupIterator的相应hasNext和next方法，lookupIterator是懒加载迭代器。
  
• 其次，LazyIterator 中的 hasNext 方法，静态变量PREFIX就是”META-INF/services/”目录，这也就是为什么需要在classpath下的META-INF/services/目录里创建一个以服务接口命名的文件。
  
• 最后，通过反射方法Class.forName()加载类对象，并用newInstance方法将类实例化，并把实例化后的类缓存到providers对象中，(LinkedHashMap类型）然后返回实例对象。
  

所以可以看到ServiceLoader不是实例化以后，就去读取设置文件中的具体实现，并举行实例化。而是比及使用迭代器去遍历的时间，才会加载对应的设置文件去解析，调用hasNext方法的时间会去加载设置文件举行解析，调用next方法的时间举行实例化并缓存。
所有的设置文件只会加载一次，服务提供者也只会被实例化一次，重新加载设置文件可使用reload方法。
JDK SPI机制的缺陷

通过上面的解析，可以发现，我们使用SPI机制的缺陷：

• 获取某个实现类的方式不够灵活，只能通过 Iterator 情势获取，不能根据某个参数来获取对应的实现类。假如不想用某些实现类，大概某些类实例化很耗时，它也被载入并实例化了，这就造成了浪费。
  
• 多个并发多线程使用 ServiceLoader 类的实例是不安全的
  

关于作者

来自一线程序员Seven的探索与实践，持续学习迭代中~
本文已收录于我的个人博客：https://www.seven97.top
公众号：seven97，欢迎关注~

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。