了解JAVA中的SPI机制,以及数据库驱动插件,这一篇就够了

Java有货

共 3922字,需浏览 8分钟

 ·

2021-05-12 15:32

点击上方「Java有货」关注我们


技术交流群添加方式


+



添加小编微信:372787553,备注:进群
带您进入Java技术交流群

前言

SPI(Service Provider Interface)是JDK内置的一种服务提供发现机制。本质是将接口实现类的全限定名配置在文件中,并由服务加载器读取配置文件,加载实现类。这样可以在运行时,动态为接口替换实现类。

在Java中SPI是被用来设计给服务提供商做插件使用的。基于策略模式来实现动态加载的机制。我们在程序只定义一个接口,具体的实现交个不同的服务提供者;在程序启动的时候,读取配置文件,由配置确定要调用哪一个实现。有很多组件的实现,如日志、数据库访问等都是采用这样的方式,最常用的就是 JDBC 驱动

上面的说明很多人还是没什么概念,我们来举个案例,一步步开启SPI知识

案例

我们来个世界这么大,想出去看看,但是最好有辆车


上图中有4个项目,

1、car项目:定义了Car的接口
2、audi-car项目:代表奥迪厂家生产的车car
3、baoma-car项目:代表宝马厂家生产的车car
4、旅游项目:我们需要一辆车,去旅行

根据上面的需求,很多小伙伴就开始写代码了

Car项目

audi-car奥迪厂家项目

baoma-car宝马厂家项目

旅游项目

如果需要奥迪厂家的车,引入奥迪项目jar包

旅行类,需要传入一个car;go方法执行调用car中的接口

最简单的实现

那如果我们不需要奥迪厂家的,要宝马厂家的怎么办?移除奥迪jar包,引入宝马车厂jar包

改造一下Car实例化代码

整个过程,小伙伴有没有发现一个问题,换一个车厂,就需要改一下实现的代码

Car car = new AudiCar();//奥迪车
Car car = new BaoMaCar();//宝马车

是不是有点麻烦,那能不能只要把车厂的jar包引入了,就能够获取到该车厂的车呢?不要再改一些代码了

其实就是我们经常听别人说的插件概念,如果需要什么功能,只要引入依赖包就ok了;不需要任何更改;不需要此功能,直接移除就ok了。

这个时候JAVA的SPI就起到这个作用了,我们来看看怎么实现的?

JAVA的SPI

JAVA的JDK中的SPI,有一个核心类ServiceLoader;这个类的作用就是用来加载实现类的

ServiceLoader会遍历所有jar包resources中META-INF/services/下文件

services下文件的名称方式:接口的全命名

我们来看看代码

奥迪车厂项目中,在resources中META-INF/services/下新建

文件名为接口全命名:com.rainbow.spi.Car,文件里面的内容为:实现类的全命名

宝马车厂

我们在来看看旅游项目的改造

通过ServiceLoader加载接口Car的实现类,那它怎么去找呢?就是去扫描所有jar包,resources中META-INF/services/com.rainbow.spi.Car文件中的值。

我们现在引入宝马jar包,启动执行

如果想换成奥迪的车,那只要重新换一下jar依赖

直接启动执行

这种效果就达到了插件概念,直接引入jar包,就达到了换车的目的;不需要修改代码。

那如果我们同时加入宝马jar包,奥迪jar包呢

执行启动

我们发现两个实现类都执行了。这个原因就是ServiceLoader会加载所有的实现类;如果业务中只需要某一种车,只需要在car中增加个协议接口就行了

奥迪的协议car:audi://

宝马的协议car:baoma://

改造一下旅游项目

在使用车car的时候,通过配置文件配置一下协议,然后拿到的车car就是对应协议的car

源码分析

我们来看一下ServiceLoader是怎么实现的源码,跟踪一下

上面是用当前线程的类加载器去加载

LazyIterator迭代器

通过反射进行实例化,并放进缓存中

整体的流程图如下

数据库驱动

我们经常用到的数据库驱动也是利用这个spi机制,我们来看一下,怎么使用的

我们一般只需要在配置文件中配置属性

spring:
datasource:
url: jdbc:mysql://localhost:3306/xxxxx?autoReconnect=true&useSSL=false&characterEncoding=utf-8&serverTimezone=Asia/Shanghai
username: dev
password: xxxxxx

然后依赖驱动jar包,我们同时加入mysql以及oracle驱动

就这么简单,我们就可以使用数据库驱动了。

我们来看一下mysql的jar包,META-INF/services有一个java.sql.Driver的文件

oracle中的jar包META-INF/services有一个java.sql.Driver的文件

java.sql.Driver接口是在哪个包下面呢?这个是在jdk中的基础jar包

上面我们看了数据库驱动的SPI基本配置,我们可继续看spring框架如何使用spi机制来完成数据库驱动的自动管理的(加载、注销),接下来就按照事情发展的先后的先后顺序把mysql驱动加载的全过程屡一下,我们这里介绍的是springboot 2.x。

用过springboot的小伙伴对springboot的自动装载机制,数据源的配置也是使用的自动装配机制,具体类
DataSourceAutoConfiguration

注意上面标红部分,这里面引入的Hikari、Tomcat等(除了
DataSourceJmxConfiguration之外)都是一些数据源配置,我们先看下springboot推荐的
Hikari数据源配置

由于在DataSourceAutoConfiguration类中首先引入的就是Hikari的配置,DataSource没有创建,满足ConditionalOnMissingBean以及其他一些条件,就会使用该配置类创建数据源,好了接下来看下createDataSource到底是怎么创建数据源的,这个过程又是怎么跟SPI关联起来的,

abstract class DataSourceConfiguration {

@SuppressWarnings("unchecked")
protected static <T> T createDataSource(DataSourceProperties properties, Class<? extends DataSource> type) {
//使用DataSourceProperties数据源配置创建DataSourceBuilder对象(设计模式中的建造者模式)
return (T) properties.initializeDataSourceBuilder().type(type).build();
}
//下面看下DataSourceBuilder的build方法
public T build() {
//在该例子中,type返回的是com.zaxxer.hikari.HikariDataSource类
Class<? extends DataSource> type = getType();
//实例化HikariDataSource类
DataSource result = BeanUtils.instantiateClass(type);
maybeGetDriverClassName();
//bind方法中会调用属性的设置,反射机制,在设置driverClassName属性时
bind(result);
return (T) result;
}

bind(result)方法就是实例化Driver接口,会调用到DriverManager类方法;

java.sql.DriverManager类中有ensureDriversInitialized

那么我们引入了oracle驱动和mysql驱动,到底使用的是哪一个呢?

关键点就在于
DriverManager.getConnection的步骤,DriverManager.getConnection中会遍历所有已经加载的驱动实例去创建连接
,当一个驱动创建连接成功时就会返回这个连接,同时不再调用其他的驱动实例。DriverManager关键代码如下:

上面的driver.connect方法是获得一个连接,这个是具体的实现类去实现的,也就是是mysql和oracle驱动包实现的。我们看一下mysql驱动包

上图的方法就是看一下url协议是否和mysql配对,不配对就直接返回null;也就是我们通常在url中配置的jdbc:mysql://协议约定,看源码

到此数据库连接完成

总结

今天老顾介绍了java的SPI机制,还是比较简单的,这个SPI机制是很好用的,很多框架组件都利用这个功能去实现插件功能,非常好用哦。谢谢!!!

https://github.com/yanghaiji/javayh-demo/tree/main/source-spl-code
浏览 26
点赞
评论
收藏
分享

手机扫一扫分享

分享
举报
评论
图片
表情
推荐
点赞
评论
收藏
分享

手机扫一扫分享

分享
举报