Gradle开发，APT采集页面路由信息(一)

已于 2023-09-19 00:38:11 修改
阅读量601 收藏
点赞数 1
分类专栏： Android笔记 文章标签： android
于 2023-09-17 01:57:11 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_46039528/article/details/132930598
版权

文章目录

APT采集页面路由信息

一. APT

注解(Annotation)

注解处理器(Annotation Processing Tool)

1.1 流程

定义注解，编写注解处理器，调用注解与注解处理器

二. 页面路由

URL，根据映射关系表，来打开特定页面的组件.

标记页面,收集页面,生成文档,注册映射.打开页面

2.1 映射关系表，采集页面

定义注解: @Destination，实现 DestinationProcessor，发布与使用

2.2 定义注解

定义注解

在这里插入图片描述

在新建的module下配置java信息
在这里插入图片描述

打开根目录setting.gradle文件，添加依赖
在这里插入图片描述

2.3 使用注解

app模块下依赖子工程。

在这里插入图片描述

在Activity页面中使用注解

在这里插入图片描述

2.4 注解处理器

新建一个模块作为注解处理器，并且实现两个方法

在这里插入图片描述

手动生成资源文件META-INF否则注解处理器可能不起作用

在这里插入图片描述
在这里插入图片描述

配置java编译环境

在这里插入图片描述

2.5 采集注解

@AutoService(Process.class)
public class MyClass extends AbstractProcessor {
    @Override
    public synchronized void init(ProcessingEnvironment processingEnv) {
        super.init(processingEnv);
        System.out.println("Hello apt1111");
        processingEnv.getMessager().printMessage(Diagnostic.Kind.NOTE,"Hello apt");
    }

    private static final String TAG = "DestinationProcessor";

    //告诉编译器，当前处理器支持的注解类型
    @Override
    public Set<String> getSupportedAnnotationTypes() {
        HashSet<String> hashSet = new HashSet<>();
        hashSet.add(Destinatign.class.getCanonicalName());
        return hashSet;
    }
    @Override
    public SourceVersion getSupportedSourceVersion() {
        return processingEnv.getSourceVersion();
    }

    //编译器找到我们关心的注解后，会回调这个方法
    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        //避免多次调用process
        if (roundEnv.processingOver()){
            return false;
        }
        System.out.println(TAG + ">>>>>>>process.....");
        //获取所有标记了@Destination 注解的类的信息
        Set<? extends Element> elements = roundEnv.getElementsAnnotatedWith(Destinatign.class);

        System.out.println(TAG + ">>>>>Number of annotations= " + elements.size());
        //当未收集到 @Destination 注解的时候，跳过后续流程
        if (elements.size() < 1) {
            return false;
        }
        //遍历所有 @Destination 注解信息，挨个获取详细信息
        for (Element element1 : elements) {
            TypeElement typeElement = (TypeElement) element1;
//            尝试在当前类上，获取 @Destination 的信息
            Destinatign destinatign = typeElement.getAnnotation(Destinatign.class);
            if (destinatign == null) {
                continue;
            }
            String url = destinatign.url();
            String description = destinatign.description();
            String realPath = typeElement.getQualifiedName().toString();
            System.out.println(TAG + "........url " + url + "....description " + description + ".....realPath " + realPath);

        }
        System.out.println(",,,,,,finish");
        return false;
    }

}

2.6 注册注解处理器

javac并不知道我们的注解处理器到底是哪个类，即便我们在app模块中引入了其所在的子模块。

添加Google的官方依赖

在这里插入图片描述

声明@AutoService(Process.class)

在这里插入图片描述

app模块中引入依赖

在这里插入图片描述

运行程序，输出注解处理器中的代码说明成功

在这里插入图片描述

在这里插入图片描述

2.7 生成映射表的类信息

生成一个类

在这里插入图片描述

我们期望生成一个类，里面包含有类路径和router的一个映射关系。在运行期访问这个类的get方法就可以拿到这个map映射关系。拿到这个map信息就可以拿到对应的url，然后就能找到对应的类，然后就能打开对应的页面了。

规划好这个类之后，去实现。

在注解中去生成拼接这个类的信息。

在这里插入图片描述

和下面这一部分信息对应

在这里插入图片描述

在循环中拼接我们的url和对应的类的信息

在这里插入图片描述

最后

在这里插入图片描述
注解处理器中process回调方法测试代码

@Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        //避免多次调用process
        if (roundEnv.processingOver()) {
            return false;
        }
        String rootDir = processingEnv.getOptions().get("root_project_dir");
        System.out.println("root_project_dir = " + rootDir);
        //        if (rootDir != null) {
//            throw new RuntimeException("root_project_dir = " + rootDir);
//        }
        //将要自动生成的类的类名
        String className = "RouterMapping" + System.currentTimeMillis();
        StringBuilder builder = new StringBuilder();
        builder.append("package com.qfh.common.mapping;\n\n");
        builder.append("import java.util.HashMap;\n");
        builder.append("import java.util.Map;\n\n");
        builder.append("public class ").append(className).append(" {\n\n");
        builder.append("    public static Map<String, String> get() {\n\n");
        builder.append("        Map<String,String> mapping = new HashMap<>();\n\n");

        JsonArray jsonArray = new JsonArray();
        System.out.println(TAG + ">>>>>>>process.....");
        //获取所有标记了@Destination 注解的类的信息
        Set<? extends Element> elements = roundEnv.getElementsAnnotatedWith(Destinatign.class);

        System.out.println(TAG + ">>>>>Number of annotations= " + elements.size());
        //当未收集到 @Destination 注解的时候，跳过后续流程
        if (elements.size() < 1) {
            return false;
        }
        //遍历所有 @Destination 注解信息，挨个获取详细信息
        for (Element element1 : elements) {
            TypeElement typeElement = (TypeElement) element1;
//            尝试在当前类上，获取 @Destination 的信息
            Destinatign destinatign = typeElement.getAnnotation(Destinatign.class);
            if (destinatign == null) {
                continue;
            }
            String url = destinatign.url();
            String description = destinatign.description();
            String realPath = typeElement.getQualifiedName().toString();
            System.out.println(TAG + "........url " + url + "....description " + description + ".....realPath " + realPath);
            builder.append("        ").append("mapping.put(").append("\"" + url + "\"")
                    .append(", ")
                    .append("\"" + realPath + "\"")
                    .append(");\n");
            JsonObject jsonObject = new JsonObject();
            jsonObject.addProperty("url", url);
            jsonObject.addProperty("description", description);
            jsonObject.addProperty("realPath", realPath);
            jsonArray.add(jsonObject);
        }
        builder.append("        return mapping;\n");
        builder.append("    }\n");
        builder.append("}\n");

        String mappningFullclassName = "com.qfh.common.mapping." + className;
        System.out.println(TAG + ".....mappningFullclassName = " + mappningFullclassName);
        System.out.println(TAG + "....class content = " + builder);
        try {
            //写入自动生成的类到本地文件中
            JavaFileObject javaFileObject = processingEnv.getFiler().createSourceFile(mappningFullclassName);
            Writer writer = javaFileObject.openWriter();
            writer.write(builder.toString());
            writer.flush();
            writer.close();
        } catch (Exception e) {
            throw new RuntimeException("Error while create " + e);
        }
        //写入JSON到本地文件中
        File rootFile = new File(rootDir);
        if (!rootFile.exists()) {
            throw new RuntimeException("root_project_dir not exist" + rootFile);
        }
//        创建router_mapping 子目录
        File jsonFile = new File(rootFile, "router_mapping");
        if (!jsonFile.exists()) {
            jsonFile.mkdir();
        }
        File mappingFile = new File(jsonFile, className + "mapping_" + System.currentTimeMillis() + ".json");
        //写入json内容
        try {
            BufferedWriter writer = new BufferedWriter(new FileWriter(mappingFile));
            String  json = jsonArray.toString();
            writer.write(json);
            writer.flush();
            writer.close();
        } catch (Throwable e) {
            throw new RuntimeException("Error while create " + e);
        }


        System.out.println(",,,,,,finish");
        return false;
    }

2.8 生成类-类信息写入本地java文件

javac才会把文件包含到我们的编译过程，然后打包到apk里面去。

在这里插入图片描述

运行apk我们发现我们输出了刚刚拼接的类的信息

在这里插入图片描述

查看我们注解处理器生成的源代码，都在这个目录下

在这里插入图片描述

在apk_debug中查看我们刚刚使用注解处理器生成的类，打包到了apk中。

在这里插入图片描述

三.发布

1.编写发布脚本，发布到本地仓库

为了把我们编写的注解和注解处理器module发给其他项目团队使用

新建脚本文件

在这里插入图片描述

新建一个gradle.properties文件在router-annotations子工程中

在这里插入图片描述

在注解处理器工程中也是一样

在这里插入图片描述

把公共的相同的部分抽取到项目根目录下的gradle.properties中

在这里插入图片描述

在脚本中编写代码

在这里插入图片描述

//使用maven插件中的发布功能
//apply plugin: 'maven-publish'
apply plugin: 'maven-publish'

Properties gradleProperties = new Properties()
gradleProperties.load(
        project.rootProject.file('gradle.properties').newDataInputStream())

def VERSION_NAME = gradleProperties.getProperty("VERSION_NAME")
def POM_URL = gradleProperties.getProperty("POM_URL")
def GROUP_ID = gradleProperties.getProperty("GROUP_ID")

Properties projectGradleProperties = new Properties()
projectGradleProperties.load(project.file('gradle.properties').newDataInputStream())

def POM_ARTIFACT_ID = projectGradleProperties.getProperty("POM_ARTIFACT_ID")
println("maven-publish VERSION_NAME = $VERSION_NAME")
println("maven-publish POM_URL = $POM_URL")
println("maven-publish GROUP_ID = $GROUP_ID")
println("maven-publish POM_ARTIFACT_ID = $POM_ARTIFACT_ID")

publishing {
    // 配置Plugin GAV
    publications {
        maven(MavenPublication) {
            groupId = GROUP_ID
            artifactId = POM_ARTIFACT_ID
            version = VERSION_NAME
            from components.java

        }
    }
    // 发布地址
    repositories {
        maven {
            url = uri('../repo')
        }
//        maven {
//            url layout.buildDirectory.dir("maven-repo")
//        }
    }
}

子工程应用根目录脚本下的发布功能

在这里插入图片描述

发布之后，该模块就发布到本地仓库上了

在这里插入图片描述

在注解处理器工程中也是一样从操作router-processor

在这里插入图片描述

发布到本地仓库之后

在这里插入图片描述

2.在工程中应用

我们新开一个项目

拷贝这个地址到新工程中

在这里插入图片描述

添加maven仓库

在这里插入图片描述

在项目根目录脚本下添加依赖

在这里插入图片描述

在app工程中添加依赖

在这里插入图片描述

使用我们本地仓库中的注解
在这里插入图片描述

构建一下，我们注解上的信息就会被映射到我们写的那个类中。发布成aar包。

在这里插入图片描述

UI仔Coder
关注
  • 1
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 5
    评论
专栏目录
gradle-apt-plugin:Java注解处理器工具的Gradle插件
06-28
未积极维护 该项目不再积极维护，感谢使用它/提供反馈/提交 PR 的每个人。 如果您在 Android 项目中使用它，请查看。 如果您在 java 项目中使用它，则更改是它可以工作但不会再更新。 随意 fork 并为其添加更多功能！ Gradle Apt 插件 Java 注释处理器工具的 Gradle 插件。 用法 将插件添加到buildscript的dependencies并添加 Sonatype 的快照存储库以便能够下载它： buildscript { dependencies { repositories { maven { url " https://oss.sonatype.org/content/repositories/snapshots/ " } .. . }
Android Gradle开发指南详解
08-25
主要为大家详细介绍了Android Gradle开发指南的相关资料，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
Android Gradle插件平台开发系列一：Android APT
u011630465的博客
08-29 617
Android APT
Gradle之apt, annotationProcessor和kapt
每天学习一点点，每天记录一点点
03-16 1万+
介绍了APT的概念和处理流程，Java和Kotlin两种语言下如何在Gradle中配置APT，以及由于APT配置方式用错导致使用ARouter路由时始终提示“There is no route match the path [/xxx/xxx], in group [xxx][ ]”
6. 在 Eclipse 中使用 Gradle 的注释处理 (apt)
雨露青瓷
07-12 1074
6. 在 Eclipse 中使用 Gradle 的注释处理 (apt) 6.1. 概览
AndroidStudio3.4.2 gradle5.1.1 apt注解解释器不执行
yan1348的博客
09-07 979
最近在学习注解是遇到一个坑,就是android studio升级到3.4.2,gradle升级到5.1.1后,apt不会执行,没办法自动生成注解文件. 搞了一个下午,终于找到一篇博客,解决了这个问题. 其实网上大部分的博客都说了其他的地方的配置,我这里就不说了,我说个其他博客没说的 implementation 'com.google.auto.service:auto-service:1.0...
拥抱AndroidStudio之五：Gradle插件开发
02-02
这一章，笔者将以开发和发布一个Gradle插件作为目标，加深学习成果。官方文档给出了比较详细的实现步骤，本文的脉络会跟官方文档差不了太多，额外增补实际例子和一些实践经验。文中的代码已经托管到了github项目中。...
详解如何使用Android Studio开发Gradle插件
01-21
这三个App有一个共同的地方就是大量的使用了Gradle这个强大的构建工具，除了携程的框架外，另外两个都发布了独立的Gradle插件提供自动化构建插件，或者生成热修复的补丁。所以学习一下Gradle插件的编写还是一件十分...
App中如何获取gradle的配置信息
08-26
主要给大家介绍了关于App中如何获取gradle的配置信息的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
android-apt 即将退出历史舞台
ASCE1885
10-20 1万+
广而告之时间：我的新书《Android 高级进阶》（https://item.jd.com/10821975932.html）在京东开始预售了，欢迎订购！
解决： Gradle DSL method not found: 'apt()'
yanjunhui2011的专栏
07-28 1万+
今天构建项目的时候发现引用了ButterKnife的 apt 插件后，我的项目突然给我报了这么一个错误。如下： Error:(27, 0) Gradle DSL method not found: 'apt()' Possible causes:The project 'TransactionTest' may be using a version of Gradle that doe
Android Studio3.0 apt 配置
yangzongbin的专栏
10-27 4610
project的build.gradle文件中删除 classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'1 module的build.gradle文件中删除 apply plugin: 'com.neenbedankt.android-apt'1 module的build.gradle文件中替换 //apt 'com
android apt 作用,apt依赖范围在Android gradle – 它是什么用？
weixin_31046947的博客
05-25 212
什么是apt依赖范围在android gradle文件我看到有时？一个例子看起来像这样？apply plugin: 'com.android.application'apply plugin: 'com.neenbedankt.android-apt'android {compileSdkVersion 20buildToolsVersion '20.0.0'defaultConfig {appl...
gradle之apt与annotationProcessor与kapt关系
火星男孩的分享空间
09-21 9519
什么是APT？ 随着一些如ButterKnife，dagger等的开源注解框架的流行，APT的概念也越来越被熟知。 APT(Annotation Processing Tool 的简称)，可以在代码编译期解析注解，并且生成新的 Java 文件，减少手动的代码输入。现在有很多主流库都用上了 APT，比如 Dagger2, ButterKnife, EventBus3 等 DataBinding Da...
你必须知道的APT、annotationProcessor、android-apt、Provided、自定义注解
热门推荐
薛瑄的博客
04-01 4万+
你可能经常在build.gradle文件中看到，这样的字眼，annotationProcessor、android-apt、Provided，它们到底有什么作用？下面就一起来看看吧 1、什么是APT？ 随着一些如ButterKnife，dagger等的开源注解框架的流行，APT的概念也越来越被熟知。 annotationProcessor和android-apt的功能是一样的，它们是替代...
XXE漏洞修补：保护您的系统免受XML外部实体攻击
最新发布
weixin_43822401的博客
06-14 345
XXE漏洞通常发生在解析XML文档时，如果允许引用外部实体，攻击者可以构造特殊的XML输入，导致应用程序读取或包含恶意文件或URL。这不仅可能泄露敏感信息，还可能被用于进一步的攻击。XXE漏洞是一个严重的安全问题，它威胁着Web应用程序和服务器的安全。通过本文介绍的修补策略，包括升级libxml版本、在代码层禁用外部实体解析以及过滤用户提交的XML数据，可以有效地减少XXE漏洞的风险。网络安全是一个持续的过程，需要系统管理员和开发者不断更新知识和技能，以应对不断变化的威胁。
【Android 11】AOSP Settings添加屏幕旋转按钮
xuanyulevel6的博客
06-13 429
这里是客户要求添加按钮以实现屏幕旋转。这里的值可以是0，1，2，3 的任意一个。我这里没有陀螺仪，所以只需要这个命令就够了。更多的可以参考但是这有个缺陷，就是开机的动画不能随着设置好的屏幕方向旋转。
Android.基本用法学习笔记
2301_78955442的博客
06-10 473
先在strings.xml声明变量方法1.方法2.
gradle插件开发学习
07-22
Gradle插件开发是一个广泛应用于构建和自动化的重要技能。以下是一些学习Gradle插件开发的途径和资源： 1. 官方文档：Gradle官方网站上提供了详细的插件开发文档和指南，包括插件结构、任务定义、扩展API等等。您可以在官网学习到最新的Gradle插件开发知识。 2. 在线教程：有许多在线教程和博客文章可以帮助您入门Gradle插件开发。一些知名的教育平台和技术社区如CSDN、简书、GitHub等都有相关的教程和示例代码供您学习。 3. 书籍：有一些书籍专门讲解Gradle插件开发，如《Gradle插件开发指南》、《Gradle实战》等。这些书籍提供了更系统和深入的知识，适合有一定经验的开发者深入学习。 4. 实践项目：参与开源项目或者自己创建一个小项目来实践Gradle插件开发，通过实际操作来加深理解和掌握技能。可以从简单的任务定义开始，逐步挑战更复杂的插件功能。 5. 社区交流：加入Gradle的官方社区或者相关的技术论坛，与其他开发者分享经验和问题。可以从其他开发者的经验中学习到更多实用的技巧和技术。 总之，学习Gradle插件开发需要掌握Gradle的基础知识和插件开发的原理，通过实践和不断学习来提升技能。希望这些资源能够帮助您开始学习Gradle插件开发。祝您学习顺利！

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 5
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值