Java基础夯实——1. 4 Java注解

最新推荐文章于 2025-04-01 09:47:31 发布

以后不吃煲仔饭

最新推荐文章于 2025-04-01 09:47:31 发布

阅读量945

点赞数 9

文章标签： java 开发语言

本文链接：https://blog.youkuaiyun.com/m0_60235638/article/details/143697498

版权

注解

在 Java 中，注解（Annotation） 是一种特殊的标记，用于向代码元素（如类、方法、字段等）添加元数据。注解本身不会影响程序的逻辑运行，但可以通过工具或框架来处理注解，以实现一些功能（如代码生成、编译检查、运行时处理等）。

Java 注解是通过元数据提供额外的信息，通常用于：

编译时检查：如标记方法是否已经实现、标记变量是否被使用等。
运行时处理：例如，框架通过注解来标识和操作特定的类和方法（如 Spring、Hibernate）。
代码生成：用于自动生成代码、配置文件等。

说人话，注解（Annotation）就是给程序添加“标签”或“备注”，这些标签或备注提供一些额外的信息，用来描述程序的某些特性、行为或配置。注解本身并不直接改变程序的执行逻辑，但它们可以被其他工具或框架读取和处理，从而影响程序的行为。

假如你有一本书，这本书的内容是固定的，但在每一页的边角上，你可以写一些备注。这些备注并不直接改变书的内容，但如果你是一个图书馆管理员或书籍分析工具，你可以利用这些备注来做一些特定的操作，比如生成书单、检查错误、分类书籍等等。

1. 注解的概念

Java 中的注解可以理解为一种标记，它的语法如下：

@AnnotationName(arguments)

其中，@AnnotationName 是注解的名字，arguments 是可选的参数。

注解的使用场景：

类级注解：用于类的定义上。
方法级注解：用于方法的定义上。
字段级注解：用于字段的定义上。

常见注解的类型

没有成员的注解：只有名字，不带参数。用于简单的标记，如 @Override。
```
@Override
public String toString() {
    return "Custom toString()";
}
```

有成员的注解：带有属性或参数的注解，如 @SuppressWarnings 和 @Entity。

@Entity
@Table(name = "users")
public class User {
    @Id
    private Long id;
}

定义自定义注解

使用 @interface 关键字定义一个注解：

public @interface MyAnnotation {
    String value() default "default value"; // 默认值
}

2. 标准元注解

Java 提供了四个标准的元注解，它们用于描述其他注解的行为和属性：

2.1 `@Retention`

指定注解的生命周期，即注解保留到何时。

RetentionPolicy.SOURCE：注解只存在于源代码中，编译时丢弃。
RetentionPolicy.CLASS：注解存在于字节码中，默认值，编译后保留。
RetentionPolicy.RUNTIME：注解在运行时保留，可以通过反射读取。

@Retention(RetentionPolicy.RUNTIME)
public @interface MyRuntimeAnnotation {
    String value();
}

2.2 `@Target`

指定注解可以应用的程序元素（如类、方法、字段等）。

ElementType.TYPE：类、接口、枚举。
ElementType.FIELD：字段。
ElementType.METHOD：方法。
ElementType.PARAMETER：方法参数。
ElementType.CONSTRUCTOR：构造函数。

@Target(ElementType.METHOD)
public @interface MethodAnnotation {
    String description() default "Method annotation";
}

2.3 `@Inherited`

标记一个注解是否可以被子类继承。默认情况下，注解不会被继承，除非标记了 @Inherited。

@Inherited
public @interface InheritedAnnotation {
}

2.4 `@Documented`

表示注解是否应该包含在 Javadoc 中。加上该注解的注解会在 Javadoc 文档中生成。

@Documented
public @interface DocumentationRequired {
}

3. 注解处理器

注解处理器是用于在编译时处理注解的工具。它允许开发者在编译阶段通过反射来解析注解并执行相应的代码生成或其他处理工作。

3.1 注解处理器的定义

要创建一个注解处理器，需要继承 AbstractProcessor 类并重写 process() 方法。注解处理器通常通过 @SupportedAnnotationTypes 和 @SupportedSourceVersion 来指定它所支持的注解类型和 Java 版本。

示例代码：

@SupportedAnnotationTypes("com.example.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)) {
            // 处理 MyAnnotation 注解
            System.out.println("Found annotation on: " + element.getSimpleName());
        }
        return true;
    }
}

3.2 注解处理器的使用

注解处理器通常在编译时由工具（如 javac 或 apt）自动调用，也可以在 IDE 中配置。使用注解处理器可以进行代码生成、日志打印、编译时校验等任务。

3.3 示例：编写注解处理器

假设你有一个自定义注解 @MyAnnotation，你可以编写注解处理器来处理它。

定义注解：

public @interface MyAnnotation {
    String value();
}

编写注解处理器：

@SupportedAnnotationTypes("MyAnnotation")
public class MyAnnotationProcessor extends AbstractProcessor {

    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        for (Element element : roundEnv.getElementsAnnotatedWith(MyAnnotation.class)) {
            MyAnnotation myAnnotation = element.getAnnotation(MyAnnotation.class);
            System.out.println("Processing: " + myAnnotation.value());
        }
        return false;
    }
}

注册处理器：

在 META-INF/services/javax.annotation.processing.Processor 文件中列出处理器类的全路径：

com.example.MyAnnotationProcessor

3.4 注解处理器的优势

代码生成：自动生成代码，比如通过注解生成实现接口的代码。
编译时检查：进行静态分析，检查程序中潜在的问题。
自动化：简化配置和验证过程，避免手动检查。

总结

Java 注解提供了一种强大且灵活的机制来为代码提供元数据，可以在编译时和运行时进行处理。通过元注解，我们可以定义注解的行为，而注解处理器则为开发者提供了在编译时动态处理注解的能力。注解广泛应用于现代 Java 框架和工具中，如 Spring、Hibernate 等，能够有效地提升代码的可维护性和扩展性。