【Java 基础篇】Java 注解详解

比眉伴天荒 2023-10-16 15:07 11阅读 0赞

![在这里插入图片描述][dee0d312218f41d1a6a2d21bcb08d1ed.png]

在 Java 编程中，注解（Annotation）是一种元数据，它提供了关于程序代码的额外信息。注解不直接影响程序的执行，但可以在运行时提供有关程序的信息，或者让编译器执行额外的检查。

本文将详细介绍 Java 注解的基本概念、内置注解和自定义注解的创建与使用。

### 1. 什么是注解？ ###

注解是一种标记在 Java 类、方法、字段和其他程序元素上的特殊标签。这些标签提供了有关元素的额外信息，通常以注解的方式存储在 Java 源代码中。注解通常不影响程序的运行，但可以在编译时、运行时或通过工具进行处理。

Java 注解以 `@` 符号开头，后跟注解的名称，如 `@Override`、`@Deprecated` 等。注解可以有元素，元素以键值对的形式存储信息。以下是一个简单的注解示例：

@Author(name = "John Doe", date = "2023-09-01")
    public class MyClass {
        
        // 类的内容
    }

在上面的示例中，`@Author` 是一个自定义注解，具有两个元素 `name` 和 `date`，它们存储了有关类 `MyClass` 的信息。

### 2. 内置注解 ###

Java 提供了一些内置注解，这些注解用于特殊的用途，如告诉编译器生成警告或错误，控制序列化过程等。以下是一些常见的内置注解：

#### 2.1 `@Override` ####

`@Override` 注解用于告诉编译器，希望重写（覆盖）父类中的方法。如果父类中不存在与该方法签名匹配的方法，编译器会产生一个错误。

@Override
    public void myMethod() {
        
        // 重写父类方法
    }

#### 2.2 `@Deprecated` ####

`@Deprecated` 注解用于标记方法、类或字段已过时，不推荐使用。编译器会发出警告，提示开发者尽量避免使用被标记为过时的元素。

@Deprecated
    public class OldClass {
        
        // 类的内容
    }

#### 2.3 `@SuppressWarnings` ####

`@SuppressWarnings` 注解用于告诉编译器忽略特定类型的警告。这对于处理旧代码或集成第三方库时非常有用。

@SuppressWarnings("unchecked")
    public List<String> getItems() {
        
        // 忽略类型未检查的警告
        return new ArrayList();
    }

#### 2.4 `@SafeVarargs` ####

`@SafeVarargs` 注解用于表示带有可变数量参数的方法是类型安全的。它告诉编译器，该方法不会导致堆污染警告。

@SafeVarargs
    public final <T> List<T> asList(T... a) {
        
        // 方法内容
    }

### 3. 自定义注解 ###

除了使用内置注解，Java 还允许我们创建自定义注解。自定义注解可以用来添加程序的元数据，或者用于特定的用途，例如测试框架、依赖注入等。要创建自定义注解，需要使用 `@interface` 关键字。

#### 3.1 创建自定义注解 ####

以下是创建自定义注解的基本步骤：

// 定义自定义注解
    public @interface MyAnnotation {
        
        String value() default "default value"; // 定义一个元素
        int number() default 0; // 定义另一个元素
    }

上面的代码创建了一个名为 `MyAnnotation` 的自定义注解，它具有两个元素 `value` 和 `number`，并分别设置了默认值。

#### 3.2 使用自定义注解 ####

一旦定义了自定义注解，就可以将其用于类、方法、字段等程序元素上。

@MyAnnotation(value = "Custom Value", number = 42)
    public class MyClass {
        
        // 类的内容
    }

在上面的示例中，我们在 `MyClass` 类上应用了自定义注解 `@MyAnnotation`，并指定了元素 `value` 和 `number` 的值。

#### 3.3 读取注解信息 ####

要读取注解信息，可以使用 Java 的反射机制。以下是一个读取自定义注解信息的示例：

Class<?> clazz = MyClass.class;
    MyAnnotation annotation = clazz.getAnnotation(MyAnnotation.class);
    
    if (annotation != null) {
        
        String value = annotation.value();
        int number = annotation.number();
        
        System.out.println("Value: " + value);
        System.out.println("Number: " + number);
    } else {
        
        System.out.println("MyAnnotation not found.");
    }

上面的代码首先获取了 `MyClass` 类的 `MyAnnotation` 注解，然后读取了注解的元素值，并打印出来。

### 4. 注解的元素 ###

注解的元素可以是基本数据类型、字符串、枚举类型、注解类型或以上类型的数组。元素的默认值使用 `default` 关键字指定。

下面是一些注解元素的示例：

public @interface MyAnnotation {
        
        int value() default 0;
        String name() default "John";
        Color color() default Color.RED;
        String[] tags() default {
        };
        Class<?>[] classes() default {
        };
        MyOtherAnnotation otherAnnotation() default @MyOtherAnnotation;
    }

### 5. 注解的使用场景 ###

Java 注解在实际开发中有多种用途，包括：

*  **代码分析工具**：可以使用注解来标记代码中的一些问题，如未使用的变量或方法，然后通过工具进行检查。
 *  **依赖注入**：许多依赖注入框架使用注解来标记需要注入的字段或方法。
 *  **测试框架**：测试框架如 JUnit 使用注解来标记测试方法。
 *  **持久性框架**：持久性框架如 Hibernate 使用注解来映射实体类与数据库表。
 *  **Web 开发**：在 Spring 框架中，注解用于配置和管理 Bean。

### 6. 注解的注意事项 ###

在使用注解时，需要注意以下几点：

*  注解本身不影响程序的运行，只提供了元数据。
 *  注解在编译时可以被处理，也可以在运行时被处理，具体取决于注解的类型和用途。
 *  自定义注解需要使用 `@Retention` 指定它的保留策略，通常是 `RUNTIME`，以便在运行时读取注解信息。
 *  注解的元素名称通常为 `value`，但可以自定义其他名称。
 *  注解的元素类型受限于一些基本数据类型、枚举类型、字符串、注解类型和以上类型的数组。

### 7. 案例总结 ###

假设我们正在开发一个简单的学生管理系统，我们想要为学生实体类添加一个自定义注解，用于标记优秀学生。首先，我们创建一个名为 `Student` 的学生类：

public class Student {
        
        private String name;
        private int age;
        private double gpa;
    
        // 构造方法和其他方法省略
    
        // 构造方法和其他方法省略
    
        public String getName() {
        
            return name;
        }
    
        public int getAge() {
        
            return age;
        }
    
        public double getGpa() {
        
            return gpa;
        }
    
        @Override
        public String toString() {
        
            return "Student{" +
                    "name='" + name + '\'' +
                    ", age=" + age +
                    ", gpa=" + gpa +
                    '}';
        }
    }

接下来，我们创建一个自定义注解 `@ExcellentStudent`，用于标记优秀学生：

import java.lang.annotation.ElementType;
    import java.lang.annotation.Retention;
    import java.lang.annotation.RetentionPolicy;
    import java.lang.annotation.Target;
    
    @Target(ElementType.TYPE) // 该注解可以用在类上
    @Retention(RetentionPolicy.RUNTIME) // 注解信息会保留到运行时
    public @interface ExcellentStudent {
        
    }

在上面的代码中，我们使用 `@Target` 和 `@Retention` 注解来指定了自定义注解的使用范围和保留策略。

现在，让我们在 `Student` 类上应用 `@ExcellentStudent` 注解：

@ExcellentStudent
    public class Student {
        
        private String name;
        private int age;
        private double gpa;
    
        // 构造方法和其他方法省略
    
        // 构造方法和其他方法省略
    
        public String getName() {
        
            return name;
        }
    
        public int getAge() {
        
            return age;
        }
    
        public double getGpa() {
        
            return gpa;
        }
    
        @Override
        public String toString() {
        
            return "Student{" +
                    "name='" + name + '\'' +
                    ", age=" + age +
                    ", gpa=" + gpa +
                    '}';
        }
    }

现在，我们已经在 `Student` 类上应用了 `@ExcellentStudent` 注解。接下来，我们可以使用反射来查找并识别优秀学生。以下是一个查找并打印优秀学生的示例：

import java.lang.annotation.Annotation;
    
    public class Main {
        
        public static void main(String[] args) {
        
            // 获取 Student 类的 Class 对象
            Class<?> clazz = Student.class;
    
            // 检查类上是否有 ExcellentStudent 注解
            if (clazz.isAnnotationPresent(ExcellentStudent.class)) {
        
                // 如果有，打印学生信息
                System.out.println("优秀学生信息：");
                Student student = new Student("Alice", 20, 4.0);
                System.out.println(student);
            } else {
        
                System.out.println("没有优秀学生信息。");
            }
        }
    }

在上面的示例中，我们使用 `clazz.isAnnotationPresent(ExcellentStudent.class)` 检查 `Student` 类上是否有 `@ExcellentStudent` 注解。如果有，我们就打印该学生的信息。

这个案例演示了如何创建自定义注解，将其应用于类，并使用反射来识别带有注解的类。注解在实际开发中可以用于各种场景，以提供程序元数据和实现不同的逻辑。

### 8. 总结 ###

本文介绍了 Java 注解的基本概念、内置注解和自定义注解的创建与使用。注解是一种有助于提供程序元数据的强大工具，它在各种 Java 应用程序中广泛使用，包括测试框架、依赖注入、持久性框架等。了解和熟练使用注解将有助于提高代码的可读性和可维护性，同时提供更多的元数据信息用于程序的分析和处理。

<table> 
 <tbody> 
  <tr> 
   <td> <strong><font>作者信息</font></strong><br> <br> <font> 作者 ： 繁依Fanyi</font><br> <font>CSDN：</font> <a href="https://blog.csdn.net/qq_21484461?spm=1000.2115.3001.5343" rel="nofollow"><font>https://techfanyi.blog.csdn.net</font></a><br> <font>掘金：</font><a href="https://juejin.cn/user/4154386571867191" rel="nofollow"><font>https://juejin.cn/user/4154386571867191</font></a> </td> 
  </tr> 
 </tbody> 
</table>

[dee0d312218f41d1a6a2d21bcb08d1ed.png]: https://img-blog.csdnimg.cn/dee0d312218f41d1a6a2d21bcb08d1ed.png