target 注解作用 编程注解功能详解
核心结论,target 注解是 Java 开发里面非常常用的元注解,元注解的意思就是用来修饰其他注解的注解,它的核心作用是限定被修饰的自定义注解,到底可以应用在哪些程序元素上面,也就是规定这个自定义注解能写在类上面 方法上面 字段上面 构造器上面还是参数上面,如果没有加上 target 注解,自定义注解默认可以放在所有允许的程序位置,加上 target 之后就会强制做编译校验,写在不允许的位置,编译器直接报错,这个注解在 Spring 框架 自定义注解开发 反射相关项目里面使用频率非常高,很多初学 Java 的同学容易把 target 和 Retention 搞混,target 管的是注解能放在哪里,Retention 管的是注解保留到哪个阶段。
之所以需要 target 注解,是因为开发者设计自定义注解的时候,很多注解只适合特定位置,比如一个标记业务权限的注解,理论上只应该写在方法上,如果不加 target 限制,代码编写人员有可能误把这个注解写到类或者成员变量上面,程序运行逻辑就会出现异常,target 就是在编译阶段提前做约束,从源头减少这类错误,属于编译期的安全校验机制。
target 支持的取值清单
ElementType TYPE 可以标注在类 接口 枚举上面
ElementType FIELD 可以标注在成员变量 字段上面
ElementType METHOD 可以标注在方法上面
ElementType PARAMETER 可以标注在方法参数上面
ElementType CONSTRUCTOR 可以标注在构造方法上面
ElementType LOCAL_VARIABLE 可以标注在局部变量上面
ElementType ANNOTATION_TYPE 可以标注在其他注解上面,也就是元注解场景
ElementType PACKAGE 可以标注在包上面
ElementType MODULE 可以标注在模块上面
基础使用步骤
第一步 导入包 import java.lang.annotation.Target
第二步 创建自定义注解
第三步 在自定义注解上方添加 Target 注解,括号里面填入需要的 ElementType 枚举值
第四步 如果需要多个位置生效,使用大括号包裹多个枚举值
第五步 编译代码,尝试把注解放到 target 没有声明的位置,编译器会直接抛出错误
示例说明
Target (ElementType.METHOD)
代表这个自定义注解只允许写在方法上
Target ({ElementType.TYPE, ElementType.FIELD})
代表这个自定义注解既可以写在类上,也可以写在字段上
target 和其他元注解对照表格
| 注解名称 | 核心作用 |
|---|---|
| Target | 限定注解可以放置的程序元素位置 |
| Retention | 限定注解保留阶段 源码 字节码 运行时 |
| Documented | 指定注解可以生成到 javadoc 文档里面 |
| Inherited | 允许子类继承父类上面的注解 |
拓展深度要点
target 只是编译期约束,它不会改变注解本身的业务逻辑,只做位置合法性校验,就算通过反射读取注解,反射获取注解的时候,依然要配合 Retention 设置成 RUNTIME,否则运行时拿不到注解对象,很多新手误以为加上 target 之后,运行时就一定可以反射读取,这个理解是错误的,target 和 Retention 是两套独立功能,需要搭配使用。
如果自定义注解没有声明 target,Java 规范默认该注解可以作用在除了 ANNOTATION_TYPE 之外全部 ElementType 位置,这个默认行为在老项目代码里面比较常见,新项目一般都会主动加上 target,做严格位置限制。
总结,target 注解本质是元注解,核心作用就是限制自定义注解可以放置的位置,使用 ElementType 枚举来指定允许的位置,编译阶段做校验,开发自定义注解的时候,一般会和 Retention 搭配使用,注意区分 target 管位置,Retention 管保留周期,不要混淆两个元注解功能。
【常见问题】
问题 1 target 注解是用来做什么的
回答 1 target 注解是 Java 元注解,核心作用就是限定自定义注解可以标注的程序元素位置,规定注解能放在类 方法 字段还是参数上面,不符合位置编译就报错。
问题 2 target 注解里面可以写多个 ElementType 吗
回答 2 target 注解支持多个 ElementType,写法是大括号包裹多个枚举值,代表这个自定义注解在 target 注解声明的多个位置都可以正常使用。
问题 3 target 注解和 Retention 注解有什么区别
回答 3 target 注解负责限定注解放置位置,Retention 注解负责控制注解保留阶段,target 注解不控制运行时能不能读取注解,二者功能独立,经常搭配一起使用。
问题 4 自定义注解不加 target 注解会怎么样
回答 4 自定义注解如果不写 target 注解,默认可以放在大部分程序元素位置,没有编译位置校验,很容易出现注解误写位置的问题,所以正式项目一般都会添加 target 注解做约束。
【免责申明】
本内容仅作为 Java 编程学习参考,不同 JDK 版本 ElementType 枚举项存在细微差异,实际开发以 JDK 官方文档和项目规范为准,本内容不替代专业开发人员评审。
