大家好,今天我们学习Dubbo增强SPI,我会从SPI的概念开始逐步深入,给大家讲解Dubbo里是如何实现SPI的。
Java SPI介绍
Java SPI 我从面向接口编程的编程原则开始,给大家介绍Java SPI的原理,实现,并举例说明。
面向接口编程
基于接口编程是面向对象编程的基本原则之一。什么是基于接口编程呢?当我们需要使用其它模块的代码时,如果调用的是接口而不是其他模块具体的实现类,这样就避免了硬编码。反之,如果我们调用的是具体的实现类,那么就违反了可拔插的原则,因为如果需要替换一种实现,就需要修改代码,从而增加了代码的耦合性,不符合面向对象的基本原则。
JAVA SPI原理
一旦代码里涉及具体的实现类,就违反了可拔插的原则,如果需要替换一种实现,就需要修改代码。为了实现在在调用过程中避免调用实现类,这就需要一种服务发现机制。JAVA SPI(service provider interface)就是这样的一个机制,会去帮我们寻找接口的实现类,并实例化。有点类似IOC的思想,就是将装配的控制权移到程序之外,在模块化设计中这个机制尤其重要。
Java SPI 的具体约定为:当服务的提供者,提供了服务接口的一种实现之后,在jar包的META-INF/services/目录里同时创建一个以服务接口命名的文件。该文件里就是实现该服务接口的具体实现类。
而当外部程序装配这个模块的时候,就能通过该jar包META-INF/services/里的配置文件找到具体的实现类名,并装载实例化,完成模块的注入。
基于这样一个约定就能很好的找到服务接口的实现类,而不需要再代码里制定。
下面的图展示了Java SPI的机制:
图中实现类的提供方既可以是引入的第三方实现的,也可以是自己实现的,场景不同实现类的提供方也是不一样的。
Java SPI的机制
JAVA SPI代码示例
接下来我会举两个例子,类分别是由外部jar包提供实现类和调用者自己提供实现类。
由外部jar包提供实现类的示例
大家在编码的过程中避免不了跟数据库打交道,操作数据库是离不开sql的。java类库中实现了利用sql操作数据库的功能,具体在java.sql包里,但是在java.sql包中并没有数据库驱动程序。针对一个数据库,可能会存在着不同的数据库驱动实现。我们在使用特定的驱动实现时,不希望修改现有的代码,而希望通过一个简单的配置就可以达到效果。具体是怎么做的的呢?
我们以mysql驱动为例,分析一下java.sql是如何加载mysql驱动程序的。我们先看java.sql是如何实现spi的。首先java.sql会提供一个驱动接口Driver.java
scala
package com.mysql.cj.jdbc;
import java.sql.DriverManager;
import java.sql.SQLException;
public class Driver extends NonRegisteringDriver implements java.sql.Driver
{
public Driver() throws SQLException { }
static {
try {
DriverManager.registerDriver(new Driver());
} catch (SQLException var1) {
throw new RuntimeException("Can't register driver!");
}
}
}
这个接口就是提供给驱动厂商去实现的。
然后我们看看java.sql是如何加载驱动接口的实现类的,这个工作是由DriverManager类中的静态方法loadInitialDrivers() 实现的,相关代码段如下。我们可以看到java spi工具类ServiceLoader的使用,ServiceLoader会把实现类加载进来。
ini
ServiceLoader<Driver> loadedDrivers = ServiceLoader.load(Driver.class);
Iterator<Driver> drivers = loadedDrivers.iterator();
println("DriverManager.initialize: jdbc.drivers = " + loadedDrivers);
然后我们看一下mysql-connector-java.jar包里是如何配合Java spi的,实现了java.sql提供的接口Driver
scala
package com.mysql.cj.jdbc;
import java.sql.DriverManager;
import java.sql.SQLException;
public class Driver extends NonRegisteringDriver implements java.sql.Driver {
public Driver() throws SQLException { }
static {
try {
DriverManager.registerDriver(new Driver());
} catch (SQLException var1) {
throw new RuntimeException("Can't register driver!");
}
}
}
然后在在META-INF/services配置了上文中提到的接口路径,打开里面的内容,可以看到是com.mysql.jdbc.Driver
这样,DriverManager在初始化的时候根据提供的实现类把所有符合的驱动都加载进去。
自己提供实现类的示例:
- 定义一个接口:
csharp
package com.dubbo.spi;
public interface CourseService {
void classBegin();
}
2.定义两个实现类:
java
package com.dubbo.spi;
public class CourseServiceP6 implements CourseService{
@Override
public void classBegin() {
System.out.println("P6 course start!!!!!!");
}
}
java
package com.dubbo.spi;
public class CourseServiceP7 implements CourseService{
@Override public void classBegin() {
System.out.println("P7 course start!!!!!!");
}
}
3.在META-INF/services/目录里创建一个以
com.dubbo.spi.CourseService为文件名的文件,这个文件里的内容就是这个接口的具体的实现类。
4.测试代码:
java
package com.dubbo.spi;
import java.util.ServiceLoader;
public class SpiTest {
public static void main(String[] args) {
ServiceLoader<CourseService> serviceLoader = ServiceLoader.load(CourseService.class);
// 执行
for (CourseService courseService : serviceLoader) {
courseService.classBegin();
}
}
}
执行结果如下:
P6 course start!!!!!!
P7 course start!!!!!!
总结
优点
使用 Java SPI 机制的优势是实现解耦,使得接口的定义与具体业务实现分离,而不是耦合在一起。应用程序可以根据实际业务情况启用或替换具体组件。
缺点
- 必须全部加载配置文件指定的实现类,不能有选择的加载。 ServiceLoader是运行时加载,但如果遇到某个实现类不需要而且加载很慢,这样就会造成很大的延迟和浪费。
- 实现类只能通过枚举获得,获取方式不够丰富。
- 多个并发多线程使用 ServiceLoader 类的实例是不安全的