Markdown版本笔记 我的GitHub首页 我的博客 我的微信 我的邮箱
MyAndroidBlogs baiqiantao baiqiantao bqt20094 baiqiantao@sina.com

ARouter 路由 组件 跳转 MD


目录

简介

一个用于帮助 Android App 进行组件化改造的框架 —— 支持模块间的路由、通信、解耦

ARouter官网

Demo下载

模块 arouter-api arouter-compiler arouter-register arouter-idea-plugin
2018-12-15 最新版本

支持的功能

  • 支持直接解析标准URL进行跳转,并自动注入参数到目标页面中
  • 支持多模块工程使用
  • 支持添加多个拦截器,自定义拦截顺序
  • 支持依赖注入,可单独作为依赖注入框架使用
  • 支持InstantRun
  • 支持MultiDex
  • 映射关系按组分类、多级管理,按需初始化
  • 支持用户指定全局降级与局部降级策略
  • 页面、拦截器、服务等组件均自动注册到框架
  • 支持多种方式配置转场动画
  • 支持获取Fragment
  • 完全支持Kotlin以及混编
  • 支持第三方 App 加固(使用 arouter-register 实现自动注册)
  • 支持生成路由文档
  • 提供IDE 插件便捷的关联路径和目标类

典型应用

  • 外部URL映射到内部页面,以及参数传递与解析
  • 跨模块页面跳转,模块间解耦
  • 拦截跳转过程,处理登陆、埋点等逻辑
  • 跨模块API调用,通过控制反转来做组件解耦

简单使用

1、添加依赖和配置

android {
defaultConfig {
...
javaCompileOptions {
annotationProcessorOptions {
arguments = [AROUTER_MODULE_NAME: project.getName()]
}
}
}
} dependencies {
api 'com.alibaba:arouter-api:x.x.x' // 需要注意的是api
annotationProcessor 'com.alibaba:arouter-compiler:x.x.x' // 要与compiler匹配使用
}

2、添加注解

// 在支持路由的页面上添加注解(必选),这里的路径需要注意的是至少需要有两级,/xx/xx
@Route(path = "/test/activity")
public class YourActivity extend Activity { ... }

3、初始化SDK

if (isDebug()) {
ARouter.openLog(); // 打印日志,这两行必须写在init之前,否则这些配置在init过程中将无效
ARouter.openDebug(); // 开启调试模式(如果在InstantRun模式下运行,必须开启调试模式!线上版本需要关闭,否则有安全风险)
}
ARouter.init(mApplication);

4、发起路由操作

ARouter.getInstance().build("/test/activity").navigation(); // 应用内简单的跳转
ARouter.getInstance().build("/test/1")
.withLong("key1", 666L) // 跳转并携带参数
.withString("key3", "888")
.withObject("key4", new Test("Jack", "Rose"))
.navigation();

5、添加混淆规则

-keep public class com.alibaba.android.arouter.routes.**{*;}
-keep public class com.alibaba.android.arouter.facade.**{*;}
-keep class * implements com.alibaba.android.arouter.facade.template.ISyringe{*;} # 如果使用了 byType 的方式获取 Service,需添加下面规则,保护接口
-keep interface * implements com.alibaba.android.arouter.facade.template.IProvider # 如果使用了 单类注入,即不定义接口实现 IProvider,需添加下面规则,保护实现
# -keep class * implements com.alibaba.android.arouter.facade.template.IProvider

6、使用 Gradle 插件实现路由表的自动加载(可选)

apply plugin: 'com.alibaba.arouter'

buildscript {
repositories {
jcenter()
} dependencies {
classpath "com.alibaba:arouter-register:?"
}
}

可选使用,通过 ARouter 提供的注册插件进行路由表的自动加载(power by AutoRegister),默认通过扫描 dex 的方式进行加载,通过 gradle 插件进行自动注册可以缩短初始化时间,解决应用加固导致无法直接访问 dex 文件,初始化失败的问题。需要注意的是,该插件必须搭配 api 1.3.0 以上版本使用!

7、使用 IDE 插件导航到目标类

在 Android Studio 插件市场中搜索 ARouter Helper, 或者直接下载文档上方 最新版本 中列出的 arouter-idea-plugin zip 安装包手动安装,安装后,插件无任何设置,可以在跳转代码的行首找到一个图标,点击该图标,即可跳转到标识了代码中路径的目标类。

进阶使用

1、通过URL跳转

新建一个Activity用于监听Schame事件,之后直接把url传递给ARouter即可

public class SchameFilterActivity extends Activity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState); Uri uri = getIntent().getData();
ARouter.getInstance().build(uri).navigation();
finish();
}
}

AndroidManifest.xml 中的配置

<activity android:name=".activity.SchameFilterActivity">
<!-- Schame -->
<intent-filter>
<data
android:host="m.aliyun.com"
android:scheme="arouter"/> <action android:name="android.intent.action.VIEW"/> <category android:name="android.intent.category.DEFAULT"/>
<category android:name="android.intent.category.BROWSABLE"/>
</intent-filter>
</activity>

2、解析URL中的参数

URL中不能传递Parcelable类型数据,通过ARouter api可以传递Parcelable对象

@Route(path = "/test/activity")
public class Test1Activity extends Activity {
@Autowired public String name; // 为每一个参数声明一个字段,并使用 @Autowired 标注
@Autowired int age;
@Autowired(name = "girl") boolean boy; // 通过name来映射URL中的不同参数
@Autowired TestObj obj; // 支持解析自定义对象,URL中使用json传递 @Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
ARouter.getInstance().inject(this); //注入
Log.d("param", name + age + boy); // ARouter会自动对字段进行赋值,无需主动获取
}
}

如果需要传递自定义对象,新建一个类(并非自定义对象类),然后实现 SerializationService,并使用@Route注解标注(方便用户自行选择序列化方式),例如:

@Route(path = "/yourservicegroupname/json")
public class JsonServiceImpl implements SerializationService {
@Override
public void init(Context context) {
//可选,用于对序列化框架初始化
} @Override
public <T> T json2Object(String text, Class<T> clazz) {
return JSON.parseObject(text, clazz); //自行选择反序列化方式,比如Gson、fastjson
} @Override
public String object2Json(Object instance) {
return JSON.toJSONString(instance); //自行选择序列化方式,比如Gson、fastjson
}
}

3、声明拦截器

拦截跳转过程,面向切面编程

比较经典的应用就是在跳转过程中处理登陆事件,这样就不需要在目标页重复做登陆检查

拦截器会在跳转之间执行,多个拦截器会按优先级顺序依次执行。

@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初始化的时候调用该方法,仅会调用一次
}
}

4、处理跳转结果

使用两个参数的navigation方法,可以获取单次跳转的结果。

ARouter.getInstance().build("/test/1").navigation(this, new NavigationCallback() {
@Override
public void onFound(Postcard postcard) {
//...
} @Override
public void onLost(Postcard postcard) {
//...
}
});

5、自定义全局降级策略

实现DegradeService接口,并加上一个Path内容任意的注解即可

@Route(path = "/xxx/xxx")
public class DegradeServiceImpl implements DegradeService {
@Override
public void onLost(Context context, Postcard postcard) {
// do something.
} @Override
public void init(Context context) { }
}

6、为目标页面声明更多信息

我们经常需要在目标页面中配置一些属性,比方说"是否需要登陆"之类的,可以通过 Route 注解中的 extras 属性进行扩展。

这个属性是一个 int 值,也就是32位,可以配置32个开关。

剩下的可以自行发挥,通过字节操作可以标识32个开关,通过开关标记目标页面的一些属性,在拦截器中可以拿到这个标记进行业务逻辑判断

@Route(path = "/test/activity", extras = Consts.XXXX)

7、通过依赖注入解耦

服务管理(一) 暴露服务

public interface HelloService extends IProvider {
String sayHello(String name); // 声明接口,其他组件通过接口来调用服务
}

实现接口

@Route(path = "/yourservicegroupname/hello", name = "测试服务")
public class HelloServiceImpl implements HelloService { @Override
public String sayHello(String name) {
return "hello, " + name;
} @Override
public void init(Context context) { }
}

服务管理(二) 发现服务

public class Test {
@Autowired HelloService helloService;
@Autowired(name = "/yourservicegroupname/hello") HelloService helloService2;
HelloService helloService3;
HelloService helloService4; public Test() {
ARouter.getInstance().inject(this);
} public void testService() {
// 1、(推荐)使用依赖注入的方式发现服务,通过注解标注字段即可使用,无需主动获取
// Autowired注解中标注name之后,将会使用byName的方式注入对应的字段,不设置name属性,会默认使用byType的方式发现服务(当同一接口有多个实现的时候,必须使用byName的方式发现服务)
helloService.sayHello("Vergil");
helloService2.sayHello("Vergil"); // 2、使用依赖查找的方式发现服务,主动去发现服务并使用,下面两种方式分别是byName和byType
helloService3 = ARouter.getInstance().navigation(HelloService.class);
helloService4 = (HelloService) ARouter.getInstance().build("/yourservicegroupname/hello").navigation();
helloService3.sayHello("Vergil");
helloService4.sayHello("Vergil");
}
}

更多功能

1、初始化中的其他设置

ARouter.openLog(); // 开启日志
ARouter.openDebug(); // 使用InstantRun的时候,需要打开该开关,上线之后关闭,否则有安全风险
ARouter.printStackTrace(); // 打印日志的时候打印线程堆栈

2、详细的API说明

ARouter.getInstance().build("/home/main").navigation(); // 构建标准的路由请求
ARouter.getInstance().build("/home/main", "ap").navigation(); // 构建标准的路由请求,并指定分组
ARouter.getInstance().build(uri).navigation(); // 构建标准的路由请求,通过Uri直接解析
ARouter.getInstance().build("/home/main", "ap").navigation(this, 5); // startActivityForResult 形式跳转
ARouter.getInstance().build("/home/main").with(params).navigation(); // 直接传递Bundle
ARouter.getInstance().build("/home/main").withFlags().navigation(); // 指定Flag
ARouter.getInstance().withObject("key", new TestObj("Jack", "Rose")).navigation(); // 对象传递
ARouter.getInstance().build("/home/main").getExtra(); // 觉得接口不够多,可以直接拿出Bundle赋值
ARouter.getInstance().build("/home/main").greenChannel().navigation();// 使用绿色通道(跳过所有的拦截器)
ARouter.setLogger();// 使用自己的日志工具打印日志
ARouter.setExecutor();// 使用自己提供的线程池 Fragment fragment = (Fragment) ARouter.getInstance().build("/test/fragment").navigation(); //获取Fragment ARouter.getInstance().build("/test/activity2")
.withTransition(R.anim.slide_in_bottom, R.anim.slide_out_bottom).navigation(this); //转场动画
ARouter.getInstance().build("/test/activity2")
.withOptionsCompat(compat).navigation(this); // 转场动画(API16+)

3、获取原始的URI

String uriStr = getIntent().getStringExtra(ARouter.RAW_URI);

4、重写跳转URL

实现 PathReplaceService 接口,并加上一个 Path 内容任意的注解即可

@Route(path = "/xxx/xxx") // 必须标明注解
public class PathReplaceServiceImpl implements PathReplaceService {
/**
* For normal path.
*
* @param path raw path
*/
String forString(String path) {
return path; // 按照一定的规则处理之后返回处理后的结果
} /**
* For uri type.
*
* @param uri raw uri
*/
Uri forUri(Uri uri) {
return url; // 按照一定的规则处理之后返回处理后的结果
}
}

5、生成路由文档

生成的文档路径:build/generated/source/apt/(debug or release)/com/alibaba/android/arouter/docs/arouter-map-of-${moduleName}.json

android {
defaultConfig {
javaCompileOptions {
annotationProcessorOptions {
arguments = [AROUTER_MODULE_NAME: project.getName(), AROUTER_GENERATE_DOC: "enable"]
}
}
}
}

其他

1、路由中的分组概念

  • SDK中针对所有的路径进行分组,只有在分组中的某一个路径第一次被访问的时候,该分组才会被初始化
  • 可以通过 @Route 注解主动指定分组,否则使用路径中第一段字符串/*/作为分组
  • 注意:一旦主动指定分组之后,应用内路由需要使用 ARouter.getInstance().build(path, group) 进行跳转,手动指定分组,否则无法找到
@Route(path = "/test/1", group = "app")

2、拦截器和服务的异同

  • 拦截器和服务所需要实现的接口不同,但是结构类似,都存在 init(Context) 方法,但是两者的调用时机不同
  • 拦截器因为其特殊性,会被任何一次路由所触发,拦截器会在ARouter初始化的时候异步初始化,如果第一次路由的时候拦截器还没有初始化结束,路由会等待,直到初始化完成。
  • 服务没有该限制,某一服务可能在App整个生命周期中都不会用到,所以服务只有被调用的时候才会触发初始化操作

3、Kotlin项目中的配置方式

可以参考 module-kotlin 模块中的写法

apply plugin: 'kotlin-kapt'

kapt {
arguments {
arg("AROUTER_MODULE_NAME", project.getName())
}
} dependencies {
compile 'com.alibaba:arouter-api:x.x.x'
kapt 'com.alibaba:arouter-compiler:x.x.x'
}

Q&A

1、"W/ARouter::: ARouter::No postcard![ ]"

2、"W/ARouter::: ARouter::There is no route match the path [/xxx/xxx], in group [xxx][ ]"

3、开启InstantRun之后无法跳转(高版本Gradle插件下无法跳转)?

因为开启InstantRun之后,很多类文件不会放在原本的dex中,需要单独去加载,ARouter默认不会去加载这些文件,因为安全原因,只有在开启了openDebug之后,ARouter才回去加载InstantRun产生的文件,所以在以上的情况下,需要在init之前调用openDebug。

4、TransformException:java.util.zip.ZipException: duplicate entry ....

ARouter有按组加载的机制,ARouter允许一个module中存在多个分组,但是不允许多个module中存在相同的分组,会导致映射文件冲突。

5、Kotlin类中的字段无法注入如何解决?

首先,Kotlin中的字段是可以自动注入的,但是注入代码为了减少反射,使用的字段赋值的方式来注入的,Kotlin默认会生成set/get方法,并把属性设置为private,所以只要保证Kotlin中字段可见性不是private即可,简单解决可以在字段上添加 @JvmField

6、通过URL跳转之后,在intent中拿不到参数如何解决?

需要注意的是,如果不使用自动注入,那么可以不写 ARouter.getInstance().inject(this),但是需要取值的字段仍然需要标上 @Autowired 注解,因为只有标上注解之后,ARouter才能知道以哪一种数据类型提取URL中的参数并放入Intent中,这样您才能在intent中获取到对应的参数。

7、新增页面之后,无法跳转?

ARouter加载Dex中的映射文件会有一定耗时,所以ARouter会缓存映射文件,直到新版本升级(版本号或者versionCode变化),而如果是开发版本,ARouter 每次启动都会重新加载映射文件,开发阶段一定要打开 Debug 功能。

2018-12-15

ARouter 路由 组件 跳转 MD的更多相关文章

  1. 使用阿里ARouter路由实现组件化(模块化)开发流程

    Android平台中对页面.服务提供路由功能的中间件,我的目标是 —— 简单且够用. 这是阿里对Arouter的定位,那么我们一起来梳理一下Arouter使用流程,和使用中我所遇到的一些问题! 先来看 ...

  2. Vue总结第五天:vue-router (使用模块化(创建Vue组件)机制编程)、router-link 标签的属性、路由代码跳转、懒加载、路由嵌套(子路由)、路由传递数据、导航守卫)

    Vue总结第五天:vue-router ✿ 路由(器)目录: □  vue中路由作用 □  vue-router基本使用 □  vue-router嵌套路由 □  vue-router参数传递 □  ...

  3. VueJs(11)---vue-router(命名路由,命名视图,重定向别名,路由组件传参)

    vue-router 上篇文章讲了第一篇vue-router相关文章,文章地址:VueJs(10)---vue-router(进阶1) 一.命名路由 有时候,通过一个名称来标识一个路由显得更方便一些, ...

  4. vue-router之路由钩子(组件内路由钩子必须在路由组件调用,子组件没用)

    模式 vue-router中的模式选项主要在router实例化的时候进行定义的,如下 const router = new VueRouter({ mode: 'history', // 两种类型hi ...

  5. Angular routing生成路由和路由的跳转

    Angular routing生成路由和路由的跳转 什么是路由 路由的目的是可以让根组件按照不同的需求动态加载不同的组件. 根据不同地址,加载不同组件,实现单页面应用. Angular 命令创建一个配 ...

  6. vue.js关于路由的跳转

    1.路由demo示例 <div id="app"> <h1>Hello App!</h1> <p> <!-- 使用 route ...

  7. 067——VUE中vue-router之使用transition设置酷炫的路由组件过渡动画效果

    <!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8&quo ...

  8. Vue路由组件vue-router

    一.路由介绍 Creating a Single-page Application with Vue + Vue Router is dead simple. With Vue.js, we are ...

  9. Vue 路由组件

    目录 组件数据局部化处理 路由逻辑跳转 组件传参 父传子 子传父 组件的生命周期钩子 路由传参 全家配置自定义 CSS 与 js 总结: 组件数据局部化处理 不管页面组件还是小组件,都可能会被多次复用 ...

随机推荐

  1. python中的*和**参数传递机制

    python的参数传递机制具有值传递(int.float等值数据类型)和引用传递(以字典.列表等非值对象数据类型为代表)两种基本机制以及方便的关键字传递特性(直接使用函数的形参名指定实参的传递目标,如 ...

  2. BZOJ2465: [中山市选2009]小球

    Description        给定n个不同颜色的球,每个球都有一个分数,同时有m个瓶子,每个瓶子都有固定的容量.现在,你必须把球放到瓶子里面.请编程计算最多能放多少个球到这些瓶子里. Inpu ...

  3. Xtreme8.0 - Kabloom 动态规划

    Xtreme8.0 - Kabloom 题目连接: https://www.hackerrank.com/contests/ieeextreme-challenges/challenges/kablo ...

  4. ios优秀的第三方框架

    1.数据请求,object-c  AFNetworking 网址:https://github.com/AFNetworking/AFNetworking swift   Alamofire 网址:h ...

  5. mysql_提示 Lock wait timeout exceeded解决办法

    我的mysql报这个错 err=1205 - Lock wait timeout exceeded; try restarting transaction 利用 SHOW PROCESSLIST来查看 ...

  6. Spring Data JPA使用keywords关键字实现CAST函数

    对不起,经过几天几夜的使用的研究得出这种方式是无法实现的,在查询上的关键字只有这些: https://docs.spring.io/spring-data/jpa/docs/2.1.x/referen ...

  7. spring cloud 学习(3) - feign入门

    feign 是一个让rest服务调用更简洁的开源项目,很多介绍文章或书也称它为声明式REST调用.传统的web service中,通过引用wsdl来自动生成一些client的代理类(或stub代码), ...

  8. MCU PWM DAC OP Voltage Output

  9. IBDAP-CMSIS-DAP

    IBDAP-CMSIS-DAP Armstart's CMSIS-DAP firmware implementation in gcc and makefile. http://www.armstar ...

  10. OPTIMIZE TABLE ipc_analysisdatasyn, ipc_analysisdatatkv,ipc_autoupdateset, ipc_equipmentwaring,ipc_fguid, ipc_receivedata, ipc_senddata, tb_qualitativeanalysis, tb_quantifyresult, tb_quantifyresulthis

    OPTIMIZE TABLE ipc_analysisdatasyn, ipc_analysisdatatkv,ipc_autoupdateset, ipc_equipmentwaring,ipc_f ...