欢迎访问我的主页:juejin.cn/user/330776…
ARouter官方文档:github.com/alibaba/ARo…
组件化ARouter系列(一、启动Activity):juejin.cn/post/704852…
组件化ARouter系列(二、跨模块API调用):juejin.cn/post/705339…
组件化ARouter系列(三、参数传递与解析):juejin.cn/post/705340…
一、ARouter概述
ARouter是一个用于帮助Android App进行组件化改造的框架 —— 支持模块间的路由、通信、解耦。ARouter的典型应用场景有:
- 从外部URL映射到内部页面,以及参数传递与解析;
- 跨模块页面跳转,模块间解耦;
- 拦截跳转过程,处理登陆、埋点等逻辑;
- 跨模块API调用,通过控制反转来做组件解耦;
本篇主要介绍ARouter的用法之一:参数传递与解析。
二、基础用法
仍然和"组件化基础ARouter(一)"中举相同的例子:在MainActivity中有一个FirstButton,FirstButton点击后打开模块first_library中的FirstActivity,不同的是,这次在打开FirstActivity时需要传递一个int参数(10)、String参数("hello")、User参数:
在不使用ARouter的情况下,简单的实现方式是通过intent传递:
public class MainActivity extends Activity implements View.OnClickListener {
@Override
public void onClick(View v) {
if (v.getId() == R.id.main_button) {
User user = new User("jack", 18);
Intent intent = new Intent(this, FirstActivity.class);
// 1.往intent中添加参数
intent.putExtra("intValue", 10);
intent.putExtra("strValue", "hello");
intent.putExtra("user", user);
startActivity(intent);
}
}
}
public class FirstActivity extends AppCompatActivity implements View.OnClickListener {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_first);
// ...省略部分代码
// 2.从intent中取参数
Intent intent = getIntent();
intValue = intent.getIntExtra("intValue", 0);
strValue = intent.getStringExtra("strValue");
user = intent.getParcelableExtra("user");
firstIntTextView.setText("intValue:"+intValue);
firstStrTextView.setText("strValue"+strValue);
firstUserTextView.setText("User:"+user.name+":"+user.age);
}
}
复制代码
下面介绍ARouter参数传递的方式:
public class MainActivity extends AppCompatActivity implements View.OnClickListener {
@Override
public void onClick(View v) {
if (v.getId() == R.id.main_button) {
User user = new User("jack", 18);
// 1.通过with系列方法传递对应类型参:支持基础类型及Parcelable、Serializable对象
ARouter.getInstance().build("/first/activity")
.withInt("intValue", 10)
.withString("strValue", "hello")
.withParcelable("user", user)
.navigation();
}
}
}
@Route(path = "/first/activity")
public class FirstActivity extends AppCompatActivity implements View.OnClickListener {
// 2.需要由ARouter传递的参数需要加@Autowired注解
@Autowired
public int intValue;
@Autowired
public String strValue;
@Autowired
public User user;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_first);
// 3.ARouter.getInstance().inject(this)方法会自动完成参数注入
ARouter.getInstance().inject(this);
firstIntTextView.setText("intValue:"+intValue);
firstStrTextView.setText("strValue"+strValue);
firstUserTextView.setText("User:"+user.name+":"+user.age);
}
}
复制代码
上面例子中的User必须是Parcelable对象,另外ARouter的withObject()方法可以直接传递非Parcelable对象,不过需要自己实现SerializationService接口来实现序列化方式,使用较少,这里不多介绍。
至此,介绍了参数传递与解析的两种实现。下面分析源码实现。
三、源码分析
下面通过源码来分析ARouter是如何实现第二节中的功能的。本文例子比"组件化基础ARouter(一)"中新增的API是:
- @Autowired注解;
- withParcelable()方法;
- inject()方法;
相应地,本节分三小节来分析每步的主要工作。
3.1 @Autowired注解
在2.2中在需要由ARouter注入的参数上添加@Autowired添加注解后,ARouter是使用2.1小节中声明的arouter-compiler来处理注解,自动生成代码,在此基础上实现参数传递的功能。关于Annotation Processor的基知识可参考:Annotation Processor简单用法。
ARouter APT处理@Autowired后自动生成一个class文件(位于/first_library/build/generated/source/kapt/debug/com/bc/first目录下):
这个class实现了ISyringe,位于com.bc.first包下(与@Autowired标记参数的所在类的包名一样):
/**
* DO NOT EDIT THIS FILE!!! IT WAS GENERATED BY AROUTER. */
public class FirstActivity$$ARouter$$Autowired implements ISyringe {
private SerializationService serializationService;
@Override
public void inject(Object target) {
serializationService = ARouter.getInstance().navigation(SerializationService.class);
FirstActivity substitute = (FirstActivity)target;
substitute.intValue = substitute.getIntent().getIntExtra("intValue", substitute.intValue);
substitute.strValue = substitute.getIntent().getExtras() == null ? substitute.strValue : substitute.getIntent().getExtras().getString("strValue", substitute.strValue);
substitute.user = substitute.getIntent().getParcelableExtra("user");
}
}
复制代码
后面再分析自动生成的代码有什么用途。
3.2 Postcard.withParcelable()
在"组件化基础ARouter(一)"中分析过ARouter.getInstance().build("/first/activity")会返回PostCard对象,接着分析PostCard.withParcelable()的主要工作:
public final class Postcard extends RouteMeta {
private Bundle mBundle;
public Postcard withInt(@Nullable String key, int value) {
mBundle.putInt(key, value);
return this;
}
public Postcard withParcelable(@Nullable String key, @Nullable Parcelable value) {
mBundle.putParcelable(key, value);
return this;
}
}
复制代码
上面的工作内容很简单:将需要传递的对象赋值到Postcard的Bundle中,接下来在navigation()的中就会将PostCard中的Bundle放到Intent来启动Activity(启动Activity的完整流程见"组件化基础ARouter(一)"):
final class _ARouter {
private Object _navigation(final Postcard postcard, final int requestCode, final NavigationCallback callback) {
final Context currentContext = postcard.getContext();
switch (postcard.getType()) {
case ACTIVITY:
final Intent intent = new Intent(currentContext, postcard.getDestination());
// 重点代码
intent.putExtras(postcard.getExtras());
String action = postcard.getAction();
if (!TextUtils.isEmpty(action)) {
intent.setAction(action);
}
runInMainThread(new Runnable() {
@Override
public void run() {
// 3.启动Activity
startActivity(requestCode, currentContext, intent, postcard, callback);
}
});
break;
}
return null;
}
}
复制代码
3.3 inject()
接着分析ARouter.getInstance().inject(this);的主要工作:
final class _ARouter {
static void inject(Object thiz) {
// 获取AutowiredService服务的实例对象
AutowiredService autowiredService = ((AutowiredService) ARouter.getInstance().build("/arouter/service/autowired").navigation());
if (null != autowiredService) {
autowiredService.autowire(thiz);
}
}
}
复制代码
以上代码分析出:具体工作是由AutowiredService完成的。
3.3.1 AutowiredService
AutowiredService接口继承了IProvider接口,ARouter的IProvider可理解为服务提供者(详见"组件化基础ARouter(二)"中的分析):
public interface AutowiredService extends IProvider {
/**
* Autowired core.
* @param instance the instance who need autowired.
*/
void autowire(Object instance);
}
复制代码
3.3.2 AutowiredServiceImpl
AutowiredService的实现是AutowiredServiceImpl,接着分析其autowire()方法:
@Route(path = "/arouter/service/autowired")
public class AutowiredServiceImpl implements AutowiredService {
// LruCache存放着ISyringe对象
private LruCache<String, ISyringe> classCache;
private List<String> blackList;
@Override
public void init(Context context) {
classCache = new LruCache<>(50);
blackList = new ArrayList<>();
}
@Override
public void autowire(Object instance) {
doInject(instance, null);
}
/**
* 递归注入参数
*/
private void doInject(Object instance, Class<?> parent) {
Class<?> clazz = null == parent ? instance.getClass() : parent;
ISyringe syringe = getSyringe(clazz);
if (null != syringe) {
// 由syringe完成注入
syringe.inject(instance);
}
Class<?> superClazz = clazz.getSuperclass();
// 递归注入
if (null != superClazz && !superClazz.getName().startsWith("android")) {
doInject(instance, superClazz);
}
}
/**
* 获得等待注入的类的注入器类
* 本文例子中,等待注入的类是FirstActivity,注入器类是FirstActivity$$ARouter$$Autowired
*/
private ISyringe getSyringe(Class<?> clazz) {
String className = clazz.getName();
try {
if (!blackList.contains(className)) {
// 1.LruCache中是否有对应的注入器类实力
ISyringe syringeHelper = classCache.get(className);
if (null == syringeHelper) {
// 2.LruCache中没有,则根据ClassName+SUFFIX_AUTOWIRED构造一个
syringeHelper = (ISyringe) Class.forName(clazz.getName() + SUFFIX_AUTOWIRED).getConstructor().newInstance();
}
// 3.更新LruCache,然后返回注入器类
classCache.put(className, syringeHelper);
return syringeHelper;
}
} catch (Exception e) {
blackList.add(className); // This instance need not autowired.
}
return null;
}
}
复制代码
上述代码中,注入器类的查找是根据ClassName + SUFFIX_AUTOWIRED查找的,后缀固定为'$$ARouter$$Autowired',这样就与3.1中介绍的自动生成的类关联了起来。
3.3.4 ISyringe
Syringe指注射器,结合3.1小节分析@Autowired注解自动生成的代码,内容就比较简单:
/**
* DO NOT EDIT THIS FILE!!! IT WAS GENERATED BY AROUTER. */
public class FirstActivity$$ARouter$$Autowired implements ISyringe {
private SerializationService serializationService;
@Override
public void inject(Object target) {
// 1.是否有自定义的序列化实现,默认为null
serializationService = ARouter.getInstance().navigation(SerializationService.class);
// 2.获得要注入的类
FirstActivity substitute = (FirstActivity)target;
// 3.注入的实现,其实也是从intent中取出来的
substitute.intValue = substitute.getIntent().getIntExtra("intValue", substitute.intValue);
substitute.strValue = substitute.getIntent().getExtras() == null ? substitute.strValue : substitute.getIntent().getExtras().getString("strValue", substitute.strValue);
substitute.user = substitute.getIntent().getParcelableExtra("user");
}
}
复制代码
3.4 总结
- Arouter通过ARouter.getInstance().inject(this);实现控制反转;
- Arouter通过APT处理@Autowired注解来自动生成注入的代码;
- Arouter通过ARouter.getInstance().build("/first/activity").withParcelable("user", user) .navigation();来传递参数,实现方式是将数据放到Postcard中,在Postcard.navigation()打开Activity时将参数放到intent中;
- Arouter在ARouter.getInstance().inject(this)方法中会调用APT自动生成的代码将参数从intent中取出赋给对应变量;
- 控制反转的主要工作是ARouter内的AutowiredService来完成的;