PancrasL的博客

Java SPI 机制

2021-07-28

SPI机制简介

SPI,全称Service Provider Interface。

在面向对象的系统设计过程中,推荐各模块之间基于接口编程,同一种接口可能拥有多个的实现类,如果需要替换一种实现,就需要修改代码。为了实现在模块装配的时候能不在程序里动态指明,就需要一种服务发现机制,Java SPI就是这样一种机制:为某个接口寻找实现类。

典型示例:JDK中有支持音乐播放,假设只支持mp3的播放,有些厂商想在这个基础之上支持mp4播放,有的想支持mp5播放,如果没有提供SPI这种实现标准,那就只能通过修改Java的源码实现;利用SPI标准,SUN公司只需要提供一个播放接口,在实现播放的功能上通过ServiceLoad的方式加载服务,那么第三方只需要实现这个播放接口,按SPI标准的约定进行打包,再放到classpath下面就OK了,没有一点代码的侵入性。

SPI约定

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

自定义SPI的实现

java.util.ServiceLoader会自动从META-INF/services/下寻找对应接口的实现类

image-20210728123630083

MainApplication.java

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
package indi.pancras;

import java.util.ServiceLoader;

import indi.pancras.service.MusicService;

/**
* @author PancrasL
*/
public class MainApplication {
public static void main(String[] args) {
ServiceLoader<MusicService> loader = ServiceLoader.load(MusicService.class);

boolean isFound = false;
for (MusicService musicService : loader) {
isFound = true;
musicService.playMusic();
}

if (!isFound) {
System.out.println("未发现MusicService实现类");
}
}
}

MusicService.java

1
2
3
4
5
6
7
8
package indi.pancras.service;

/**
* @author PancrasL
*/
public interface MusicService {
void playMusic();
}

MusicServiceMp3Impl.java

1
2
3
4
5
6
7
8
9
10
11
12
13
package indi.pancras.mp3;

import indi.pancras.service.MusicService;

/**
* @author PancrasL
*/
public class MusicServiceMp3Impl implements MusicService {
@Override
public void playMusic() {
System.out.println("play MP3 music...");
}
}

MusicServiceMp4Impl.java

1
2
3
4
5
6
7
8
9
10
11
12
13
package indi.pancras.mp4;

import indi.pancras.service.MusicService;

/**
* @author PancrasL
*/
public class MusicServiceMp4Impl implements MusicService {
@Override
public void playMusic() {
System.out.println("play MP4 music...");
}
}

image-20210728124016090

image-20210728124030785

music-application不引入实现模块

image-20210728124137040

image-20210728124159209

music-application引入一个实现模块

image-20210728124225536

image-20210728124244496

music-application引入多个实现模块

image-20210728124254376

image-20210728124308008