Java注解处理器使用注意事项
目录
[TOC]
注解
元注解
@Target
用于标记可以应用于哪些类型上.
类型说明
元素类型 | 适用场合 |
---|---|
ANOTATION_TYPE | 注解类型声明 |
PACKAGE | 包 |
TYPE | 类,枚举,接口,注解 |
METHOD | 方法 |
CONSTRUCTOR | 构造方法 |
FIELD | 成员域,枚举常量 |
PARAMETER | 方法或构造器参数 |
LOCAL_VARIABLE | 局部变量 |
TYPE_PARAMETER | 类型参数 |
TYPE_USE | 类型用法 |
@Retention
用于标注注解保留时间
类型说明
保留类型 | 说明 |
---|---|
SOURCE | 只保留到源码中,编译出来的class不存在 |
CLASS | 保留到class文件中,但是JVM不会加载 |
RUNTIME | 一直存在,JVM会加载,可用反射获取 |
注解处理器
方法重载注意事项
- 为兼容
JDK_6
,最好重载方法getSupportedAnnotationTypes
和getSupportedSourceVersion
而不是使用注释@SupportedAnnotationTypes
和@SupportedSourceVersion
注解处理器的注册
方式一
res/META-INF/services/javax.annotation.processing.Processor
添加注解处理器的类全路径及名称,如果有多个注解处理器,换行分割.
举例:
com.yxf.socketframe.annotation.ClientCallbackProcessor com.yxf.socketframe.annotation.ServerInterfaceProcessor
有一个非常巨大的坑,如果是在Android Studio中做这些事情,需要在库的build.gradle中添加如下配置
sourceSets { main { java { srcDir 'src' } resources { srcDir 'res' } } }
不然注解处理器不生效.
方式二
添加对谷歌自动注册注解库的引用
implementation ‘com.google.auto.service:auto-service:1.0-rc4’
在注解处理器类前面声明
@AutoService(Processor.class)
配置
在项目app的build.gradle中添加
android { defaultConfig { javaCompileOptions { annotationProcessorOptions { includeCompileClasspath true } } } }
或者使用 annotationProcessor
来编译有注解处理器的部分.
常用实现
getSupportedSourceVersion
@Override public SourceVersion getSupportedSourceVersion() { return SourceVersion.latestSupported(); }
getSupportedAnnotationTypes
@Override public Set<String> getSupportedAnnotationTypes() { Set<String> annotations = new LinkedHashSet<String>(); annotations.add(ServerInterface.class.getCanonicalName()); return annotations; }
process
从EventBus源码中借鉴
@Override public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) { round++; messager.printMessage(Diagnostic.Kind.NOTE, "Processing round " + round + ", new annotations: " + !set.isEmpty() + ", processingOver: " + roundEnvironment.processingOver()); if (roundEnvironment.processingOver()) { if (!set.isEmpty()) { messager.printMessage(Diagnostic.Kind.ERROR, "Unexpected processing state: annotations still available after processing over"); return false; } } if (set.isEmpty()) { return false; } if (writerRoundDone) { messager.printMessage(Diagnostic.Kind.ERROR, "Unexpected processing state: annotations still available after writing."); } if (!generateSourceFile(set, roundEnvironment)) { return false; } writerRoundDone = true; return true; }
Element
类型说明
Element | 说明 |
---|---|
TypeElement | 一般是类或者接口元素 |
ExecutableElement | 类方法或者接口方法元素 |
VariableElement | 成员变量,参数元素 |
属性获取
属性的获取感觉有点让人心累,无法直接获得所属对象的class.
一般通过 Element.getQualifiedName()
, Element.getSimpleName()
这两个方法获得类名和路径.
通过 Element.getKind()
获得元素类型.
通过 ExecutableElement.getReturnType().getKind()
获得方法返回类型.
通过 VariableElement.asType().toString()
获得参数类型,或者通过 VariableElement.asType().getKind()
获取,但是这种方式只能获得基础类型的类型.
注意
-
应当注意的是,在生成Java源文件的代码中,生产的内部变量尽可能添加下划线,以避免和动态参数产生变量名冲突
-
注解处理器和库之间应当分离作为两个库
-
如果自建Java库,注解处理器和注解分离,则在这个库中使用的注解,注解处理器将不会执行,所以不要在自己的库中使用自己的注解.
-
process
方法返回false会停止编译,如果编译出现问题,可以通过Messager
打印错误信息,并且process
返回false.
如果你现在在JAVA这条路上挣扎,也想在IT行业拿高薪,可以参加我们的训练营课程,选择最适合自己的课程学习,技术大牛亲授,7个月后,进入名企拿高薪。我们的课程内容有:Java工程化、高性能及分布式、高性能、深入浅出。高架构。性能调优、Spring,MyBatis,Netty源码分析和大数据等多个知识点。如果你想拿高薪的,想学习的,想就业前景好的,想跟别人竞争能取得优势的,想进阿里面试但担心面试不过的,你都可以来,q群号为:779792048
注:加群要求
1、具有1-5工作经验的,面对目前流行的技术不知从何下手,需要突破技术瓶颈的可以加。
2、在公司待久了,过得很安逸,但跳槽时面试碰壁。需要在短时间内进修、跳槽拿高薪的可以加。
3、如果没有工作经验,但基础非常扎实,对java工作机制,常用设计思想,常用java开发框架掌握熟练的,可以加。
4、觉得自己很牛B,一般需求都能搞定。但是所学的知识点没有系统化,很难在技术领域继续突破的可以加。
5.阿里Java高级大牛直播讲解知识点,分享知识,多年工作经验的梳理和总结,带着大家全面、科学地建立自己的技术体系和技术认知!