Java 注解

最新推荐文章于 2025-06-15 16:27:08 发布

今天你慧了码码码码码码码码码码

最新推荐文章于 2025-06-15 16:27:08 发布

阅读量524

点赞数 24

分类专栏： JavaSE基础文章标签： java 开发语言

本文链接：https://blog.youkuaiyun.com/weixin_73042028/article/details/145928531

版权

JavaSE基础专栏收录该内容

42 篇文章

订阅专栏

Java 注解

引言

Java 注解（Annotation）是 Java 5 引入的一种元数据机制，它允许开发者将额外的信息嵌入到源代码中。通过注解，我们可以在不改变代码逻辑的情况下，为类、方法、字段等元素添加标记或说明。本文将详细介绍 Java 注解的基本概念、作用、内置注解、自定义注解以及如何处理注解。

1. 什么是注解？

Java 注解是一种特殊的语法元数据，它可以被添加到 Java 代码中的类、方法、字段、参数和包等元素上。注解本身不会影响代码的执行，但它可以通过反射机制在运行时被读取和处理。

注解的作用类似于标签，它可以为代码添加额外的信息或标记。例如，@Override 注解用于标记子类中重写父类的方法，编译器会检查该方法是否正确重写了父类的方法。

2. 注解的作用

注解的主要作用是为代码提供元数据，这些元数据可以用于编译时检查、运行时处理、生成文档等。Java 提供了一些内置注解，开发者也可以自定义注解来满足特定的需求。

2.1 内置注解

Java 提供了一套内置注解，主要分为两类：

2.1.1 用于代码的注解

@Override：检查该方法是否正确地重写了父类的方法。如果重写错误，会报编译错误。
@Deprecated：标记过时的方法或类。如果使用该方法或类，会报编译警告。
@SuppressWarnings：指示编译器忽略注解中声明的警告。
@SafeVarargs：Java 7 引入，用于忽略使用泛型参数的方法或构造函数调用产生的警告。
@FunctionalInterface：Java 8 引入，用于标记函数式接口。

2.1.2 用于其他注解的注解（元注解）

元注解用于修饰其他注解，常见的元注解有：

@Retention：指定注解的生命周期（源码、类文件、运行时）。
@Documented：标记注解是否包含在 Javadoc 中。
@Target：指定注解可以应用的目标元素（类、方法、字段等）。
@Inherited：标记注解是否可以被继承。
@Repeatable：Java 8 引入，标记注解是否可以在同一个声明上重复使用。

2.2 注解的分类

根据注解的生命周期，Java 注解可以分为三类：

源码级别的注解：只在源码阶段保留，编译时会被丢弃，如 @Override。
类文件级别的注解：被保留到编译阶段，但不会被加载到 JVM 中。
运行时级别的注解：在程序运行时仍然存在，可以通过反射读取，如 @Retention(RetentionPolicy.RUNTIME)。

3. 自定义注解

自定义注解是 Java 注解的核心内容之一。通过自定义注解，开发者可以为代码添加特定的标记或元数据。自定义注解的步骤通常包括创建注解、定义注解参数、使用元注解配置注解。

3.1 创建注解

注解通过 @interface 关键字定义。例如，定义一个用于检查字符串长度的注解 @Length：

public @interface Length {
}

3.2 定义注解参数

注解可以包含参数，参数的类型可以是基本数据类型、String、枚举、Class、注解或它们的数组。例如，为 @Length 注解添加 min、max 和 message 参数：

public @interface Length {
    int min() default 0;
    int max() default Integer.MAX_VALUE;
    String message() default "长度不合法";
}

3.3 使用元注解配置注解

元注解用于配置自定义注解的行为。例如，使用 @Retention 指定注解的生命周期，使用 @Target 指定注解可以应用的目标元素：

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.FIELD)
public @interface Length {
    int min() default 0;
    int max() default Integer.MAX_VALUE;
    String message() default "长度不合法";
}

4. 处理注解

定义注解后，通常需要通过反射机制来处理注解。例如，检查字段的长度是否符合注解中定义的限制。

4.1 通过反射读取注解

通过反射 API，可以判断某个注解是否存在于类、字段、方法或构造器上，并获取注解的具体内容。例如，读取 @Length 注解的参数：

import java.lang.reflect.Field;

public class Student {

    @Length(min = 2, max = 5, message = "昵称的长度必须在2~5之间")
    private String nickname;

    public static void main(String[] args) throws NoSuchFieldException {
        Field field = Student.class.getDeclaredField("nickname");
        if (field.isAnnotationPresent(Length.class)) {
            Length annotation = field.getAnnotation(Length.class);
            System.out.println("min=" + annotation.min());
            System.out.println("max=" + annotation.max());
            System.out.println("message=" + annotation.message());
        }
    }
}

4.2 编写校验方法

通过反射获取注解后，可以编写校验方法来检查字段是否符合注解中定义的限制。例如，检查 nickname 字段的长度：

import java.lang.reflect.Field;

public class Student {

    @Length(min = 2, max = 5, message = "昵称的长度必须在2~5之间")
    private String nickname;

    public void checkFieldLength() throws IllegalAccessException {
        for (Field field : this.getClass().getDeclaredFields()) {
            if (field.isAnnotationPresent(Length.class)) {
                Length annotation = field.getAnnotation(Length.class);
                field.setAccessible(true);
                String value = (String) field.get(this);
                if (value.length() < annotation.min() || value.length() > annotation.max()) {
                    throw new IllegalArgumentException(field.getName() + ":" + annotation.message());
                }
            }
        }
    }

    public static void main(String[] args) throws IllegalAccessException {
        Student student = new Student();
        student.nickname = "小";
        student.checkFieldLength();
    }
}