Java SPI提供的可插拔特性

面向接口编程的设计中,我们在使用一个service时,通常是从接口的层面来使用,通俗的说,即声明service实例时使用接口名来声明,而非使用具体实现。这么做的原因是我们的代码不会依赖具体实现(依赖的是接口),后期具体实现的修改或者替换,对既有代码的影响相对比较小,如果是使用Spring IOC来注入,基本上不需要修改调用方的代码;如果调用方是new ServiceImpl()的方式引入对象,只修改这一行即可创建为新的实现类即可。好处不言而喻。

如果我们的project因为某些变更,需要替换掉某个外部的jar包,该怎么约束这个变更来减少影响呢。

因为面向接口编程的原则如此重要,所以在引用外部jar的service,一样也采用了这个原则。通过接口的约束,我们同样能够在替换jar的时候,只需要变动很少的代码来拥抱变化。继续使用容器的依赖注入帮我们注入实现类,或者手动修改service的创建逻辑。但是这样,似乎并不优雅。

于是有了SPI的机制,即service provider interface。这个不是什么新鲜的东西,只是面向接口编程的一个约束,主要用在module之间(比如jar的引用),它通过读配置文件来获取某个接口的实现类,然后使用。说白了就是通过一个配置文件来解耦接口和具体实现(无论是jar之间的接口--实现还是jar内部的接口--实现,都可以通过这个方式解耦)。透明地实现的具体实现的切换,达到插件的效果,即插即用,不插没有。

看一下SPI的使用规范。

  • 配置文件:在实现类所在module的根目录(classpath)下面的META-INF/services目录下,创建一个文件,以接口全限定类名作为文件名,接口实现类的全限定类名作为文件的内容,每个实现类名占一行,注意文件编码必须是UTF-8
  • 查找逻辑:使用jdk的ServiceLoader.load(xxx.class)方法查找对应接口的provider实现。注意这个查找是可以跨jar包的。

SPI的常见使用有:

  • 数据库驱动加载
  • 日志门面实现类的选用
  • Spring MVC利用Servlet 3.0的SPI机制启动容器,参考这篇

SPI示例

module结构

三个module,一个接口门面searchfacede,一个provider实现simplesearch,还有一个是调用方spidemo。

  • searchfacede,此module中只有一个接口demo.spi.facede.SearchService
  • simplesearch,此module依赖searchfacede,并且提供了实现类,定义了spi配置文件
  • spidemo,依赖上面两个module,提供SPI查找SearchService的实现,并使用。
  1. searchfacede中
public interface SearchService {
    String search(String name);
}
  1. simplesearch中
import demo.spi.facede.SearchService;

public class SimpleSearchService implements SearchService{
    @Override
    public String search(String name) {
        return name + " from " + this.getClass().getSimpleName();
    }
}

SPI配置文件:maven工程结构下
文件:resources/META-INF/services/demo.spi.facede.SearchService
内容:spi.provider.SimpleSearchService

  1. spidemo
import demo.spi.facede.SearchService;

public class Main {

    public static void main(String[] args) {
        ServiceLoader<SearchService> serviceServiceLoader = ServiceLoader.load(SearchService.class);
        for (Iterator<SearchService> iterator = serviceServiceLoader.iterator(); iterator.hasNext(); ) {
            SearchService next = iterator.next();
            System.out.println(next);
            System.out.println(next.search("a"));
        }
    }
}
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,214评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,307评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,543评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,221评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,224评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,007评论 1 284
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,313评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,956评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,441评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,925评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,018评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,685评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,234评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,240评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,464评论 1 261
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,467评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,762评论 2 345

推荐阅读更多精彩内容

  • 【译者按】作为软件研发项目的项目经理,只懂项目管理知识是不够的,需要对软件技术本身有基本的了解。Java 是一种主...
    黄军雷阅读 3,046评论 1 15
  • SPI简介 如何使用SPI 应用举例1. 组织方制定接口2. 实现方根据SPI规范实现接口3. 组织方加载实现类 ...
    齐晋阅读 896评论 0 5
  • 作者:成 富, 软件工程师, IBM 中国软件开发中心 类加载器(class loader)是 Java™中的一个...
    Android技术研究阅读 3,900评论 0 74
  • 本文通过探析JDK提供的,在开源项目中比较常用的Java SPI机制,希望给大家在实际开发实践、学习开源项目提供参...
    caison阅读 125,462评论 25 156
  • 刚看了一篇文章,讲陪伴肝癌母亲的两年抗癌经历。 文字并没有多煽情,我看得泪流不止。。。。。 泪水模糊了我的视线,溢...
    燕子聊家常阅读 179评论 0 3