阿里路由框架ARouter简介

Android的页面跳转一般是用intent直接指定组件名来完成，可是再多模块开发的时候，这种方式会使各模块耦合严重，代码过多侵入，不能达到模块完全分离的目的，这个时候就需要使用隐式intent来完成页面的跳转，也就是页面路由。ARouter就是一个Android的路由解决方案。

简单使用

1.添加依赖和配置

android {
    defaultConfig {
    ...
    javaCompileOptions {
        annotationProcessorOptions {
        arguments = [ moduleName : project.getName() ]
        }
    }
    }
}

dependencies {
    // 替换成最新版本, 需要注意的是api
    // 要与compiler匹配使用，均使用最新版可以保证兼容
    compile 'com.alibaba:arouter-api:x.x.x'
    annotationProcessor 'com.alibaba:arouter-compiler:x.x.x'
    ...
}
// 旧版本gradle插件(< 2.2)，可以使用apt插件，配置方法见文末'其他#4'
// Kotlin配置参考文末'其他#5'

2.添加注解

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

3.初始化SDK

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

4.发起路由操作

// 1. 应用内简单的跳转(通过URL跳转在'进阶用法'中)
ARouter.getInstance().build("/test/activity").navigation();

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

注意，如果要传递自定义的对象，要实现json序列化和反序列化：

@Route(path = "/service/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);
    }

    @Override
    public String object2Json(Object instance) {
        return JSON.toJSONString(instance);
    }
}

网址跳转

ARouter的页面跳转也支持uri跳转的方式，只要path是正确的就能跳转到目标界面，所以我们在跳转界面的时候也可以用如下的方式跳转：

Uri uri = Uri.parse("arouter://m.aliyun.com/test/Main2Activity");
ARouter.getInstance().build(uri).navigation();

其中scheme和host可以根据我们的需求任意指定。

更加重要的使用方式是，从网页跳转到APP的时候：

// 新建一个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>

这样从网页上跳转到APP的都会通过SchameFilterActivity这个过滤器，然后有她跳转到真正的Activity。

其中网页跳转链接如下：

<a href="router://m.aliyun.com/test/Main2Activity">跳转</a>

也可以在网页后面添加参数：

<a href="router://m.aliyun.com/test/Main2Activity?name=xuyu">跳转</a>

然后通过如下方法来初始化参数：

@Route(path = "/test/Main2Activity")
public class Main2Activity extends AppCompatActivity
{
    @Autowired
    String name;

    @Override
    protected void onCreate(Bundle savedInstanceState)
    {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main2);

        ARouter.getInstance().inject(this);
        Log.e("Main2Activity", name + "");

    }
}

注意这种方式获得的参数是通过url传参，是data携带的参数，而不是intent直接携带的，原始的获取方法如下：

getIntent().getData().getQueryParameter("name");

但是使用ARouter跳转的原始的方式获取的data会为空。可以通过如下方式获取跳转的uri：

getIntent().getStringExtra(ARouter.RAW_URI)

其实ARouter是将uri的字符串通过bundle发送到下一个界面的。

页面拦截

先定义一个拦截器：

@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)
    {

    }
}

然后在Activity里面指定拦截器：

@Route(path = "/test/SecondActivity",priority = 8)

这样当跳转到这个Activity时，会被拦截器拦截到，来决定调到是否继续跳转：

ARouter.getInstance().build("/test/SecondActivity").navigation(FirstActivity.this, new NavigationCallback()
{

    @Override
    public void onInterrupt(Postcard postcard)
    {
        Log.e("FirstActivity", "onInterrupt" + (postcard != null ? postcard.toString() : "null"));
    }
});

还可以在目标页面配置更多的额外信息，以供拦截器处理，例如一个界面可能需要登录且绑定手机号，就可以如下写：

//用二进制最低位判断是否登录，次高位判断是否绑定手机号
@Route(path = "/test/SecondActivity",priority = 8,extra=3)

然后在拦截器判断：

//获取目标页面的extras，注意这里不可以使用postcard.getExtras()
//他是获取传到目标页面bundle信息的方法
int extra=postcard.getExtra()
if(((extra & 2) > 0) & ((extra & 1) > 0));
{
    //目标界面需要登录且绑定手机号
}
if((extra & 2) > 0)
{
    //目标界面仅需要绑定手机号（业务上不应该有这个状态）
}
if((extra & 1) > 0)
{
    //目标界面需要仅登录
}

分组管理

ARouter对页面路由路径的管理是分组做的，默认我们写的路径最前面的就是组名，例如：
@Route(path = "/test/SecondActivity") 组名就是test,这也解释了之前的路径为什么要至少写两级，因为要组名加具体路径，分组只有在分组中的某一个路径第一次被访问的时候，该分组才会被初始化。

也可以通过如下手动置顶分组：

@Route(path = "/test/1", group = "app")

制定分组后，必须指定分组跳转：

ARouter.getInstance().build("/test/1", "app").navigation();

ARouter已不推荐手动指定分组。

注意：ARouter允许一个module中存在多个分组，但是不允许多个module中存在相同的分组，会导致映射文件冲突。