从携程Apollo客户端源码学到的SPI知识(二)

知识点:SPI(Service Provider Interfaces)到底是啥玩意,简单一句话概括就是用来被第三方实现的 API。有点抽象,我们先仿照Apollo客户端写个简单例子吧

场景举例

假设有一个短信平台需要对接多家SMS渠道用来发送短信。当然这个场景不一定要用SPI机制来实现,毕竟条条大路通罗马。本案例只是用来介绍SPI的使用方式方法。

工程目录

fg-great-spi.png

fg-spi-sms-interface 是接口部分,提供了一个默认实现,fg-spi-sms-provider是自定义的一个实现

fg-spi-sms-interface

接口部分的代码结构如下,本模块假设为通用实现

fg-spi-sms-interface.png

我们首先提供一个短信发送的接口或者抽象类,下面我们新建一个接口如下:

package com.example.fg.sms;

/**
 * @author cattle -  稻草鸟人
 * @date 2020/4/23 下午12:49
 */
public interface MessageServiceProvider {

    /**
     *  发送短息
     * @param message 短信内容
     */
    void sendMessage(String message);

}

其次我们对这个接口做一个默认实现如下:

package com.example.fg.sms;

/**
 * @author cattle -  稻草鸟人
 * @date 2020/4/23 下午12:57
 */
public class DefaultMessageServiceProvider implements MessageServiceProvider {
    @Override
    public void sendMessage(String message) {
        System.out.println("default:::" + message);
    }
}

再次,我们在resources/META-INF/services目录下新建一个文件,名为com.example.fg.sms.MessageServiceProvider此名字和接口同名,内容为com.example.fg.sms.DefaultMessageServiceProvider是我们的默认实现

最后,我们就可以通过ServiceLoader.load。例如,通过如下代码实现执行我们默认方法实现的方法

package com.example.fg.sms;

import java.util.ServiceLoader;

/**
 * @author cattle -  稻草鸟人
 * @date 2020/4/23 下午12:52
 */
public class MessageServiceFactory {

    private ServiceLoader<MessageServiceProvider> serviceProviders = ServiceLoader.load(MessageServiceProvider.class);

    public void sendMessage(String message) {

        for (MessageServiceProvider serviceProvider : serviceProviders) {
            serviceProvider.sendMessage(message);
        }

    }
}

接口测试

package com.example.fg.sms;

import org.junit.jupiter.api.Test;

import static org.junit.jupiter.api.Assertions.*;

class MessageServiceFactoryTest {

    @Test
    void sendMessage() {
        MessageServiceFactory factory = new MessageServiceFactory();
        factory.sendMessage("hello spi");
    }
}

输出:

default:::hello spi

fg-spi-sms-provider

本模块是另外一个实现,用来模拟某供应商针对接口实现自己的短信发送方法。

fg-spi-sms-provider.png

接口实现

package com.example.fg.sms;

/**
 * @author cattle -  稻草鸟人
 * @date 2020/4/23 下午1:06
 */
public class MyMessageServiceProvider implements MessageServiceProvider {
    @Override
    public void sendMessage(String message) {
        System.out.println("MyMessage:::" + message);
    }
}

本模块我们依然要在resources/META-INF/services目录下新建一个名为com.example.fg.sms.MessageServiceProvider内容就是我们自己的实现,即com.example.fg.sms.MyMessageServiceProvider

接口测试

package com.example.fg.sms;

import org.junit.jupiter.api.Test;

class MessageServiceFactoryTest {

    @Test
    void sendMessage() {
        MessageServiceFactory factory = new MessageServiceFactory();
        factory.sendMessage("hello spi");
    }
}

输出:

MyMessage:::hello spi
default:::hello spi

其他SPI场景

目前开源的很多框架里面,如果大家仔细观察的话,SPI用到了非常多的地方,比如dubbo,motan,日志处理框架,还有JDBC Driver等等。

总结

经过上面的案例其实已经很清楚了,写一个接口,然后自己去实现,另外在resources/META-INF/services目录下新建一个文件夹,内容是具体的实现。然后通过ServiceLoader.load之后调用具体的实现。

思考

  1. 多个实现的情况下,如何只执行其中一种实现呢?比如MyMessageServiceProviderDefaultMessageServiceProvider两个实现只执行其中一个sendMessage方法

  2. apollo-client中对于SPI的具体应用,和我们当前的例子是否有差别呢?

源码

https://github.com/cattles/fucking-great-spi

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

推荐阅读更多精彩内容