ARoute初步探究(一):配置文件的生成

ARoute是由阿里开源的一款路由组件:https://github.com/alibaba/ARouter
他的原理不难猜测,是通过注解在编译时保存路由信息,在路由时根据保存的路由信息表跳转;这里我们首先探究下该框架路由信息的生成,着重于路由信息的生成

注解生成

@AutoService:帮助生成项目的注解器信息

@AutoService是谷歌提供的注解处理器的注解
可以看到Aroute的注解处理器使用的这个注解,能帮助我们在/build/classes/java/main/META-INF/services 目录下注册该注解器。
我们在app中使用
annotationProcessor project(':arouter-compiler')就能指定注解处理器

帮助我们注册注解器信息,使得项目能直接用

ARoute中的注解处理器

主要是在aroute-compiler中:

项目中的注解处理器

其中使用SupportedAnnotationTypes 表示了支持的注解类型
我们的目标链条是跳转Activity,使用的注解是@Route,所以我们下面会看RouteProcessor这个类,他的注解处理类型是
@SupportedAnnotationTypes({ANNOTATION_TYPE_ROUTE, ANNOTATION_TYPE_AUTOWIRED})
也就是@Route和@AutoWired,前者标注路由信息,后者是路由信息中的成员变量标注

解析基本数据

// 首先第一步,拿出目标entry中注解Route内部的内容
 Set<? extends Element> routeElements = roundEnv.getElementsAnnotatedWith(Route.class);
// 第二步,遍历注解中的element,如果是我们想要的Activity类型,那么增加一个RouteMeta 
if (types.isSubtype(tm, type_Activity)) 
routeMeta = new RouteMeta(route, element, RouteType.ACTIVITY, paramsType);
// 这里会进行排序,按照路径分组,这样同个组下的路径接近,同时加快后面匹配的速度
categories(routeMeta);

这里可以着重看下,因为涉及到了分组的概念
ARoute 在处理路由信息的时候,给每一条”地址“加上了组的概念,在@Route注解中有一个group参数可以指定组别,否则默认是第一个\之前的内容;如果没有怎么办?嘻嘻,抛出异常,代码如下:

private boolean routeVerify(RouteMeta meta) {
        String path = meta.getPath();
        if (StringUtils.isEmpty(path) || !path.startsWith("/")) {   // The path must be start with '/' and not empty!
            return false;
        }
        if (StringUtils.isEmpty(meta.getGroup())) { // Use default group(the first word in path)
            try {
                String defaultGroup = path.substring(1, path.indexOf("/", 1));
                if (StringUtils.isEmpty(defaultGroup)) {
                    return false;
                }
                meta.setGroup(defaultGroup);
                return true;
            } catch (Exception e) {
                logger.error("Failed to extract default group! " + e.getMessage());
                return false;
            }
        }
        return true;
    }

将组放到储存中的代码如下:

 private void categories(RouteMeta routeMete) {
        if (routeVerify(routeMete)) {
            logger.info(">>> Start categories, group = " + routeMete.getGroup() + ", path = " + routeMete.getPath() + " <<<");
            Set<RouteMeta> routeMetas = groupMap.get(routeMete.getGroup());
            if (CollectionUtils.isEmpty(routeMetas)) {
                Set<RouteMeta> routeMetaSet = new TreeSet<>(new Comparator<RouteMeta>() {
                  // 这里还对路径进行了排序,方便后期查找地址
                    @Override
                    public int compare(RouteMeta r1, RouteMeta r2) {
                        try {
                            return r1.getPath().compareTo(r2.getPath());
                        } catch (NullPointerException npe) {
                            logger.error(npe.getMessage());
                            return 0;
                        }
                    }
                });
                routeMetaSet.add(routeMete);
                groupMap.put(routeMete.getGroup(), routeMetaSet);
            } else {
                routeMetas.add(routeMete);
            }
        } else {
            logger.warning(">>> Route meta verify error, group is " + routeMete.getGroup() + " <<<");
        }
    }

最后我们将处理结果放入缓存中

 groupMap.put(routeMete.getGroup(), routeMetaSet);

构造java文件,将组信息储存

因为之前自己比较少使用javapoet进行动态java文件增添,所以这里想详细过一下
首先是遍历组信息

for (Map.Entry<String, Set<RouteMeta>> entry : groupMap.entrySet()) {

然后会构造一个叫loadInfo的方法,因为是给组信息记录用的,所以叫loadIntoMethodOfGroupBuilder

MethodSpec.Builder loadIntoMethodOfGroupBuilder = MethodSpec.methodBuilder(METHOD_LOAD_INTO) //方法名称(loadInto)
                        .addAnnotation(Override.class)
                        .addModifiers(PUBLIC)
                        .addParameter(groupParamSpec);

随后遍历出一个组内所有的路由信息;我们之前在解析的时候,有保存路由中的param信息(即AutoWired注解),这个时候我们需要传入一张表用于记录变量名称以及类型<String,int>

if (MapUtils.isNotEmpty(paramsType)) {
    List<RouteDoc.Param> paramList = new ArrayList<>();
        for (Map.Entry<String, Integer> types : paramsType.entrySet()) {
            // 根据我们之前解析出来的AutoWired注解,进行map注入,起到记录地址中成员变量以及类型的作用
            mapBodyBuilder.append("put(\"").append(types.getKey()).append("\", ").append(types.getValue()).append("); ");
            RouteDoc.Param param = new RouteDoc.Param();
            Autowired injectConfig = injectConfigs.get(types.getKey());
            param.setKey(types.getKey());
            param.setType(TypeKind.values()[types.getValue()].name().toLowerCase());
            param.setDescription(injectConfig.desc());
            param.setRequired(injectConfig.required());
            paramList.add(param);
            }
            routeDoc.setParams(paramList);
        }
}

随后便是给loadInfo函数增加一行表达式,这里使用到了javapoet的占位符
$S表示字符串,$T表示TypeName,这里是将类抽象出来了,我们传入的时候其实就是我们的Route数据类RouteMeta
由于我们刚才在遍历变量信息的时候主动拼成了字符串,所以现在直接传参即可:

String mapBody = mapBodyBuilder.toString();
                    // 方法,增加表达式,写下我们的记录
                    loadIntoMethodOfGroupBuilder.addStatement(
                            "atlas.put($S, $T.build($T." + routeMeta.getType() + ", $T.class, $S, $S, " + (StringUtils.isEmpty(mapBody) ? null : ("new java.util.HashMap<String, Integer>(){{" + mapBodyBuilder.toString() + "}}")) + ", " + routeMeta.getPriority() + ", " + routeMeta.getExtra() + "))",
                            routeMeta.getPath(),
                            routeMetaCn,
                            routeTypeCn,
                            className,
                            routeMeta.getPath().toLowerCase(),
                            routeMeta.getGroup().toLowerCase());

生成结果

到这一步,我们就拥有了1+n个文件,包括一个ARoute$$Root$$app.java文件,他记录了每个组的配置信息目录:

根组信息

以及n个组的文件,组内记录了组下所有的路由路径
组内路由游戏

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,294评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,493评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,790评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,595评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,718评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,906评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,053评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,797评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,250评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,570评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,711评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,388评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,018评论 3 316
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,796评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,023评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,461评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,595评论 2 350

推荐阅读更多精彩内容