Android 自定义注解处理器并生成 json 文件

最新推荐文章于 2023-05-05 14:11:55 发布
最新推荐文章于 2023-05-05 14:11:55 发布
阅读量528 收藏 1
点赞数
原文链接：https://www.jianshu.com/p/5e4dcf1cc317
版权

code小生 一个专注大前端领域的技术平台公众号回复Android加入安卓技术群

作者：12313凯皇
链接：https://www.jianshu.com/p/5e4dcf1cc317
声明：本文已获12313凯皇授权发表，转发等请联系原作者授权

最近在慕课网上学习Navigation相关的时候，一般Navigation的底部导航菜单设置是直接写xml文件，也通过自定义注解动态生成json文件然后去解析定制底部导航栏。由于这些东西都是比较新的东西之前没怎么接触过，所以特地写个demo来记录一下。

这个Demo中以新建项目中的 Bottom Navigation Activity 模板为例，实现三个Fragment实现对应json文件的解析。

初始化环境

  1. app下的build.gradle中统一JDK版本

android {
     ...
 
     compileOptions {
         sourceCompatibility JavaVersion.VERSION_1_8
         targetCompatibility JavaVersion.VERSION_1_8
     }
 }

  1. 创建一个新的moudle名为libmyannotationprocessor，记得选择类型的时候选择Java Library。

  2. 统一JDK环境，将moudle的build.gradle中的sourceCompatibility和targetCompatibility改为8。

dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])
    ...
}

sourceCompatibility = "8"
targetCompatibility = "8"

  1. build.gradle中引入所需资源 这里用到了fastjson用作json转换处理，auto-service辅助实现注解处理器，最新版本可至git仓库中获取。

dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])

    //fastjson
    implementation 'com.alibaba:fastjson:1.2.59'
    
    //auto service
    implementation 'com.google.auto.service:auto-service:1.0-rc6'
    annotationProcessor 'com.google.auto.service:auto-service:1.0-rc6'
}

自定义注解

先自定义两个注解分别用于给Activity和Fragment标记。

//public @interface FragmentDestination {
@Target(ElementType.TYPE) //标记在类、接口上
public @interface FragmentDestination {

    String pageUrl();  //url

    boolean needLogin() default false;  //是否需要登录 默认false

    boolean asStarter() default false;  //是否是首页  默认false
}

//ActivityDestination
@Target(ElementType.TYPE) //标记在类、接口上
public @interface ActivityDestination {

    String pageUrl();  //url

    boolean needLogin() default false;  //是否需要登录 默认false

    boolean asStarter() default false;  //是否是首页  默认false
}

自定义注解处理器

/**
 * Created by Hy on 2020/01/15 21:27
 * <p>
 * SupportedSourceVersion  源码类型  也可通过{@link #getSupportedSourceVersion()}设置
 * SupportedAnnotationTypes 设定需要处理的注解 也可通过{@link #getSupportedAnnotationTypes()}设置
 **/
@SuppressWarnings("unused")
@AutoService(Processor.class)  //auto-service
@SupportedSourceVersion(SourceVersion.RELEASE_8)  //源码类型 1.8
@SupportedAnnotationTypes({"com.yu.hu.libmyannotationprocessor.annotation.ActivityDestination", "com.yu.hu.libmyannotationprocessor.annotation.FragmentDestination"})
public class NavProcessor extends AbstractProcessor {

    private static final String OUTPUT_FILE_NAME = "destination.json";

    private Messager messager; //使用日志打印

    private Filer filer;  //用于文件处理

    //该方法再编译期间会被注入一个ProcessingEnvironment对象，该对象包含了很多有用的工具类。
    @Override
    public synchronized void init(ProcessingEnvironment processingEnvironment) {
        super.init(processingEnvironment);
        //日志打印,在java环境下不能使用android.util.log.e()
        this.messager = processingEnvironment.getMessager();
        //文件处理工具
        this.filer = processingEnvironment.getFiler();
    }

    /**
     * 该方法将一轮一轮的遍历源代码
     *
     * @param set              该方法需要处理的注解类型
     * @param roundEnvironment 关于一轮遍历中提供给我们调用的信息.
     * @return 改轮注解是否处理完成 true 下轮或者其他的注解处理器将不会接收到次类型的注解.用处不大.
     */
    @SuppressWarnings("ResultOfMethodCallIgnored")
    @Override
    public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {

        //通过处理器环境上下文roundEnv分别获取 项目中标记的FragmentDestination.class 和ActivityDestination.class注解。
        //此目的就是为了收集项目中哪些类 被注解标记了
        Set<? extends Element> fragmentElements = roundEnvironment.getElementsAnnotatedWith(FragmentDestination.class);
        Set<? extends Element> activityElements = roundEnvironment.getElementsAnnotatedWith(ActivityDestination.class);

        if (!fragmentElements.isEmpty() || !activityElements.isEmpty()) {
            HashMap<String, JSONObject> destMap = new HashMap<>();
            //分别 处理FragmentDestination  和 ActivityDestination 注解类型
            //并收集到destMap 这个map中。以此就能记录下所有的页面信息了
            handleDestination(fragmentElements, FragmentDestination.class, destMap);
            handleDestination(activityElements, ActivityDestination.class, destMap);

            // app/src/assets
            FileOutputStream fos = null;
            OutputStreamWriter writer = null;
            try {
                //filer.createResource()意思是创建源文件
                //我们可以指定为class文件输出的地方，
                //StandardLocation.CLASS_OUTPUT：java文件生成class文件的位置，/app/build/intermediates/javac/debug/classes/目录下
                //StandardLocation.SOURCE_OUTPUT：java文件的位置，一般在/ppjoke/app/build/generated/source/apt/目录下
                //StandardLocation.CLASS_PATH 和 StandardLocation.SOURCE_PATH用的不多，指的了这个参数，就要指定生成文件的pkg包名了
                FileObject resource = filer.createResource(StandardLocation.CLASS_OUTPUT, "", OUTPUT_FILE_NAME);
                String resourcePath = resource.toUri().getPath();
                messager.printMessage(Diagnostic.Kind.NOTE, "resourcePath: " + resourcePath);

                //由于我们想要把json文件生成在app/src/main/assets/目录下,所以这里可以对字符串做一个截取，
                //以此便能准确获取项目在每个电脑上的 /app/src/main/assets/的路径
                String appPath = resourcePath.substring(0, resourcePath.indexOf("app") + 4);
                String assetsPath = appPath + "src/main/assets";

                File file = new File(assetsPath);
                if (!file.exists()) {
                    file.mkdir();
                }

                //写入文件
                File outputFile = new File(file, OUTPUT_FILE_NAME);
                if (outputFile.exists()) {
                    outputFile.delete();
                }
                outputFile.createNewFile();

                //利用fastjson把收集到的所有的页面信息 转换成JSON格式的。并输出到文件中
                String content = JSON.toJSONString(destMap);
                fos = new FileOutputStream(outputFile);
                writer = new OutputStreamWriter(fos, StandardCharsets.UTF_8);
                writer.write(content);
                writer.flush();
            } catch (IOException e) {
                e.printStackTrace();
            } finally {
                if (writer != null) {
                    try {
                        writer.close();
                    } catch (IOException e) {
                        e.printStackTrace();
                    }
                }
                if (fos != null) {
                    try {
                        fos.close();
                    } catch (IOException e) {
                        e.printStackTrace();
                    }
                }
            }
        }

        return true;
    }

    private void handleDestination(Set<? extends Element> elements, Class<? extends Annotation> annotationClass, HashMap<String, JSONObject> destMap) {
        for (Element element : elements) {
            //TypeElement是Element的一种。
            //如果我们的注解标记在了类名上。所以可以直接强转一下。使用它得到全类名
            TypeElement typeElement = (TypeElement) element;
            //全类名
            String className = typeElement.getQualifiedName().toString();
            //页面的id.此处不能重复,使用页面的类名做hascode即可
            int id = Math.abs(className.hashCode());
            //是否需要登录
            boolean needLogin = false;
            //页面的pageUrl相当于隐式跳转意图中的host://schem/path格式
            String pageUrl = null;
            //是否作为首页的第一个展示的页面
            boolean asStarter = false;
            //标记该页面是fragment 还是activity类型的
            boolean isFragment = false;

            Annotation annotation = typeElement.getAnnotation(annotationClass);
            if (annotation instanceof FragmentDestination) {
                FragmentDestination dest = (FragmentDestination) annotation;
                pageUrl = dest.pageUrl();
                needLogin = dest.needLogin();
                asStarter = dest.asStarter();
                isFragment = true;
            } else if (annotation instanceof ActivityDestination) {
                ActivityDestination dest = (ActivityDestination) annotation;
                pageUrl = dest.pageUrl();
                needLogin = dest.needLogin();
                asStarter = dest.asStarter();
            }

            if (destMap.containsKey(pageUrl)) {
                messager.printMessage(Diagnostic.Kind.ERROR, "不同的页面不允许使用相同的pageUrl" + className);
            } else {
                JSONObject object = new JSONObject();
                object.put("id", id);
                object.put("needLogin", needLogin);
                object.put("asStarter", asStarter);
                object.put("pageUrl", pageUrl);
                object.put("className", className);
                object.put("isFragment", isFragment);
                destMap.put(pageUrl, object);
            }
        }
    }

    /**
     * 返回我们Java的版本.
     * <p>
     * 也可以通过{@link SupportedSourceVersion}注解来设置
     */
    @Override
    public SourceVersion getSupportedSourceVersion() {
        //return SourceVersion.latest();
        return super.getSupportedSourceVersion();
    }

    /**
     * 返回我们将要处理的注解
     * <p>
     * 也可通过{@link SupportedAnnotationTypes}注解来设置
     */
    @Override
    public Set<String> getSupportedAnnotationTypes() {
//        Set<String> annotataions = new LinkedHashSet<>();
//        annotataions.add(ActivityDestination.class.getCanonicalName());
//        annotataions.add(FragmentDestination.class.getCanonicalName());
//        return annotataions;
        return super.getSupportedAnnotationTypes();
    }

}

使用

  1. 在app的build.gradle中引入自定义注解处理器

dependencies {
     ...
     
     //引入项目已使用注解 如果觉得跟下面的合起来有点怪可以单独再创建一个moudle，把注解的定义放到那里面去
     implementation project(path: ':libmyannotationprocessor')
     //配置注解处理器
     annotationProcessor project(':libmyannotationprocessor')
 
 
 }

  1. 使用自定义注解，给默认生成的三个fragment加上自定义的注解：

@FragmentDestination(pageUrl = "tabs/dashboard")
public class DashboardFragment extends Fragment {
    ...
}

@FragmentDestination(pageUrl = "tabs/home")
public class HomeFragment extends Fragment {
    ...
}

@FragmentDestination(pageUrl = "tabs/notification")
public class NotificationsFragment extends Fragment {
    ...
}

  1. 标记好注解后，重新Make Project即可在app/src/main/assets/生成对应的destination.json文件：

{
    "tabs/dashboard":{
        "isFragment":true,
        "asStarter":false,
        "needLogin":false,
        "pageUrl":"tabs/dashboard",
        "className":"com.yu.hu.annotationprocessortest.ui.dashboard.DashboardFragment",
        "id":1222462875
    },
    "tabs/notification":{
        "isFragment":true,
        "asStarter":false,
        "needLogin":false,
        "pageUrl":"tabs/notification",
        "className":"com.yu.hu.annotationprocessortest.ui.notifications.NotificationsFragment",
        "id":2030977523
    },
    "tabs/home":{
        "isFragment":true,
        "asStarter":false,
        "needLogin":false,
        "pageUrl":"tabs/home",
        "className":"com.yu.hu.annotationprocessortest.ui.home.HomeFragment",
        "id":1050166585
    }
}

参考文章

Java中的注解-自定义注解

Java注解解析-搭建自己的注解处理器（CLASS注解使用篇）

相关阅读

1 Gson 解析服务端返回的多种类型的 JSON
2 为 Retrofit2 提供的 FastJson 转换库
3 探索 Android 内存优化方法
4 LiveData+Retrofit 网络请求实战
5 安卓开发小总结

如果你有写博客的好习惯

欢迎投稿

点个在看,小生感恩❤️

weixin_38754349
关注
Android注解以及自定义注解实例与解析
Zhu的博客
09-11 656
Android注解以及自定义注解实例与解析 1. 什么是注解 注解是JDK1.5版本开始引入的一个特性，用于对代码进行说明，可以对包、类、接口、字段、方法参数、局部变量等进行标记，例如我们常见的@Override和@Deprecated， 一般常用的注解可以分为三类： 一类是Java自带的标准注解，包括@Override（标明重写某个方法）、@Deprecated（标明某个类或方法过时）和@SuppressWarnings（标明要忽略的警告），使用这些注解后编译器就会进行检查。 一类为元注解，元注解
如何创建自定义navigation注解处理器
peterluntao的博客
03-15 385
创建自定义的navigation注解处理器主要有以下几个步骤->对慕课的jetpack项目进行一个小总结 1.创建libnavannotation和libnavcompiler libnavannotation中还需要创建创建ActivityDestination和FragmentDestination注解文件 ActivityDestination import java.lang.annotation.ElementType; import java.lang.annotation.Target
android之JSON数据的构建
07-10
安卓中JSON数据的构建
Android Studio 创建.json 文件，个人调取json文件代码。
weixin_55650333的博客
03-29 5540
.json文件的创建
android创建json数据,Android下Json数据的读写与创建
weixin_39653405的博客
05-27 529
首先准备一个Json格式的文件text.json{"languages":[{"id":1,"ide":"Eclipse","name":"Java"},{"id":2,"ide":"XCode","name":"Swift"},{"id":3,"ide":"Visual Studio","name":"C#"},],"cat":"it"}//Json数据的读写try {InputStream i...
Android开发-Json数据的生成与解析-完整Demo-AndroidStuidio
08-29
Android开发-Json数据的生成与解析-完整Demo-AndroidStuidio http://blog.csdn.net/iwanghang Android开发-Json(一)Json数据的生成-完整Demo-AndroidStuidio Android开发-Json(二)Json数据的解析-完整Demo-AndroidStuidio
Android中生成、使用Json数据实例
01-04
1、Json的制作 代码如下: package com.example.usingjson2;    import org.json.JSONException;  import org.json.JSONObject;    import android.os.Bundle;  import android.app.Activity;    public class MainActivity extends Activity {        @Override      protected void onCreate(Bundle savedInstanceStat
JsonToKotlinClass：:rocket:AndroidStudio和IntelliJ Idea的插件可从JSON文本（从Json到Kotlin）生成Kotlin数据类代码
02-03
2. **Moshi**：由Square开发，专注于现代JSON，具有类型安全的注解处理器和强大的转换器。 3. **Jackson**：高性能的JSON库，支持Java和Kotlin，功能强大，但配置相对复杂。 4. **LoganSquare**：同样来自Square，专...
深入解析注解处理器
理解注解处理器 ### 1.1 什么是注解处理器 注解处理器是一种工具，用于在编译时对注解进行处理和解析。它能够在编译阶段扫描、检查和修改源代码中的注解，并生成新的代码或修改已有的代码。 注解处理器通过读取...
Android APT
zenmela2011的专栏
08-01 1179
1.APT注解处理器 APT是Annotation Processing Tool 的简称，即注解处理器。它是一种处理注解的工具，可以在代码编译期扫描并解析注解，最终生成处理注解逻辑的Java文件，从而减少手动的代码输入。ButterKnife、EventBus、ARouter、GreenDAO都使用了APT技术。 使用APT可以在编译时来处理编译时注解，生成额外的Java文件，有如下效果： ①可以达到减少重复代码手工编写的效果。如ButterKnife，可以直接使用注解来减少findviewb.
AE插件生成JSON文件，Android读取JSON播放动画
08-09
Android动画，读取AE生成的JSON播放动画，提高动画运行效率，Android使用Lottie-Android插件
java 自定义注解 生成json_java使用自定义注解配合Jackson实现动态输出花样时间
weixin_34862449的博客
02-25 273
前言在项目中经常越到需要将时间字段转化为诸如：几年前、几月前、几天前、几小时前、分钟前等等的花样时间，如果每次都因为一个字段从数据库取出后还需要进行一次数据处理这样对于开发来说是很不友好的，本可以直接取数据返回，现因一个字段要加一层处理，实在有些繁琐，这时就需要这样一个插件来为您解决开发处理层的问题。本文章命名为花样时间处理，实现了通过自定义注解把时间字段处理为花样时间然后返回前端。期间对于开发者...
Android中生成json格式数据的几种方法
system_err的博客
09-07 3873
String生成的json数据有两种 1 String json="[{'name':'tom','age':12},{'name':'jack','age':13}]"; JSONArray a = new JSONArray(json); System.out.println(a.toString());   2 String json2="{'json':[{'name':'to...
Android 使用 Gson 解析 json 数据及生成
最新发布
diuping20110926的博客
05-05 1316
将下载的 gson-2.9.1.jar 拷贝到 app 目录下的 libs 文件夹中。在 app 文件下的 build.gradle 文件 导入。鼠标右键 点击 Add As Library...直接去下载最新的 Gson 包。gson:2.9.1 包。3.解析所需要的 实体类。1.导入 Gson 包。2.json 数据解析。选择最新的包进行下载。
第一章：navigation注解生成器生成json配置文件
黄孝果的博客
06-10 811
创建注解处理器 创建两个java Library 创建注解lib_navanotation @Target(ElementType.TYPE) public @interface ActivityDestination { String pageUrl(); boolean needLogin() default false; boolean asStarter() default false; } @Target(ElementType.TYPE) public @int
Android存储与加载JSON格式的本地文件
热门推荐
小康师兄
01-27 1万+
Android存储与加载JSON格式的本地文件，直接读写在SD卡上。其它的有用到Spinner、Adapter、TableLayout、TableRow等。
注解简介及自定义注解处理器
Yang_RT的博客
07-30 583
1.基础知识 注解分为标准注解和元注解。注解是代码中的特殊标记，可以在编译，类加载，运行时被读取，并执行相应的处理。 标准注解有4种： @Override 对覆盖超类中的方法进行标记 @Deprecated 对不鼓励使用或已经过时的方法进行标记 @SuppressWarnings 选择性地取消特定代码段中的警告 @SafeVarargs 声明使用了可变长度参数的方法 元注解用来注解其他注解，从而创建新的注解。元注解有以下几种： @Target 注解...
Android注解处理器：AutoService与gradle版本不兼容
手写我对你的温柔
02-27 5117
需要把工程的gradle-wrapper和gradle-plugin分别降低到4.10.1，3.2.0: 详细原因：https://github.com/gradle/gradle/issues/1471 不想降级gradle，那么必须在`libnavcompiler`中额外添加依赖 annotationProcessor 'com.google.auto.service:a...
Android JSON的封装（JSONObject，JSONStringer两种方法）
u013470176的专栏
12-18 7371
创建如下所示的一个json文件： {   "phone" : ["12345678", "87654321"], // 数组   "name" : "yuanzhifei89", // 字符串   "age" : 100, // 数值   "address" : { "country" : "china", "province" : "jiangsu" }, // 对象   "marr
Java自定义注解处理器：自动化API文档生成
"Java 自定义注解处理器是用于在编译期间自动处理并生成文档的强大工具。通过定义一系列正则表达式模式，该处理器能够解析类、方法、注释和其他元数据，从而构建详细的API文档。本文档示例展示了如何创建一个`...
评论 3
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值