注解处理器配置以及使用

  • 配置
// As-3.4.1及其以上 + gradle5.1.1-all + auto-service:1.0-rc4
api 'com.google.auto.service:auto-service:1.0-rc4'
annotationProcessor 'com.google.auto.service:auto-service:1.0-rc4'

java项目避免输出乱码,增加配置

// java控制台输出中文乱码
tasks.withType(JavaCompile) {
    options.encoding = "UTF-8"
}
  • 继承AbstractProcessor,重写init和实现process方法
  • 增加@AutoService(Processor.class)注解
  • 配置注解
    • SupportedAnnotationTypes 设置要处理的注解类型
    • SupportedSourceVersion 设置jdk编译版本
    • SupportedOptions 设置接收的参数
  • 从init方法中初始化基本工具类实例
// 初始化
/*操作Element的工具类(类,函数,属性,都属于Element)*/
elementUtils = processingEnvironment.getElementUtils();
/*类类型工具,用于操作TypeMirror的工具类*/
typeUtils = processingEnvironment.getTypeUtils();
/*用于打印日志*/
messager = processingEnvironment.getMessager();
/*用于生成文件*/
filer = processingEnvironment.getFiler();

//获取参数,传递参数后文介绍
Map<String, String> options = processingEnv.getOptions();
if (options.size() == 0 || !options.containsKey("eventBusIndex")) {
    messager.printMessage(Diagnostic.Kind.NOTE, "需要传递一个类索引类的全类名");
    return;
}
eventBusIndexClassName = options.get("eventBusIndex");
  • 在process方法中处理Element

    • roundEnv.getElementsAnnotatedWith(Subscribe.class) 获取Subscribe注解的所有元素
    • element.getKind() 获取该元素类型,是类,函数或者字段等
    • element.getModifiers() 获取修饰符
    • executableElement.getReturnType() 获取返回值
    • executableElement.getParameters() 获取参数
    • executableElement.getEnclosingElement() 获取该函数的所属的类元素

    executableElement表示这是一个可执行的元素即方法

    • elementUtils.getTypeElement("全类名") 根据字符串获取类的类型用于javapoet自动生成文件的类型
    • TypeName 某个属性或者参数的类型,一般的可以使用ClassName.get获取,可传递class,TypeElement,TypeMirror等,复合型的类型,例如含有泛型的可以使用ParameterizedTypeName.get获取,例如Map<T1,T2>,第一个参数就传递ClassName.get(Map.class),T1,T2依次传递即可。
    • 生成一个类,应该用倒序的方式去写,先把类的结构搭建起,然后需要什么再添加什么,例如:

    JavaFile.builder(packageName, typeSpec).build().writeTo(filer);
    这就是生成一个类的方法,但是这里需要传入报名和TypeSpec,所以就去创建一个typeSpec,这是一个类结构的封装对象。

    TypeSpec typeSpec = TypeSpec.classBuilder(className).build()
    这句话就能生成一个类结构的封装对象,className就是类名,然后我们可以通过TypeSpec的builder去添加很多关于类的所有东西,最后再build:

    • 实现一个接口使用addSuperinterface或者继承一个类使用superclass当然都需要传递接口或者要继承的类的类型
    • 同样可以添加类的修饰符addModifiers,可传递多个
    • 可以添加字段addField,添加的字段可以创建一个FieldType,需要字段名,类型以及修饰符,例如:
    FieldSpec.builder(/*字段类型,参考上文的TypeName*/fieldType,
     /*字段名*/"info",
     /*修饰符*/ Modifier.PRIVATE, Modifier.STATIC, Modifier.FINAL)
     .build();
    
    • 静态代码块addStaticBlock,可以创建一个CodeBlock.builder(),然后内部的每一行代码都可以通过add添加,但是需要注意,使用add添加的代码不会自动添加分号
    • 添加方法addMethod,可以创建一个 MethodSpec.methodBuilder("方法名")来添加,可以添加方法修饰符(addModifiers),方法参数(addParameter),方法返回值(returns),方法体(addStatement或者addCode,前者每句结尾会自动添加分号,后者不会)。
    • 然后在添加的过程中还有一个重要的知识点就是format的占位符

    $N 用来表示变量名

    $S 用来表示字符串

    $T 用来表示类

    $L 用来表示枚举的值

    然后每一个占位符都需要一个值来填充,例如要生成info = new HashMap<Class<?>, String>();这样一句话就可以:

    addStatement(/*format*/"$N = new $T<$T, $T>()"
    /*对应值*/ "info",ClassName.get(HashMap.class),
    ClassName.get(Class.class),ClassName.get(String.class)
    )
    

    这样生成出来就是上边那句话了,$N$S的传值都是字符串,显示出来前者会去掉引号变成一个变量,后者就是字符串显示。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,214评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,307评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,543评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,221评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,224评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,007评论 1 284
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,313评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,956评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,441评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,925评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,018评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,685评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,234评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,240评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,464评论 1 261
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,467评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,762评论 2 345

推荐阅读更多精彩内容