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

Java --- 注解（Annotation）

article 2025/3/11 6:15:35

一.什么是注解？

在Java中，注解（Annotation）是一种元数据（metadata），它为程序中的类、方法、字段等提供额外的描述信息。注解本身不直接改变程序的行为，但可以被编译器、开发工具、框架（如Spring、Hibernate等）以及运行时反射机制使用，从而影响程序的执行或者辅助生成代码、验证等操作。

注解在Java中被广泛用于：

编译时的代码检查
代码生成
配置元数据
框架驱动的行为（例如，Spring中使用的注解）

二.注解的组成与使用：

Java中的注解通常由@符号开始，可以附加到类、方法、字段、参数、构造器等元素上。注解可以包含元素（属性），这些元素可以具有默认值。例如下面代码：

public @interface MyAnnotation {
    String value() default "default value";  // 元素，带默认值
    int count() default 0;                   // 另一个元素，带默认值
}

1.定义注解：

注解的元素类似于接口的方法，不能有方法体，且可以指定默认值。

public @interface 注解名 {
    // 元素（即注解的属性）
    类型 元素名() default 默认值;  // 默认值可选
}

2.使用注解：

（1）自定义一个注解：

// 定义一个注解
public @interface MyAnnotation {
    String value() default "Hello, Annotation!";  // 一个带默认值的元素
}

（2）使用注解：

@MyAnnotation(value = "Custom Value")  // 为注解指定参数
public class MyClass {
    public void myMethod() {
        System.out.println("Method with annotation.");
    }
}

（3）使用反射读取注解：

使用反射可以在运行时读取注解，示例代码如下：

import java.lang.annotation.Annotation;
import java.lang.reflect.Method;

public class AnnotationExample {
    public static void main(String[] args) throws Exception {
        Class<MyClass> clazz = MyClass.class;
        Method method = clazz.getMethod("myMethod");

        // 判断方法是否有 @MyAnnotation 注解
        if (method.isAnnotationPresent(MyAnnotation.class)) {
            // 获取注解对象
            MyAnnotation myAnnotation = method.getAnnotation(MyAnnotation.class);
            System.out.println("Annotation value: " + myAnnotation.value()); // Annotation value: Custom Value
        }
    }
}

三.常见的内置注解：

Java 提供了一些常用的内置注解，用于指定类、方法或字段的特殊含义。最常见的内置注解包括：

@Override：用于标记一个方法是重写父类的方法。
@Deprecated：标记一个方法或类是过时的，提示开发者不要再使用它。
@SuppressWarnings：用于抑制编译器的警告。
@FunctionalInterface：标记一个接口是函数式接口（即只有一个抽象方法的接口）。

四.元注解：

Java还提供了元注解（用于注解其他注解）来定义注解的行为。这些元注解包括：

@Retention：指定注解的生命周期（源代码、编译期、运行期）。
@Target：指定注解可以应用的地方（类、方法、字段、参数等）。
@Documented：指示将此注解包含在Javadoc中。
@Inherited：指示子类可以继承父类的注解。

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

// RetentionPolicy.RUNTIME 表示该注解在运行时可用
@Retention(RetentionPolicy.RUNTIME)
// Target指定注解只能用于方法
@Target(ElementType.METHOD)
public @interface MyRuntimeAnnotation {
    String value();
}

注解的生命周期由@Retention元注解决定，Java提供了以下几种不同的生命周期：

RetentionPolicy.SOURCE：注解仅存在于源代码中，编译后会被丢弃。
RetentionPolicy.CLASS：注解会保留到编译后的.class文件中，但JVM在运行时忽略它。
RetentionPolicy.RUNTIME：注解会保留到运行时，并可以通过反射读取。

有关使用注解进行开发请见下面文章：AOP面向切面编程的代码实现_aop切面编程代码-CSDN博客

查看全文

http://www.kler.cn/a/427443.html