Java 中的 SPI 机制是什么鬼？高级 Java 必须掌握！

作者：sigangjun

blog.csdn.net/sigangjun/article/details/79071850

SPI的全名为：Service Provider Interface，大多数开发人员可能不熟悉，因为这个是针对厂商或者插件的。在java.util.ServiceLoader的文档里有比较详细的介绍。 

简单的总结下 Java  SPI 机制的思想。我们系统里抽象的各个模块，往往有很多不同的实现方案，比如日志模块的方案，xml解析模块、jdbc模块的方案等。面向的对象的设计里，我们一般推荐模块之间基于接口编程，模块之间不对实现类进行硬编码。

一旦代码里涉及具体的实现类，就违反了可拔插的原则，如果需要替换一种实现，就需要修改代码。为了实现在模块装配的时候能不在程序里动态指明，这就需要一种服务发现机制。

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

Java  SPI 的具体约定为:当服务的提供者，提供了服务接口的一种实现之后，在jar包的META-INF/services/目录里同时创建一个以服务接口命名的文件。该文件里就是实现该服务接口的具体实现类。

而当外部程序装配这个模块的时候，就能通过该jar包META-INF/services/里的配置文件找到具体的实现类名，并装载实例化，完成模块的注入。 

基于这样一个约定就能很好的找到服务接口的实现类，而不需要再代码里制定。jdk提供服务实现查找的一个工具类：java.util.ServiceLoader。

1.common-logging   

apache最早提供的日志的门面接口。只有接口，没有实现。具体方案由各提供商实现， 发现日志提供商是通过扫描 META-INF/services/org.apache.commons.logging.LogFactory配置文件，通过读取该文件的内容找到日志提工商实现类。

只要我们的日志实现里包含了这个文件，并在文件里制定 LogFactory工厂接口的实现类即可。关注Java技术栈微信公众号，在后台回复关键字：Java，可以获取更多栈长整理的Java技术干货。

2.jdbc   

 jdbc4.0以前， 开发人员还需要基于Class.forName("xxx")的方式来装载驱动，jdbc4也基于spi的机制来发现驱动提供商了，可以通过META-INF/services/java.sql.Driver文件里指定实现类的方式来暴露驱动提供者。

一个内容管理系统有一个搜索模块。是基于接口编程的。搜索的实现可能是基于文件系统的搜索，也可能是基于数据库的搜索

接口定义如下：

package my.xyz.spi; import java.util.List; public interface Search {    public List serch(String keyword); }
import java.util.List; 
public interface Search { 
  public List serch(String keyword); 
}

A公司采用文件系统搜索的方式实现了 Search接口，B公司采用了数据库系统的方式实现了Search接口。

• A公司实现的类：com.A.spi.impl.FileSearch  

• B公司实现的类：com.B.spi.impl.DatabaseSearch  

那么A公司发布 实现jar包时，则要在jar包中META-INF/services/my.xyz.spi.Search文件中写下如下内容：

com.A.spi.impl.FileSearch.A.spi.impl.FileSearch

那么B公司发布 实现jar包时，则要在jar包中META-INF/services/my.xyz.spi.Search文件中写下如下内容：

com.B.spi.impl.DatabaseSearch.B.spi.impl.DatabaseSearch

下面是 SPI 测试代码：

package com.xyz.factory; import java.util.Iterator; import java.util.ServiceLoader; import my.xyz.spi.Search; public class SearchFactory {    private SearchFactory() {   }    public static Search newSearch() {     Search search = null;     ServiceLoader<Search> serviceLoader = ServiceLoader.load(Search.class);     Iterator<Search> searchs = serviceLoader.iterator();      if (searchs.hasNext()) {       search = searchs.next();     }     return search;   } }
import java.util.Iterator; 
import java.util.ServiceLoader; 
import my.xyz.spi.Search; 
public class SearchFactory { 
  private SearchFactory() { 
  } 
  public static Search newSearch() { 
    Search search = null; 
    ServiceLoader<Search> serviceLoader = ServiceLoader.load(Search.class); 
    Iterator<Search> searchs = serviceLoader.iterator(); 
    if (searchs.hasNext()) { 
      search = searchs.next(); 
    } 
    return search; 
  } 
}

关注Java技术栈微信公众号，在后台回复关键字：Java，可以获取更多栈长整理的Java技术干货。

最近干货分享

Spring Cloud Gateway VS Zuul 怎么选择？

46张PPT弄懂JVM、GC算法和性能调优！

数据库怎么分库分表，垂直？水平？

Zookeeper怎么实现分布式锁？

分享一份Java架构师学习资料

一个人学习、工作很迷茫？

点击「阅读原文」加入栈长的小圈子！