一、前言
SPI(Service Provider Interface)是Java提供的一种服务发现机制。它允许服务提供者实现一个接口,并在运行时由服务加载器发现这些实现。这样,Java应用可以在不修改代码的情况下,动态地发现和加载实现特定接口的服务。
例如,在JDBC中,不同的数据库厂商可以提供自己实现的JDBC驱动,而这些驱动都实现了相同的JDBC接口。用户只需要在META-INF/services目录下配置相应的文件,就可以轻松地切换不同的数据库驱动。
二、Java SPI实现
SPI机制的核心是java.util.ServiceLoader类,它用于加载服务提供者。服务提供者需要在资源目录META-INF/services下创建一个以接口全限定名命名的文件,该文件包含实现类的全限定名,多个实现类之间用换行符分隔。
代码示例:
- 定义接口
public interface Food {
void make();
}
- 接口实现类
public class Cake implements Food{
@Override
public void make() {
System.out.println("蛋糕的制作方式......");
}
}
public class Bread implements Food{
@Override
public void make() {
System.out.println("面包的制作方式.......");
}
}
- 注册服务提供者
在META-INF/services目录下创建一个名为com.example.Animal的文件,文件内容为:
com.example.yddemo.spi.Bread
com.example.yddemo.spi.Cake
- ServiceLoader加载服务
public class Test {
public static void main(String[] args) {
ServiceLoader<Food> serviceLoader = ServiceLoader.load(Food.class);
for (Food food : serviceLoader) {
food.make();
}
}
}
代码执行结果
核心源码展示
public final class ServiceLoader<S> implements Iterable<S>
它实现了 Iterable 接口,这意味着你可以通过迭代器来遍历所有可用的服务提供者。
private ServiceLoader(Class<S> svc, ClassLoader cl) {
......
}
构造函数是私有的,不能直接实例化 ServiceLoader。使用其静态工厂方法 load 或 loadInstalled 来获取 ServiceLoader 的实例。
public static <S> ServiceLoader<S> load(Class<S> service){
}
ServiceLoader 使用 load 方法来加载服务提供者
public static <S> ServiceLoader<S> load(Class<S> service, ClassLoader loader) {
}
这个方法获取当前线程的上下文类加载器,并调用另一个load方法,该方法接受类加载器作为参数。
三、Spring SPI实现
SPI(Service Provider Interface)是Java提供的一套用来被第三方实现或者扩展的接口机制,Spring框架在此基础上进行了扩展和优化,形成了Spring SPI机制。Spring SPI主要用于在不修改Spring源码的前提下,提供对Spring框架的扩展性,实现插件的自由插拔。
代码示例
- 定义接口
public interface Play {
void doPlay();
}
- 接口实现类
public class Basketball implements Play{
@Override
public void doPlay() {
System.out.println("打篮球......");
}
}
public class Football implements Play{
@Override
public void doPlay() {
System.out.println("踢足球......");
}
}
- 在项目的META-INF目录下,新增spring.factories文件
com.example.yddemo.spi.Play = com.example.yddemo.spi.Basketball, com.example.yddemo.spi.Football
- 运行结果
public class Test1 {
public static void main(String[] args) {
// 使用Spring的SPI机制加载MyService接口的实现类
List<Play> services = SpringFactoriesLoader.loadFactories(Play.class, null);
// 调用实现类的doSomething方法
for (Play play : services) {
play.doPlay();
}
}
}
源码分析
Spring SPI机制主要通过spring.factories文件来配置接口的实现类,然后在应用启动时,Spring框架会读取这些配置文件,并加载相应的实现类。具体过程如下:
①. 配置文件:在项目的META-INF目录下创建spring.factories文件,并在该文件中配置接口及其实现类的映射关系。
②. 加载实现类:Spring框架在启动时,会通过SpringFactoriesLoader类加载spring.factories文件中配置的实现类。
③. 实例化与注册:加载到的实现类会被实例化,并根据需要进行注册(如注册为Spring容器中的Bean),以便在后续的使用过程中进行依赖注入和调用。
以上可以看到Java SPI实现与Spring SPI实现的主要区别
Java SPI是一个服务提供接口对应一个配置文件,配置文件中存放当前接口的所有实现类,多个服务提供接口对应多个配置文件,所有配置都在services目录下。
Spring factories SPI是一个spring.factories配置文件存放多个接口及对应的实现类,以接口全限定名作为key,实现类作为value来配置,多个实现类用逗号隔开,仅spring.factories一个配置文件。
四、总结
上面是对Java SPI以及Spring SPI的详细介绍,以及代码示例。
SPI机制的优势:
1. 解耦:服务提供者与服务消费者之间解耦,消费者只需知道接口,不需要知道具体实现。
2. 扩展性:可以在不修改原有代码的情况下,通过添加新的服务提供者来扩展应用。
3. 灵活性:服务提供者可以在运行时被发现和加载,支持热插拔。