浅析java的SPI机制

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 应用场景

1.common-logging
apache最早提供的日志的门面接口。只有接口，没有实现。详细方案由各提供商实现， 发嫡志提供商是通过扫描 META-INF/services/org.apache.commons.logging.LogFactory设置文件，通过读取该文件的内容找到日志提工商实现类。只要我们的日志实现里包括了这个文件，并在文件里拟定 LogFactory工场接口的实现类即可。

2.jdbc

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

4 案例说明

一个内容打点系统有一个搜索模块。是基于接口编程的。搜索的实现大概是基于文件系统的搜索，也大概是基于数据库的搜索

接口界说如下

package my.xyz.spi;  
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

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

com.B.spi.impl.DatabaseSearch

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

package my.xyz.test;  
import java.util.Iterator;  
import java.util.ServiceLoader;  
import com.xyz.factory.SearchFactory;  
import my.xyz.spi.Search;  
public class SearchTest {  
    public static void main(String[] args) {  
        Search search = SearchFactory.newSearch();  
        search.serch("java spi test");  
    }  
}