目录
Java 注解（Annotations）
注解（Annotations） 是 Java 提供的一种元数据机制，用于为代码提供补充信息。注解本身不会对代码的执行产生直接影响，但它们可以在编译时、类加载时或者运行时被读取，并应用于编译器、开发工具或运行时的逻辑操作中。通过使用注解，开发者可以更好地控制代码行为、减少样板代码，并增强代码的可读性和可维护性。本模块将介绍 Java 中的内置注解、自定义注解以及注解处理器的使用。
1. 注解的概述
注解是用 @ 符号标识的元数据，它们可以应用于类、方法、字段、参数等不同的位置。Java 预定义了一些常用的注解，同时开发者也可以根据需要创建自定义注解。
1.1 注解的用途
-
为编译器提供信息：例如，
@Override告诉编译器该方法是重写方法。 -
编译时和运行时处理：注解可以被用来生成代码、配置依赖注入、进行运行时的逻辑判断等。
-
替代配置文件：注解可以作为配置的替代方式，例如在 Spring 框架中大量使用的注解。
1.2 内置注解
Java 提供了一些内置注解，它们主要用于提供编译器提示和代码标记。
-
@Override：表示当前方法重写了父类的方法。 -
@Deprecated：标记一个类、方法或字段已经过时，不推荐使用。 -
@SuppressWarnings：用于抑制编译器产生的警告信息。
示例：使用内置注解
public class AnnotationExample {
@Override
public String toString() {
return "这是一个重写的 toString 方法";
}
@Deprecated
public void oldMethod() {
System.out.println("这是一个过时的方法，不推荐使用");
}
@SuppressWarnings("unchecked")
public void suppressWarningExample() {
// 不推荐的未检查转换，编译器会给出警告
List rawList = new ArrayList();
rawList.add("Hello");
}
}在这个例子中，@Override 用于确保重写父类方法的正确性，@Deprecated 标记了不推荐使用的方法，而 @SuppressWarnings 则抑制了编译器的警告。
2. 自定义注解
Java 允许开发者创建自定义注解，用于特定场景的元数据标记。自定义注解通常结合注解处理器进行处理，能够显著减少样板代码并简化开发流程。
2.1 定义自定义注解
使用 @interface 关键字可以定义自定义注解。自定义注解可以包含元素，这些元素可以用来存储注解的值。
示例：定义自定义注解
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface MyAnnotation {
String value() default "默认值";
}在这个例子中，@Retention 指定了注解的保留策略为运行时（RUNTIME），这样注解可以在运行时被反射读取。@Target 指定了注解可以应用于的方法级别。
2.2 使用自定义注解
示例：应用自定义注解
public class CustomAnnotationExample {
@MyAnnotation(value = "这是一个自定义注解")
public void annotatedMethod() {
System.out.println("执行带有自定义注解的方法");
}
public static void main(String[] args) throws Exception {
CustomAnnotationExample example = new CustomAnnotationExample();
example.annotatedMethod();
// 通过反射获取注解信息
if (example.getClass().getMethod("annotatedMethod").isAnnotationPresent(MyAnnotation.class)) {
MyAnnotation annotation = example.getClass().getMethod("annotatedMethod").getAnnotation(MyAnnotation.class);
System.out.println("注解的值: " + annotation.value());
}
}
}在这个例子中，我们为 annotatedMethod 方法应用了自定义注解 @MyAnnotation，并通过反射获取了注解的值。
3. 元注解
元注解 是用于注解其他注解的注解，它们可以帮助描述自定义注解的行为。
-
@Retention：指定注解的生命周期（保留策略）。-
SOURCE：注解只在源码中存在，编译后丢弃。 -
CLASS：注解在字节码中存在，但运行时不可见。 -
RUNTIME：注解在运行时也可见，可以通过反射读取。
-
-
@Target：指定注解的应用目标。-
例如：
ElementType.METHOD表示注解可以应用于方法。
-
-
@Documented：表明该注解会被包含在 Javadoc 中。 -
@Inherited：允许子类继承父类的注解。
示例：元注解使用
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.TYPE})
@Inherited
public @interface InheritableAnnotation {
String info() default "继承注解示例";
}在这个例子中，@Retention 表示注解在运行时保留，@Target 表示注解可以应用于类和方法，@Inherited 允许子类继承该注解。
4. 注解处理器
注解处理器 是用于在编译时处理注解的工具，通常与自定义注解一起使用，用于生成代码或执行编译时检查。Java 提供了 javax.annotation.processing 包来编写注解处理器。
4.1 创建注解处理器
示例：创建一个简单的注解处理器
import javax.annotation.processing.*;
import javax.lang.model.SourceVersion;
import javax.lang.model.element.Element;
import javax.lang.model.element.TypeElement;
import java.util.Set;
@SupportedAnnotationTypes("MyAnnotation")
@SupportedSourceVersion(SourceVersion.RELEASE_8)
public class MyAnnotationProcessor extends AbstractProcessor {
@Override
public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
for (Element element : roundEnv.getElementsAnnotatedWith(MyAnnotation.class)) {
System.out.println("处理注解: " + element.getSimpleName());
}
return true;
}
}在这个例子中，我们创建了一个简单的注解处理器 MyAnnotationProcessor，它在编译时扫描并处理带有 @MyAnnotation 的元素。
总结与后续
在本模块中，我们学习了 Java 的注解机制，包括内置注解、自定义注解以及如何编写注解处理器。注解是 Java 代码中非常强大的元数据工具，通过注解，我们可以实现编译时检查、减少样板代码并增强代码的可维护性。
在下一模块中，我们将深入学习 Java 泛型和反射，了解如何使用泛型来编写通用代码，并通过反射在运行时动态地操作类和对象。
