Java中的SPI的使用例子
首先,看一下总体的结构图:
在src的main中,我们定义了com.lf这样一个路径,下面有两个包,首先我们看一下API包中,我们定义了一个接口MyPrinterAPI
:
package com.lf;
import com.lf.API.MyPrinterAPI;
import java.util.ServiceLoader;
public class testClient {
public static void main(String[] args) {
ServiceLoader<MyPrinterAPI> printers = ServiceLoader.load(MyPrinterAPI.class);
// System.out.println(printers);
for (MyPrinterAPI printer : printers) {
printer.sayHello("SPI");
}
}
}
然后,在impl包下定义了两个这个接口的实现–MyPrinterA
与MyPrinterB
,(C是一个对比,并没有实现接口),其代码如下:
// MyPrinterA.java
package com.lf.impl;
import com.lf.API.MyPrinterAPI;
public class MyPrinterA implements MyPrinterAPI {
@Override
public String sayHello(String str) {
String res = "This is printer A!\nHello " + str;
System.out.println(res);
return res;
}
}
// MyPrinterB.java
package com.lf.impl;
import com.lf.API.MyPrinterAPI;
public class MyPrinterB implements MyPrinterAPI {
@Override
public String sayHello(String str) {
String res = "This is printer B!\nHello " + str;
System.out.println(res);
return res;
}
}
在完成了这三个java文件后,我们在resources文件夹下创建META-INF/services这样的文件夹路径,然后在services文件夹下创建一个文件com.lf.API.MyPrinterAPI
,可以看到,这个文件的即为我们所定义的接口MyPrinterAPI
的全限定名。
之后,我们在这个文件下写入:
com.lf.impl.MyPrinterA
com.lf.impl.MyPrinterB
(上图中,我的IDE在我写入时是有提示A与B的,但是没有C,因为C没有实现接口)
以上步骤完成后,我们就可以开始我们的测试了。
我们在com.lf下创建一个测试文件testClient,在里面写入main函数作为测试的入口:
// testClient.java
package com.lf;
import com.lf.API.MyPrinterAPI;
import java.util.ServiceLoader;
public class testClient {
public static void main(String[] args) {
ServiceLoader<MyPrinterAPI> printers = ServiceLoader.load(MyPrinterAPI.class);
for (MyPrinterAPI printer : printers) {
printer.sayHello("SPI");
}
}
}
运行结果:
This is printer A!
Hello SPI
This is printer B!
Hello SPI
可以看到成功地调用了我们所写的两个实现类。