当前位置：首页 > ai >正文

注解的使用和自定义

ai 2025/7/28 3:03:40

在 Java 里，注解是一种元数据形式，它能够为程序元素（像类、方法、字段等）添加补充信息。这些信息不会对程序的运行逻辑造成影响，但可以在编译阶段、运行阶段被读取并加以利用。下面为你详细介绍注解的使用方法以及自定义注解的编写方式：

内置注解

Java 自身提供了一些内置注解，常见的有：

@Override：此注解用于标明某个方法是对父类方法的重写。
@Deprecated：表示某个程序元素已过时，不建议再使用。
@SuppressWarnings：用于抑制编译器产生的警告信息。
@FunctionalInterface：用于标记某个接口是函数式接口。

元注解

元注解的作用是对注解进行注解，Java 定义了以下几种元注解：

@Retention：它指定了注解的保留策略，可选值有：
- RetentionPolicy.SOURCE：注解仅在源代码阶段保留，编译时会被编译器丢弃。
- RetentionPolicy.CLASS：注解会被保留到编译后的 class 文件中，但运行时不会被 JVM 读取。
- RetentionPolicy.RUNTIME：注解在运行时可以被 JVM 读取，能够通过反射机制获取注解信息。
@Target：用于限定注解可以应用的程序元素类型，例如：
- ElementType.TYPE：可以应用于类、接口、枚举等类型。
- ElementType.METHOD：只能应用于方法。
- ElementType.FIELD：只能应用于字段。
- 还有其他多种可选值，如PARAMETER、CONSTRUCTOR等。
@Documented：该注解表明它所修饰的注解会被包含在 JavaDoc 文档中。
@Inherited：此注解使得子类可以继承父类的注解。
@Repeatable：从 Java 8 开始支持，允许在同一个程序元素上重复使用同一个注解。

自定义注解的定义

下面通过一个示例来展示如何定义自定义注解：

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;// 定义一个可以在类和方法上使用的运行时注解
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {// 定义注解的属性，带有默认值String value() default "";int count() default 1;Class<?> category() default Void.class;
}

注解属性的定义

在自定义注解时，需要注意以下几点：

注解属性的返回类型只能是以下几种：基本数据类型、String、Class、枚举类型、注解类型，以及这些类型的数组。
定义属性的语法为type attributeName() default defaultValue;，其中default部分是可选的。
如果注解中只有一个属性，通常将其命名为value，这样在使用注解时可以省略属性名。

注解的使用

以下是使用自定义注解的示例：

@MyAnnotation(value = "Example", count = 3, category = MyClass.class)
public class MyClass {@MyAnnotation("Method Annotation")public void myMethod() {// 方法实现}
}

通过反射读取注解

当注解的保留策略为RUNTIME时，可以利用反射机制来读取注解信息：

import java.lang.reflect.Method;public class AnnotationProcessor {public static void main(String[] args) throws NoSuchMethodException {// 获取类上的注解Class<?> clazz = MyClass.class;if (clazz.isAnnotationPresent(MyAnnotation.class)) {MyAnnotation classAnnotation = clazz.getAnnotation(MyAnnotation.class);System.out.println("Class Annotation: " + classAnnotation.value());System.out.println("Count: " + classAnnotation.count());System.out.println("Category: " + classAnnotation.category().getName());}// 获取方法上的注解Method method = clazz.getMethod("myMethod");if (method.isAnnotationPresent(MyAnnotation.class)) {MyAnnotation methodAnnotation = method.getAnnotation(MyAnnotation.class);System.out.println("Method Annotation: " + methodAnnotation.value());}}
}

重复注解的使用（Java 8+）

Java 8 引入了对重复注解的支持，使用方式如下：

import java.lang.annotation.ElementType;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;// 定义重复注解容器
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@interface Filters {Filter[] value();
}// 定义可重复注解
@Repeatable(Filters.class)
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@interface Filter {String value();
}// 使用重复注解
public class RepeatingAnnotationsExample {@Filter("auth")@Filter("logging")public void process() {// 方法实现}
}// 读取重复注解
public class RepeatingAnnotationsProcessor {public static void main(String[] args) throws NoSuchMethodException {Method method = RepeatingAnnotationsExample.class.getMethod("process");Filter[] filters = method.getAnnotationsByType(Filter.class);for (Filter filter : filters) {System.out.println("Filter: " + filter.value());}}
}