SPI框架实现之旅一:背景介绍

SPI框架实现之旅一:背景介绍

SPI的全名为Service Provider Interface,简单的总结下java spi机制的思想。我们系统里抽象的各个模块,往往有很多不同的实现方案,比如日志模块的方案,xml解析模块、jdbc模块的方案等。面向的对象的设计里,我们一般推荐模块之间基于接口编程,模块之间不对实现类进行硬编码。一旦代码里涉及具体的实现类,就违反了可拔插的原则,如果需要替换一种实现,就需要修改代码。为了实现在模块装配的时候能不在程序里动态指明,这就需要一种服务发现机制。 java spi就是提供这样的一个机制:为某个接口寻找服务实现的机制

1. 背景

上面摘抄了一下spi的概念,接着以个人的理解,简单的谈一下为什么会用到SPI, 什么场景下可以用到这个, 以及使用了SPI机制后有什么优越性

什么是SPI

虽然最开始就引用了spi的解释,这里浅谈一下个人理解。Service Provider Interface 以接口方式提供服务, 和API不同,spi的机制是定义一套标准规范的接口,实现交给其他人来做。

所以一个接口,可以有很多的实现,你完全可以根据自己的需要去选择具体的实现方式,因为是面向接口的开发,所以你的业务代码基本上就不用修改,就可以切到另一个实现了

什么场景可以用

分别从框架层面和业务层面,给出一个我认为比较合适的场景

1. 日志输出 SLF4j

SLF4j:大名鼎鼎的日志输出接口,这个jar包里面提供的都只是接口方式,具体的实现需要自己去实现,当然比较常用的 logback 就是一个具体的实现包了, 在项目中使用 slf4j 的api进行日志的输出, 通过简单的配置,引入logback, 就可以使用logback来实现具体的日志输出; 也可以换一个日志实现 commons-logging,业务上不需要任何的改动,就可以用不同的实现来输出日志

2. 业务场景

假设你现在有个用户注册成功后的欢迎用户的业务,不同渠道(微信,qq,微博等)注册的,显示的欢迎不同,对此有两种不同的实现方式

  • 如果每个不同的渠道进来的,都有一个独立的应用来响应 (因为绝大多数的业务都一样,可能就欢迎词不同,如果做到代码最大程度的复用)
  • 只有一个应用,来处理所有的这些场景

可以怎么用

结合上面的业务场景,来描述下可以怎么用

1. 代码复用

为了实现代码最大程度的复用,那么可以将不同的地方,抽象成一个SPI接口,在业务层通过接口来代替具体的实现类实现业务逻辑;

每个渠道,都有个独立的应用,那么在微信渠道,创建一个 WeixinSpiImpl来实现接口

在qq渠道,实现 QQSpiImpl;那么在具体的接口调用处,实际上就是执行的spi实现类方法

2. 业务场景的选择区分

这个与上面不同,同一个服务接口,根据不同的业务场景,选择不同的实现来执行;当然你是完全可以使用 if, else来实现这种场景,唯一的问题就是扩展比较麻烦;

这种场景下,我们希望的就是这个接口,能自动的根据业务场景,来选择最合适的实现类来执行

简单来讲,就是�spi接口执行之前,其实需要有一个自动选择匹配的实现类的前置过程;

通常这种业务场景下,具体的spi实现会有多个,但是需要有一个选择的策略


2. 小目标

在具体的实现之前,先定义一个小目标,我们想要实现一个什么样子的东西出来

通过上面的背景描述,我们的小目标也就很明确了,我们的实现至少需要满足两个场景

  1. 静态选择SPI实现, 即在选择完成之后,所有对这个spi接口的引用都是确定由这个实现来承包
  2. 动态选择SPI实现, 不到运行之时,你都不知道会是哪个spi实现来干这件事

3. 技术储备

java本身就提供了一套spi的支持方式: ServiceLoader,我们后续的开发,也会在这个基础之上进行

利用java的 ServiceLoader 找到服务接口的实现类,有一些约定,下面给出要求说明和一个测试case

一般实现流程

  • 定义spi接口 : IXxx
  • 具体的实现类: AXxx, BXxx
  • 在jar包的META-INF/services/目录下新建一个文件,命名为 spi接口的完整类名,内容为spi接口实现的完整类名,一个实现类占一行

测试case如下

spi接口 com.hust.hui.quicksilver.commons.spi.HelloInterface

package com.hust.hui.quicksilver.commons.spi;

/**
 * Created by yihui on 2017/3/17.
 */
public interface HelloInterface {

    void sayHello();

}

spi接口的两个实现类

com.hust.hui.quicksilver.commons.spi.impl.ImageHello.java

package com.hust.hui.quicksilver.commons.spi.impl;

import com.hust.hui.quicksilver.commons.spi.HelloInterface;

/**
 * Created by yihui on 2017/3/17.
 */
public class ImageHello implements HelloInterface {
    @Override
    public void sayHello() {
        System.out.println("image hello!");
    }
}

com.hust.hui.quicksilver.commons.spi.impl.TextHello.java

package com.hust.hui.quicksilver.commons.spi.impl;

import com.hust.hui.quicksilver.commons.spi.HelloInterface;

/**
 * Created by yihui on 2017/3/17.
 */
public class TextHello implements HelloInterface {
    @Override
    public void sayHello() {
        System.out.println("text hello");
    }
}

配置文件 com.hust.hui.quicksilver.commons.spi.HelloInterface

com.hust.hui.quicksilver.commons.spi.impl.ImageHello
com.hust.hui.quicksilver.commons.spi.impl.TextHello

测试类

public class HelloSpiTest {

    @Test
    public void testSPI() {
        ServiceLoader<HelloInterface> serviceLoader = ServiceLoader.load(HelloInterface.class);

        for (HelloInterface hello: serviceLoader) {
            hello.sayHello();
        }
    }
}

输出如下:

image hello!
text hello

测试类演示如下图:

演示图
演示图

4. 设计思路

画了一下结构图,方便理解, 下面的核心是 SpiLoader 类, 负责加载spi接口的所有实现类, 初始化所有定义的选择器, 返回一个spi接口的实现类初始化用户自定义的spi对象,然后用户持有此对象调用spi接口中提供的方法即可

https://static.oschina.net/uploads/img/201705/26185143_ULnL.png

5. 其他

博客系列链接:

源码地址:
https://git.oschina.net/liuyueyi/quicksilver/tree/master/silver-spi

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,497评论 18 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,085评论 25 707
  • SPI框架实现之旅二:整体设计 上一篇简单的说了一下spi相关的东西, 接下来我们准备开动,本篇博文主要集中在一些...
    一灰灰blog阅读 1,467评论 0 5
  • 我一向喜欢熙熙攘攘的街道。 街道上永远穿行着密密麻麻的人群,混着各种叫卖声,还有宣传的喇叭声,仿佛这一切...
    凌裳阅读 354评论 2 5
  • 在图书馆无意打开自己大二时期写的文章,不禁感概万分,现在已是大三学婶的我还是孤身一人,还是会遇到很多不顺与麻...
    八月的小狮子_阅读 457评论 0 2