JAVA SPI 机制介绍

秦彦卿 1年前 ⋅ 735 阅读

SPI机制简介

SPI是 Java 提供的一种服务加载方式,全名为Service Provider Interface.大多数开发人员可能不熟悉,因为这个是针对厂商或者插件的。在java.util.ServiceLoader的文档里有比较详细的介绍。简单的总结下java spi机制的思想。我们系统里抽象的各个模块,往往有很多不同的实现方案,比如日志模块的方案,xml解析模块、jdbc模块的方案等。面向的对象的设计里,我们一般推荐模块之间基于接口编程,模块之间不对实现类进行硬编码。一旦代码里涉及具体的实现类,就违反了可拔插的原则,如果需要替换一种实现,就需要修改代码。为了实现在模块装配的时候能不在程序里动态指明,这就需要一种服务发现机制。 java spi就是提供这样的一个机制:为某个接口寻找服务实现的机制。有点类似IOC的思想,就是将装配的控制权移到程序之外,在模块化设计中这个机制尤其重要。

SPI具体约定

java spi的具体约定为:当服务的提供者,提供了服务接口的一种实现之后,在jar包的META-INF/services/目录里同时创建一个以服务接口命名的文件。该文件里就是实现该服务接口的具体实现类。而当外部程序装配这个模块的时候,就能通过该jar包META-INF/services/里的配置文件找到具体的实现类名,并装载实例化,完成模块的注入。 基于这样一个约定就能很好的找到服务接口的实现类,而不需要再代码里制定。jdk提供服务实现查找的一个工具类:java.util.ServiceLoader


SPI应用场景

  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文件里指定实现类的方式来暴露驱动提供者.

SPI 示例

一个消息推送系统有一个用户通知服务,像用户发送通知,有两种方式一种是发送邮件,一种是发送短信。
接口定义:

package com.fschina.bootlab.spi;

public interface SendMessage {

    public String send();
}

邮件通知实现类

public class EmailSendMessageImpl implements SendMessage {
    @Override
    public String send() {
        System.out.println("send email to user");
        return "send email success!";
    }
}

短信通知

public class SMSSendMessageImpl implements SendMessage {
    @Override
    public String send() {
        System.out.println("send sms to user");
        return "send sms success!";
    }
}

通过在资源目录 META-INF/services中放置提供者配置文件 来标识服务提供者
文件名称是服务类型的完全限定二进制名称
针对本例文件名为:com.fschina.bootlab.spi.SendMessage
文件内容如下:

com.fschina.bootlab.spi.impl.EmailSendMessageImpl  #send email
com.fschina.bootlab.spi.impl.SMSSendMessageImpl    #send sms

新增SearchFactory类它定义了一个静态工厂方法,该方法迭代所有已知并可用的提供者

public class SearchFactory {

        private SearchFactory(){

        }

        public static SendMessage getSender(){
            SendMessage sendMessage =null;
            ServiceLoader serviceLoader=ServiceLoader.load(SendMessage.class);
            Iterator iterator=serviceLoader.iterator();
            while (iterator.hasNext()){
                sendMessage = iterator.next();
                sendMessage.send();
            }
            return  sendMessage;
        }
}

编写一个测试类来测试加载服务

public class SPITest  {

    @Test
    public void spiTest(){
        SearchFactory.getSender();
    }
}

运行结果:

    Connected to the target VM, address: '127.0.0.1:60238', transport: 'socket'
send email to user

Disconnected from the target VM, address: '127.0.0.1:60238', transport: 'socket'
send sms to user

结果表明,可以成功发现服务。

总结

Java 通过 SPI 机制为我们提供了一种服务发现机制。通过在 META-INF/services/ 目录下创建以接口全限定名为名称的文件,并在文件中每行写入一个服务提供者的全限定名,Java 可以发现并创建服务提供者的实例。

通过 ServiceLoader 我们可以获取指定接口的所有服务提供者,并实现接口调用与服务提供者的解耦

附件:示例代码下载地址


注意:本文归作者所有,未经作者允许,不得转载

全部评论: 0

    我有话说: