ARouter是阿里开源的Android路由框架,主要用于解决Android应用组件化改造解耦后组件间跳转、通信等操作。 本篇文章管中窥豹地简单总结下ARouter的使用和源码。
项目地址:
https://github.com/alibaba/ARouter
一、ARouter使用
1.1 框架引入
根工程build.gradle
dependencies {
//ARouter插件依赖
classpath "com.alibaba:arouter-register:1.0.2"
}
对需要路由的组件均做如下配置:build.gradle
plugins {
//引入aroute插件
id 'com.alibaba.arouter'
}
android {
defaultConfig {
//ARouter配置
javaCompileOptions {
annotationProcessorOptions {
arguments = [AROUTER_MODULE_NAME: project.getName(), AROUTER_GENERATE_DOC: "enable"]
}
}
}
}
dependencies {
//arouter库
compileOnly("com.alibaba:arouter-api:1.5.0") {
exclude group: 'com.android.support' //排除掉support包,保证版本统一
}
annotationProcessor("com.alibaba:arouter-compiler:1.2.2")
}
这里arouter库一般只在宿主中通过implementation引入,各组件只需要compileOnly
1.2 使用
完整使用参考官方文档。
这里以一个案例简单介绍下常用的通过服务接口实现解耦组件间调用
案例组件构成:
- host 宿主
- base_core 基础组件
- ft_a 业务A组件
- ft_login 业务登录组件
业务A组件调用登录组件登录功能说明:
host:宿主
public class RefApplication extends Application {
@Override
public void onCreate() {
super.onCreate();
//ARouter初始化
ARouter.init(this);
}
}
application中做ARouter初始化
base_core组件:
定义接口
public interface LoginService extends IProvider {
void login(Context context);
}
定义供外部组件统一调用的登录功能包装入口
public class LoginWrapper {
private static LoginWrapper sLoginWrapper = null;
@Autowired(name = Constants.LOGIN) // /login/login_service 至少两级地址
protected LoginService mLoginService;
private LoginWrapper() {
ARouter.getInstance().inject(this);
}
public static LoginWrapper getInstance() {
if (sLoginWrapper == null) {
synchronized (LoginWrapper.class) {
if (sLoginWrapper == null) {
sLoginWrapper = new LoginWrapper();
}
}
}
return sLoginWrapper;
}
public void login(Context context) {
mLoginService.login(context);
}
}
ft_login组件
@Route(path = Constants.LOGIN)//与@Autowired name保持一致
public class LoginServiceImpl implements LoginService {
@Override
public void login(Context context) {
//TODO login具体功能
}
@Override
public void init(Context context) {
//实现IProvider init()方法,这里就是个初始化回调
}
}
ft_a组件
A组件调用登录功能:
LoginWrapper.getInstance().login(this);
base_core业务组件都会依赖,以它作为中转站,定义服务接口和提供具体服务执行包装类,不相互依赖的业务组件间通过它来统一获取其他组件的功能。这里ft_a组件通过LoginWrapper调用login功能,内部由接口LoginService通过注解的方式获取ft_login具体实现LoginServiceImpl来执行最终的login功能。下面通过这个流程来简单看下ARouter内部是怎么实现的。
二、ARouter源码浅析
2.1 APT动态生成文件
ARouter在编译阶段通过APT动态生成一批文件:
这里Processor如何生成对应模板不铺开分析了,这不是重点,感兴趣的可以自行撸下源码,这里简单看下编译生成的模板类是什么样的:
@Router
注解通过RouteProcessor生成存储了path、group以及目标类相关映射关系的类文件:
public class ARouter$$Providers$$ft_login implements IProviderGroup {
@Override
public void loadInto(Map<String, RouteMeta> providers) {
}
}
public class ARouter$$Root$$ft_login implements IRouteRoot {
@Override
public void loadInto(Map<String, Class<? extends IRouteGroup>> routes) {
routes.put("login", ARouter$$Group$$login.class);
}
}
public class ARouter$$Group$$login implements IRouteGroup {
@Override
public void loadInto(Map<String, RouteMeta> atlas) {
atlas.put("/login/login_service", RouteMeta.build(RouteType.ACTIVITY, LoginActivity.class, "/login/login_service", "login", null, -1, -2147483648));
}
}
@Autowired
注解通过AutowiredProcessor也生成相关的映射文件
public class LoginWrapper$$ARouter$$Autowired implements ISyringe {
private SerializationService serializationService;
@Override
public void inject(Object target) {
serializationService = ARouter.getInstance().navigation(SerializationService.class);
LoginWrapper substitute = (LoginWrapper)target;
substitute.mLoginService = (LoginService)ARouter.getInstance().build("/login/login_service").navigation();
}
}
2.2 ARouter初始化
ARouter.init(this)
这里ARouter作为门面,具体功能实现交由代理_ARouter来处理,整个init过程最终核心功能在LogisticsCenter.init(...)
public synchronized static void init(Context context, ThreadPoolExecutor tpe) throws HandlerException {
mContext = context;
executor = tpe;
try {
long startInit = System.currentTimeMillis();
//billy.qi modified at 2017-12-06
//load by plugin first
loadRouterMap();
if (registerByPlugin) {
logger.info(TAG, "Load router map by arouter-auto-register plugin.");
} else {
Set<String> routerMap;
// It will rebuild router map every times when debuggable.
if (ARouter.debuggable() || PackageUtils.isNewVersion(context)) {
logger.info(TAG, "Run with debug mode or new install, rebuild router map.");
// These class was generated by arouter-compiler.
//扫描com.alibaba.android.arouter.routes包下面包含的所有的ClassName
routerMap = ClassUtils.getFileNameByPackageName(mContext, ROUTE_ROOT_PAKCAGE);
if (!routerMap.isEmpty()) {
context.getSharedPreferences(AROUTER_SP_CACHE_KEY, Context.MODE_PRIVATE).edit().putStringSet(AROUTER_SP_KEY_MAP, routerMap).apply();
}
PackageUtils.updateVersion(context); // Save new version name when router map update finishes.
} else {
logger.info(TAG, "Load router map from cache.");
routerMap = new HashSet<>(context.getSharedPreferences(AROUTER_SP_CACHE_KEY, Context.MODE_PRIVATE).getStringSet(AROUTER_SP_KEY_MAP, new HashSet<String>()));
}
logger.info(TAG, "Find router map finished, map size = " + routerMap.size() + ", cost " + (System.currentTimeMillis() - startInit) + " ms.");
startInit = System.currentTimeMillis();
for (String className : routerMap) {
//com.alibaba.android.arouter.routes.ARouter$$Root
if (className.startsWith(ROUTE_ROOT_PAKCAGE + DOT + SDK_NAME + SEPARATOR + SUFFIX_ROOT)) {
// This one of root elements, load root.
//这里将该文件信息加载到Warehouse对应Map中,作为内存缓存
((IRouteRoot) (Class.forName(className).getConstructor().newInstance())).loadInto(Warehouse.groupsIndex);
//com.alibaba.android.arouter.routes.ARouter$$Interceptors
} else if (className.startsWith(ROUTE_ROOT_PAKCAGE + DOT + SDK_NAME + SEPARATOR + SUFFIX_INTERCEPTORS)) {
// Load interceptorMeta
((IInterceptorGroup) (Class.forName(className).getConstructor().newInstance())).loadInto(Warehouse.interceptorsIndex);
//com.alibaba.android.arouter.routes.ARouter$$Providers
} else if (className.startsWith(ROUTE_ROOT_PAKCAGE + DOT + SDK_NAME + SEPARATOR + SUFFIX_PROVIDERS)) {
// Load providerIndex
((IProviderGroup) (Class.forName(className).getConstructor().newInstance())).loadInto(Warehouse.providersIndex);
}
}
}
...
}
init过程主要是扫描com.alibaba.android.arouter.routes包下动态生成的类,按映射关系(组分类、多级管理,按需初始化)分类加载到内存,由Warehouse不同的Map来保存。
这里简单看下RouteMeta的数据结构,以及其build方法
public class RouteMeta {
private RouteType type; // 路由支持的类型:ACTIVITY、SERVICE、PROVIDER、CONTENT_PROVIDER、BOARDCAST、METHOD、FRAGMENT、UNKNOWN
private Element rawType; // Raw type of route
private Class<?> destination; // 访问的目标类
private String path; // 路由路径,这里指Route注解设置的path
private String group; // Group of route
private int priority = -1; // The smaller the number, the higher the priority
private int extra; // Extra data
private Map<String, Integer> paramsType; // Param type
private String name;
private Map<String, Autowired> injectConfig; // Cache inject config.
public RouteMeta() {
}
//初始化RouteMeta实例
public static RouteMeta build(RouteType type, Class<?> destination, String path, String group, Map<String, Integer> paramsType, int priority, int extra) {
return new RouteMeta(type, null, destination, null, path, group, paramsType, priority, extra);
}
然后将该实例添加到Map<String, RouteMeta> 中,key是Router path value是初始化好的RouteMeta实例。
2.3 路由的方式调用目标类的方法
LoginWrapper.getInstance().login(this);
从上面的源码看,LoginWrapper作为包装类,最终login方法是通过具体的service去实现。
那么这里就要了解如何发现化服务,官方介绍有两种方式:
1) (推荐)使用依赖注入的方式发现服务,通过注解标注字段,即可使用,无需主动获取
public class LoginWrapper {
@Autowired(name = Constants.LOGIN)
protected LoginService mLoginService;
private LoginWrapper() {
ARouter.getInstance().inject(this);
}
public void login(Context context) {
mLoginService.login(context);
}
}
为LoginService打上@Autowired注解,通过ARouter的inject方法直接调用APT生成的模板类:
inject方法的调用栈:
ARouter.inject ->_ARouter.inject -> AutowiredServiceImpl.autowire -> LoginWrapper$$ARouter$$Autowired.inject
public class LoginWrapper$$ARouter$$Autowired implements ISyringe {
private SerializationService serializationService;
@Override
public void inject(Object target) {
serializationService = ARouter.getInstance().navigation(SerializationService.class);
LoginWrapper substitute = (LoginWrapper)target;
substitute.mLoginService = (LoginService)ARouter.getInstance().build("/login/login_service").navigation();
}
}
2)使用依赖查找的方式发现服务
public class LoginWrapper {
protected LoginService mLoginService;
public void login(Context context) {
mLoginService = (LoginService) ARouter.getInstance().build(Constants.LOGIN).navigation();
mLoginService.login(context);
}
}
直接通过ARouter来查找,实现其实与APT生成的模板类是一样的,只是从写法上来说,打上@Autowired注解更简洁,也是官方推荐的方式。
这里mLoginService最终实例对应的是ft_a中的LoginServiceImpl,通过它来实现具体的login功能。那么关键就是分析清楚如下代码:
(LoginService) ARouter.getInstance().build(Constants.LOGIN).navigation();
从调用来看主要分两步:
- build("/login/login_service"):
_ARouter.java
protected Postcard build(String path) {
if (TextUtils.isEmpty(path)) {
throw new HandlerException(Consts.TAG + "Parameter is invalid!");
} else {
PathReplaceService pService = ARouter.getInstance().navigation(PathReplaceService.class);
if (null != pService) {
path = pService.forString(path);
}
//构建一个携带 path和group两个路由地址数据的Postcard对象
return build(path, extractGroup(path));
}
}
整个build过程实际上就是构建一个Postcard。一个Postcard 对象就对应了一次路由请求,该对象作用于本次路由全过程。
- navigation():
经过层层调用最终核心实现在
com/alibaba/android/arouter/launcher/_ARouter.java
/**
* 参数:
* Postcard this
* requestCode -1
* callback null
*/
protected Object navigation(final Context context, final Postcard postcard, final int requestCode, final NavigationCallback callback) {
PretreatmentService pretreatmentService = ARouter.getInstance().navigation(PretreatmentService.class);
...
//从Warehouse对应map中获取@Router标记的目标类更多信息,完善当前Postcard
LogisticsCenter.completion(postcard);
...
//绿色通道,默认不走
if (!postcard.isGreenChannel()) { // It must be run in async thread, maybe interceptor cost too mush time made ANR.
...
} else {
return _navigation(context, postcard, requestCode, callback);
}
return null;
}
这里核心代码就两处:一个是通过LogisticsCenter.completion(postcard)来完善Postcard的类信息。另一个是通过_navigation来执行对应的操作。
先看LogisticsCenter.completion()方法
public synchronized static void completion(Postcard postcard) {
if (null == postcard) {
throw new NoRouteFoundException(TAG + "No postcard!");
}
// 从仓库的路由地址清单列表中尝试获取对应的RouteMeta
RouteMeta routeMeta = Warehouse.routes.get(postcard.getPath());
if (null == routeMeta) { // Maybe its does't exist, or didn't load.
// 如果前面没获取到,则根据一级地址,尝试获取对应的路由地址清单的文件类(ARouter$$Root$$工程名)
Class<? extends IRouteGroup> groupMeta = Warehouse.groupsIndex.get(postcard.getGroup()); // Load route meta.
if (null == groupMeta) {
throw new NoRouteFoundException(TAG + "There is no route match the path [" + postcard.getPath() + "], in group [" + postcard.getGroup() + "]");
} else {
// Load route and cache it into memory, then delete from metas.
try {
if (ARouter.debuggable()) {
logger.debug(TAG, String.format(Locale.getDefault(), "The group [%s] starts loading, trigger by [%s]", postcard.getGroup(), postcard.getPath()));
}
IRouteGroup iGroupInstance = groupMeta.getConstructor().newInstance();
iGroupInstance.loadInto(Warehouse.routes);
Warehouse.groupsIndex.remove(postcard.getGroup());
if (ARouter.debuggable()) {
logger.debug(TAG, String.format(Locale.getDefault(), "The group [%s] has already been loaded, trigger by [%s]", postcard.getGroup(), postcard.getPath()));
}
} catch (Exception e) {
throw new HandlerException(TAG + "Fatal exception when loading group meta. [" + e.getMessage() + "]");
}
completion(postcard); // Reload
}
} else {
//完善postcard信息
postcard.setDestination(routeMeta.getDestination());
postcard.setType(routeMeta.getType());
postcard.setPriority(routeMeta.getPriority());
postcard.setExtra(routeMeta.getExtra());
Uri rawUri = postcard.getUri();
if (null != rawUri) { // Try to set params into bundle.
Map<String, String> resultMap = TextUtils.splitQueryParameters(rawUri);
Map<String, Integer> paramsType = routeMeta.getParamsType();
if (MapUtils.isNotEmpty(paramsType)) {
// Set value by its type, just for params which annotation by @Param
for (Map.Entry<String, Integer> params : paramsType.entrySet()) {
setValue(postcard,
params.getValue(),
params.getKey(),
resultMap.get(params.getKey()));
}
// Save params name which need auto inject.
postcard.getExtras().putStringArray(ARouter.AUTO_INJECT, paramsType.keySet().toArray(new String[]{}));
}
// Save raw uri
postcard.withString(ARouter.RAW_URI, rawUri.toString());
}
//针对不同的type做不同的设置
switch (routeMeta.getType()) {
//如果是PROVIDER类型,会通过routeMeta获取目标类,并实例化,最终由postcard.setProvider设置目标类的实例化对象
case PROVIDER: // if the route is provider, should find its instance
// Its provider, so it must implement IProvider
Class<? extends IProvider> providerMeta = (Class<? extends IProvider>) routeMeta.getDestination();
IProvider instance = Warehouse.providers.get(providerMeta);
if (null == instance) { // There's no instance of this provider
IProvider provider;
try {
provider = providerMeta.getConstructor().newInstance();
provider.init(mContext);
Warehouse.providers.put(providerMeta, provider);
instance = provider;
} catch (Exception e) {
throw new HandlerException("Init provider failed! " + e.getMessage());
}
}
postcard.setProvider(instance);
postcard.greenChannel(); // Provider should skip all of interceptors
break;
case FRAGMENT:
postcard.greenChannel(); // Fragment needn't interceptors
default:
break;
}
}
}
complete主要是通过Warehouse来完善postcard信息 ,这里因为LoginService继承的IProvider,routeMeta对应的类型为PROVIDER,这里会初始化目标类LoginServiceImpl,并通过postcard.setProvider来设置到postcard中。
再看_navigation()方法
private Object _navigation(final Context context, final Postcard postcard, final int requestCode, final NavigationCallback callback) {
final Context currentContext = null == context ? mContext : context;
switch (postcard.getType()) {
case ACTIVITY:
// Build intent
final Intent intent = new Intent(currentContext, postcard.getDestination());
intent.putExtras(postcard.getExtras());
// Set flags.
int flags = postcard.getFlags();
if (-1 != flags) {
intent.setFlags(flags);
} else if (!(currentContext instanceof Activity)) { // Non activity, need less one flag.
intent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
}
// Set Actions
String action = postcard.getAction();
if (!TextUtils.isEmpty(action)) {
intent.setAction(action);
}
// Navigation in main looper.
runInMainThread(new Runnable() {
@Override
public void run() {
startActivity(requestCode, currentContext, intent, postcard, callback);
}
});
break;
case PROVIDER:
return postcard.getProvider();
case BOARDCAST:
case CONTENT_PROVIDER:
case FRAGMENT:
Class fragmentMeta = postcard.getDestination();
try {
Object instance = fragmentMeta.getConstructor().newInstance();
if (instance instanceof Fragment) {
((Fragment) instance).setArguments(postcard.getExtras());
} else if (instance instanceof android.support.v4.app.Fragment) {
((android.support.v4.app.Fragment) instance).setArguments(postcard.getExtras());
}
return instance;
} catch (Exception ex) {
logger.error(Consts.TAG, "Fetch fragment instance error, " + TextUtils.formatStackTrace(ex.getStackTrace()));
}
case METHOD:
case SERVICE:
default:
return null;
}
return null;
}
根据PostCard携带的类型,做相应的操作。这里因为类型为PROVIDER,返回的 postcard.getProvider(),由上面complete我们知道postcard.getProvider()获取的是目标类LoginServiceImpl的实例。
最后再总结一张ARoute核心工作原理图:
本篇文章从组件化经典应用案例出发,通过分析涉及的框架源码简单了解了ARouter的核心工作原理, 仅仅只是管中窥豹,更详细使用和说明还参考官方文档。完成这篇文章又到了凌晨1点多,年前的最后一篇文章,希望新的一年能沉淀出更好的自己,加油!