java spi的使用

最新推荐文章于 2024-05-22 13:34:31 发布

后端工程狮

最新推荐文章于 2024-05-22 13:34:31 发布

阅读量1.4k

点赞数 1

分类专栏： java知识文章标签： java 开发语言

本文链接：https://blog.csdn.net/qq_49662572/article/details/128435720

版权

java知识专栏收录该内容

3 篇文章 0 订阅

订阅专栏

什么是SPI

SPI（Service Provider Interface），是JDK内置的一种服务提供发现机制，可以用来启用框架扩展和替换组件，主要是被框架的开发人员使用，比如java.sql.Driver接口，其他不同厂商可以针对同一接口做出不同的实现，MySQL和PostgreSQL都有不同的实现提供给用户，而Java的SPI机制可以为某个接口寻找服务实现类（这个服务实现类往往不在当前项目（当前接口所在）的Jar包中（接口与实现类不在一个JAR包（项目）中），而在其他独立的Jar包中，所以就需要一套机制帮我们去寻找这个服务实现类了，JAVA的SPI可以做到）。Java中SPI机制主要思想是可以将装配的控制权(服务的实现类)移到当前程序之外（放到其他程序（jar）中），在模块化设计中这个机制尤其重要，其核心思想就是解耦。

ServiceLoader 加载的是classpath下所有jar包的META-INF/services目录下的配置文件（利用迭代器去完成的）

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

ServiceLoader 加载的是classpath下所有jar包的META-INF/services目录下的配置文件（利用迭代器去完成的）

JDK SPI机制的简单示例

我们现在需要使用一个内容搜索接口，搜索的实现可能是基于文件系统的搜索，也可能是基于数据库的搜索。

1 先定义好接口

public interface Search {
    public List<String> searchDoc(String keyword);   
}

2 写实现类

文件搜索实现

public class FileSearch implements Search{
    @Override
    public List<String> searchDoc(String keyword) {
        System.out.println("文件搜索 "+keyword);
        return null;
    }
}

数据库搜索实现

public class DatabaseSearch implements Search{
    @Override
    public List<String> searchDoc(String keyword) {
        System.out.println("数据搜索 "+keyword);
        return null;
    }
}

3 根据接口全限定名新建配置文件在META-INF/services/目录下

如

配置文件中的内容就是服务实现类的全限定名

4 测试

public class test {




    public static void main(String[] args) {
        ServiceLoader<Search> s = ServiceLoader.load(Search.class);
        Iterator<Search> iterator = s.iterator();
        while (iterator.hasNext()) {
            Search search =  iterator.next();
            search.searchDoc("hello world");
        }
    }
}


//打印结果
数据搜索 hello world
文件搜索 hello world

SPI机制的应用

SPI自测项目

可以参考 spi-common-interface,spi-wxpayimpl spi-alipayimpl,spi-maintest这四个项目

SPI机制1 - JDBC DriverManager（使用JDK原生的SPI）

在JDBC4.0之前，我们开发有连接数据库的时候，通常会用Class.forName("com.mysql.jdbc.Driver")这句先加载数据库相关的驱动，然后再进行获取连接等的操作。而JDBC4.0之后不需要用Class.forName("com.mysql.jdbc.Driver")来加载驱动，直接获取连接就可以了，现在这种方式就是使用了Java的SPI扩展机制来实现。

JDBC接口定义

首先在java中定义了接口java.sql.Driver，并没有具体的实现，具体的实现都是由不同厂商来提供的。

mysql实现

在mysql的jar包mysql-connector-java-6.0.6.jar中，可以找到META-INF/services目录，该目录下会有一个名字为java.sql.Driver的文件，文件内容是com.mysql.cj.jdbc.Driver，这里面的内容就是针对Java中定义的接口的实现。

postgresql实现

同样在postgresql的jar包postgresql-42.0.0.jar中，可以找到META-INF/services目录也可以找到同样的配置文件java.sql.Driver ，文件内容是org.postgresql.Driver，这是postgresql对Java的java.sql.Driver的实现

使用方法

上面说了，现在使用SPI扩展来加载具体的驱动，我们在Java中写连接数据库的代码的时候，不需要再使用Class.forName("com.mysql.jdbc.Driver")来加载驱动了，而是直接使用如下代码：

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

这里并没有涉及到spi的使用，接着看下面的解析。

源码实现

上面的使用方法，就是我们普通的连接数据库的代码，并没有涉及到SPI的东西，但是有一点我们可以确定的是，我们没有写有关具体驱动的硬编码Class.forName("com.mysql.jdbc.Driver")！

上面的代码可以直接获取数据库连接进行操作，但是跟SPI有啥关系呢？上面代码没有了加载驱动的代码，我们怎么去确定使用哪个数据库连接的驱动呢？这里就涉及到使用Java的SPI扩展机制来查找相关驱动的东西了，关于驱动的查找其实都在DriverManager中，DriverManager是Java中的实现，用来获取数据库连接，在DriverManager中有一个静态代码块如下：

static {
    loadInitialDrivers();
    println("JDBC DriverManager initialized");
}

可以看到是加载实例化驱动的，接着看loadInitialDrivers方法：

private static void loadInitialDrivers() {
    String drivers;
    try {
        drivers = AccessController.doPrivileged(new PrivilegedAction<String>() {
            public String run() {
                return System.getProperty("jdbc.drivers");
            }
        });
    } catch (Exception ex) {
        drivers = null;
    }


    AccessController.doPrivileged(new PrivilegedAction<Void>() {
        public Void run() {
			//使用SPI的ServiceLoader来加载接口的实现
            ServiceLoader<Driver> loadedDrivers = ServiceLoader.load(Driver.class);
            Iterator<Driver> driversIterator = loadedDrivers.iterator();
            try{
                while(driversIterator.hasNext()) {
                    driversIterator.next();
                }
            } catch(Throwable t) {
            // Do nothing
            }
            return null;
        }
    });


    println("DriverManager.initialize: jdbc.drivers = " + drivers);


    if (drivers == null || drivers.equals("")) {
        return;
    }
    String[] driversList = drivers.split(":");
    println("number of Drivers:" + driversList.length);
    for (String aDriver : driversList) {
        try {
            println("DriverManager.Initialize: loading " + aDriver);
            Class.forName(aDriver, true,
                    ClassLoader.getSystemClassLoader());
        } catch (Exception ex) {
            println("DriverManager.Initialize: load failed: " + ex);
        }
    }
}

上面的代码主要步骤是：

从系统变量中获取有关驱动的定义。

使用SPI来获取驱动的实现。

遍历使用SPI获取到的具体实现，实例化各个实现类。

根据第一步获取到的驱动列表来实例化具体实现类。

我们主要关注2,3步，这两步是SPI的用法，首先看第二步，使用SPI来获取驱动的实现，对应的代码是：

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

这里没有去META-INF/services目录下查找配置文件，也没有加载具体实现类，做的事情就是封装了我们的接口类型和类加载器，并初始化了一个迭代器。

接着看第三步，获取迭代器并且迭代器遍历使用SPI获取到的具体服务实现类并实例化各个实现类，对应的代码如下：

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

在遍历的时候，首先调用driversIterator.hasNext()方法，这里会搜索classpath下以及classpath下所有jar包中所有的META-INF/services目录下的java.sql.Driver文件，并找到文件中的实现类的名字，此时并没有实例化具体的实现类

然后是调用driversIterator.next();方法，此时就会根据驱动名字（实现类名称）具体实例化各个实现类了。现在驱动就被找到并实例化了。

可以看下截图，我在测试项目中添加了两个jar包，mysql-connector-java-6.0.6.jar和postgresql-42.0.0.0.jar，跟踪到DriverManager中之后：

可以看到此时迭代器中有两个驱动，mysql和postgresql的都被加载了

Spring的SPI

JDK有内置的SPI机制的实现ServiceLoader，Dubbo也有自己的SPI机制的实现ExtensionLoader，但是这里我们都不讲。。

这里我们着重讲一下Spring的SPI机制的实现SpringFactoriesLoader。

SpringFactoriesLoader

Spring的SPI机制规定，配置文件必须在classpath路径下的META-INF文件夹内，文件名必须为spring.factories，文件内容为键值对，一个键可以有多个值，只需要用逗号分割就行，同时键和值都需要是类的全限定名。但是键和值可以没有任何关系，当然想有也可以有。

看一个示例

1 这里我自定义2个类，MyEnableAutoConfiguration作为键，值就是User类

public class MyEnableAutoConfiguration {
}

@Getter
@Setter
public class User implements BeanNameAware {
    public String name;
    public Integer age;
}

2 spring.factories文件

com.sanyou.spring.extension.spi.MyEnableAutoConfiguration=com.sanyou.spring.extension.User

3 然后放在META-INF底下

4测试：

public class Application {


    public static void main(String[] args) {
        List<String> classNames =
//SpringFactoriesLoader.loadFactoryNames方法需要的参数
//是spring.factories文件中键的Class對象，和ClassLoader
 SpringFactoriesLoader.loadFactoryNames(MyEnableAutoConfiguration.class, MyEnableAutoConfiguration.class.getClassLoader());
        classNames.forEach(System.out::println);
    }


}

结果：

com.sanyou.spring.extension.User

可以看出，通过SpringFactoriesLoader的确可以从spring.factories文件中拿到MyEnableAutoConfiguration键对应的值。

到这你可能说会，这SPI机制也没啥用啊。的确，我这个例子比较简单，拿到就是遍历，但是在Spring中，如果Spring在加载类的话使用SPI机制，那我们就可以扩展，接着往下看。

SPI机制2 - SpringBoot中SPI机制的使用(Springboot自动装配的灵魂)

【JavaSPI机制你真的懂吗？来看看动画版通俗易懂SPI机制讲解-哔哩哔哩】 JavaSPI机制你真的懂吗？来看看动画版通俗易懂SPI机制讲解_哔哩哔哩_bilibili

【java spi思想是springboot的灵魂，掌握了程序的灵魂才能年薪百万-哔哩哔哩】 java spi思想是springboot的灵魂，掌握了程序的灵魂才能年薪百万_哔哩哔哩_bilibili

什么是自动装配

就是Springboot项目启动时，会去从所有jar包中的spring.factories文件中读取@EnableAutoConfiguration键对应的值，这些值就是需要被加载到Spring中的bean（bean的全限定名）---实际上这些Bean一般就是一些配置类，这些配置类加载到Spring中去了之后，就可以根据一些条件判断，决定哪些配置可以使用，哪些不能使用。

其实自动装配就是spring自动帮你把所需要的Bean对象进行装配加载到spring容器中。

自动装配的目的

（（把依赖的框架下的一些类的Bean交给Spring框架管理））（或者说把一些指定的类型bean交给Spring框架管理）

Springboot默认扫描的包是启动类所在的包及其下属子包，但是在Springboot项目中往往会依赖于其他框架，如MybatisPlus,如果此时我们需要把（依赖的框架）MybatisPlus中的bean交给到Spring管理，由于其他框架的类所在的包，不在Springboot启动类的包下，故就不能使用包扫描的方式把Bean交给Spring框架去管理，而且这个过程要尽可能的解耦，为了解决这个问题，Springboot的自动装配就参考了JDK SPI的思想，使用Spring的Spi 在项目启动的时候扫描classpath下所有jar包META-INF下的spring.factories文件，把这些spring.factories文件中类名所对应的类交给Spring去管理，这就很体现了SPI的扩展性和解耦的优点（SPI为很多框架的扩展提供了可能）（实现了框架的bean装配的可插拔，加了这个就可以被装配，不加这个就不会被装配）

可以参考 spi-common-interface,spi-wxpayimpl spi-alipayimpl,spi-maintest这四个项目

Springboot的自动装配过程中（把依赖的框架下的一些类的Bean交给Spring框架管理）,最终会加载的配置文件是META-INF下的spring.factories文件，而加载的过程是由SpringFactoriesLoader加载的。从CLASSPATH下的每个Jar包中搜寻所有META-INF/spring.factories配置文件，然后每个配置文件都将解析成properties文件，然后找到properties里面所有的类名（即要加载到Spring框架中类的类名）。需要注意的是，其实这里不仅仅是会去ClassPath路径下查找，会扫描所有路径下的Jar包，只不过这个文件只会在Classpath下的jar包中。（虽然不是接口-实现类的模式，但是实际利用的也是SPI的思想）

public static final String FACTORIES_RESOURCE_LOCATION = "META-INF/spring.factories";
// spring.factories文件的格式为：key=value1,value2,value3
// 从所有的jar包中找到META-INF/spring.factories文件
// 然后从文件中解析出key=factoryClass类名称的所有value值
//factoryClass参数，表示key(键)的class对象，
public static List<String> loadFactoryNames(Class<?> factoryClass, ClassLoader classLoader) {
    String factoryClassName = factoryClass.getName();
    // 取得资源文件的URL
    Enumeration<URL> urls = (classLoader != null ? classLoader.getResources(FACTORIES_RESOURCE_LOCATION) : ClassLoader.getSystemResources(FACTORIES_RESOURCE_LOCATION));
    List<String> result = new ArrayList<String>();
    // 遍历所有的URL
    while (urls.hasMoreElements()) {
        URL url = urls.nextElement();
        // 根据资源文件URL解析properties文件，得到对应的一组@Configuration类
        Properties properties = PropertiesLoaderUtils.loadProperties(new UrlResource(url));
        String factoryClassNames = properties.getProperty(factoryClassName);
    // 组装数据，并返回（找到properties中里面所有的类名）即要加载到Spring框架中类的类名
        result.addAll(Arrays.asList(StringUtils.commaDelimitedListToStringArray(factoryClassNames)));
    }
    return result;
}

SpringBoot自动装配的核心流程

1 @EnableAutoConfiguration注解--即SpringBoot自动装配的键

@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {
    //忽略
}

我们可以看到这个注解被@Import注解修饰，而@Import注解导入的类AutoConfigurationImportSelector实现了ImportSelector接口，这样的话我们就知道在AutoConfigurationImportSelector类中会将一批bean加载到Spring框架中

在SpringBoot中，@EnableAutoConfiguration是通过@SpringBootApplication来使用的。即@EnableAutoConfiguration注解修饰了@SpringBootApplication注解

2 AutoConfigurationImportSelector

在AutoConfigurationImportSelector中有这样一段代码

可以看到它利用了Spring的SPI机制去配置文件中找到所有EnableAutoConfiguration键对应的值，这个值就是需要被自动装配（加载）到Spring中bean的全限定名

在配置文件中找到所有EnableAutoConfiguration键对应的值后（这个值就是需要被自动装配（加载）到Spring中bean的全限定名）利用ImportSelector接口的selectImports方法就可以把这些Bean交给Spring框架管理了

AutoConfigurationImportSelector 的部分源码（核心部分都挑出来了）

public class AutoConfigurationImportSelector implements DeferredImportSelector, BeanClassLoaderAware,
      ResourceLoaderAware, BeanFactoryAware, EnvironmentAware, Ordered {
   private static final AutoConfigurationEntry EMPTY_ENTRY = new AutoConfigurationEntry();
   private static final String[] NO_IMPORTS = {};
   private static final Log logger = LogFactory.getLog(AutoConfigurationImportSelector.class);
   private static final String PROPERTY_NAME_AUTOCONFIGURE_EXCLUDE = "spring.autoconfigure.exclude";
   private ConfigurableListableBeanFactory beanFactory;
   private Environment environment;
   private ClassLoader beanClassLoader;
   private ResourceLoader resourceLoader;
   private ConfigurationClassFilter configurationClassFilter;
   


   @Override
   public String[] selectImports(AnnotationMetadata annotationMetadata) {
      if (!isEnabled(annotationMetadata)) {
         return NO_IMPORTS;
      }
      AutoConfigurationEntry autoConfigurationEntry = getAutoConfigurationEntry(annotationMetadata);
      return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());
   }
    
   protected AutoConfigurationEntry getAutoConfigurationEntry(AnnotationMetadata annotationMetadata) {
   if (!isEnabled(annotationMetadata)) {
      return EMPTY_ENTRY;
   }
   AnnotationAttributes attributes = getAttributes(annotationMetadata);
   List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes);
   configurations = removeDuplicates(configurations);
   Set<String> exclusions = getExclusions(annotationMetadata, attributes);
   checkExcludedClasses(configurations, exclusions);
   configurations.removeAll(exclusions);
   configurations = getConfigurationClassFilter().filter(configurations);
   fireAutoConfigurationImportEvents(configurations, exclusions);
   return new AutoConfigurationEntry(configurations, exclusions);
}


protected List<String> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) {
   List<String> configurations = SpringFactoriesLoader.loadFactoryNames(getSpringFactoriesLoaderFactoryClass(),
         getBeanClassLoader());
   Assert.notEmpty(configurations, "No auto configuration classes found in META-INF/spring.factories. If you "
         + "are using a custom packaging, make sure that file is correct.");
   return configurations;
}




protected Class<?> getSpringFactoriesLoaderFactoryClass() {
   return EnableAutoConfiguration.class;
}
   
......部分源碼

我们如何利用Springboot自动装配自己加载一个类到Spring中

第一步，写个配置类：（定义需要被加载到Spring中的类）

public class UserAutoConfiguration {


    @Bean
    public UserFactoryBean userFactoryBean() {
        return new UserFactoryBean();
    }


}

public class UserFactoryBean implements FactoryBean<User> {


    @Override
    public User getObject() throws Exception {
        User user = new User();
        System.out.println("调用 UserFactoryBean 的 getObject 方法生成 Bean:" + user);
        return user;
    }


    @Override
    public Class<?> getObjectType() {
        // 这个 FactoryBean 返回的Bean的类型
        return User.class;
    }


}

第二步，往spring.factories文件配置一下键值对

注意SpringBoot自动装配在spring.factories文件的中键一定是 @EnableAutoConfiguration

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.sanyou.spring.extension.springbootextension.UserAutoConfiguration

到这就已经实现了自动装配的扩展。

开始测试

接下来进行测试：

@SpringBootApplication
public class Application {


    public static void main(String[] args) {
        ConfigurableApplicationContext applicationContext = SpringApplication.run(Application.class);


        User user = applicationContext.getBean(User.class);


        System.out.println("获取到的Bean为" + user);
    }


}

运行结果：

调用 UserFactoryBean 的 getObject 方法生成 Bean:com.sanyou.spring.extension.User@3406472c
获取到的Bean为com.sanyou.spring.extension.User@3406472c

结果总结

从运行结果可以看出，自动装配起了作用，并且虽然往容器中注入的Bean的class类型为UserFactoryBean，但是最终会调用UserFactoryBean的getObject的实现User对象注入到Spring中。故UserFactoryBean和User 这个两个Bean都会被加载到Spring中

自动装配机制是SpringBoot的一个很重要的扩展点，很多框架在整合SpringBoot的时候，也都通过自动装配来的，实现项目启动，这些框架的配置类就自动被加载到Spring中。相当于项目启动，这些框架也会跟着自动启动的

这里我举个Mybatis和dubbo整合SpringBoot中。如下

Springboot自动装配示例1-加载dubbo的的自动配置类到Spring中來

Springboot自动装配示例2-加载Mybatis的的自动配置类到Spring中來

SPI机制3 -SLF4J

SPI机制4 -Dubbo

面试常问的dubbo的spi机制到底是什么？（上） (qq.com)

面试常问的dubbo的spi机制到底是什么？（下） (qq.com)

SPI机制深入理解

SPI机制通常怎么使用

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

有关组织或者公司定义标准。
具体厂商或者框架开发者实现具体的标准（接口的实现）。
程序猿使用。

定义标准

定义标准，就是定义接口。比如接口java.sql.Driver

具体厂商或者框架开发者实现具体的标准

厂商或者框架开发者开发具体的实现：

在META-INF/services目录下定义一个名字为接口全限定名的文件，比如java.sql.Driver文件，文件内容是具体实现类名字，比如me.cxis.sql.MyDriver。

写具体的实现me.cxis.sql.MyDriver，都是对接口Driver的实现。

使用

我们会引用具体厂商的jar包来实现我们的功能：

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

如下

public class test {




    public static void main(String[] args) {
        ServiceLoader<Search> s = ServiceLoader.load(Search.class);
        Iterator<Search> iterator = s.iterator();
        while (iterator.hasNext()) {
            Search search =  iterator.next();
            search.searchDoc("hello world");
        }
    }
}


//打印结果
数据搜索 hello world
文件搜索 hello world

使用规范

最后总结一下jdk spi需要遵循的规范

SPI和API的区别是什么

这里实际包含两个问题，第一个SPI和API的区别？第二个什么时候用API，什么时候用SPI？

SPI - 的“接口”位于“调用方”所在的“包”中

概念上更依赖调用方。
接口组织上位于调用方所在的包中。（如Driver接口在JDK下）
接口的实现类位于往往位于独立的jar包中。 （而Driver接口的实现类在各个厂商独立的JAR包中）

常见的例子是：插件模式的插件。

（如Driver接口在JDK下，而Driver接口的实现类在各个厂商独立的JAR包中，

API - 的接口”位于“实现方”所在的“包”中

概念上更接近实现方。
组织上位于实现方所在的包中。
接口的实现类和接口在一个jar包中。

JDK SPI机制实现原理（重要）

不妨看下JDK中ServiceLoader<S>方法的具体实现：

//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;




    //重新加载，就相当于重新创建ServiceLoader了，用于新的服务提供者安装到正在运行的Java虚拟机中的情况。
    public void reload() {
        //清空缓存中所有已实例化的服务提供者
        providers.clear();
        //新建一个迭代器，该迭代器会从头查找和实例化服务提供者
        lookupIterator = new LazyIterator(service, loader);
    }


    //私有构造器
    //使用指定的类加载器和服务创建服务加载器
    //如果没有指定类加载器，使用系统类加载器，就是应用类加载器。
    private ServiceLoader(Class<S> svc, ClassLoader cl) {
        service = Objects.requireNonNull(svc, "Service interface cannot be null");
        loader = (cl == null) ? ClassLoader.getSystemClassLoader() : cl;
        acc = (System.getSecurityManager() != null) ? AccessController.getContext() : null;
        reload();
    }


    //解析失败处理的方法
    private static void fail(Class<?> service, String msg, Throwable cause)
        throws ServiceConfigurationError
    {
        throw new ServiceConfigurationError(service.getName() + ": " + msg,
                                            cause);
    }


    private static void fail(Class<?> service, String msg)
        throws ServiceConfigurationError
    {
        throw new ServiceConfigurationError(service.getName() + ": " + msg);
    }


    private static void fail(Class<?> service, URL u, int line, String msg)
        throws ServiceConfigurationError
    {
        fail(service, u + ":" + line + ": " + msg);
    }


    //解析服务提供者配置文件中的一行
    //首先去掉注释校验，然后保存
    //返回下一行行号
    //重复的配置项和已经被实例化的配置项不会被保存
    private int parseLine(Class<?> service, URL u, BufferedReader r, int lc,
                          List<String> names)
        throws IOException, ServiceConfigurationError
    {
        //读取一行
        String ln = r.readLine();
        if (ln == null) {
            return -1;
        }
        //#号代表注释行
        int ci = ln.indexOf('#');
        if (ci >= 0) ln = ln.substring(0, ci);
        ln = ln.trim();
        int n = ln.length();
        if (n != 0) {
            if ((ln.indexOf(' ') >= 0) || (ln.indexOf('\t') >= 0))
                fail(service, u, lc, "Illegal configuration-file syntax");
            int cp = ln.codePointAt(0);
            if (!Character.isJavaIdentifierStart(cp))
                fail(service, u, lc, "Illegal provider-class name: " + ln);
            for (int i = Character.charCount(cp); i < n; i += Character.charCount(cp)) {
                cp = ln.codePointAt(i);
                if (!Character.isJavaIdentifierPart(cp) && (cp != '.'))
                    fail(service, u, lc, "Illegal provider-class name: " + ln);
            }
            if (!providers.containsKey(ln) && !names.contains(ln))
                names.add(ln);
        }
        return lc + 1;
    }


    //解析配置文件，解析指定的url配置文件
    //使用parseLine方法进行解析，未被实例化的服务提供者会被保存到缓存中去
    private Iterator<String> parse(Class<?> service, URL u)
        throws ServiceConfigurationError
    {
        InputStream in = null;
        BufferedReader r = null;
        ArrayList<String> names = new ArrayList<>();
        try {
            in = u.openStream();
            r = new BufferedReader(new InputStreamReader(in, "utf-8"));
            int lc = 1;
            while ((lc = parseLine(service, u, r, lc, names)) >= 0);
        }
        return names.iterator();
    }


    //服务提供者查找的迭代器
    private class LazyIterator
        implements Iterator<S>
    {


        Class<S> service;//服务提供者接口
        ClassLoader loader;//类加载器
        Enumeration<URL> configs = null;//保存实现类的url
        Iterator<String> pending = null;//保存实现类的全名
        String nextName = null;//迭代器中下一个实现类的全名


        private LazyIterator(Class<S> service, ClassLoader loader) {
            this.service = service;
            this.loader = loader;
        }


  private boolean hasNextService() {
       if (this.nextName != null) {
          return true;
       } else {
          if (this.configs == null) {
              try {
                String var1 = "META-INF/services/" + this.service.getName();
                if (this.loader == null) {
                //获取实现类的url
                    this.configs = ClassLoader.getSystemResources(var1);
                } else {
                    this.configs = this.loader.getResources(var1);
                }
            } catch (IOException var2) {
                ServiceLoader.fail(this.service, "Error locating configuration files", var2);
            }
        }


        while(this.pending == null || !this.pending.hasNext()) {
            if (!this.configs.hasMoreElements()) {
                return false;
            }
          //解析配置文件中写的实现类的全限定名
            this.pending = ServiceLoader.this.parse(this.service, (URL)this.configs.nextElement());
        }


        this.nextName = (String)this.pending.next();
        return true;
    }




  private S nextService() {
    if (!this.hasNextService()) {
        throw new NoSuchElementException();
    } else {
        String var1 = this.nextName;
        this.nextName = null;
        Class var2 = null;


        try {
        //根据实现类的全限定名获取实现类的Class对象
            var2 = Class.forName(var1, false, this.loader);
        } catch (ClassNotFoundException var5) {
            ServiceLoader.fail(this.service, "Provider " + var1 + " not found");
        }


        if (!this.service.isAssignableFrom(var2)) {
            ServiceLoader.fail(this.service, "Provider " + var1 + " not a subtype");
        }


        try {
        //根据实现类的Class对象创建该实现类的对象（即实例化该实现类）
            Object var3 = this.service.cast(var2.newInstance());
            ServiceLoader.this.providers.put(var1, var3);
            return var3;
        } catch (Throwable var4) {
            ServiceLoader.fail(this.service, "Provider " + var1 + " could not be instantiated", var4);
            throw new Error();
        }
    }
}


        public boolean hasNext() {
            if (acc == null) {
                return hasNextService();
            } else {
                PrivilegedAction<Boolean> action = new PrivilegedAction<Boolean>() {
                    public Boolean run() { return hasNextService(); }
                };
                return AccessController.doPrivileged(action, acc);
            }
        }


        public S next() {
            if (acc == null) {
                return nextService();
            } else {
                PrivilegedAction<S> action = new PrivilegedAction<S>() {
                    public S run() { return nextService(); }
                };
                return AccessController.doPrivileged(action, acc);
            }
        }


        public void remove() {
            throw new UnsupportedOperationException();
        }


    }


    //获取迭代器
    //返回遍历服务提供者的迭代器
    //以懒加载的方式加载可用的服务提供者
    //懒加载的实现是：解析配置文件和实例化服务提供者的工作由迭代器本身完成
    public Iterator<S> iterator() {
        return new Iterator<S>() {
            //按照实例化顺序返回已经缓存的服务提供者实例
            Iterator<Map.Entry<String,S>> knownProviders
                = providers.entrySet().iterator();


         //第一次调用的我们容易知道knownProviders没有值，则调用lookupIterator.hasNext()
           //第二次调用的时候就有值了直接返回true
             public boolean hasNext() {
                if (knownProviders.hasNext())
                    return true;
                return lookupIterator.hasNext();
            }


            public S next() {
                if (knownProviders.hasNext())
                    return knownProviders.next().getValue();
                return lookupIterator.next();
            }


            public void remove() {
                throw new UnsupportedOperationException();
            }


        };
    }


    //为指定的服务使用指定的类加载器来创建一个ServiceLoader
    public static <S> ServiceLoader<S> load(Class<S> service,
                                            ClassLoader loader)
    {
        return new ServiceLoader<>(service, loader);
    }


    //使用线程上下文的类加载器来创建ServiceLoader
    public static <S> ServiceLoader<S> load(Class<S> service) {
        ClassLoader cl = Thread.currentThread().getContextClassLoader();
        return ServiceLoader.load(service, cl);
    }


    //使用扩展类加载器为指定的服务创建ServiceLoader
    //只能找到并加载已经安装到当前Java虚拟机中的服务提供者，应用程序类路径中的服务提供者将被忽略
    public static <S> ServiceLoader<S> loadInstalled(Class<S> service) {
        ClassLoader cl = ClassLoader.getSystemClassLoader();
        ClassLoader prev = null;
        while (cl != null) {
            prev = cl;
            cl = cl.getParent();
        }
        return ServiceLoader.load(service, prev);
    }


    public String toString() {
        return "java.util.ServiceLoader[" + service.getName() + "]";
    }


}

详解：

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

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

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

所以我们可以看到ServiceLoader不是实例化以后，就去读取配置文件中的具体实现，并进行实例化。而是等到使用迭代器去遍历的时候，才会加载对应的配置文件去解析，调用hasNext方法的时候会去加载配置文件进行解析出里面的实现类的全限定名，调用next方法的时候把实现类进行实例化并缓存。

ServiceLoader<Search> s = ServiceLoader.load(Search.class);
        Iterator<Search> iterator = s.iterator();
        while (iterator.hasNext()) {
            Search search =  iterator.next();
            search.searchDoc("hello world");
        }

ServiceLoader<Search> s = ServiceLoader.load(Search.class);

这个方法的作用，这里没有去META-INF/services目录下查找配置文件，也没有加载具体实现类，做的事情就是封装了我们的接口类型和类加载器，并初始化了一个迭代器。

iterator.hasNext()方法的是迭代器中的方法，用于检测集合中是否还有元素，但是在这里它还有别的作用，就是去读取META-INF/services目录下的指定配置文件，并把配置文件中的实现类的全限定名都读出来

    //获取迭代器
    //返回遍历服务提供者的迭代器
    //以懒加载的方式加载可用的服务提供者
    //懒加载的实现是：解析配置文件和实例化服务提供者的工作由迭代器本身完成
    public Iterator<S> iterator() {
        return new Iterator<S>() {
            //按照实例化顺序返回已经缓存的服务提供者实例
            Iterator<Map.Entry<String,S>> knownProviders
                = providers.entrySet().iterator();


         //第一次调用的我们容易知道knownProviders没有值，则调用lookupIterator.hasNext()
           //第二次调用的时候就有值了直接返回true
public boolean hasNext() {
 return this.knownProviders.hasNext() ? true : ServiceLoader.this.lookupIterator.hasNext();
}


            public S next() {
                if (knownProviders.hasNext())
                    return knownProviders.next().getValue();
                return lookupIterator.next();
            }


            public void remove() {
                throw new UnsupportedOperationException();
            }


        };
    }

lookupIterator.hasNext()方法调用的是(lookupIterator是懒加载迭代器)中的hasNext方法

其实就是ServiceLoader中有一个内部类的LazyIterator的hasNext方法

public boolean hasNext() {
    if (ServiceLoader.this.acc == null) {
        return this.hasNextService();
    } else {
        PrivilegedAction var1 = new PrivilegedAction<Boolean>() {
            public Boolean run() {
                return LazyIterator.this.hasNextService();
            }
        };
        return (Boolean)AccessController.doPrivileged(var1, ServiceLoader.this.acc);
    }
}

之后调用这个LazyIterator（lookupIterator）的hasNextService方法

这个方法中就是去读取META-INF/services目录下的指定配置文件，并把配置文件中的实现类的全限定名都读出来

private boolean hasNextService() {
    if (this.nextName != null) {
        return true;
    } else {
        if (this.configs == null) {
            try {
                String var1 = "META-INF/services/" + this.service.getName();
                if (this.loader == null) {
                //获取实现类的url
                    this.configs = ClassLoader.getSystemResources(var1);
                } else {
                    this.configs = this.loader.getResources(var1);
                }
            } catch (IOException var2) {
                ServiceLoader.fail(this.service, "Error locating configuration files", var2);
            }
        }


        while(this.pending == null || !this.pending.hasNext()) {
            if (!this.configs.hasMoreElements()) {
                return false;
            }
          //解析配置文件中写的实现类的全限定名
            this.pending = ServiceLoader.this.parse(this.service, (URL)this.configs.nextElement());
        }


        this.nextName = (String)this.pending.next();
        return true;
    }
}

iterator.next();的作用，会返回迭代器的下一个元素此外在这里还有一个作用就是调用LazyIterator下的next()方法

  //获取迭代器
    //返回遍历服务提供者的迭代器
    //以懒加载的方式加载可用的服务提供者
    //懒加载的实现是：解析配置文件和实例化服务提供者的工作由迭代器本身完成
    public Iterator<S> iterator() {
        return new Iterator<S>() {
            //按照实例化顺序返回已经缓存的服务提供者实例
            Iterator<Map.Entry<String,S>> knownProviders
                = providers.entrySet().iterator();


      
   public boolean hasNext() {
 return this.knownProviders.hasNext() ? true : ServiceLoader.this.lookupIterator.hasNext();
}
       //第一次会调用lookupIterator（LazyIterator）的next()方法
            public S next() {
                if (knownProviders.hasNext())
                    return knownProviders.next().getValue();
                return lookupIterator.next();
            }


            public void remove() {
                throw new UnsupportedOperationException();
            }


        };
    }

LazyIterator（lookupIterator）下的next()方法的核心就是调用LazyIterator（lookupIterator）下的nextService方法

public S next() {
    if (ServiceLoader.this.acc == null) {
        return this.nextService();
    } else {
        PrivilegedAction var1 = new PrivilegedAction<S>() {
            public S run() {
                return LazyIterator.this.nextService();
            }
        };
        return AccessController.doPrivileged(var1, ServiceLoader.this.acc);
    }
}

LazyIterator（lookupIterator）下的nextService方法的主要作用就是根据实现类的全限定名获取实现类的Class对象然后根据实现类的Class对象创建该实现类的对象（即实例化该实现类）

private S nextService() {
    if (!this.hasNextService()) {
        throw new NoSuchElementException();
    } else {
        String var1 = this.nextName;
        this.nextName = null;
        Class var2 = null;


        try {
        //根据实现类的全限定名获取实现类的Class对象
            var2 = Class.forName(var1, false, this.loader);
        } catch (ClassNotFoundException var5) {
            ServiceLoader.fail(this.service, "Provider " + var1 + " not found");
        }


        if (!this.service.isAssignableFrom(var2)) {
            ServiceLoader.fail(this.service, "Provider " + var1 + " not a subtype");
        }


        try {
        //根据实现类的Class对象创建该实现类的对象（即实例化该实现类）
            Object var3 = this.service.cast(var2.newInstance());
            ServiceLoader.this.providers.put(var1, var3);
            return var3;
        } catch (Throwable var4) {
            ServiceLoader.fail(this.service, "Provider " + var1 + " could not be instantiated", var4);
            throw new Error();
        }
    }
}

SPI机制的缺陷

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

不能按需加载，需要遍历classpath下所有jar包的META-INF/services/下的指定配置文件的下所有的实现类，并实例化，然后在循环中才能找到我们需要的实现。如果不想用某些实现类，或者某些类实例化很耗时，它也被载入并实例化了，这就造成了浪费。

获取某个实现类的方式不够灵活，只能通过 Iterator 形式获取，不能根据某个参数来获取对应的实现类。

多个并发多线程使用 ServiceLoader 类的实例是不安全的。

后端工程狮

关注

1
点赞
踩
4

收藏

觉得还不错? 一键收藏
0
评论
java spi的使用

SPI（Service Provider Interface），是JDK内置的一种服务提供发现机制，可以用来启用框架扩展和替换组件，主要是被框架的开发人员使用，比如java.sql.Driver接口，其他不同厂商可以针对同一接口做出不同的实现，MySQL和PostgreSQL都有不同的实现提供给用户，而Java的SPI机制可以为某个接口寻找服务实现类（这个服务实现类往往不在当前项目（当前接口所在）的Jar包中（接口与实现类不在一个JAR包（项目）中
复制链接

扫一扫

专栏目录