SPI设计目标
SPI的全名为Service Provider Interface
.大多数开发人员可能不熟悉,因为这个是针对厂商或者插件的。在java.util.ServiceLoader的文档里有比较详细的介绍。我们系统里抽象的各个模块,往往有很多不同的实现方案,比如日志模块的方案,xml解析模块、jdbc模块的方案等。面向的对象的设计里,我们一般推荐模块之间基于接口编程,模块之间不对实现类进行硬编码。一旦代码里涉及具体的实现类,就违反了可拔插的原则,如果需要替换一种实现,就需要修改代码。为了实现在模块装配的时候能不在程序里动态指明,这就需要一种服务发现机制。 java spi就是提供这样的一个机制:为某个接口寻找服务实现的机制。有点类似IOC的思想,就是将装配的控制权移到程序之外,在模块化设计中这个机制尤其重要。
SPI具体约定
java spi的具体约定为:当服务的提供者,提供了服务接口的一种实现之后,在jar包的META-INF/services/目录里同时创建一个以服务接口命名的文件。该文件里就是实现该服务接口的具体实现类。而当外部程序装配这个模块的时候,就能通过该jar包META-INF/services/里的配置文件找到具体的实现类名,并装载实例化,完成模块的注入。 基于这样一个约定就能很好的找到服务接口的实现类,而不需要再代码里指定。jdk提供服务实现查找的一个工具类:java.util.ServiceLoader
Java的SPI原理
首先我们写一个小例子来展示Java自带的SPI功能
- Command 接口提供各种行为,使用多个实现类来实现这个接口
package com.soa.other.spi.service;
/**
* Created by pengyunlong on 2018/5/25.
*/
public interface Command {
void excute();
}
- StartCommand 实现Command 接口
package com.soa.other.spi.service.impl;
import com.soa.other.spi.service.Command;
/**
* Created by pengyunlong on 2018/5/25.
*/
public class StartCommand implements Command {
@Override
public void excute() {
System.out.println("start...");
}
}
- ShutdownCommand实现Command 接口
package com.soa.other.spi.service.impl;
import com.soa.other.spi.service.Command;
/**
* Created by pengyunlong on 2018/5/25.
*/
public class ShutdownCommand implements Command {
@Override
public void excute() {
System.out.println("shutdown...");
}
}
- META-INF/services/下新建一个名字为com.soa.other.spi.service.Command的文件,写入所有实现类的包名+类名
META-INF/services/com.soa.other.spi.service.Command
com.soa.other.spi.service.impl.StartCommand
com.soa.other.spi.service.impl.ShutdownCommand
- 使用ServiceLoader加载META-INF/services/下的配置文件并创建所有实现类,并通过接口调用实现类的方法
package com.soa.other.spi;
import com.soa.other.spi.service.Command;
import java.util.ServiceLoader;
/**
* Created by pengyunlong on 2018/5/25.
*/
public class Main {
public static void main(String[] args) {
ServiceLoader<Command> serviceLoader = ServiceLoader.load(Command.class);
for (Command command:serviceLoader) {
command.excute();
}
}
}
- 打出日志
start...
shutdown...
- 修改
META-INF/services/com.soa.other.spi.service.Command
com.soa.other.spi.service.impl.StartCommand
- 重新启动
start...
优缺点
优点:SPI机制使得我们可以动态的提供扩展类的实现而不用修改代码,就是将装配的控制权移到程序之外,在模块化设计中这个机制尤其重要
缺点:所有接口的实现类会同时加载,影响性能