Java SPI全称Service Provider Interface,是Java提供的一套用来被第三方实现或者扩展的API,它可以用来启用框架扩展和替换组件。实际上是“基于接口的编程+策略模式+配置文件”组合实现的动态加载机制.
ServiceLoader的使用
操作步骤:
1、定义一个接口文件
2、写出多个该接口文件的实现
3、在 src/main/resources/ 下建立 /META-INF/services 目录, 新增一个以接口命名的文件 , 内容是要接口的实现类全路径
4、使用ServiceLoader类 来获取到这些实现的接口
先创建一个interface的module。
然后在其他的模块实现这个接口,并在实现这个接口的module中创建一个resources文件夹,文件夹里建一个文件,文件名为(对应接口的全路径 + 接口名),文件里面写的内容则为其(实现类的全路径+实现类名)。在操作过程中,遇到了一个坑,就是文件夹是两级文件夹,我在操作的时候图简单,直接META-INF.services,结果导致通过ServiceLoader获取实现类的时候,获取为空。这里应该先创建一个文件夹,命名为META-INF,然后再在这个文件夹再创建一个文件夹,命名为services,虽然在AS上显示仍然为META-INF.services,但是这是一个二级文件夹 ,而我那种做法只算以及文件夹。导致获取不到文件里的内容。
然后创建一个help类,其具体的实现为:
public class ServiceHelper {
//针对一种接口多个实现类操作
public static List getServices(Class interfaceClass){
ServiceLoader loader = ServiceLoader.load(interfaceClass);
Iterator iterator = loader.iterator();
List list = new ArrayList<>();
while (iterator.hasNext()){
T t = (T) iterator.next();
if (t != null){
list.add(t);
}
}
return list;
}
//针对一个接口一个实现类操作
public static T getService(Class interfaceClass){
ServiceLoader loader = ServiceLoader.load(interfaceClass);
Iterator iterator = loader.iterator();
if (iterator.hasNext()){
return (T) iterator.next();
}else {
return null;
}
}
}
然后在App模块中调用,
AInterface aInterface = ServiceHelper.getService(AInterface.class);
Log.e("zzf",aInterface + "");
BInterface bInterface = ServiceHelper.getService(BInterface.class);
Log.e("zzf",aInterface.getname() +"------------" + bInterface.getname());
这种方法在平常组件化开发中非常便利,但是每次都需要到/META-INF/services 目录建立文件,不能动态添加。因此采用Google的@AutoService,他可以帮我们在编译的时候动态去生成这些东西。
ServiceLoader + @AutoService的使用
添加依赖:
implementation 'com.google.auto.service:auto-service:1.0'
annotationProcessor 'com.google.auto.service:auto-service:1.0'
接口module不需要变,我们只需要在实现类进行改变一下即可:
@AutoService(CInterface.class)
public class C2Impl implements CInterface {
@Override
public String getName() {
return "C2Impl";
}
}
只需要在具体的实现类上面加上一个@AutoService注解,参数则为接口的class类。
然后在App模块中调用,
List list = ServiceHelper.getServices(CInterface.class);
for (CInterface cInterface:list){
Log.e("zzf",cInterface.getName());
}
ARouter
阿里的ARouter框架就是是借助了这种思想,它只需要我们的自己的接口继承IProvider接口,
public interface BInterface extends IProvider {
String getname();
}
然后在B模块实现接口
@Route(path = "/user/BInterface")
public BImpl implements BInterface{
@Override
public String getname() {
return "A2Impl";
}
}
然后在其他模块通过ARouter注解获取实例
@Autowired//(name = "/user/BInterface")
BImpl mBImpl;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
ARouter.getInstance().inject(this);
...