找回密码
 立即注册
首页 业界区 业界 JAVA注解处理

JAVA注解处理

蔬陶 2025-8-2 22:04:57
元注解

JDK元注解

@Target

指定注解可以应用的目标(如类、方法、字段等)。
常用取值(ElementType 枚举):

  • TYPE:类、接口、枚举
  • FIELD:字段
  • METHOD:方法
  • PARAMETER:方法参数
  • CONSTRUCTOR:构造函数
  • ANNOTATION_TYPE:注解(用于定义元注解)
示例
  1. @Target(ElementType.METHOD) // 只能用在方法上
  2. public @interface MyAnnotation {}
复制代码
@Retention

指定注解的生命周期(源码、编译期、运行时)。
常用取值(RetentionPolicy 枚举):

  • SOURCE:仅源码保留(如 @Override,编译后丢弃)
  • CLASS:编译期保留(默认,但运行时不可见)
  • RUNTIME:运行时保留(可通过反射读取)
示例
  1. @Retention(RetentionPolicy.RUNTIME) // 运行时可通过反射获取
  2. public @interface MyAnnotation {}
复制代码
@Documented

标记注解是否包含在 JavaDoc 中。
示例
  1. @Documented // 生成的 JavaDoc 会显示此注解
  2. public @interface MyAnnotation {}
复制代码
@Inherited

允许子类继承父类的注解(仅对 @Target(ElementType.TYPE) 有效)。
示例
  1. @Inherited // 子类会继承父类的此注解
  2. public @interface MyAnnotation {}
  3. @MyAnnotation
  4. class Parent {}
  5. class Child extends Parent {} // Child 也拥有 @MyAnnotation
复制代码
@Repeatable(Java 8+)

允许同一注解在同一个位置重复使用。
示例
  1. @Repeatable(MyAnnotations.class) // 可重复使用
  2. public @interface MyAnnotation {
  3.     String value();
  4. }
  5. @MyAnnotation("A")
  6. @MyAnnotation("B") // 合法
  7. class MyClass {}
复制代码
@Native(Java 8+)

用于指示某个字段可能被本地代码(如 JNI)引用。
用法

  • 不强制约束:@Native 仅是一个标记,不改变字段的访问权限或行为。
  • 非运行时注解:编译后会被丢弃,无法通过反射获取。
  • 仅限字段:不能用于方法、类或其他目标。
示例
  1. public class NativeExample {
  2.     @Native
  3.     public static final int BUFFER_SIZE = 1024; // 可能被本地代码使用
  4.     static {
  5.         System.loadLibrary("nativeLib"); // 加载本地库
  6.     }
  7.     public native void nativeMethod(); // 本地方法声明
  8. }
复制代码
Spring 扩展的元注解

@AliasFor

定义注解属性的别名(如 @RequestMapping.path 和 @RequestMapping.value)。
示例
  1. public @interface MyAnnotation {
  2.     @AliasFor("path") // value 和 path 是别名
  3.     String value() default "";
  4.    
  5.     @AliasFor("value")
  6.     String path() default "";
  7. }
复制代码
@Component(间接元注解)

标记一个类为 Spring 组件(@Service、@Controller 等均元标注了 @Component)。
示例
  1. @Component // @Service 元标注了 @Component
  2. public @interface Service {}
复制代码
@Indexed(Spring 5+)

加速类路径扫描,提升启动性能。
示例
  1. @Indexed // 标记为可索引的组件
  2. @Component
  3. public class MyComponent {}
复制代码
Spring工具类

AnnotatedElementUtils

findMergedAnnotation(AnnotatedElement, Class)

这个方法完全支持@AliasFor。例如@PostMapping中嵌套了@RequestMapping注解,并且各属性依赖于它的属性。通过以下代码可以获取@PostMapping的path属性,且path和value的值互通。
示例
  1. RequestMapping requestMapping = AnnotatedElementUtils.findMergedAnnotation(clazz, RequestMapping.class);
  2. System.out.println(Arrays.toString(requestMapping.path()));
复制代码
参考来源:org.springframework.web.servlet.mvc.method.annotation.MvcUriComponentsBuilder#getClassMapping
  1. private static String getClassMapping(Class<?> controllerType) {
  2.     Assert.notNull(controllerType, "'controllerType' must not be null");
  3.     RequestMapping mapping = AnnotatedElementUtils.findMergedAnnotation(controllerType, RequestMapping.class);
  4.     if (mapping == null) {
  5.         return "/";
  6.     }
  7.     String[] paths = mapping.path();
  8.     if (ObjectUtils.isEmpty(paths) || !StringUtils.hasLength(paths[0])) {
  9.         return "/";
  10.     }
  11.     if (paths.length > 1 && logger.isTraceEnabled()) {
  12.         logger.trace("Using first of multiple paths on " + controllerType.getName());
  13.     }
  14.     return paths[0];
  15. }
复制代码
AnnotationUtils

getAnnotation(Annotation, Class)

对于元注解的支持没有AnnotatedElementUtils强大,不支持元注解@AliasFor在嵌套注解中属性的关联,仅能获取当前注解的@AliasFor关联属性。以下代码可以获取@RequestMapping的path属性,且path和value的值互通。但不能通过获取@RequestMapping来获取@PostMapping中配置的path属性值。
示例:
  1. RequestMapping requestMapping = AnnotationUtils.getAnnotation(clazz, RequestMapping.class);
  2. System.out.println(Arrays.toString(requestMapping.path()));
复制代码
不支持递归父级,递归处理需使用 findAnnotation(...)相关的方法
findAnnotation(AnnotatedElement, Class)

若指定的方法或者类上没有找到对应的注解,则会递归查找父类或者接口对应的元素上有无该注解。

来源:豆瓜网用户自行投稿发布,如果侵权,请联系站长删除

相关推荐

您需要登录后才可以回帖 登录 | 立即注册