【开发12年码农教你】Android端简单易用的SPI框架-—

@Service(priority = 1)
public class APrinterService implements IPrinterService {
@Override
public void print() {
System.out.println(“this is a printer service.”);
}
}
复制代码

B模块 —— BPrinterService

@Service(path=“b_printer”, priority = 2)
public class BPrinterService implements IPrinterService {
@Override
public void print() {
System.out.println(“this is b printer service.”);
}
}
复制代码

C模块 —— CPrinterService

@Service(priority = 3)
public class CPrinterService implements IPrinterService {
@Override
public void print() {
System.out.println(“this is c printer service.”);
}
}
复制代码

最后是Main模块, 下面的逻辑也可以存在于是A,B,C模块中

IPrinterService printer = Spa.getService(IPrinterService.class); //取最高优先级
printer.print(); // 输出: this is c printer service.

APrinterService aprinter = Spa.getFixedService(APrinterService.class);
aprinter.print();// 输出: this is a printer service.

BPrinterService bPrinter = Spa.getFixedService(BPrinterService.class);
bPrinter.print();// 输出: this is b printer service.

// 和上面的Spa.getFixedService(BPrinterService.class)等价
IPrinterService pathPrinter = Spa.getService(“b_printer”); //是不是有路由的感觉
pathPrinter.print(); // 输出: this is b printer service.

复制代码

这就是SPA最基本的用法，到目前为止他已经有了SPI机制的能力了，是不是很简单！！！难道SPA只有这点内容吗，当然不是！

SPA创建的对象的生命周期是怎样的?

对于上面的示例大家有没有一个疑问， bPrinter和pathPrinter都是实现类BPrinterService对象，那么这两个对象相等吗, bPrinter == pathPrinter?

下面介绍一下@Service注解的 scope属性

scope定义一个对象的生命周期，SPA内置的scope有

normal, 普通对象，每次都返回一个新创建对象，默认scope
global, 全局对象，可以看做是一个单例，每次返回的都是同一个对象, 对象将在第一次被使用时创建
weak, 对象使用弱引用缓存，如果没有被gc回收，则不会重新创建
soft, 对象使用软引用缓存，如果没有被gc回收，则不会重新创建
custom, 自定义缓存策略, 当scope不是上面列出的值时，会被认为是自定义缓存策略，自定义缓存策略将在Spa进阶篇中介绍

那么bPrinter和pathPrinter相等吗? 答案就显而易见了，因为SPA对象默认的生命周期是nornal,也就是每次都会创建一个新对象，所以 bPrinter != pathPrinter。如果想要 bPrinter == pathPrinter, 只需要将BPrinterService的scope定义为 global！

@Service(path=“b_printer”, priority = 2, scope=Spa.Scope.GLOBAL) //scope 设置为 global
public class BPrinterService implements IPrinterService {
@Override
public void print() {
System.out.println(“this is b printer service.”);
}
}
复制代码

SPA的方法拦截能力

SPA并不是简单的创建并返回一个对象，SPA实际返回的是目标对象的代理，通过代理，对象执行方法时，我们就能对该对象实施拦截，

SPA有灵活的拦截能力，不仅仅可以设置拦截器，还可以设置拦截策略

自定义拦截器，多个拦截器默认按优先级顺序依次执行拦截
自定义拦截策略，多个拦截器时，这些拦截器的执行顺序、执行方式由拦截策略决定

自定义拦截策略放到后面进阶篇,这里先说一下拦截器的用法,我们先看一下SPA执行方法的流程图，流程图演示的是上一节示例的CPrinterService的print方法调用过程

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

拦截器代码中是如何使用的？

实现IServiceInterceptor接口并被@Service标记的类会被SPA认为是一个方法调用拦截器

先定义一个高优先级的拦截器

@Service(priority = Spa.Priority.MAX)
public class MaxPriorityServiceInterceptor implements IServiceInterceptor {
@Override
public void intercept(Class<? extends IService> originClass, IService source, Method method, Object[] args, IServiceInterceptorCallback callback) {
System.out.println(“this is a max priority interceptor.”)
callback.onContinue(method, args);

}
}
复制代码

再定义一个普通优先级的拦截器

@Service
public class NormalServiceInterceptor implements IServiceInterceptor {

@Override
public void intercept(Class<? extends IService> originClass, IService source, Method method, Object[] args, IServiceInterceptorCallback callback) {
System.out.println(“this is a normal priority interceptor.”)
callback.onContinue(method, args);
}
}
复制代码

再定义一个低优先级的拦截器

@Service(priority = Spa.Priority.MIN)
public class MinPriorityServiceInterceptor implements IServiceInterceptor {
@Override
public void intercept(Class<? extends IService> originClass, IService source, Method method, Object[] args, IServiceInterceptorCallback callback) {
System.out.println(“this is a min priority interceptor.”)
if (“chao.sample.c.CPrinterService”.equalse(originClass.getName()) && “print”.equals(method.getName())) { // 当拦截的是CPrinterService的print方法时，拦截！
callback.onInterrupt(null); //如果方法有返回值，null可以替换为拦截的值
} else {
callback.onContinue(method, args);
}
}
}

执行print方法

IPrinterService printService = Spa.getService(IPrinterService.class); //cPrinter
printService.print();

最后看输出结果

this is a max priority interceptor.
this is a normal priority interceptor.
this is a min priority interceptor.

this is c printer service. cPrinter的print被拦截，没有被执行，所以不会有这条输出

再看下整个流程的时序图

SPA应用实战1 —— 子模块如何获取主模块的BuildConfig信息

多模块开发/组件化开发过程中，主模块(plugin为com.android.application的模块，一般指app模块)可以依赖任何模块，但是子模块无法依赖主模块，如果子模块想拿主模块的内容要怎么办呢？下面演示如何通过Spa来获取主模块的Context和BuildConfig中的内容。 先在接口层定义一个BuildService

BuildService.java

public interface BuildService extends IService {
String buglyId(); // build.gradle中使用buildConfigField定义的buglyId

boolean debuggable();

String versionName();

int versionCode();

String applicationId();

String buildType();
}

在app模块中，实现这个service接口并使用@Service标记

BuildServiceImpl.java

@Service(scope = Spa.Scope.GLOBAL) //Global可以看做是单例
public class BuildServiceImpl implements BuildService {
@Override
public String buglyId() {
return BuildConfig.BUGLY_ID;
}

@Override
public boolean debuggable() {
return BuildConfig.DEBUG;
}

@Override
public String versionName() {
return BuildConfig.VERSION_NAME;
}

@Override
public int versionCode() {
return BuildConfig.VERSION_CODE;
}

@Override
public String applicationId() {
return BuildConfig.APPLICATION_ID;
}

@Override
public String buildType() {
return BuildConfig.BUILD_TYPE;
}
}

准备工作已经完成，现在我们在pages模块的BuildInfoActivity中应用它

BuildInfoActivity.java

public class BuildInfoActivity extends AppCompatActivity {

@Override
protected void onCreate(@Nullable Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
BuildInfoPageBinding viewBinding = BuildInfoPageBinding.inflate(LayoutInflater.from(this));
setContentView(viewBinding.getRoot());

BuildService buildService = Spa.getService(BuildService.class);
viewBinding.applicationId.setText("applicationId: " + buildService.applicationId());
viewBinding.versionName.setText("versionName: " + buildService.versionName());
viewBinding.versionCode.setText("versionCode: " + buildService.versionCode() + “”);
viewBinding.buildType.setText("buildType: " + buildService.buildType());
viewBinding.debuggable.setText("debuggable: " + buildService.debuggable());
viewBinding.buglyId.setText(“buglyId:” + buildService.buglyId());
}
}}

看看最终的效果

这是SPA最简单的一个应用场景，更多应用实战将会在SPA的进阶篇中介绍

上面涉及到的所有示例代码都在这里

进阶篇链接:

SPA进阶篇1 —— 服务分发
SPA进阶篇2 —— 路由分发SPRouter
SPA进阶篇3 —— 组件Mock
SPA进阶篇4 —— RPC通信SPRpc

总结

本文主要介绍了Android端简单易用的SPI框架 —— SPA(Service Pool for Android)的能力和用法, 并和Java的SPI机制做了对比。相信大家看得出SPA更强大,更简洁而且消耗更低。
作者：小码哥哥
链接：https://juejin.
im/post/6872335132229894158