某厂面试:如何优雅使用 SPI 机制(二)

发布于 2022-6-23 17:07
浏览
0收藏

 

为什么要有 SPI
了解一项技术的前提,一定要知道它为了解决什么样的痛点而存在,JDK 作者也不会没屁事加点代码玩

 

引入了 SPI 机制后,服务接口与服务实现就会达成分离的状态,可以实现 解耦以及程序可扩展机制。服务提供者(比如 springboot starter)提供出 SPI 接口后,客户端(平常的 springboot 项目)就可以通过本地注册的形式,将实现类注册到服务端,轻松实现可插拔

 

数据加密举例
以实际项目举个例子,就拿 sharding-jdbc 数据加密模块来说,sharding-jdbc 本身支持 AES 和 MD5 两种加密方式。但是,如果客户端不想用内置的两种加密,偏偏想用 RSA 算法呢?难道每加一种算法,sharding-jdbc 就要发个版本么

 某厂面试:如何优雅使用 SPI 机制(二)-开源基础软件社区
sharding-jdbc 可不会这么干,首先提供出 Encryptor 加密接口,并引入 SPI 的机制,做到服务接口与服务实现分离的效果。如果客户端想要使用新的加密算法,只需要在客户端项目 META-INF/services 目录下定义接口的全限定名称文件,并在文件内写上加密实现类的全限定名,就像这样式的

 某厂面试:如何优雅使用 SPI 机制(二)-开源基础软件社区
通过 SPI 的方式,就可以将客户端提供的加密算法加载到 sharding-jdbc 加密规则中,这样就可以在项目运行中选择自定义算法来对数据进行加密存储

通过 sharding-jdbc 的例子,可以很好的看出来,上面提到的 SPI 优点,都体现了出来

  1. 客户端(自己的项目)提供了服务端(sharding-jdbc)的接口自定义实现,但是与服务端状态分离,只有在客户端提供了自定义接口实现时才会加载,其它并没有关联;客户端的新增或删除实现类不会影响服务端
  2. 如果客户端不想要 RSA 算法,又想要使用内置的 AES 算法,那么可以随时删掉实现类,可扩展性强,插件化架构


配合实际案例理解 SPI 是不是很简单。为了防止有些小伙伴没有理解 sharding-jdbc 的例子,这里再举一个真实的例子

 

对象存储举例
假如你是一家集团公司里做公共架构开发的(可以把这个集团想大一点,几百家子公司的那种 🙃️ ),领导给你安排了个开发任务,需要你开发一个对象存储服务,让其它业务线的团队使用,统一集团内部的对象存储

OK,开发诉求明白了,这个时候就该想想怎么去完成这个需求(主要想给领导留个好印象,升官发财 ing...)。首先应该考虑的是要兼容多套对象存储供应商,比如阿里 OSS、腾讯 COS、华为云 OBS,最基本的三连对吧

高高兴兴的封装了个 starter,告诉领导封装完成了,然后就下发到各项目组去用了。但是这个时候其中一个子公司负责人告诉你,说他们之前用的七牛云 Kodo

 某厂面试:如何优雅使用 SPI 机制(二)-开源基础软件社区
心态炸了呀,难道要给他再适配一个七牛云么?万一适配完这个,又一位大哥说项目自建 HDFS 咋整

聊到这,大家就明白了吧,SPI 的场景可不就出现了么。就是身为服务提供者,在你无法形成绝对规范强制的时候,"放权" 往往是比较明智的选择,适当让客户端去自定义实现

这个时候,回过头想一想最初的一个问题。为什么 sharding-jdbc 不多实现几套算法,而是提供出一个 SPI 接口呢

因为开发者明白,不论提供多少接口,总有个别用户因各方面因素导致的个性化需求。个性化这个事情是追摸不透的,就像 女生的心思一样,永远不知道在想什么...(重点都加黑加粗了,剩下的全靠自己领悟) 

某厂面试:如何优雅使用 SPI 机制(二)-开源基础软件社区

实战讲解

都说到这了,不来个实战,感觉有点说不过去。吹过的牛逼,负责到底!就实现上面说的统一对象存储服务的代码

最简单的对象存储,只需要两个接口就可以实现功能,分别是 上传和下载

某厂面试:如何优雅使用 SPI 机制(二)-开源基础软件社区

 定义好上传、下载接口后,我们就要考虑,如何让客户端项目可以选择底层的对象存储服务器,以及如何通过 SPI 的方式将客户端自定义的文件存储组件加载到服务端

我们可以定义个对象存储容器,存放可以使用的对象存储服务,然后再 使用 SPI 的机制加载客户端自定义组件放到容器。对象存储服务放到容器中自然需要一个标识,那么就需要给文件接口加一个获取类型接口

 某厂面试:如何优雅使用 SPI 机制(二)-开源基础软件社区
定义好了接口,就要写具体的代码了。我们为 对象存储服务提供出一个对外的门面,所有访问对象存储的服务,必须访问门面对象进行文件的上传下载操作

下面这段代码将 对象服务 bean 存储至容器,并提供根据客户端的自定义配置,选择合适的对象存储服务

代码里用到的关键字 var 是 lombok 的注解,可以自动识别对象类型

 某厂面试:如何优雅使用 SPI 机制(二)-开源基础软件社区
因为是个示例 demo,所以将获取对象存储和具体的上传、下载耦合在了一起,如果小伙伴有类似需求,一定要将不同行为拆分开,类职责尽量单一些

这段代码整体逻辑不算复杂,所以也有点自信回头,就没跑单元测试,不过问题应该不大。解释一下其中具体逻辑:

  1. FileServiceFactory 大家可以理解为文件服务对外的统一访问入口。实现了 spirng 初始化的一个接口,可以在 bean 初始化时进行代码逻辑操作
  2. bean 初始化时,通过 ServiceLoader 类加载器负责加载对象存储接口,这样就能加载到客户端存放到 META-INF/services 中的自定义对象存储实现
  3. 获取到自定义对象存储后,和服务端本身自带的对象存储一起存放至容器中,这样就可以根据项目中的 fileStoreType 获取对应的服务了
    结合实际的项目场景,一个简简单单的 SPI 应用就完成了,自我感觉比 JDBC 装配的例子更好理解一些

 某厂面试:如何优雅使用 SPI 机制(二)-开源基础软件社区
上面的业务只是为了让不理解 SPI 的小伙伴更好的掌握应用场景,其实对象存储服务是一种可穷举的业务场景,SPI 并不是唯一的解决思路。当然,为了省事使用 SPI 也没啥问题。最后提一句,SPI 最合适的还是没有统一业务实现场景,就像上面提到过的加密算法

 

深入解析 SPI
一篇技术解析文章,适当放一些源码解析感觉会更好一些。下面一起来看看 ServiceLoader 底层都做了什么事情

通过 ServiceLoader 的 load 方法创建一个新的 ServiceLoader,并实例化其中的成员变量

 某厂面试:如何优雅使用 SPI 机制(二)-开源基础软件社区
应用程序通过迭代器接口获取对象实例,这里首先会判断 providers 对象中是否有实例对象

如果有实例,那么就返回;如果没有,执行类的装载步骤,具体类装载实现如下:

  1. LazyIterator#hasNextService 读取 META-INF/services 下的配置文件,获得所有能被实例化的类的名称,并完成 SPI 配置文件的解析
  2. LazyIterator#nextService 负责实例化 hasNextService() 读到的实现类,并将实例化后的对象存放到 providers 集合中缓存

某厂面试:如何优雅使用 SPI 机制(二)-开源基础软件社区
 如果你不知道上面的一些 "黑话" 不要紧,因为都是 ServiceLoader 底层执行的方法,跟着下面这个程序敲一遍代码就懂了

 某厂面试:如何优雅使用 SPI 机制(二)-开源基础软件社区
这里为了跟源码,也是把上面对象存储的逻辑,简单写了个 SPI 示例,证明是没有问题的。如果小伙伴想真正了解,就需要跟下源码去看看,其它源码部分就不细说了

结言
上面说了很多关于 SPI 机制的优点以及应用场景,这里总结下关键内容

  1. SPI 机制优势就是解耦。将接口的定义以及具体业务实现分离,而不是和业务端全部耦合在一端。可以实现 运行时根据业务实际场景启用或者替换具体组件
  2. SPI 机制的场景就是 没有统一实现标准的业务场景。一般就是,服务端有标准的接口,但是没有统一的实现,需要业务方提供其具体实现。比如说 JDBC 的 java.sql.Driver 接口和不同云厂商提供的数据库实现包

每个事物都是既有优点,同时也伴随着缺点。要从两个方面去看,不能总盯着一方面。这里说一下 SPI 机制的缺点

  1. 不能按需加载。虽然 ServiceLoader 做了延迟加载,但是只能通过遍历的方式全部获取。如果其中某些实现类很耗时,而且你也不需要加载它,那么就形成了资源浪费
  2. 获取某个实现类的方式不够灵活,只能通过迭代器的形式获取。这两点可以参考 Dubbo SPI 实现方式进行业务优化
    文章通过图文并茂的方式帮助大家重新梳理了一遍 SPI 的场景、优势和缺点,看完文章后相信大家对 SPI 机制有了更深入的认识

梳理出 SPI 的场景以及优势后,小伙伴最好再去 Debug 源代码,这样会大家对 SPI 的实现才能更加清楚。只有对一个知识点真正掌握,才不至于事后很快遗忘

另外可以通过项目中的场景,比如文中提到的加密、对象存储,通过类比的方式结合项目逻辑去实现代码代入,这样能够更好的去学习以及扩展相关的设计思路

 

文章转自公众号:龙台的技术笔记

标签
已于2022-6-23 17:07:21修改
收藏
回复
举报
回复
添加资源
添加资源将有机会获得更多曝光,你也可以直接关联已上传资源 去关联
    相关推荐