Android 路由框架 Router 分析

阅读 4873
收藏 0
2017-02-02
原文链接: www.jianshu.com

Android路由框架Router的分析

什么是路由?说简单点就是映射页面跳转关系的,当然它也包含跳转相关的一切功能。

路由框架的意义

Android系统已经给我们提供了api来做页面跳转,比如startActivity,为什么还需要路由框架呢?我们来简单分析下路由框架存在的意义:

  1. 在一些复杂的业务场景下(比如电商),灵活性比较强,很多功能都是运营人员动态配置的,比如下发一个活动页面,我们事先并不知道具体的目标页面,但如果事先做了约定,提前做好页面映射,便可以自由配置。
  2. 随着业务量的增长,客户端必然随之膨胀,开发人员的工作量越来越大,比如64K问题,比如协作开发问题。App一般都会走向组件化、插件化的道路,而组件化、插件化的前提就是解耦,那么我们首先要做的就是解耦页面之间的依赖关系。
  3. 简化代码。数行跳转代码精简成一行代码。
  4. 其他...

工作流程图

Router的工作流程简要如下图:


工作流程图

特性

Router有哪些特性或者有点呢?

  1. 简单(看源码就知道了~)
  2. 链式调用,api友好
  3. 多路径支持
  4. 结果回调,每次跳转都会回调跳转结果
  5. 编译期处理注解,没有使用反射,不影响运行时性能
  6. 除了可以使用注解定义路由,还支持手动分配路由
  7. 自定义拦截器,可以对路由进行拦截,比如登录判断和埋点处理
  8. 自定义路由匹配规则,相比较其他路由框架,该项目并没有写死路由的匹配规则,除了内置的几个匹配器,用户完全可以定义自己的规则
  9. 支持隐式Intent跳转
  10. 支持多模块使用,支持组件化开发

    其他功能正在添加中...

集成

集成过程也可参考项目主页README

  1. 在项目级的build.gradle中加入依赖:

     buildscript {
         repositories {
             jcenter()
         }
         dependencies {
             classpath 'com.android.tools.build:gradle:2.2.x ↑'
             classpath 'com.chenenyu.router:gradle-plugin:latest.integration'
         }
     }
    
     // Optional. Specify the dependencies version, default to the latest version.
     ext {
         ...
         routerVersion = "x.y.z"
         compilerVersion = "x.y.z"
     }

    其中ext中的配置是可选的,用来指定依赖的router和注解处理器的版本,默认为最新的版本。

    注意,Router需要使用2.2.0及以上版本的Android gradle plugin来处理注解处理器,截至写作时,最新版本为2.3.0-beta2

  2. 在module级的build.gradle中使用plugin:

     apply plugin: 'com.android.application/library'
     apply plugin: 'com.chenenyu.router'

至此,集成工作就完成了,简单的两步:添加依赖插件和应用插件。

使用

  1. Router需要初始化,用于初始化路由表,建议放到Application中做:

     public class App extends MultiDexApplication {
         @Override
         public void onCreate() {
             super.onCreate();
             // 初始化
             Router.initialize(this);
             // 开启log
             if (BuildConfig.DEBUG) {
                 Router.openLog();
             }
         }
     }
  2. 添加注解

     // 单路径注解
     @Route("test")
     public class TestActivity extends Activity {
     ...
     }
    
     // 多路径注解,这几个注解都能打开该Activity
     @Route({"user", "example://user", "http://example.com/user"})
     public class UserActivity extends Activity {
     ...
     }
  3. 发起路由操作

     // 最简单的路由跳转,打开TestActivity
     Router.build("test").go(context);
    
     // 其他部分api
     Router.build("user")
         .requestCode(int) // 调用startActivityForResult
         .extras(bundle)  // 携带跳转参数
         .addFlags(flag)  // 添加标记,比如intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP)
         .anim(enter, exit)  // 添加跳转动画
         .callback(calback)  // 跳转结果回调
         .go(context);

进阶

自定义路由表

Router除了可以使用注解来做映射,还支持在代码中自定义:

// 动态添加路由
Router.addRouteTable(new RouteTable() {
    @Override
    public void handleActivityTable(Map<String, Class<? extends Activity>> map) {
        map.put("dynamic", DynamicActivity.class);
    }
});

即路由表由两部分组成,一部分是注解,另一部分是手动添加的。

拦截器

Router支持拦截器的配置,比如在跳转前做登录状态的校验,

Router.addRouteInterceptor(new RouteInterceptor() {
    @Override
    public boolean intercept(Context context, @NonNull Uri uri, @Nullable Bundle extras) {
        // operation.
        return false;
    }
});

intercept方法返回true即表示拦截该路由,false表示不拦截。拦截器可以添加多个,依次调用,方便协作开发。

❗️自定义路由解析规则

该功能是Router的特色功能之一。由于每个产品的业务都不一样,灵活的路由处理规则是十分必要的。用户可以借鉴Router内置的几个匹配器(Matcher),来实现自己的规则。

内置的Matcher

Router目前内置了4个Matcher,已经能适用绝大部分业务场景,优先级从高到低分别是SimpleMatcher(0x1000)、SchemeMatcher(0x0100)、ImplicitMatcher(0x0010)、BrowserMatcher(0x0000),优先级高的Matcher会优先匹配。

自定义Matcher

自定义的Matcher需要继承Matcher抽象类,指定该Matcher的优先级,并实现两个抽象方法:

// 返回true表示当前路由被该Matcher匹配,返回false则会继续匹配其他Matcher
public abstract boolean match(Context context, Uri uri, @Nullable String route, RouteOptions routeOptions);

// match方法返回true后会调用该方法,用来生成一个Intent对象
public abstract Intent onMatched(Context context, Uri uri, @Nullable Class<? extends Activity> target);

然后调用Router.registerMatcher(new CustomMatcher(int priority));来注册自定义的Matcher。

Matcher支持配置多个,会依次进行匹配。

其他

获取Intent

Intent intent = Router.build(uri).getIntent(context);,即可获取一个符合路由规则Intent对象,然后你可以使用这个intent来跳转,或者发一个通知。

显示log

在调试过程中,可能需要打印Router相关的log,通过Router.openLog()即可打开,建议在debug环境下打开。

总结

Router是一个十分小巧灵活的路由框架,代码设计也很优雅简洁,且完美支持组件化开发,目前仍在不断地迭代中,源码地址为github.com/chenenyu/Ro…,欢迎各位试用点评。