【Android 组件化】路由组件 ( 构造路由表中的路由信息 )(一)

简介: 【Android 组件化】路由组件 ( 构造路由表中的路由信息 )(一)

文章目录

一、封装路由信息

二、注解处理器 生成路由表信息

1、Activity 中使用 @Route 注解

2、注解处理器中判定注解是否检测出来

3、获取被 @Route 标注的 注解节点

4、判断被 @Route 标注的 注解节点的类型

5、路由信息分组

三、完整的 注解处理器 代码

四、博客资源



组件化系列博客 :


【Android 组件化】从模块化到组件化

【Android 组件化】使用 Gradle 实现组件化 ( Gradle 变量定义与使用 )

【Android 组件化】使用 Gradle 实现组件化 ( 组件模式与集成模式切换 )

【Android 组件化】使用 Gradle 实现组件化 ( 组件 / 集成模式下的 Library Module 开发 )

【Android 组件化】路由组件 ( 路由组件结构 )

【Android 组件化】路由组件 ( 注解处理器获取被注解的节点 )

【Android 组件化】路由组件 ( 注解处理器中使用 JavaPoet 生成代码 )

【Android 组件化】路由组件 ( 注解处理器参数选项设置 )


在【Android 组件化】路由组件 ( 注解处理器参数选项设置 ) 博客中在注解处理器中 , 获取了在 build.gradle 中设置的参数 ;


本篇博客中讲解 " 注解处理器 " 后续开发 , 生成路由表中的 路由信息 ;






一、封装路由信息


在 " 编译时注解 " 依赖库 Module 中 , 定义 封装 路由信息 的 JavaBean 类 , 其中需要封装以下数据 ;


① 被 " kim.hsl.router_annotation.Route " 注解的 路由类型 , Activity 界面组件 / Service 服务组件 ;


② 被 " kim.hsl.router_annotation.Route " 注解的 " javax.lang.model.element.Element " 类型 注解节点 ;


③ 被 " kim.hsl.router_annotation.Route " 注解的 Activity 界面组件 / Service 服务组件的 组件类对象 ;


④ 路由地址 , 字符串类型 ,


⑤ 路由分组 , 字符串类型 , 将路由信息根据路由分组拆分开进行放置 ,



代码示例 :


package kim.hsl.router_annotation.model;
import javax.lang.model.element.Element;
import kim.hsl.router_annotation.Route;
/**
 * 存储路由节点信息的 Bean
 */
public class RouteBean {
    /**
     * 注解类的类型
     * Activity 界面 / Service 服务
     */
    public enum Type {
        ACTIVITY,
        SERVICE
    }
    private Type type;
    /**
     * 被注解的节点
     */
    private Element element;
    /**
     * 被注解类
     */
    private Class<?> clazz;
    /**
     * 路由地址
     */
    private String routeAddress;
    /**
     * 路由组
     */
    private String routeGroup;
    public RouteBean(Type type, Element element, Route route) {
        this.type = type;
        this.element = element;
        this.clazz = null;
        this.routeAddress = route.path();
        this.routeGroup = route.group();
    }
    public RouteBean(Type type, Element element, Class<?> clazz, String routeAddress, String routeGroup) {
        this.type = type;
        this.element = element;
        this.clazz = clazz;
        this.routeAddress = routeAddress;
        this.routeGroup = routeGroup;
    }
    public Type getType() {
        return type;
    }
    public void setType(Type type) {
        this.type = type;
    }
    public Element getElement() {
        return element;
    }
    public void setElement(Element element) {
        this.element = element;
    }
    public Class<?> getClazz() {
        return clazz;
    }
    public void setClazz(Class<?> clazz) {
        this.clazz = clazz;
    }
    public String getRouteAddress() {
        return routeAddress;
    }
    public void setRouteAddress(String routeAddress) {
        this.routeAddress = routeAddress;
    }
    public String getRouteGroup() {
        return routeGroup;
    }
    public void setRouteGroup(String routeGroup) {
        this.routeGroup = routeGroup;
    }
}






二、注解处理器 生成路由表信息




1、Activity 中使用 @Route 注解


下面开始开发 AbstractProcessor 注解处理器中的 process 方法 , 在该方法中生成 Java 代码 ;


在 MainActivity 中使用了 @Route(path = “/app/MainActivity”) 标注了 MainActivity 类 ;


@Route(path = "/app/MainActivity")
public class MainActivity extends Activity {
}



2、注解处理器中判定注解是否检测出来


在 注解处理器 中的 process 方法中 , 首先判定解析到了 注解节点 , 如果没有解析到注解节点 , 就立刻退出 , 参考之前出现的问题 【错误记录】Android 编译时技术报错 ( 注解处理器 process 方法多次调用问题 ) ;


if (set == null || set.isEmpty()){
    // 如果没有检测到注解 , 直接退出
    return false;
}



3、获取被 @Route 标注的 注解节点


获取被 Route 注解标注的类节点 , 调用 RoundEnvironment 参数的 getElementsAnnotatedWith 方法 , 传入要获取的注解类对象 ;


// 获取被 @Route 注解的节点
// 这些 注解节点 都是类节点 , TypeElement 类型的
Set<? extends Element> routeElements = roundEnvironment.getElementsAnnotatedWith(Route.class);




4、判断被 @Route 标注的 注解节点的类型


判断被 @Route 标注的 注解节点的类型 : 是否是 Activity 子类类型 ;


获取 android.app.Activity 类型的 的 TypeElement 注解节点 ;


// 获取 android.app.Activity 类型的注解节点
TypeElement activityElement = mElementUtils.getTypeElement("android.app.Activity");


判定获取的 Set<? extends Element> routeElements 节点是否是 " android.app.Activity " 子类节点 , 如果是则创建路由信息对象 ;


mTypeUtils.isSubtype(element.asType(), activityElement.asType())


创建路由信息对象 完整代码示例 :


private void generateRouteClass(Set<? extends Element> routeElements) {
        // 获取 android.app.Activity 类型的注解节点
        TypeElement activityElement = mElementUtils.getTypeElement("android.app.Activity");
        // 处理 @Route(path = "app/MainActivity") 节点
        for (Element element : routeElements) {
            // 获取 Route 注解
            Route route = element.getAnnotation(Route.class);
            // 路由表中的单个路由对象
            RouteBean routeBean = null;
            // 打印类节点全类名
            mMessager.printMessage(Diagnostic.Kind.NOTE,
                    "打印类节点 typeElement : " + activityElement.getQualifiedName());
            // 判断 typeMirror 注解节点是否是 Activity 类型
            if (mTypeUtils.isSubtype(element.asType(), activityElement.asType())) {
                // 该节点是 android.app.Activity 类型的
                routeBean = new RouteBean(
                        RouteBean.Type.ACTIVITY,    // 路由对象类型
                        element,         // 路由节点
                        null,    // 类对象
                        route.path(),   // 路由地址
                        route.group()); // 路由组
                // 检查路由地址
                checkRouteAddress(routeBean);
                // 打印路由信息
                mMessager.printMessage(Diagnostic.Kind.NOTE,
                        "打印路由信息 : " + routeBean.toString());
            }else{
                // 该节点不是 android.app.Activity 类型的
                throw new RuntimeException("@Route 注解节点类型错误");
            }
        }
    }



目录
相关文章
|
2月前
|
设计模式 Android开发
[Android 四大组件] --- BroadcastReceiver
[Android 四大组件] --- BroadcastReceiver
33 0
|
3月前
|
Android开发 开发者
什么是Android Jetpack,它包括哪些组件?
什么是Android Jetpack,它包括哪些组件?
39 0
|
2月前
|
数据库 Android开发 数据库管理
【Android】使用android studio查看内置数据库信息
【Android】使用android studio查看内置数据库信息
64 0
|
2月前
|
数据可视化 Android开发
[Android 四大组件] --- Service
[Android 四大组件] --- Service
24 0
|
2月前
|
Android开发
[Android 四大组件] --- Activity
[Android 四大组件] --- Activity
22 1
|
2月前
|
存储 数据库 Android开发
安卓四大组件是什么?
安卓四大组件是什么?
|
3月前
|
数据库 Android开发 开发者
Android基础知识:什么是Android应用的四大组件?
Android基础知识:什么是Android应用的四大组件?
59 1
|
3月前
|
开发工具 Android开发
Android获取SDK的版本信息
Android获取SDK的版本信息
39 0
|
4月前
|
Java 定位技术 Android开发
【Android App】利用腾讯地图获取地点信息和规划导航线路讲解及实战(附源码和演示视频 超详细必看)
【Android App】利用腾讯地图获取地点信息和规划导航线路讲解及实战(附源码和演示视频 超详细必看)
61 1
|
4月前
|
Android开发 网络架构
【Android App】检查手机连接WiFi信息以及扫描周围WiFi的讲解及实战(附源码和演示 超详细必看)
【Android App】检查手机连接WiFi信息以及扫描周围WiFi的讲解及实战(附源码和演示 超详细必看)
162 1