Java中的Annotation注解

青山^

已于 2024-08-20 17:45:37 修改

阅读量374

点赞数 11

文章标签： java 开发语言

于 2024-08-20 17:37:10 首次发布

本文链接：https://blog.csdn.net/qq_68874993/article/details/141363890

版权

Annotation注解在Java及许多其他编程语言中扮演着重要的角色，它提供了一种为代码添加额外信息（元数据）的方式，这些信息对程序的执行逻辑无直接影响，但可以被编译器或运行时环境用来执行特定的任务或生成额外的代码、文档等。

1.定义与本质

定义：注解（Annotation）是Java 5（JDK 1.5）及以后版本引入的一种特性，它用于为代码元素（如类、方法、字段等）提供元数据。注解本身不会改变程序的操作，但可以被编译器或运行时环境读取并据此执行特定操作。
本质：注解在Java中是一种特殊的接口，由@interface关键字定义。所有的注解都自动继承自java.lang.annotation.Annotation接口。注解内部定义的是一些元素（类似于接口中的抽象方法），这些元素在注解使用时需要被赋值。

2.作用

提供元数据：为代码元素提供额外的信息，这些信息可以被工具或框架在编译时、加载时或运行时读取。
编译时检查：通过自定义注解和注解处理器，可以在编译时检查代码是否符合特定规范，提前发现潜在问题。
框架支持：许多Java框架（如Spring、Hibernate）都大量使用注解来简化配置和代码编写。
文档生成：注解信息可以被用于生成API文档，提供关于代码元素的额外说明。

3.分类

Java语言本身并没有直接定义Annotation的严格分类，但可以根据Annotation的用途、成员变量、生命周期等因素来对其进行分类。

1. 根据成员变量的存在与否

标记型注解（Marker Annotation）：这种注解没有定义任何成员变量，它仅通过自身的存在与否来提供信息。例如，@Override注解就是一个标记型注解，它用于指示某个方法是重写父类中的方法。
元数据注解（Metadata Annotation）：这种注解包含了成员变量，可以接受更多的元数据。自定义的注解通常都属于这一类，它们可以包含多个成员变量，每个成员变量都有一个默认值或在使用注解时指定值。

2. 根据生命周期

Java通过@Retention元注解来指定注解的生命周期，即注解信息在何时保留。

SOURCE：注解信息仅保留在源代码中，编译器编译时直接丢弃这种注解。例如，@Override注解在编译后就不会保留在.class文件中。
CLASS：编译器将注解信息保留在.class文件中，但JVM在运行时不会保留这些信息。这是注解的默认行为。
RUNTIME：编译器将注解信息保留在.class文件中，并且JVM在运行时可以通过反射机制读取这些信息。这使得程序在运行时能够动态地处理注解。

3. 根据应用目标

Java通过@Target元注解来指定注解可以应用于哪些Java元素。

TYPE：类、接口（包括注解类型）或枚举声明。
FIELD：字段声明（包括枚举常量）。
METHOD：方法声明。
PARAMETER：参数声明。
CONSTRUCTOR：构造方法声明。
LOCAL_VARIABLE：局部变量声明。
ANNOTATION_TYPE：注解类型声明。
PACKAGE：包声明。

4. 特殊注解（元注解）

一些特殊的注解被称为元注解（Meta-Annotation），它们用于修饰其他注解。Java提供了四种元注解：

@Target：用于指定被修饰的注解能用于哪些Java元素。
@Retention：用于指定被修饰的注解的保留策略。
@Documented：用于指定被修饰的注解是否应该被javadoc或类似的工具文档化。
@Inherited：用于指定被修饰的注解是否自动被继承。

4.使用场景

使用

在 Java 中使用 Annotation 可以直接在被注解的程序元素上添加 @ 符号，后面跟上 Annotation 的名称和属性值。

标记过时功能：使用@Deprecated注解标记不再推荐使用的方法或类。
依赖注入：在Spring等框架中，使用注解（如@Autowired）实现依赖的自动注入。
权限控制：通过自定义注解实现方法或类的权限控制。
生成代码：利用注解处理器在编译时生成额外的源代码文件。
文档说明：为代码元素提供额外的文档说明信息，帮助其他开发者理解代码。

5.示例

MyAnnotation是一个自定义注解，它包含了一个名为value的成员变量，并指定了注解的保留策略为RUNTIME（即运行时保留），以及注解可以应用于方法和类。

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, ElementType.TYPE}) // 指定注解可以应用于方法和类  
public @interface MyAnnotation {  
    String value() default "default value"; // 定义一个成员变量，并指定默认值  
}

结束