Java 中的SPI 机制

水深无声 2021-11-29 23:16 271阅读 0赞

**目录**

1.SPI机制简介

2.SPI具体约定

3.应用场景

3.1.common-logging

3.2.jdbc

4.案例说明

--------------------

## 1.SPI机制简介 ##

SPI的全名为**Service Provider Interface**.大多数开发人员可能不熟悉，因为**这个是针对厂商或者插件**的。

在java.util.ServiceLoader的文档里有比较详细的介绍。简单的总结下java spi机制的思想。

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

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

## 2.SPI具体约定 ##

java spi的具体约定为:当服务的提供者，提供了服务接口的一种实现之后，在jar包的 **META-INF/services/**目录里同时创建一个以服务接口命名的文件。该文件里就是实现该服务接口的具体实现类。而当外部程序装配这个模块的时候，就能**通过该jar包META-INF/services/里的配置文件找到具体的实现类名，并装载实例化，完成模块的注入**。 基于这样一个约定就能很好的找到服务接口的实现类，而不需要再代码里制定。

jdk提供服务实现查找的一个工具类：java.util.ServiceLoader

## 3.应用场景 ##

### 3.1.common-logging ###

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

只要我们的日志实现里包含了这个文件，并在文件里制定 LogFactory工厂接口的实现类即可。

### 3.2.jdbc  ###

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

## 4.案例说明 ##

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

接口定义：

public interface Search {
        public List search(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

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

com.B.spi.impl.DatabaseSearch

public class SearchFactory {
    
        private SearchFactory(){
    
        }
    
        public static Search newSearch(){
            Search search = null;
            ServiceLoader<Search> serviceLoader = ServiceLoader.load(Search.class);
            Iterator<Search> iterator = serviceLoader.iterator();
            if(iterator.hasNext()){
                search = iterator.next();
            }
            return search;
        }
    }

public class SearchTest {
        public static void main(String[] args) {
            Search search = SearchFactory.newSearch();
            search.search("keyword");
        }
    }

可以看到，SPI 中最为核心的就是，接口定义是一方，接口的实现是第三方或者第四方。但是需要用到这个接口的是第一方，所以第一方在使用时，需要通过META-INF/services/\{接口定义的类名全称\}  这个文件中的定义去寻找。

--------------------

**转自：**

[Java 中的SPI机制][Java _SPI]

[Java _SPI]: https://blog.csdn.net/sigangjun/article/details/79071850