java spi最全使用总结

目录
  • 前言
  • 一、JDK中SPI的使用规范
    • 案例展示
    • SPI优点
    • SPI缺点
  • SPI机制在实际生产中的一个应用
  • 二、DUbbo中SPI的使用
    • Dubbo的SPI举例
  • 三、springboot中SPI思想的使用

前言

在开发过程中,经常要用到第三方提供的SDK来完成一些业务扩展功能,比如调用第三方的发短信、图片验证码、人脸识别等等功能,但问题是,第三方SDK只是提供了标准的功能实现,某些场景下,开发者还想基于这些SDK做一些个性化的定制和扩展,那要怎么办呢?

于是,一些优秀的SDK就通过SPI的机制,将一些接口扩能开放出来,开发者就可以基于这些SPI接口做自身的业务扩展了;

总结一下SPI思想:在系统的各个模块中,往往有不同的实现方案,例如日志模块的方案、xml解析的方案等,为了在装载模块的时候不具体指明实现类,我们需要一种服务发现机制,java spi就提供这样一种机制。有点类似于IoC的思想,将服务装配的控制权移到程序之外,在模块化设计时尤其重要

Java 的SPI机制在很多框架,中间件等都有着广泛的使用,如springboot,Dubbo中均有采用,属于高级Java开发知识点,有必要掌握

下面用一张简图说明下SPI机制的原理

一、JDK中SPI的使用规范

  • 定义通用的服务接口,针对服务接口,提供具体实现类
  • 在jar包的META-INF/services/目录中,新建一个文件,文件名为 接口的 “全限定名”, 文件内容为该接口的具体实现类的 “全限定名”
  • 将spi所在jar放在主程序的classpath中
  • 服务调用方用java.util.ServiceLoader,用服务接口为参数,去动态加载具体的实现类到JVM中

案例展示

案例业务背景:

  • 提供一个统一的支付接口
  • 有两种支付方式,分别为支付宝支付和微信支付,实际中为不同支付厂商提供的SDK
  • 客户端为customer工程,即调用支付SDK的使用者

从工程的结构来看,也是遵循SPI的服务规范的,即在resources目录下,创建一个指定名称的文件夹,将接口实现的全限定名放进去,那么客户端只需要依赖特定的SDK,然后通过 serviceLoader的方式即可加载到依赖的SDK的服务

客户端customer工程导入依赖

	<dependencies>

        <dependency>
            <artifactId>service-common</artifactId>
            <groupId>com.congge</groupId>
            <version>1.0-SNAPSHOT</version>
        </dependency>

        <dependency>
            <artifactId>ali-pay</artifactId>
            <groupId>com.congge</groupId>
            <version>1.0-SNAPSHOT</version>
        </dependency>

        <dependency>
            <artifactId>wechat-pay</artifactId>
            <groupId>com.congge</groupId>
            <version>1.0-SNAPSHOT</version>
        </dependency>

    </dependencies>
public class MainTest {

    public static void main(String[] args) {

        ServiceLoader<PayService> loader = ServiceLoader.load(PayService.class);
        loader.forEach(payService ->{
            System.out.println(payService);
            payService.pay();
            System.out.println("=======");
        });
    }

}

运行下这段客户端的测试程序

我们不妨来看看serviceLoader中的一段关键代码,即加载服务接口时,可以发现,该方法最终要去找接口的实现类所在jar包下的 “META-INF/services” 目录中的服务实现,如果找到了就能被加载和使用

SPI优点

  • 使用Java SPI机制的优势是实现解耦,使得第三方服务模块的装配控制的逻辑与调用者的业务代码分离
  • 应用程序可根据实际业务情况启用框架扩展或替换框架组件

SPI缺点

  • srviceLoader 只能通过遍历全部获取,也就是接口的实现类全部加载并实例化一遍
  • 如果并不想用某些实现类,它也被加载并实例化了,这就造成了浪费
  • 获取某个实现类的方式不够灵活,只能通过Iterator形式获取,不能根据某个参数来获取对应的实现类
  • 多个并发多线程使用ServiceLoader类的实例是不安全的,需要加锁控制

SPI机制在实际生产中的一个应用

在小编的实际项目开发中,有这样一个需求,标准产品针对单点登录提供了多种实现,比如 基于cas方案,ldap方案,oauth2.0方案等,针对每种方案,提供了一套具体的实现,即封装成了各自的jar包

标准产品在出厂并在客户端安装的时候,会有一套默认的实现,即oauth2.0实现,但是客户方有时候有自己的一套,比如cas服务器,那么客户希望能够对接cas单点登录,这么以来,具体到项目在实际部署的时候,就需要现场做一些特定的参数配置,将标准实现切换为 cas的实现即可,那么问题来了,标准产品是如何根据参数配置做到的呢?

其实也很简单,就是使用了 serviceLoader机制,自动发现标准产品中能够加载到的所有单点登录实现,如果没有外部配置参数传入,则默认使用oauth2.0的实现,否则,将会采用外部参数传过来的那个实现。

二、DUbbo 中SPI的使用

可以说,dubbo框架是对spi使用的一个很好的例子,dubbo框架本身就是基于SPI规范做了更进一步的封装,从上面的优缺点分析中,我妈了解了原生的SPI在客户端选择服务的时候需要遍历所有的接口实现,比较浪费资源,而dubbo在此基础上有了更好的封装和实现,下面来了解下dubbo的SPI使用吧

Dubbo 的 SPI 规范是:

接口名:可随意定义

实现类名:在接口名前添加一个用于表示自身功能的“标识前辍”字符串

提供者配置文件路径:在依次查找的目录为

  • META-INF/dubbo/internal
  • META-INF/dubbo
  • META-INF/services

提供者配置文件名称:接口的全限定性类名,无需扩展名

提供者配置文件内容:文件的内容为 key=value 形式,value 为该接口的实现类的全限类性类名,key 可以随意,但一般为该实现类的“标识前辍”(首字母小写)。一个类名占 一行

提供者加载:ExtensionLoader 类相当于 JDK SPI 中的 ServiceLoader 类,用于加载提供者配置文件中所有的实现类,并创建相应的实例

Dubbo 的 SPI 举例

1、创建一个maven工程,并导入核心依赖

		<dependency>
            <groupId>org.apache.dubbo</groupId>
            <artifactId>dubbo</artifactId>
            <version>3.0.0</version>
        </dependency>

        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
        </dependency>

2、 定义 SPI 接口

比如这里有一个下单的接口,注意接口上需要加上@SPI 注解 ,注解里面的值可以填,也可以不用填,如果填,请注意和配置文件里面的key值名称保持一致,填写了的话,加载的时候,会默认找这个key对应的实现

@SPI("alipay")
public interface Order {
    String way();
}

3、定义两个接口的实现类

public class AlipayOrder implements Order{

    public String way() {
        System.out.println("使用支付宝支付");
        return "支付宝支付";
    }

}
public class WechatOrder implements Order {

    public String way() {
        System.out.println("微信支付");
        return "微信支付";
    }

}

4、定义扩展类配置文件

alipay=com.congge.spi.AlipayOrder
wechat=com.congge.spi.WechatOrder

5、测试方法

	@Test
    public void test1(){
        ExtensionLoader<Order> extensionLoader = ExtensionLoader.getExtensionLoader(Order.class);
        Order alipay = extensionLoader.getExtension("alipay");
        System.out.println(alipay.way());

        Order wechat = extensionLoader.getExtension("wechat");
        System.out.println(wechat.way());
    }

如果不指定加载哪个,而且接口配置了默认值,这里只需要在getExtension中设置 “true”,就会自动加载默认的那个

在Dubbo源码中,很多地方会存在下面这样的三种代码,分别是自适应扩展点、指定名称的扩展点、激活扩展点,dubbo通过这些扩展的spi接口实现众多的插拔式功能

ExtensionLoader.getExtensionLoader(xxx.class).getAdaptiveExtension();
ExtensionLoader.getExtensionLoader(xxx.class).getExtension(name);
ExtensionLoader.getExtensionLoader(xxx.class).getActivateExtension(url, key);

以dubbo源码中的Protocol 为例,对应dubbo源码中的rpc模块

@SPI("dubbo")
public interface Protocol {  

    int getDefaultPort();  

    @Adaptive
    <T> Exporter<T> export(Invoker<T> invoker) throws RpcException;  

    @Adaptive
    <T> Invoker<T> refer(Class<T> type, URL url) throws RpcException;  

    void destroy();  

} 

Protocol protocol = ExtensionLoader.getExtensionLoader(Protocol.class).getAdaptiveExtension();
  • Protocol接口,在运行的时候dubbo会判断一下应该选用这个Protocol接口的哪个实现类来实例化对象
  • 如果你配置了Protocol,则会将你配置的Protocol实现类加载到JVM中来,然后实例化对象时,就用你配置的那个Protocol实现类就可以了

上面那行代码就是dubbo里面大量使用的,就是对很多组件,都是保留一个接口和多个实现,然后在系统运行的时候动态的根据配置去找到对应的实现类。如果你没有配置,那就走默认的实现类,即dubbo

三、springboot 中SPI思想的使用

我们知道,springboot框架相比spring,从配置文件上简化了不少,但简化的只是开发者看到的那些xml配置文件中的东西,其本质仍然未变,就算是少了xml配置文件,依旧在启动的时候,需要做配置的解析工作,如解析原来的数据库连接的xml配置文件中的内容加载到spring容器中

而springboot来说,很多看不到的配置文件,都是在容器启动过程中,自动将配置进行读取,解析和加载,而在这个过程中,我们不禁好奇,这些配置是存在哪里呢?这里就用到了SPI的思想,也就是涉及到springboot的自动装配过程

举例来说,springboot怎么知道启动时需要加载 DataSource这个数据库连接的bean对象呢?怎么知道要使用JdbcTemplate 还是Druid的连接呢?

在spingboot工程启动过程中,有很重要的一个工作,就是完成bean的自动装配过程,自动装配装配的是什么东西呢?简单来说就是:

  • 扫描classpath(工程目录下)下所有依赖的jar包装中指定目录中以特定的全限定名称的文件,进行解析并装配成bean
  • 扫描xml文件,解析xml配置并装配成bean
  • 解析那些被认为是需要装配的配置类,如@configuration,@service等

其中第一步中的那些文件是什么呢?其实就是和dubbo或原生的spi规范中的那些 /META-INF 文件,只不过在springboot工程中,命名的格式和规范稍有不同

下面通过源码来看看springboot启动过程中是如何加载这些spi文件的吧

然后来到下面这里,重点关注setInitializers 这个方法,顾名思义,表示在启动过程中要做的一些初始化设置,那么要设置哪些东西呢?

在这个方法中,有一个方法getSpringFactoriesInstances,紧接着这个方法看进去

在该方法中需要重点关注这句代码,通过这句代码,将依赖包下的那些待装配的文件进行加载,说白了,就是加载classpath下的那些 spring.factory的文件里面的name

SpringFactoriesLoader.loadFactoryNames(type, classLoader)

那么问题是具体加载的是什么样的文件呢?不妨继续点进去看看,在SpringFactoriesLoader类的开头,有一个这样的路径,想必大家就猜到是什么了吧

也就是说,会去找以这样的名字结尾的文件,比如我们在依赖的jar包中,看到下面这一幕,在这个spring.factories中,会看到更多我们熟悉的配置

这样问题就很明白了,通过找到spring.factories的文件,然后解析出具体的类的完整的名称,然后再在:createSpringFactoriesInstances 这个方法中完成对这些 扩展的SPI接口实现类的初始化加载,即完成配的过程

沿着这个思路继续探究下去,相信感兴趣的同学对springboot中的这种类SPI的方式会有更深一层的理解,本篇到此结束,最后感谢观看!

到此这篇关于java spi最全使用总结的文章就介绍到这了,更多相关java spi详解内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们!

(0)

相关推荐

  • Java SPI用法案例详解

    1.什么是SPI      SPI全称Service Provider Interface,是Java提供的一套用来被第三方实现或者扩展的接口,它可以用来启用框架扩展和替换组件. SPI的作用就是为这些被扩展的API寻找服务实现. 2.SPI和API的使用场景     API (Application Programming Interface)在大多数情况下,都是实现方制定接口并完成对接口的实现,调用方仅仅依赖接口调用,且无权选择不同实现. 从使用人员上来说,API 直接被应用开发人员使用.

  • Java进阶之SPI机制详解

    一.前言 SPI的英文全称为Service Provider Interface,字面意思为服务提供者接口,它是jdk提供给"服务提供厂商"或者"插件开发者"使用的接口. 在面向对象的设计中,模块之间我们一般会采取面向接口编程的方式,而在实际编程过程过程中,API的实现是封装在jar中,当我们想要换一种实现方法时,还要生成新的jar替换以前的实现类.而通过jdk的SPI机制就可以实现,首先不需要修改原来作为接口的jar的情况下,将原来实现的那个jar替换为另外一种实

  • JAVA中的SPI思想介绍

    目录 1. SPI介绍 2. SPI规则 3. SPI案例 3.1 组件的定义 3.2 组件的实现 3.3 组件的选用 4. SPI原理 5. SPI要求 6. SPI应用 总结 1. SPI介绍 SPI全称Service Provider Interface,是Java提供的一套用来被第三方实现或者扩展的接口,其意义在于为某个接口寻找服务的实现,主要应用在框架中用来寻找组件,提高扩展性. 汽车制造是一个比较繁琐的过程,通常的手段是先规定汽车各个零部件的生产规格,各个零部件厂商按照这种规则去生产

  • 一文搞懂Java的SPI机制(推荐)

    目录 1 简介 缺点 源码 使用 适用场景 插件扩展 案例 1 简介 SPI,Service Provider Interface,一种服务发现机制. 有了SPI,即可实现服务接口与服务实现的解耦: 服务提供者(如 springboot starter)提供出 SPI 接口.身为服务提供者,在你无法形成绝对规范强制时,适度"放权" 比较明智,适当让客户端去自定义实现 客户端(普通的 springboot 项目)即可通过本地注册的形式,将实现类注册到服务端,轻松实现可插拔 缺点 不能按需

  • java基础--JDK SPI概述

    目录 JDK SPI是什么 JDK SPI使用说明及示例 SPI在JDBC中的应用 对SPI的理解 JDK SPI是什么 最近工作中听几个同事说了好几次SPI这个名词,虽然和我没关系,但是心里默默想还是学习一下,不然下次和我说到SPI,连是什么都不知道那就尴尬了. 所以SPI是什么呢?SPI全称Service Provider Interface,在Java中还是一个比较重要的概念,是Java提供的一套用来被第三方实现或者扩展的API,或者换句话说,SPI是一种服务发现机制. JDK SPI使用

  • Java SPI机制详细介绍

    目录 为什么需要SPI? 什么是SPI?SPI和API的区别 来人,上点对抗 spi-provider spi-user 总结 为什么需要SPI? 思考一个场景,我们封装了一套服务,别人通过引入我们写好的包,就可以使用这些接口API,完成相应的操作,这本来没有什么问题,但是会存在使用该服务的实体有不相同的业务需求,需要进一步的扩展,但是由于api是写好的,想要扩展并非那么的简单,如果存在这样子的场景,我们该怎么办? 可以使用Java 提供的SPI机制 什么是SPI?SPI和API的区别 SPI

  • Java插件扩展机制之SPI案例讲解

    目录 什么是SPI 与 接口类-实现类 提供的RPC 方式有什么区别? 假设我们需要实现RPC,是怎么做的? 那RPC究竟跟SPI什么关系? SPI的应用场景 怎么实现一个SPI? 中间件是怎么实现SPI的? Apollo-Client中的实现 JDBC中的实现 什么是SPI SPI ,全称为 Service Provider Interface,是一种服务发现机制.其为框架提供了一个对外可扩展的能力. 与 接口类-实现类 提供的RPC 方式有什么区别? 传统的接口类实现形式为如下 public

  • Java SPI简单应用案例详解

    开篇 本文主要谈一下 Java SPI(Service Provider Interface) ,因为最近在看 Dubbo 的相关内容,其中涉及到了 一个概念- Dubbo SPI, 最后又牵扯出来了 JAVA SPI, 所以先从 Java SPI 开整. 正文 平常学习一个知识点,我们的常规做法是: 是什么 有什么用 怎么用 这次我们倒着做,先不谈什么是 SPI 及其作用,来看下如何使用. 使用 1. 创建一个 maven 工程 2. 创建一个接口类以及实现类 // 接口 public int

  • 浅析Java SPI 与 dubbo SPI

    Java原生SPI 面向接口编程+策略模式 实现 建立接口 Robot public interface Robot { /** * 测试方法1 */ void sayHello(); } 多个实现类实现接口 RobotA public class RobotA implements Robot { public RobotA() { System.out.println("Happy RobotA is loaded"); } @Override public void sayHel

  • java spi最全使用总结

    目录 前言 一.JDK中SPI的使用规范 案例展示 SPI优点 SPI缺点 SPI机制在实际生产中的一个应用 二.DUbbo中SPI的使用 Dubbo的SPI举例 三.springboot中SPI思想的使用 前言 在开发过程中,经常要用到第三方提供的SDK来完成一些业务扩展功能,比如调用第三方的发短信.图片验证码.人脸识别等等功能,但问题是,第三方SDK只是提供了标准的功能实现,某些场景下,开发者还想基于这些SDK做一些个性化的定制和扩展,那要怎么办呢? 于是,一些优秀的SDK就通过SPI的机制

  • Java SPI 机制知识点总结

    前言 不知大家现在有没有去公司复工,我已经在家办公将近 3 周了,同时也在家呆了一个多月:还好工作并没有受到任何影响,我个人一直觉得远程工作和 IT 行业是非常契合的,这段时间的工作效率甚至比在办公室还高,同时由于我们公司的业务在海外,所以疫情几乎没有造成太多影响. 扯远了,这次主要是想和大家分享一下 Java 的 SPI 机制. 还没看过的朋友的我先做个前景提要,当时的需求: 我实现了一个类似于的 SpringMVC 但却很轻量的 http 框架 cicada,其中当然也需要一个 IOC 容器

  • 详解JAVA SPI机制和使用方法

    JAVA SPI 简介 SPI 是 Java 提供的一种服务加载方式,全名为 Service Provider Interface.根据 Java 的 SPI 规范,我们可以定义一个服务接口,具体的实现由对应的实现者去提供,即服务提供者.然后在使用的时候再根据 SPI 的规范去获取对应的服务提供者的服务实现.通过 SPI 服务加载机制进行服务的注册和发现,可以有效的避免在代码中将具体的服务提供者写死.从而可以基于接口编程,实现模块间的解耦. SPI 机制的约定 1 在 META-INF/serv

  • Java SPI的简单小实例

    JDK有个ServiceLoader类,在java.util包里,支持按约定目录/META-INF/services去找到接口全路径命名的文件,读取文件内容得到接口实现类的全路径,加载并实例化.如果我们在自己的代码中定义一个接口,别人按接口实现并打包好了,那么我们只需要引入jar包,通过ServiceLoader就能够把别人的实现用起来.举个例子,JDK中的JDBC提供一个数据库连接驱动接口,不同的厂商可以有不同的实现,如果它们给的jar包里按规定提供了配置和实现类,那么我们就可以执行不同的数据

  • JAVA SPI机制详解使用方法

    目录 写在前面 什么是SPI 使用场景 实现约定 四种角色 基于JAVA原生特性实现的JAVA SPI机制的DEMO 1. 主要角色 2. 示例代码 3. 说明 基于SPRING BOOT实现的JAVA SPI机制的DEMO 写在前面 Java SPI提供了一种为某个接口寻找服务实现的机制.有点类似IOC的思想,就是将装配的控制权移到程序之外,在模块化设计中这个机制尤其重要,SPI的核心思想就是解耦. 什么是SPI SPI全称Service Provider Interface,是Java提供的

  • Java内部类的全限定名规律代码示例

    简述: 由于最近遇到不少需要反射的类,而其中不乏内部类,在此总结一下内部类的全限定名的规律. 成员内部类 测试结果表明,无论成员内部类是否为静态,其全限定名都使用如下命名方法: 包名.外部类名$内部类名 测试代码: package com.test; public class InnerClassTest { static class StaticInner{ } class Inner{ } public static void main(String[] args) { StaticInne

  • 解决android studio 打开java文件 内容全变了的问题

    问题描述: 某天打开项目的activity的java文件界面突然变成下面这样了,但是用Notepad++打开代码什么的都正常,不知道什么原因造成的 解决办法 使用notepad++打开java文件,随便改个地方或者直接按俩空格再保存,返回AS一切恢复.... 补充知识:Android Studio 打开后无故爆红后解决办法,简单粗暴  有效治疗AndroidStudio大姨妈的方法. 今天打开AndroidSutudio后表示一脸蒙蔽,项目无故爆红,我本以为是哪里的代码有错导致 报错,于是乎逐个

随机推荐