Java的SPI机制

Posted by KANG's BLOG on Tuesday, March 15, 2022

Java SPI机制

我们系统里抽象的各个模块,往往有很多不同的实现方案,比如日志模块的方案,xml解析模块、jdbc模块的方案等。 面向的对象的设计里,我们一般推荐模块之间基于接口编程,模块之间不对实现类进行硬编码。一旦代码里涉及具体的实现类,就违反了可拔插的原则, 如果需要替换一种实现,就需要修改代码。为了实现在模块装配的时候能不在程序里动态指明,这就需要一种服务发现机制。

Java SPI的约定

当服务的提供者,提供了服务接口的一种实现之后,在jar包的META-INF/services/目录里同时创建一个以服务接口命名的文件。 该文件里就是实现该服务接口的具体实现类。而当外部程序装配这个模块的时候,就能通过该jar包META-INF/services/里的配置文件找到具体的实现类名,并装载实例化,完成模块的注入。

基于这样一个约定就能很好的找到服务接口的实现类,而不需要再代码里制定。 jdk提供服务实现查找的一个工具类:java.util.ServiceLoader

例:

META-INF/services里边有一个名为InterfaceSample的文件,内容就是实现了给接口的类名

com.alipay.campus.demos.spi.SampleClass1
com.alipay.campus.demos.spi.SampleClass2

代码中使用

ServiceLoader<IProgrammer> serviceLoader = ServiceLoader.load(InterfaceSample.class);
Iterator<IProgrammer> it = serviceLoader.iterator();
while(it.hasNext()){
    // 返回实例
    InterfaceSample sample = it.next();
}