编译时注解学习三之 注解处理器AbstractProcessor工具和Element属性简述

最新推荐文章于 2024-07-05 19:50:48 发布
最新推荐文章于 2024-07-05 19:50:48 发布
阅读量3.2k 收藏 3
点赞数 1
分类专栏： 编译期注解学习 文章标签： AbstractProcessor工具 ElementType MirrorType
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/u010126792/article/details/96713820
版权

1 如何读取build.gradle配置的常量

配置，读取：

@SupportedOptions({"CLASSNAME"})
@SupportedAnnotationTypes("com.ldx.annotationlib.BindView")
@SupportedSourceVersion(SourceVersion.RELEASE_7)
//@AutoService(Processor.class)
public class AptProcessor extends AbstractProcessor {

    private Map<String,String> mOptionMap;

    @Override
    public synchronized void init(ProcessingEnvironment processingEnvironment) {
        super.init(processingEnvironment)；
        mOptionMap = processingEnv.getOptions();
    }

    @Override
    public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {
        if (set != null && set.size() > 0){

            Set<? extends Element>  elements = roundEnvironment.getElementsAnnotatedWith(BindView.class);
            for (Element element : elements) {
                VariableElement variableElement = (VariableElement) element;
         		//读取配置参数
                mMessager.printMessage(Diagnostic.Kind.NOTE,"aptprocessor     "+mOptionMap.get("CLASSNAME"));

                createFile(enclosingElement, bindViewFiledClassType, bindViewFiledName, bindAnnotation.value());
            }

            return true;
        }
        return false;
    }

build.gradle中配置（如何配置编译时注解变量）：

 javaCompileOptions {
            annotationProcessorOptions {
                arguments = ["xxxx":"xxxxx", "CLASSNAME":"lidxclassname"]

            }
        }

2 打印信息

由于在编译期，所以无法利用System，log，打印信息，系统提供了Messager工具进行信息的打印。
private Messager mMessager = processingEnv.getMessager();;
在这里插入图片描述
第一个参数Kind标识日志的级别，包括：

 public static enum Kind {
        ERROR,
        WARNING,
        MANDATORY_WARNING,
        NOTE,
        OTHER;

        private Kind() {
        }
    }

第二个参数为打印信息，后面参数Element为需要打印的Element。

3 Elements 工具

Elements mElementsUtils = processingEnv.getElementUtils();
在这里插入图片描述
在这里插入图片描述

  //包名
                mMessager.printMessage(Diagnostic.Kind.NOTE,"aptprocessor     "+mElementsUtils.getPackageOf(enclosingElement).asType().toString());
                mMessager.printMessage(Diagnostic.Kind.NOTE,"aptprocessortwo     "+mElementsUtils.getBinaryName(enclosingElement));
                mMessager.printMessage(Diagnostic.Kind.NOTE,"aptprocessortwo     "+mElementsUtils.getPackageOf(enclosingElement).getQualifiedName().toString());
                mMessager.printMessage(Diagnostic.Kind.NOTE,"aptprocessortwo     "+mElementsUtils.isDeprecated(enclosingElement));
                mMessager.printMessage(Diagnostic.Kind.NOTE,"aptprocessortwo     "+mElementsUtils.getPackageElement("com.ldx.canvasdrawdemo").getQualifiedName());

4 Filer

Filer mFilerUtils = processingEnv.getFiler();
完全类名：javax.annotation.processing.Filer，注解处理器可用此创建新文件（源文件、类文件、辅助资源文件）。由此方法创建的源文件和类文件将由管理它们的工具（javac）处理
在这里插入图片描述
在这里插入图片描述
apt常用方法为：
在这里插入图片描述
第一个参数为生成的java文件的全限定名（也就是包名和文件名，写法应该是包名（com.ldx.xx）然后加上一个点（.）在加上文件名），例如要生成com.ldx.xx.demo.java，第一个参数写法为"com.ldx.xx.demo",其中demo就是文件名。
第二个参数是与此文件的创建有因果关联的类型或包元素，该参数可以省略或者为 null，类型为一个数组，一般写法为new Element[]{}或者为null。

  private void createFile(TypeElement enclosingElement, String bindViewFiledClassType, String bindViewFiledName, int id) {
        String pkName = mElementsUtils.getPackageOf(enclosingElement).getQualifiedName().toString();
        String packName = mElementsUtils.getPackageOf(enclosingElement).asType().toString();
        String className = enclosingElement.getSimpleName().toString();
        try {
            JavaFileObject jfo = mFilerUtils.createSourceFile(pkName + "."+className+ "$ViewBinding", new Element[]{});
            Writer writer = jfo.openWriter();
            writer.write(brewCode(className,pkName, bindViewFiledClassType, bindViewFiledName, id));
            writer.flush();
            writer.close();
        } catch (IOException e) {
            e.printStackTrace();
        }

    }

    private String brewCode(String className,String pkName, String bindViewFiledClassType, String bindViewFiledName, int id) {
        StringBuilder builder = new StringBuilder();
        builder.append("package " + pkName + ";\n\n");
        builder.append("public class " + className + "$ViewBinding { \n\n");
        builder.append("public static void main(String[] args){ \n\n");
        String info = String.format("%s %s = findViewById(%d)", bindViewFiledClassType, bindViewFiledName, id);
        builder.append("System.out.println(\"" + info + "\");\n\n");
        builder.append("}\n\n");
        builder.append("}");
        return builder.toString();
    }

5 ElementKind

如何判断Element的类型呢，需要用到ElementKind，ElementKind为元素的类型，元素的类型判断不需要用instanceof去判断，而应该通过getKind()去判断对应的类型
类型 说明
PACKAGE 包
ENUM 枚举
CLASS 类
ANNOTATION_TYPE 注解
INTERFACE 接口
ENUM_CONSTANT 枚举常量
FIELD 字段
PARAMETER 方法参数
LOCAL_VARIABLE 局部变量
METHOD 方法
CONSTRUCTOR 构造方法
TYPE_PARAMETER 类型参数

  Set<? extends Element>  elements = roundEnvironment.getElementsAnnotatedWith(BindView.class);
            for (Element element : elements) {
                ElementKind kind = element.getKind();
                if (kind.isField()){
                   mMessager.printMessage(Diagnostic.Kind.NOTE,"aptprocessor     "+"element 是 Field，利用VariableElement进行强转");
                }
                }

6 TypeMirror

TypeMirror是一个接口，表示Java编程语言中的类型。这些类型包括基本类型、引用类型、数组类型、类型变量和null类型等等

类型 说明
ArrayType 表示数组类型
DeclaredType 表示声明类型(类或接口类型)
ErrorType 表示异常类或接口类型
ExecutableType 表示executable类型(方法、构造方法、初始化)
NoType 表示在实际类型不适合的地方使用的伪类型
NullType 表示null类型
PrimitiveType 表示基本数据类型
ReferenceType 表示引用类型
TypeVariable 表示类型变量
WildcardType 表示通配符类型参数

 for (Element element : elements) {
                ElementKind kind = element.getKind();
                if (kind.isField()){
                    mMessager.printMessage(Diagnostic.Kind.NOTE,"aptprocessor     "+"element 是 Field，利用VariableElement进行强转");
                    TypeMirror mirror = element.asType();
                    
                    TypeKind kind1 = mirror.getKind();
                    
                }

如果Element是一个VariableElement，variableElement.asType().toString()可以获取它的全类名。

  String bindViewFiledClassType = variableElement.asType().toString();
                //变量名
                mMessager.printMessage(Diagnostic.Kind.NOTE,"aptprocessor     "+bindViewFiledClassType);

输出：
android.widget.TextView

7 TypeKind

TypeKind为类型的属性，类型的属性判断不需要用instanceof去判断，而应该通过getKind()去判断对应的属性

类型 说明
BOOLEAN 基本类型boolean
INT 基本类型int
LONG 基本类型long
FLOAT 基本类型float
DOUBLE 基本类型double
VOID 对应于关键字void的伪类型
NULL null类型
ARRAY 数组类型
PACKAGE 对应于包元素的伪类型
EXECUTABLE 方法、构造方法、初始化
DECLARE 声明类型

 for (Element element : elements) {
                ElementKind kind = element.getKind();
                if (kind.isField()){
                    mMessager.printMessage(Diagnostic.Kind.NOTE,"aptprocessor     "+"element 是 Field，利用VariableElement进行强转");
                    TypeMirror mirror = element.asType();
                    
                    TypeKind kind1 = mirror.getKind();
                    
                }

8 Types

Types mTypesUtils = processingEnv.getTypeUtils();
Type操作工具，包括对TypeMirror，TypeKind,DeclaredType
在这里插入图片描述在这里插入图片描述
asElement，根据特定TypeMirror获取与之关联的ElementType。
contains，是否一个TypeMirror包含另外一个TypeMirror，类似数组和普通元素。
。。。。。。。

编译时注解学习一之 Element元素
编译时注解学习二之 注解处理器初探AbstractProcessor
编译时注解学习三之 注解处理器AbstractProcessor工具和Element属性简述
编译期注解学习四 简单的view注入框架
编译期注解学习五 - ElementKind，TypeKind，不同Element类型判断
编译期注解学习六- 生成java文件javapoet
编译期注解学习七-如何进行调试
编译时注解学习八 -模板文件读取

lidongxiu0714
关注
专栏目录
Spring5.0源码学习系列之Spring AOP简述（九）
Nicky's blog
12-01 2810
在前面章节的学习中，我们对Spring框架的IOC实现源码有了一定的了解，接着本文继续学习Springframework一个核心的技术点AOP技术。 在学习Spring AOP源码之前，您是否对AOP有足够熟悉的理解？在对应用都不熟悉之前就去学习源码，肯定是很难理解的，所以本文先不描述源码的实现，先通过本篇博客了解熟悉Spring AOP，然后再学习源码
Java Annotation(注解）简述
qq_41962032的博客
10-02 167
此片文章只是说明一下注解的一些基本组成和一些参数，然后举个自定义注解的例子 1.Java的Annotation主要由三个部分组成，Annotation. ElementTyp. RetentionPolicy 2.Annotation接口 当你自定义注解的时候一定会用到@interface ，这个就表示你自定义的这个接口继承了Annotation接口，它的源码中声明了几个方法，有兴趣可以看一下源码 3.ElementType 它是一个枚举类，里面有10个枚举值(jdk1.8)...
【实用工具】JSR-269 插入式注解处理器AbstractProcessor
秋装什么的博客
05-05 1110
【实用工具】JSR-269 插入式注解处理器AbstractProcessor
Java-详解javac AbstractProcessor
yueerba126的博客
07-06 1183
AbstractProcessor 就是注解处理器 ，在java文件编译成class文件之前，对java文件进行操作，生成代码。（可以参考lombok）这些对象必须在init方法里初始化@SupportedAnnotationTypes(“cc.HelloWorld”) ，“cc.HelloWorld” 是HelloWorld注解的类全名。@SupportedSourceVersion(SourceVersion.RELEASE_7) ，annotation支持版本,向前兼容到JDK7。
android2024 gradle8 Processor和ksp两种编译时注解实现
最新发布
jzlhll123的专栏
07-05 1316
android的编译时注解，老生常谈，外面的例子都是bindView，脑壳看疼了，自己学习和编写下。而且现在已经进化到kotlin2.0了，google也逐渐放弃kapt，进入维护状态。所以要好好看看本贴，基于最新的gradle8.6，kotlin2.0+，介绍kapt，ksp的写法。
AbstractProcessor注解处理器
有码走遍天下，无码寸步难行
07-03 1万+
1. 注解一般我们定义一个注解的代码如下:@Retention(RetentionPolicy.CLASS) @Target({ElementType.FIELD, ElementType.TYPE}) public @interface Json { String value(); }在注解上面的注解叫做元注解，元注解共有四种: - @Retention: 保留的范围，默认值为CLASS.
AbstractProcessor 用法示例
weixin_34055787的博客
05-24 1254
自定义一个注解，如果此注解需要在编译期检查注解相关的值，可以自定义一个Annotation的处理类，该类在javax.annotation.processing包中，示例如下：1）自定义一个annotation ,如Version.javaimportjava.lang.annotation.Documented; importjava.lang.anno...
AbstractProcessor: 利用注解动态生成代码
ZhangJian的博客
03-26 1万+
注解动态生成代码
注解简介及自定义注解处理器
Yang_RT的博客
07-30 581
1.基础知识 注解分为标准注解和元注解。注解是代码中的特殊标记，可以在编译，类加载，运行时被读取，并执行相应的处理。 标准注解有4种： @Override 对覆盖超类中的方法进行标记 @Deprecated 对不鼓励使用或已经过时的方法进行标记 @SuppressWarnings 选择性地取消特定代码段中的警告 @SafeVarargs 声明使用了可变长度参数的方法 元注解用来注解其他注解，从而创建新的注解。元注解有以下几种： @Target 注解...
Java注解Target、Retention、Inherited、Documented的作用简述，以@Transactional注解为例（处女座总结）
Java Punk
11-25 4493
通过本篇，你将学会@Target、@Retention、@Inherited、@Documented注解的含义，以及他们的使用场景，方便大家更好的学习源码。
Junit单元测试、注解
vlucky_long的博客
10-27 1249
1、Junit单元测试 软件测试分类： ●黑盒测试：不需要写代码，给输入值，看程序是否能够输出期望值 ●白盒测试：需要写代码，关注程序具体的执行流程 1.1、Junit介绍 junit是一个java语言的单元（就是方法）测试框架，属于白盒测试，简单理解为可以用于取代main方法，junit属于第三方工具，需要导入jar包后使用。 Junit的使用 编写测试类，简单理解为junit可以用于取代java的main方法 在测试类方法上添加注解@Test @Test修饰的方法要求：public void 方法名(
ButterKnife源码分析- 涉及元注解和AbstractProcessor和javapoet
HopCoder
11-20 537
一 、 从调用端分析 为了方便理解我们从最简单最常用的findViewById入手，通常我们只需要写下这样一份代码就可以替代繁琐的findViewById方法。 @BindView(R.id.toolbar) Toolbar toolbar; @Override protected void onCreate(Bundle savedInstanceState) { super.onCr...
Java注解编译期处理AbstractProcessor详解
热门推荐
LoveSummer
05-30 3万+
我们接触的注解主要分为以下两类运行时注解：通过反射在运行时动态处理注解的逻辑编译时注解：通过注解处理器在编译期动态处理相关逻辑平时我们接触的框架大部分都是运行时注解，比如：@Autowire @Resoure @Bean 等等。那么我们平时有接触过哪些编译期注解呢，@Lombok等等像这些编译时注解的作用都是自动生成代码，一是为了提高编码的效率，二是避免在运行期大量使用反射，通过在编译期利用反射生成辅助类和方法以供运行时使用。那这些编译器注解都是如何运行的呢?又是怎么自动生成代码的呢？
Java注解（三）：自定义Java编译时注解处理器
lucyLee的博客
01-23 7199
1. 絮絮叨叨 要么是注解跟我有仇，要么是公司配发的笔记本跟我有仇，要么是因为心急吃不了热豆腐 痛定思痛：从头开始，新建一个Java项目，实现一个超级简单的注解@Hello 在 process()方法中简单打印 getSupportedSourceVersion()方法返回的结果 在此，记录一下如何定义一个简单的Java编译时注解处理器 1.1 AbstractProcessor 自定义Java编译时注解处理器，一般都是通过继承AbstractProcessor实现的 AbstractProcesso
thymeleaf自定义标签方言处理
weixin_30663471的博客
01-29 307
项目背景:springboot+thymeleaf thymeleaf两种方式处理自定义标签：AbstractAttributeTagProcessor 和AbstractElementTagProcessor 一、AbstractAttributeTagProcessor ： 1. 定义dialog package com.spt.im.web.config; impo...
IDEA插件编写一（采用AbstractProcessor编写DEMO）
wang5525369的博客
10-20 1125
IDEA插件编写一
Java进阶--编译时注解处理器（APT）详解
smily的博客
08-24 3万+
上篇文章我们使用注解+反射实现了一个仿ButterKnife功能的示例。考虑到反射是在运行时完成的，多少会影响程序性能。因此，ButterKnife本身并非基于注解+反射来实现的，而是用Annotation Processor在编译时处理注解的。Annotation Processor是javac的一个工具，它用来在编译时扫描和处理注解。 一、了解Annotation Processor 自定......
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值