# SPI
# 1. 简介
SPI 全称为 Service Provider Interface，是一种服务发现机制。
SPI 的本质是将接口实现类的全限定名配置在文件中，并由服务加载器读取配置文件，加载实现类。
这样可以在运行时，动态为接口替换实现类。
正因此特性，我们可以很容易的通过 SPI 机制为我们的程序提供拓展功能。
SPI 机制在第三方框架中也有所应用，比如 Dubbo 就是通过 SPI 机制加载所有的组件。不过，Dubbo 并未使用 Java 原生的 SPI 机制，而是对其进行了增强，使其能够更好的满足需求。在 Dubbo 中，SPI 是一个非常重要的模块。基于 SPI，我们可以很容易的对 Dubbo 进行拓展。
# 2. JAVA SPI 使用范例
# 2.1 定义接口
public interface Color {
void draw();
}
1
2
3
2
3
# 2.2 定义实现类
// Red
public class Red implements Color {
@Override
public void draw() {
System.out.println(" I am Red");
}
}
// Black
public class Black implements Color {
@Override
public void draw() {
System.out.println(" I am black");
}
}
// Blue
public class Blue implements Color {
@Override
public void draw() {
System.out.println(" I am blue");
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# 2.3 创建 META-INF/services 文件
在 src/main/META-INF/services 文件夹下创建一个文件，名称为 Color 的全限定名 com.alibaba.dubbo.demo.model.java_spi.Color。
文件内容为实现类的全限定的类名，如下：
com.alibaba.dubbo.demo.model.java_spi.Black
com.alibaba.dubbo.demo.model.java_spi.Blue
com.alibaba.dubbo.demo.model.java_spi.Red
1
2
3
2
3
# 2.4 测试
// Java 原生 ServiceLoader
import java.util.ServiceLoader;
public class Java_SPI_Test {
@Test
public void spiTest() {
ServiceLoader<Color> serviceLoader = ServiceLoader.load(Color.class);
System.out.println("Java SPI");
Iterator<Color> iterator = serviceLoader.iterator();
while (iterator.hasNext()) {
Color color = iterator.next();
color.draw();
}
// Java SPI
// I am black
// I am blue
// I am Red
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
# 3. Dubbo SPI 使用范例
# 3.1 定义接口
import com.alibaba.dubbo.common.extension.SPI;
import com.alibaba.dubbo.common.URL;
// 比 java spi 多了一个 @SPI 注解
@SPI
public interface Color {
void draw(URL url);
}
1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
# 3.2 定义实现类
// Red
public class Red implements Color {
@Override
public void draw(URL url) {
System.out.println(" I am Red");
}
}
// Black
public class Black implements Color {
@Override
public void draw(URL url) {
System.out.println(" I am black");
}
}
// Blue
public class Blue implements Color {
@Override
public void draw(URL url) {
System.out.println(" I am blue");
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# 3.3 创建 META-INF/dubbo 文件
和 Java SPI 不同， Java SPI在 META-INF/services 下创建文件，而 Dubbo SPI 是在 META-INF/dubbo 下创建文件。
在 src/main/META-INF/dubbo 文件夹下创建一个文件，名称为 Color 的全限定名 com.alibaba.dubbo.demo.model.dubbo_spi.Color。
文件内容为实现类的全限定的类名，如下：
black=com.alibaba.dubbo.demo.model.dubbo_spi.Black
blue=com.alibaba.dubbo.demo.model.dubbo_spi.Blue
red=com.alibaba.dubbo.demo.model.dubbo_spi.Red
1
2
3
2
3
# 3.4 测试
# 3.4.1 通过名称获取
import com.alibaba.dubbo.common.URL;
import com.alibaba.dubbo.common.extension.ExtensionLoader;
import com.alibaba.dubbo.demo.model.dubbo_spi.Color;
public class Dubbo_SPI_Test {
@Test
public void dubboSPI_Test() {
URL url = URL.valueOf("test://localhost/test");
ExtensionLoader<Color> extensionLoader = ExtensionLoader.getExtensionLoader(Color.class);
Color red = extensionLoader.getExtension("red");
red.draw(url);
Color blue = extensionLoader.getExtension("blue");
blue.draw(url);
Color black = extensionLoader.getExtension("black");
black.draw(url);
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# 3.4.2 SPI 带参数，URL 不带参数
// SPI 后指定值
@SPI("blue")
public interface Color {
void draw(URL url);
}
1
2
3
4
5
2
3
4
5
import com.alibaba.dubbo.common.URL;
import com.alibaba.dubbo.common.extension.ExtensionLoader;
import com.alibaba.dubbo.demo.model.dubbo_spi.Color;
public class Dubbo_SPI_Test {
@Test
public void adaptiveTest() {
URL url = URL.valueOf("test://localhost/test"); // URL 不带参数
ExtensionLoader<Color> extensionLoader = ExtensionLoader.getExtensionLoader(Color.class);
final Color color = extensionLoader.getAdaptiveExtension();
color.draw(url); // I am blue
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
# 3.4.3 SPI 带参数，URL 带参数
// SPI 后指定值
@SPI("blue")
public interface Color {
@Adaptive({"haha"})
void draw(URL url);
}
1
2
3
4
5
6
2
3
4
5
6
import com.alibaba.dubbo.common.URL;
import com.alibaba.dubbo.common.extension.ExtensionLoader;
import com.alibaba.dubbo.demo.model.dubbo_spi.Color;
public class Dubbo_SPI_Test {
@Test
public void adaptiveTest() {
URL url = URL.valueOf("test://localhost/test?haha=red"); // URL 带参数
ExtensionLoader<Color> extensionLoader = ExtensionLoader.getExtensionLoader(Color.class);
final Color color = extensionLoader.getAdaptiveExtension();
color.draw(url); // I am Red
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
# 3.4.4 测试4：SPI 带参数，URL 带参数，实现类带 Adaptive 注解
// SPI 后指定值
@SPI("blue")
public interface Color {
// URL 后的参数
@Adaptive({"haha"})
void draw(URL url);
}
// 实现类带 Adaptive 注解
@Adaptive
public class Black implements Color {
@Override
public void draw(URL url) {
System.out.println(" I am black");
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
import com.alibaba.dubbo.common.URL;
import com.alibaba.dubbo.common.extension.ExtensionLoader;
import com.alibaba.dubbo.demo.model.dubbo_spi.Color;
public class Dubbo_SPI_Test {
@Test
public void adaptiveTest() {
URL url = URL.valueOf("test://localhost/test?haha=red"); // URL 带参数
ExtensionLoader<Color> extensionLoader = ExtensionLoader.getExtensionLoader(Color.class);
final Color color = extensionLoader.getAdaptiveExtension();
color.draw(url); // I am black
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
# 3.5 结论
上面的几个测试用例，可以得到下面的结论：
- 在类上面添加
Adaptive注解 优先级最高。 URL中 如果带参数，优先级次之。- 最后是
SPI带参数，优先级最低。
← Dubbo 常用技巧 JavaSPI →