Java和Dubbo的SPI机制原理解析

SPI: 简单理解就是,你一个接口有多种实现,然后在代码运行时候,具体选用那个实现,这时候我们就可以通过一些特定的方式来告诉程序寻用那个实现类,这就是SPI。

JAVA的SPI

全称为 Service Provider Interface,是一种服务发现机制。它是约定在 Classpath 下的 META-INF/services/ 目录里创建一个以服务接口命名的文件,然后文件里面记录的是此 jar 包提供的具体实现类的全限定名。

这样当我们引用了某个 jar 包的时候就可以去找这个 jar 包的 META-INF/services/ 目录,再根据接口名找到文件,然后读取文件里面的内容去进行实现类的加载与实例化。

例如:

java的jdbc就使用了SPI机制,当我项目种应用了mysql的连接jar时候,就会去去mysql-connector-java.jar下的META-INF/services/ 目录查找java.sql.Driver名的文件,然后加载里面全类名的类。如果使用oracle连接驱动时候,就会去ojdbc.jar下面去找java.sql.Driver文件里的配置的全类名。

并且通过IDEA的智能提示功能,也能看到,在你切换不同连接的jar包时候,Driver接口实现类是不同的。

使用mysql的连接驱动:

切换到oracle的连接驱动:

Java的SPI机制源码分析

下面这段代码,以jdbc的SPI为例,可以作为debug的入口:

package com.example.demo;

import java.sql.Connection;
import java.sql.DriverManager;
/**
 * @author:luzaichun
 * @Date:2021/3/14
 * @Time:14:09
 **/
public class JDBCMain {
  private static final String URL = "jdbc:mysql://localhost:3306/test?useSSL=true&useUnicode=true&characterEncoding=UTF-8";

  public static void main(String[] args) throws Exception{
    Connection conn = DriverManager.getConnection(URL, "root", "123456");
  }
}

在使用DriverManager.getConnection()方法时候,会加载并初始化DriverManager类,此类是jdbc使用SPI的核心类。

1.DriverManager类初始化,调用static代码块,执行DriverManager#loadInitialDrivers()方法

2.使用javaSPI的核心类ServiceLoader#load()和以及其内部实现了Iterator的LazyIterator#hasNext()和
LazyIterator#next(),加载接口的具体实现类。

ServiceLoader.load()整个代码流程,如下图。其实就是给LazyIterator类的赋值属性,是那个接口要进行SPI,使用的类加载器是哪一个。

driversIterator.hasNext()和driversIterator.next()方法负责类实际类的加载

  • driversIterator.hasNext()最后实际是调到了LazyIterator.hasNext();
  • driversIterator.next()最后实际是调到了LazyIterator.next();

hashNext()方法读到SPI的配置文件里的全类名

next()方法最后通过反射创建出具体实现类的实例

总结:

  1. jdbc的SPI,通过DriverManager类静态代码块执行loadInitialDrivers()方法
  2. 然后通过ServiceLoader.load()拿到具体的接口,以及类加载器。
  3. 通过实现了Iterator类的LazyIterator类的hasNext方法读取配置文件,拿到接口的具体实现全类名
  4. 在next()方法内部,通过反射机制,由实现类的全类名,加载具体实现类。

代码实战java SPI

DemoService接口

public interface DemoService {
  String sayHello(String msg);
} 

XiaoHongDemoServiceImpl实现类

public class XiaoHongDemoServiceImpl implements DemoService {
  @Override
  public String sayHello(String msg) {
    return "xiaohong:"+msg;
  }
}

ZhangSanDemoServiceImpl实现类

public class ZhangSanDemoServiceImpl implements DemoService {
  @Override
  public String sayHello(String msg) {
    return "zhangsan:"+msg;
  }
}

定义SPI配置文件

最后使用

public class DemoMain {
  public static void main(String[] args) {
    ServiceLoader<DemoService> serviceLoad = ServiceLoader.load(DemoService.class);
    Iterator<DemoService> iterator = serviceLoad.iterator();
    while (iterator.hasNext()){
      DemoService demoService = iterator.next();
      String returnStr = demoService.sayHello("lzc贼帅!!!!");
      System.out.println(returnStr);
    }
  }
}

执行结果:

java SPI劣势,会加载SPI配置文件里定义的所有配置类,如果用不上该类,也会加载。通俗点讲,就是无法按需加载。

Dubbo的SPI

dubbo SPI使用

需要先引入dubbo相关的依赖

1.定义接口
通过dubbo的SPI注解标注定义的接口

@SPI("xiaohong")
public interface DubboSPIService {

  void sayHello();
}

2.多个实现类

public class XiaoHongDubboSPIServiceImpl implements DubboSPIService {
  @Override
  public void sayHello() {
    System.out.println("小红说:lzc贼帅!");
  }
}
public class XiaoMingDubboSPIServiceImpl implements DubboSPIService {
  @Override
  public void sayHello() {
    System.out.println("小明说:lzc贼帅!");
  }
}

3.定义dubbo SPI配置文件
META-INF/dubbo目录下定义接口全类名的文件,配置key-value的实现

Dubbo 对配置文件目录的约定,不同于 Java SPI ,Dubbo 分为了三类目录。

META-INF/services/ 目录:该目录下的 SPI 配置文件是为了用来兼容 Java SPI 。

META-INF/dubbo/ 目录:该目录存放用户自定义的 SPI 配置文件。

META-INF/dubbo/internal/ 目录:该目录存放 Dubbo 内部使用的 SPI 配置文件。

4.使用

public class DubboSPIMain {
  public static void main(String[] args) {
  //default,会取@SPI注解里定义的key对应的实现
//    DubboSPIService defaultExtensionService = ExtensionLoader.getExtensionLoader(DubboSPIService.class).getDefaultExtension();
//    defaultExtensionService.sayHello();
    DubboSPIService dubboSPIService = ExtensionLoader.getExtensionLoader(DubboSPIService.class).getExtension("xiaoming");
    dubboSPIService.sayHello();
  }
}

结果:

源码分析

ExtensionLoader.getExtensionLoader(DubboSPIService.class).getExtension("xiaoming");
dubbo SPI的核心就是ExtensionLoader类

1.ExtensionLoader#getExtensionLoader()

该方法主要是,从一个map里取key为当前传进来的接口Class的value(value是ExtensionLoader对象),如果取不到,我们就往这个map里put一份这样的key-value。value是new ExtensionLoader(type)传进去的type是接口的Class对象,最后会赋值给ExtensionLoader对象的type属性,后面会用到

2.拿到ExtensionLoader对象后,通过ExtensionLoader#getExtension()获取具体的实现的实例

首先会取缓存里拿,没拿到就调用createExtension()方法取创建所需要的实例,最后塞入缓存。

3.createExtension方法

通过getExtension(“xiaoming”)传进来的name=xiaoming,从SPI配置文件获取到所需要实现类的全类名,通过反射拿到实现类的Class对象,最后通过反射拿到相应的实例。核心是getExtensionClasses()方法。

4.getExtensionClasses()

getExtensionClasses()方法返回一个Map,key为SPI配置文件中的key,value为SPI配置文件中,实现类的Class对象。

可以看到,代码中用来大量的缓存机制,锁的双检查。cacheDefaultExtensionName()方法里会拿到SPI注解上配置的默认key,然后赋值给cachedDefaultName属性,如果使用getDefaultExtension()时候会使用到strategies,其实是通过java得SPI拿到得一个数组

5.循环三个SPI文件得目录,分别调用loadDirectory方法

fileName最后在三次循环里,会拼出三个路径,META-INF/dubbo/com.example.demo.service.DubboSPIService,这一个才是正确得路径,然后获得配置文件得绝对路径。然后会执行loadResource()方法读取SPI配置文件

  • META-INF/dubbo/com.example.demo.service.DubboSPIService
  • META-INF/services/com.example.demo.service.DubboSPIService
  • META-INF/dubbo/internal/com.example.demo.service.DubboSPIService


6.loadResource()读取SPI配置文件

一行一行读配置文件里得key-value,然后通过Class.forName()获取类得Class对象。然后put到第四步定义得空Map,extensionClasses这个Map里,再返回到第三步得getExtensionClasses()方法。

好了,今天先到这里,凌晨了。。。Adaptive 注解 - 自适应扩展下次有时间再写。

到此这篇关于Java和Dubbo的SPI机制原理解析的文章就介绍到这了,更多相关Java和Dubbo的SPI内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们!

(0)

相关推荐

  • Java 添加、删除、替换、格式化Word中的文本的步骤详解(基于Spire.Cloud.SDK for Java)

    Spire.Cloud.SDK for Java提供了TextRangesApi接口可通过addTextRange()添加文本.deleteTextRange()删除文本.updateTextRangeText()替换文本.updateTextRangeFormat()格式化文本等.本文将从以上方法介绍如何来实现对文本的操作.可参考以下步骤进行准备: 一.导入jar文件 创建Maven项目程序,通过maven仓库下载导入.以IDEA为例,新建Maven项目,在pom.xml文件中配置maven仓

  • Java 基于Spire.Cloud.SDK for Java在PDF中绘制形状

    Spire.Cloud.SDK for Java提供了pdfPathApi接口可用于在PDF文档中绘制形状(或图形),如绘制线条形状drawLine().绘制矩形形状drawRectanglef(),下面将介绍如何通过Java示例和步骤来实现: 一.导入jar文件.(有2种方式) 创建Maven项目程序,通过maven仓库下载导入.以IDEA为例,新建Maven项目,在pom.xml文件中配置maven仓库路径,并指定spire.cloud.sdk的依赖,如下: <repositories>

  • Java 添加、删除、格式化Word中的图片步骤详解( 基于Spire.Cloud.SDK for Java )

    本文介绍使用Spire.Cloud.SDK for Java提供的ImagesApi接口来操作Word中的图片.具体可通过addImage()方法添加图片.deleteImage()方法删除图片.updateImageFormat()格式化Word中的图片以及getImageFormat()获取Word中的图片格式等.操作方法和代码示例可参考下文中的步骤. 步骤1:导入jar文件 创建Maven项目程序,通过maven仓库下载导入.以IDEA为例,新建Maven项目,在pom.xml文件中配置m

  • 在java中使用SPI创建可扩展的应用程序操作

    简介 什么是可扩展的应用程序呢?可扩展的意思是不需要修改原始代码,就可以扩展应用程序的功能.我们将应用程序做成插件或者模块. 这样可以在不修改原应用的基础上,对系统功能进行升级或者定制化. 本文将会向大家介绍如何通过java中的SPI机制实现这种可扩展的应用程序. SPI简介 SPI的全称是Java Service Provider Interface.是java提供的一种服务发现的机制. 通过遵循相应的规则编写应用程序之后,就可以使用ServiceLoader来加载相应的服务了. SPI的实现

  • Java基于Spire Cloud Excel把Excel转换成PDF

    Spire.Cloud.Excel Sdk 提供GeneralApi接口和WorkbookApi接口,支持将本地Excel和云端Excel文档转换为ODS, PDF, XPS, PCL, PS等格式.本文以将Excel表格转为PDF为例,介绍实现格式转换的步骤及方法. 所需工具:Spire.Cloud.Excel.Sdk 必要步骤: 步骤1:Jar文件下载及导入.可通过"下载中心"下载获取jar:或者通过maven仓库安装导入,具体参考安装方法. 步骤2:ID及Key获取.需要在云端创

  • 浅谈Java的SPI技术

    人狠话不多,先上截图和代码吧. 这是工程目录.看到resources目录下面没有,添加了META-INF和services目录. 添加了一个com.gys.test.IAnimal文件.这个文件名和上面的接口名完全对应.这个目录的文件名是有讲究的,按照SPI规范来的. 上代码: package com.gys.test; public interface IAnimal { void eat(); } package com.gys.test.impl; import com.gys.test.

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

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

  • Java 自旋锁(spinlock)相关知识总结

    一.前言 谈到『自旋锁』,可能大家会说,这有啥好讲的,不就是等待资源的线程"原地打转"嘛.嗯,字面理解的意思很到位,但能深入具体点吗?自旋锁的设计真就这么简单? 本文或者说本系列的目的,都是让大家不要停留在表面,而是深入分析,做到: 灵活使用 掌握原理 优缺点 二.锁的优化:自旋锁 当多个线程想同时访问同一个资源时,就存在资源冲突,这时,大家最直接想到的就是加锁来互斥访问,加锁会有这么几个问题: 等待资源的线程进入睡眠,发生用户态向内核态的切换,有一定的性能开销: 占用资源的线程很快就

  • Java SPI机制原理及代码实例

    SPI的全名为:Service Provider Interface,大多数开发人员可能不熟悉,因为这个是针对厂商或者插件的.在java.util.ServiceLoader的文档里有比较详细的介绍. 简单的总结下 Java SPI 机制的思想.我们系统里抽象的各个模块,往往有很多不同的实现方案,比如日志模块的方案,xml解析模块.jdbc模块的方案等.面向的对象的设计里,我们一般推荐模块之间基于接口编程,模块之间不对实现类进行硬编码. 一旦代码里涉及具体的实现类,就违反了可拔插的原则,如果需要

  • 深入学习Java中的SPI机制

    概述 SPI(Service Provider Interface),是JDK内置的一种服务提供发现机制,可以用来启用框架扩展和替换组件,主要是被框架的开发人员使用,比如java.sql.Driver接口,其他不同厂商可以针对同一接口做出不同的实现,MySQL和PostgreSQL都有不同的实现提供给用户,而Java的SPI机制可以为某个接口寻找服务实现. Java中SPI机制主要思想是将装配的控制权移到程序之外,在模块化设计中这个机制尤其重要,其核心思想就是解耦. SPI整体机制图如下 当服务

  • Java中SPI的一些理解

    前言 最近在面试的时候被问到SPI了,没回答上来,主要也是自己的原因,把自己给带沟里去了,因为讲到了类加载器的双亲委派模型,后面就被问到了有哪些是破坏了双亲委派模型的场景,然后我就说到了SPI,JNDI,以及JDK9的模块化都破坏了双亲委派. 然后就被问,那你说说对Java中的SPI的理解吧.然后我就一脸懵逼了,之前只是知道它会破坏双亲委派,也知道是个怎么回事,但是并没有深入了解,那么这次我就好好的来总结一下这个知识吧. 什么是SPI SPI全称Service Provider Interfac

  • Java进阶之SPI机制详解

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

  • 深入理解Java中的SPI机制

    本文通过探析JDK提供的,在开源项目中比较常用的Java SPI机制,希望给大家在实际开发实践.学习开源项目提供参考. 1 SPI是什么 SPI全称Service Provider Interface,是Java提供的一套用来被第三方实现或者扩展的API,它可以用来启用框架扩展和替换组件. 整体机制图如下: Java SPI 实际上是"基于接口的编程+策略模式+配置文件"组合实现的动态加载机制. 系统设计的各个抽象,往往有很多不同的实现方案,在面向的对象的设计里,一般推荐模块之间基于接

  • Java SPI的简单小实例

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

  • JAVA SPI特性及简单应用代码实例

    最近在研究dubbo时,发现了JAVA的SPI特性.SPI的全名为Service Provider Interface,是JDK内置的一种服务发现机制. 具体实现: 1.定义一个接口 public interface IShape { /** * 渲染 */ void render(); } 2.添加几种实现 public class CircularShape implements IShape { @Override public void render() { System.out.pri

  • java中spi使用详解

    一.简介 java中spi(service provider interface)是jdk内置的一种服务发现机制,可以基于配置,在运行时加载指定服务.java中提供了很多服务提供接口,如jdbc.jndi等. 1.什么是SPI SPI全称Service Provider Interface,是Java提供的一套用来被第三方实现或者扩展的接口,它可以用来启用框架扩展和替换组件. SPI的作用就是为这些被扩展的API寻找服务实现. 2.SPI和API的使用场景 API (Application Pr

  • 详解java实践SPI机制及浅析源码

    1.概念 正式步入今天的核心内容之前,溪源先给大家介绍一下关于SPI机制的相关概念,最后会提供实践源代码. SPI即Service Provider Interface,属于JDK内置的一种动态的服务提供发现机制,可以理解为运行时动态加载接口的实现类.更甚至,大家可以将SPI机制与设计模式中的策略模式建立联系. SPI机制: 从上图中理解SPI机制:标准化接口+策略模式+配置文件: SPI机制核心思想:系统设计的各个抽象,往往有很多不同的实现方案,在面向的对象的设计里,一般推荐模块之间基于接口编

随机推荐