Java SPI机制及Springboot的使用实例代码

目录

• 一、SPI是什么
• 二、使用场景
• 三、使用介绍
• 四、Springboot实例运用
• 总结

一、SPI是什么

SPI全称Service Provider Interface，是Java提供的一php套用来被第三方实现或者扩展的API，它可以用来启用框架扩展和替换组件。

整体机制图如下：

Java SPI 实际上是“基于接口的编程＋策略模式＋配置文件”组合实现的动态加载机制。

系统设计的各个抽象，往往有很多不同的实现方案，在面向的对象的设计里，一般推荐模块之间基于接口编程，模块之间不对实现类进行硬编码。一旦代码里涉及具体的实现类，就违反了可拔插的原则，如果需要替换一种实现，就需要修改代码。为了实现在模块装配的时候能不在程序里动态指明，这就需要一种服务发现机制。

Java SPIpython就是提供这样的一个机制：为某个接口寻找服务实现的机制。有点类似IOC的思想，就是将装配的控制权移到程序之外，在模块化设计中这个机制尤其重要。所以SPI的核心思想就是解耦。

二、使用场景

概括地说，适用于：调用者根据实际使用需要，启用、扩展、或者替换框架的实现策略

比较常见的例子：

• 数据库驱动加载接口实现类的加载：JDBC加载不同类型数据库的驱动
• 日志门面接口实现类加载：SLF4J加载不同提供商的日志实现类
• Spring：Spring中大量使www.devze.com用了SPI,比如：对servlet3.0规范对ServletContainerInitializer的实现、自动类型转换Type Conversion SPI(Converter SPI、Formatter SPI)等
• Dubbo：Dubbo中也大量使用SPI的方式实现框架的扩展, 不过它对Java提供的原生SPI做了封装，允许用户扩展实现Filter接口

三、使用介绍

要使用Java SPI，需要遵循如下约定：

1. 当服务提供者提供了接口的一种具体实现后，在jar包的META-INF/services目录下创建一个以“接口全限定名”为命名的文件，内容为实现类的全限定名；
2. 接口实现类所在的jar包放在主程序的classpath中；
3. 主程序通过java.util.ServiceLoder动态装载实现模块，它通过扫描META-INF/services目录下的配置文件找到实现类的全限定名，把类加载到JVM；
4. SPI的实现类必须携带一个不带参数的构造方法；

示例代码

• 步骤1：

定义一组接口 (假设是org.foo.demo.IShout)，并写出接口的一个或多个实现，(假设是org.foo.demo.animal.Dog、org.foo.demo.animal.Cat)。

public interface IShout {
    void shout();
}
public class Cat implements IShout {
    @Override
    public void shout() {
        System.out.println("miao miao");
    }
}
public class Dog implements IShout {
    @Override
    public void shout() {
        System.out.println("wang wang");
    }
}

• 步骤2：

在 src/main/resources/ 下建立 /META-INF/services 目录， 新增一个以接口命名的文件 (org.foo.demo.IShout文件)，内容是要应用的实现类（这里是org.foo.demo.animal.Dog和org.foo.demo.animal.Cat，每行一个类）。

- src
    -main
        -resources
            - META-INF
                - services
                    - org.foo.demo.IShout

文件内容

org.foo.demo.animal.Dog
org.foo.demo.animal.Cat

• 步骤3：

使用 ServiceLoader 来加载配置文件中指定的实现。

public class SPIMain {
    public static void main(String[] args) {
        ServiceLoader<IShout> shouts = ServiceLoader.load(IShout.class);
        for (IShout s : shouts) {
jCKoM            s.shout();
        }
    }
}
/**
* 此代码输出为：
* wang wang
* miao miao
*/

四、Springboot实例运用

Springboot相信很多人都用过，在spring-boot和spring-boot-autoconfigure这两个jar包javascript的META-INF/spring.factories路径下，保存的就是springboot使用SPI机制配置的属性，里面有sprignboot运行时需要读取的类，包括EnableAutoConfiguration等自动配置类，其部分关键配置如下：

# PropertySource Loaders
org.springframework.boot.env.PropertySourceLoader=\
org.springframework.boot.env.PropertiesPropertySourceLoader,\
org.springframework.boot.env.YamlPropertySourceLoader

# Application Listeners
org.springframework.context.ApplicationListener=\
org.springframework.boot.ClearCachesApplicationListener,\
org.springframework.boot.builder.ParentContextCloserApplicationListener,\
org.springframework.boot.context.FileEncodingApplicationListener,\
org.springframework.boot.context.config.AnsiOutputApplicationListener,\
org.springframework.boot.context.config.ConfigFileApplicationListener,\

在这里面配置了PropertySourceLoader和ApplicationListener等接口的具体实现类，然后通过SpringFactoriesLoader这个类去加载这个文件，并获得具体的类路径。

SpringFactoriesLoader其部分关键源码如下：

public final class SpringFactoriesLoader {
    // 加载器所需要加载的路径
    public static final String FACTORIES_RESOURCE_LOCATION = 
            "META-INF/spring.factories";
    private static Map<String, List<String>> loadSpringFactories(
            @Nullable ClassLoader classLoader) {
       MultiValueMap<String, String> result = cache.get(classLoader);
       if (result != null) {
          return result;
       }
       try {
           // 根据路径去录取各个包下的文件
          Enumeration<URL> urls = (classLoader != null ?
                classLoader.getResources(FACTORIES_RESOURCE_LOCATION) :
                ClassLoader.getSystemResources(FACTORIES_RESOURCE_LOCATION));
          result = new LinkedMultiValueMap<>();
          // 获取后进行循环遍历，因为不止一个包有spring.factories文件
          while (urls.hasMoreElements()) {
             URL url = urls.nextElement();
             UrlResource resource = new UrlResource(url);
             Properties properties = PropertiesLoaderUtils
                     .loadProperties(resource);
             // 获取到了key和value对应关系
             for (Map.Entry<?, ?> entry : properties.entrySet()) {
                String factoryClassName = ((String) entry.getKey()).trim();
                // 循环获取配置文件的value，并放进result集合中
                for (String factoryName : 
                        StringUtils
                                .commaDelimitedListToStringArray(
                                        (String) entry.getValue())) {
                   result.add(factoryClassName, factoryName.trim());
                }
             }
          }
          // 并缓存起来，以便后续直接获取
          cache.put(classLoader, result);
          return result;
       }
       catch (IOException ex) {
          ...
       }
    }
}

当开发者获取到这些key-value后，便可以直接使用Class.forName()方法获取Class对象，接着使用Class实例化便可以完成基于接口的编程＋策略模式＋配置文件这种搭配模式了。

总结

优点：

• 使用Java SPI机制的优势是实现解耦，使得第三方服务模块的装配控制的逻辑与调用者的业务代码分离，而不是耦合在一起。应用程序可以根据实际业务情况启用框架扩展或替换框架组件。

缺点：

• 虽然ServiceLoader也算是使用的延迟加载，但是基本只能通过遍历全部获取，也就是接口的实现类全部加载并实例化一遍。如果你并不想用某些实现类，它也被加载并实例化了，这就造成了浪费。获取某个实现类的方式不够灵活，只能通过Iterator形式获取，不能根据某个参数来获取对应的实现类。
• 多个并发多线程使用ServiceLoader类的实例是不安全的。

以上为个人经验，希望能给大家一个参考，也希望大家多多支持编程客栈(www.devze.com)。