Java中的SPI机制

在学习SPI之前,在了解一下API(应用程序接口),API就是服务方定义好接口和实现,然后提供暴露一个接口给调用方。那什么是SPI呢?

SPI介绍

SPI ,全称为 Service Provider Interface,是一种服务发现机制。它通过在classpath路径下的META-INF/services文件夹查找文件,自动加载文件里所定义的类。Java自身提供的服务发现机制,是扫描META-INF/services文件夹文件定义的类。但是,也可以自己实现SPI功能,扫描不同的文件夹文件,像DubboSPI机制和SpirngBootSPI机制,都是自己实现的SPI功能,这为很多框架拓展功能提供了更多的可能性。

SPI可以让开发者拓展JDK自身或者框架本身的功能,就是说开发者是服务实现方,而JDK或者框架是服务调用方。

简而言之,就是指定那个目录下,通过全限定类名去加载对应的类。

思考,为什么需要SPI

思考一个问题,有这样一个需求,需要为某个开源框架或者已有的系统拓展一下功能。

比较常见的做法可能是在原来的代码进行修改,然后重新编译打包再发布。

那有没有方法可以不修改原来代码就可以进行拓展呢?答案就是SPI,这要求原来提供框架的开发者,使用SPI,定义接口(interface)或者抽象类(abstract class), 以及实现了服务接口的具体类。

在使用中,框架提供接口,框架提供基础的实现类,开发者可以去拓展自己的实现类。其中实现类的定义需要放在META-INF/services下面, 在运行时框架会扫描服务配置文件下面的实现类,从而框架就可以调用。

使用实例

定义一个接口

public interface SPIService {
    void service();
}

原系统调用

public class SPIServiceTest {
    public static void main(String[] args) {
        ServiceLoader<SPIService> spiServices = ServiceLoader.load(SPIService.class);
        Iterator<SPIService> iterator = spiServices.iterator();
        while (iterator.hasNext()) {
            SPIService next = iterator.next();
            next.service();
        }
    }
}

实现类1

public class SPIServiceA implements SPIService {
    @Override
    public void service() {
        System.out.println("SPIServiceA");
    }
}

实现类2

public class SPIServiceB implements SPIService {
    @Override
    public void service() {
        System.out.println("SPIServiceB");
    }
}

resource下面新建META-INF/services目录,然后新建文件com.spi.learn.service.SPIService

文件内容

com.spi.learn.service.SPIServiceA
com.spi.learn.service.SPIServiceB

JDK应用场景——Driver

java.sql.DriverManager类的loadInitialDrivers()方法中

    private static void loadInitialDrivers() {
        ....

        AccessController.doPrivileged(new PrivilegedAction<Void>() {
            public Void run() {

                ServiceLoader<Driver> loadedDrivers = ServiceLoader.load(Driver.class);
                Iterator<Driver> driversIterator = loadedDrivers.iterator();

                /* Load these drivers, so that they can be instantiated.
                 * It may be the case that the driver class may not be there
                 * i.e. there may be a packaged driver with the service class
                 * as implementation of java.sql.Driver but the actual class
                 * may be missing. In that case a java.util.ServiceConfigurationError
                 * will be thrown at runtime by the VM trying to locate
                 * and load the service.
                 *
                 * Adding a try catch block to catch those runtime errors
                 * if driver not available in classpath but it's
                 * packaged as service and that service is there in classpath.
                 */
                try{
                    while(driversIterator.hasNext()) {
                        driversIterator.next();
                    }
                } catch(Throwable t) {
                // Do nothing
                }
                return null;
            }
        });

        ....
    }

其中ServiceLoader.load(Driver.class)会去加载META-INF/services目录下,所有实现了Driver接口的类,因此在mysql中实现了Driver接口的类会被加载,然后执行静态块,这样子就实现了不同数据库的驱动注册。

com.mysql.jdbc.Driver

public class Driver extends NonRegisteringDriver implements java.sql.Driver {
    //
    // Register ourselves with the DriverManager
    // static块,执行这行Class.forName("com.mysql.jdbc.Driver");的时候,会调用static块
    static {
        try {
            java.sql.DriverManager.registerDriver(new Driver());
        } catch (SQLException E) {
            throw new RuntimeException("Can't register driver!");
        }
    }

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

推荐阅读更多精彩内容