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

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

作者: 虚假雨 | 来源:发表于2019-11-02 14:44 被阅读0次

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个组的文件,组内记录了组下所有的路由路径
组内路由游戏

相关文章

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

    ARoute是由阿里开源的一款路由组件:https://github.com/alibaba/ARouter他的原...

  • ARoute初步探究(二):路由定位过程

    上一篇文章我们记录了在编译期ARoute将目标注解生成文件保存的过程,这一节我们来探究下在用户使用时ARoute做...

  • URXVT

    配置文件 生成简明的配置文件 生成有详细说明的配置文件 [1] 示例配置文件 .Xresource / .X...

  • PJAX初步探究

    这段时间一直在做vtiger的二次开发在做新模块的时候发现vtiger很多页面是用pjax技术实现的虽然说我也可以...

  • xvfb 初步探究

    转载:http://blog.csdn.net/span76/article/details/11473315 有...

  • MySQL 初步探究

    MySQL 是最流行的关系型数据库管理系统,在WEB应用方面 MySQL 是最好的RDBMS(Relational...

  • 一、ARoute

    简单使用 // 在支持路由的页面上添加注解(必选)// 这里的路径需要注意的是至少需要有两级,/xx/xx 发起路...

  • vue-cli4.x创建 vue项目 引入 ESLint 配置文

    ESLint Standard生成配置文件 ESLint Pretiter生成配置文件 ESLint Airbnb...

  • jupyter notebook 链接linux与windows

    安装jupyter 生成配置文件Jupyter Notebook 默认的配置只能从本地访问,所以需要生成配置文件,...

  • ubuntu16 自动更换壁纸

    编辑脚本文件 生成配置文件 添加配置文件 如果有新家图片在重新通过脚本生成配置文件即可

网友评论

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

      本文链接:https://www.haomeiwen.com/subject/ehxamctx.html