ARouter的介绍和使用
西门旻
ARouter的介绍和使用
官方使用说明
阿里巴巴自研路由框架，主要解决组件间、模块间的 界面跳转 问题
典型应用
1.从外部URL映射到内部页面，以及参数传递与解析
2.跨模块页面跳转，模块间解耦
3.拦截跳转过程，处理登陆、埋点等逻辑
4.跨模块API调用，通过控制反转来做组件解耦
基础功能
1, 添加依赖和配置
android {
defaultConfig {
...
//每一个用的build.都要加
javaCompileOptions {
annotationProcessorOptions {
arguments = [AROUTER_MODULE_NAME: project.getName()]
}
}
}
}
2.配置
dependencies {
implementation 'com.alibaba:arouter-api:1.5.1'
annotationProcessor 'com.alibaba:arouter-compiler:1.5.1'
...
}
3.初始化sdk
public class App extends Application {
@Override
public void onCreate() {
super.onCreate();
ARouter.openLog(); // 打印日志
ARouter.openDebug(); // 开启调试模式(如果在InstantRun模式下运行，必须开启调试模式！线上版本需要关闭,否则有安全风险)
ARouter.init(this); // 尽可能早，推荐在Application中初始化
}
}
在清单 文件中设置name属性.
2,添加注解-配置路径(无参)
添加注释（Add annotations）
目标页面添加@Route注解
path：模板页面路径，必须以斜杠开头两级以上路径
group:页面组，默认为module名作为命名
// 在支持路由的页面上添加注解(必选)
// 这里的路径需要注意的是至少需要有两级，/xx/xx
@Route(path = "/Xxx_module/XxxActivity")
public class XxxActivity extend Activity {
...
}
/**
* 配置路径
*/
@Route( path = "/shop/main2")
public class Main2Activity extends AppCompatActivity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main2);
}
}
跳转页面（Initiate the routing）
//Activity跳转
ARouter.getInstance().build("/Xxx_module/XxxActivity").navigation();
//Fragment引入
Fragment fragment = (Fragment) ARouter.getInstance().build("/Xxx_module/XxxFragment").navigation();
- 跳转并携带参数
跳转页面携带参数（Initiate the routing Jump with parameters）
参数携带已withXXX()方法进行对应数据类型参数携带
特别说明：withObject()不可直接使用：如何使用见向下继续看
ARouter.getInstance().build("/test/1")
.withString("key3", "888")
.navigation();
3.1 携带参数withObject（Initiate the routing Jump with parameters）
在页面跳转传递自定义对象参数时，我们要进行序列号服务的创建。
好-。-如何创建公共的序列化服务，只需要创建一次，作为工具类。
1.实现ARouter接口SerializationService
2.完成对应方法实现，我们可以使用JSON 或 GSON来进行方法实现，进行对象和字符串的转换
@Route(path = "/service/gson")
public class GosnServiceImp implements SerializationService {
private Gson gson;
@Override
public <T> T json2Object(String input, Class<T> clazz) {
return gson.fromJson(input, clazz);
}
@Override
public String object2Json(Object instance) {
return gson.toJson(instance);
}
@Override
public <T> T parseObject(String input, Type clazz) {
return gson.fromJson(input, clazz);
}
@Override
public void init(Context context) {
gson = new Gson();
}
}
此接口的路径随意. 它的主要目的是把字符串和对象直接相互转换.
它提供框架,我们实现逻辑.比如可以用Gson 也可以用FastJson.
7, 用路由动态添加fragment
创建fragment
@Route(path = "/fragment/blank")
public class BlankFragment extends Fragment {
@Override
public View onCreateView(LayoutInflater inflater, ViewGroup container,
Bundle savedInstanceState) {
// Inflate the layout for this fragment
return inflater.inflate(R.layout.fragment_blank, container, false);
}
}
使用路由查找
public void btn3(View view) {
Fragment fragment = (Fragment) ARouter.getInstance().build("/fragment/blank").navigation();
getSupportFragmentManager().beginTransaction().add(R.id.ll,fragment).commit();
8 拦截器的实现
// 比较经典的应用就是在跳转过程中处理登陆事件，这样就不需要在目标页重复做登陆检查
// 拦截器会在跳转之间执行，多个拦截器会按优先级顺序依次执行
@Interceptor(priority = 8, name = "测试用拦截器")
public class TestInterceptor implements IInterceptor {
@Override
public void process(Postcard postcard, InterceptorCallback callback) {
...
callback.onContinue(postcard); // 处理完成，交还控制权
// callback.onInterrupt(new RuntimeException("我觉得有点异常")); // 觉得有问题，中断路由流程
// 以上两种至少需要调用其中一种，否则不会继续路由
}
@Override
public void init(Context context) {
// 拦截器的初始化，会在sdk初始化的时候调用该方法，仅会调用一次
}
}
应用:
ARouter.getInstance().build("/news/main").navigation(this, new NavigationCallback() {
@Override
public void onFound(Postcard postcard) {
}
@Override
public void onLost(Postcard postcard) {
}
@Override
public void onArrival(Postcard postcard) {
}
//子线程
@Override
public void onInterrupt(Postcard postcard) {
runOnUiThread(new Runnable() {
@Override
public void run() {
Toast.makeText(MainActivity.this, "拦截了", Toast.LENGTH_SHORT).show();
}
});
}
});
ARouter 和 Calces结合使用
特别注意事项:
如果是接着用calces来做项目的话, Main2Activity文件可能提示找不到.
这要在修改两个地方,一个是.
app {
applicationName '.App'
modules ':news',':shop'
}
类似资料：