简单工厂、java spi、dubbo spi

前言:在日常的代码中,我们经常使用简单工厂来生成,某个接口不同实现的实例,但是其实还是有替代方案来完成,比如java SPI和dubbo SPI

1.java SPI

例子其实烂大街了,代码可参见dubbo 官方文档,拿来主义见https://github.com/somewaters/java_case
贴下关键代码,可以看到,java spi的核心类即ServiceLoader

@Test
    public void testJavaSPI(){
        ServiceLoader<Robot> serviceLoader = ServiceLoader.load(Robot.class);
        Iterator<Robot> it =  serviceLoader.iterator();
        while(it.hasNext()){
            Robot robot = it.next();
            robot.sayHello();
        }
    }

大眼一看,ServiceLoader做了两个动作,一个是load,一个是遍历。看下源码,在这两个动作中,究竟发生了什么呢?

public final class ServiceLoader<S> implements Iterable<S> {
    private static final String PREFIX = "META-INF/services/";
    private Class<S> service;
    private ClassLoader loader;
    private LinkedHashMap<String, S> providers = new LinkedHashMap();
    private ServiceLoader<S>.LazyIterator lookupIterator;

    public static <S> ServiceLoader<S> load(Class<S> var0) {
        ClassLoader var1 = Thread.currentThread().getContextClassLoader();
        return load(var0, var1);
    }

首先,这个类实现了Iterable,那么后续自然可以看下其遍历相关的方法。
其次,这个类主要有五个属性
1.PREFIX ,这个值眼熟吧,就是spi文件的路径(jdk 1.8类里面用到路径的时候还是写的magic String)
2.Class<S> service ,一个泛型Class属性
3.ClassLoader loader,一个类加载器
4.LinkedHashMap<String, S> providers 一个map
5.一个自定义LazyIterator

回到开头两个动作的问题,load()做了什么?load利用构造函数实例化了一个ServiceLoader对象,且初始化了上述2,3,5三个属性,关键代码见下

public void reload() {
        this.providers.clear();
        this.lookupIterator = new ServiceLoader.LazyIterator(this.service, this.loader);
    }

    private ServiceLoader(Class<S> var1, ClassLoader var2) {
        this.service = (Class)Objects.requireNonNull(var1, "Service interface cannot be null");
        this.loader = var2 == null ? ClassLoader.getSystemClassLoader() : var2;
        this.reload();
    }

那么遍历的时候做了什么呢?
主要做了三件事,1.加载类文件2.生成实例3.将实例放入providers MAP中。

public S next() {
            if (!this.hasNext()) {
                throw new NoSuchElementException();
            } else {
                String var1 = this.nextName;
                this.nextName = null;
                Class var2 = null;

                try {//@setp1,根据全限定名加载某一个实现类
                    var2 = Class.forName(var1, false, this.loader);
                } catch (ClassNotFoundException var5) {
                    ServiceLoader.fail(this.service, "Provider " + var1 + " not found");
                }

                if (!this.service.isAssignableFrom(var2)) {
                    ServiceLoader.fail(this.service, "Provider " + var1 + " not a subtype");
                }

                try {
                    //@setp2,调用类的newInstance方法生成一个实例
                    Object var3 = this.service.cast(var2.newInstance());
                   //@setp3,将生成的实例放入MAP providers 中
                    ServiceLoader.this.providers.put(var1, var3);
                    return var3;
                } catch (Throwable var4) {
                    ServiceLoader.fail(this.service, "Provider " + var1 + " could not be instantiated: " + var4, var4);
                    throw new Error();
                }
            }
        }

放入providers MAP中做什么呢?其实ServiceLoader暴露给用户的接口,主要就在操作这个MAP来获取相应的service实现。

2.dubbo SPI

同样贴下关键代码,可以看到关键类为ExtensionLoader,核心操作也有两个
1.getExtensionLoader
2.getExtension

@Test
    public void testDubboSPI(){
        ExtensionLoader<Robot> extensionLoader = ExtensionLoader.getExtensionLoader(Robot.class);
        Robot robot = extensionLoader.getExtension("bumblebee");
        robot.sayHello();
    }

ExtensionLoader的属性是相对比较多的,我只贴一下关键的几个,前面几个路径,可以对比java spi的相关路径,就知道是做什么用的了。主要关注一下两个ConcurrentMap EXTENSION_LOADERS和EXTENSION_INSTANCES ,看结构,一个是存ExtensionLoader本身,一个是用来存实例。

 private static final Logger logger = LoggerFactory.getLogger(ExtensionLoader.class);
    private static final String SERVICES_DIRECTORY = "META-INF/services/";
    private static final String DUBBO_DIRECTORY = "META-INF/dubbo/";
    private static final String DUBBO_INTERNAL_DIRECTORY = "META-INF/dubbo/internal/";
    private static final Pattern NAME_SEPARATOR = Pattern.compile("\\s*[,]+\\s*");
    private static final ConcurrentMap<Class<?>, ExtensionLoader<?>> EXTENSION_LOADERS = new ConcurrentHashMap();
    private static final ConcurrentMap<Class<?>, Object> EXTENSION_INSTANCES = new ConcurrentHashMap();

那么两个核心操作,getExtensionLoader和getExtension都做了什么呢?只需要看最后一个else分支
就是去EXTENSION_LOADERS这个ConcurrentMap里面去取,取不到new 一个放进去再取,比较简单就不分析了

public static <T> ExtensionLoader<T> getExtensionLoader(Class<T> type) {
        if (type == null) {
            throw new IllegalArgumentException("Extension type == null");
        } else if (!type.isInterface()) {
            throw new IllegalArgumentException("Extension type(" + type + ") is not interface!");
        } else if (!withExtensionAnnotation(type)) {
            throw new IllegalArgumentException("Extension type(" + type + ") is not extension, because WITHOUT @" + SPI.class.getSimpleName() + " Annotation!");
        } else {
            ExtensionLoader<T> loader = (ExtensionLoader)EXTENSION_LOADERS.get(type);
            if (loader == null) {
                EXTENSION_LOADERS.putIfAbsent(type, new ExtensionLoader(type));
                loader = (ExtensionLoader)EXTENSION_LOADERS.get(type);
            }

            return loader;
        }
    }

第二个核心操作,getExtension做了什么呢?看下核心代码。是同样的操作,去map取实例,没有的话,实例化之后放进去,然后再取。

T instance = EXTENSION_INSTANCES.get(clazz);
                if (instance == null) {
                    EXTENSION_INSTANCES.putIfAbsent(clazz, clazz.newInstance());
                    instance = EXTENSION_INSTANCES.get(clazz);
                }

dubbo的所有核心功能,比如注册中心,序列化,传输等都支持使用spi的方式进行拓展,以负载均衡为例,dubbo内置了四种,Random,RoundRorbin,LeastActive,ConsistentHash.那么在dubbo的jar包中,有一个这样的文件,META-INF/dubbo/internal/com.alibaba.dubbo.rpc.cluster.LoadBalance,内容见下

random=com.alibaba.dubbo.rpc.cluster.loadbalance.RandomLoadBalance
roundrobin=com.alibaba.dubbo.rpc.cluster.loadbalance.RoundRobinLoadBalance
leastactive=com.alibaba.dubbo.rpc.cluster.loadbalance.LeastActiveLoadBalance
consistenthash=com.alibaba.dubbo.rpc.cluster.loadbalance.ConsistentHashLoadBalance

在初始化的时候,可以看到,确实是通过dubbo spi,以getExtension的方式来获取的LoadBalance实例。那么如果你需要实现自己开发的LoadBalance算法,其实只需要新增一个实现,然后在配置文件里面配上你自己的算法名称,然后就可以初始化的时候使用你自己的负载算法了。

protected LoadBalance initLoadBalance(List<Invoker<T>> invokers, Invocation invocation) {
        if (CollectionUtils.isNotEmpty(invokers)) {
            return ExtensionLoader.getExtensionLoader(LoadBalance.class).getExtension(invokers.get(0).getUrl()
                    .getMethodParameter(RpcUtils.getMethodName(invocation), LOADBALANCE_KEY, DEFAULT_LOADBALANCE));
        } else {
            return ExtensionLoader.getExtensionLoader(LoadBalance.class).getExtension(DEFAULT_LOADBALANCE);
        }
    }

3 三者的联系于区别是什么呢?

联系:三者都可以实现,根据client的不同输入,生产不同的实例交给client。
区别:
1.简单工厂需要自己实现工厂类,而另外两种相当于有现成的工厂类
2.java spi 需要在遍历的过程中,进行实例生成的工作。没有办法特定针对某一种实现直接生成实例,而dubbo spi就支持这一点。
3.dubbo spi的功能更丰富,还支持ioc,自适应拓展等其他更为复杂的功能
可以根据业务需要进行取舍。

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