Java学习十六—掌握注解：让编程更简单

一、关于注解

1.1 简介

Java 注解（Annotation）是一种特殊的语法结构，可以在代码中嵌入元数据。它们不直接影响代码的运行，但可以通过工具和框架提供额外的信息，帮助在编译、部署或运行时进行处理。

​

初学者可以这样理解注解：想像代码具有生命，注解就是对于代码中某些鲜活个体的贴上去的一张标签。简化来讲，注解如同一张标签。

‍

1.2 发展

Java注解的发展可以追溯到Java 5.0的发布，引入了注解这一特性，为开发者提供了一种新的元数据形式，允许在代码中添加类型信息而不改变程序的逻辑。以下是Java注解发展的一些关键里程碑：

1. Java 5.0 (2004) : 引入了注解的概念，包括@Override​, @Deprecated​, @SuppressWarnings​等内置注解。
2. Java 6.0 (2006) : 增加了对注解的元注解支持，例如@Retention​, @Target​, @Documented​，这些元注解可以用来定义其他注解的元数据。
3. Java 7.0 (2011) : 引入了@SafeVarargs​和@FunctionalInterface​注解，用于提供关于可变参数和函数式接口的编译时检查。
4. Java 8.0 (2014) : 引入了@Repeatable​注解，允许在一个元素上使用同一个注解类型多次。同时，Java 8也是Spring框架开始广泛使用注解的时期，例如@Autowired​, @RestController​等。
5. Java 11.0 (2018) : 在这个版本中，Java模块系统（Jigsaw项目）正式成为Java的一部分，引入了@Module​, @Requires​, @Exports​等模块相关的注解。
6. Spring框架的发展: 从Spring 1.x的@Transactional​和@ManagedResource​开始，Spring框架逐渐引入了更多的注解来简化配置和提高开发效率。到了Spring 3.x，引入了@Configuration​, @ComponentScan​, @EnableAutoConfiguration​等注解，进一步推动了注解编程的普及。
7. Spring 4.x (2013) : 引入了@Conditional​注解，允许基于条件创建Bean，这是Spring Boot中自动配置的核心。
8. Spring 5.x (2017) : 引入了@Indexed​注解，用于提高注解驱动的组件扫描性能。

Java注解的发展不仅提高了代码的可读性和可维护性，也为框架和库的开发者提供了强大的工具，使得他们能够创建更加灵活和强大的API。随着Java语言和相关框架的不断进步，注解将继续在软件开发中扮演重要角色。

‍

1.3 特点

Java注解是一种强大的工具，它使得代码更加清晰、模块化，并且可以与编译器、开发工具和运行时环境紧密协作，提高开发效率和代码质量。

‍

优点

1. 增强代码可读性

   • 注解提供了清晰的元数据，使代码更易于理解，特别是在使用框架时，可以减少对 XML 配置的依赖。

2. 减少样板代码

   • 使用注解可以减少大量的样板代码，简化配置。例如，在 Spring 框架中，可以通过注解来代替繁琐的 XML 配置。

3. 编译时检查

   • 通过注解处理器，可以在编译时检查注解的使用，帮助开发者及早发现问题，提升代码质量。

4. 灵活性

   • 注解可以与各种编程范式结合使用，如面向对象编程、面向切面编程等，为开发者提供了灵活的编程方式。

5. 支持元编程

   • 注解与反射机制结合，可以在运行时动态地处理元数据，适用于许多框架和库的设计，如 ORM 和依赖注入。

6. 自定义能力

   • 开发者可以根据需要创建自定义注解，灵活地定义元数据，满足特定的需求。

‍

缺点

1. 性能开销

   • 使用反射机制读取注解可能会带来性能开销，尤其是在大规模应用中，频繁的反射调用会影响运行效率。

2. 调试困难

   • 注解的使用可能使得调试过程变得复杂，尤其是在错误信息中不明确标识出注解的影响，可能导致追踪问题时的困惑。

3. 学习曲线

   • 对于初学者而言，理解注解及其用法可能需要一定的学习成本，特别是在注解与反射结合使用时。

4. 过度使用

   • 过度使用注解可能导致代码难以维护和理解，尤其是当多个注解叠加在同一元素上时，可能使得逻辑变得复杂。

5. 编译器支持

   • 并非所有的 IDE 和工具都完全支持注解的编写和使用，可能会导致一些兼容性问题。

6. 不适用于所有场景

   • 在一些简单的场景中，使用注解可能显得过于复杂，反而增加了开发和维护的成本。

‍

1.4 使用场景

Java 注解在很多场景下都有应用，例如：

• 代码分析工具：例如使用 @Deprecated​ 标记方法过时，帮助开发者识别风险和改进代码。
• 编译时处理：例如通过自定义注解，在编译时生成辅助代码，如 Lombok 库。
• 运行时处理：通过反射机制，可以在运行时获取和处理注解信息，实现动态的行为。

‍

‍

二、基本语法

Java 注解的语法主要包括定义注解、使用注解以及元注解。以下是具体的语法示例和解释：

2.1 定义注解

使用 @interface​ 关键字定义一个注解。可以定义元素（属性）和默认值。

public @interface MyAnnotation {
    // 定义一个字符串类型的元素，带有默认值
    String value() default "default value";

    // 定义一个整型元素，带有默认值
    int count() default 0;
}

‍

2.2 注解的元注解

元注解是用来注解其他注解的注解。Java 提供了以下元注解：

• @Retention：定义注解的生命周期。
• @Target：定义注解可以应用于哪些 Java 元素（类、方法、字段等）。
• @Documented：表示该注解应该被 javadoc 工具记录。
• @Inherited：表示该注解可以被子类继承。

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) // 注解可以用于方法
public @interface MyMethodAnnotation {
    String description();
}

‍

2.3 使用注解

使用自定义注解时，直接在需要的元素上加上注解即可。

public class MyClass {

    @MyMethodAnnotation(description = "This is a custom method annotation")
    public void myAnnotatedMethod() {
        // 方法实现
    }
}

‍

2.4 访问注解

使用反射机制在运行时访问注解信息。

import java.lang.reflect.Method;

public class AnnotationExample {
    public static void main(String[] args) throws Exception {
        Method method = MyClass.class.getMethod("myAnnotatedMethod");

        if (method.isAnnotationPresent(MyMethodAnnotation.class)) {
            MyMethodAnnotation annotation = method.getAnnotation(MyMethodAnnotation.class);
            System.out.println("Description: " + annotation.description());
        }
    }
}

‍

2.5 组合注解

可以将多个注解组合在一起使用。

@MyAnnotation
@AnotherAnnotation
public class AnotherClass {
    // 类实现
}

‍

‍

三、Java 预置的注解

Java 提供了一些预置的注解，这些注解在 Java 开发中非常常用。以下是一些主要的预置注解及其用途：

1. @Override​

• 用途：用于指示一个方法重写了超类的方法。

• 示例：

  @Override
  public String toString() {
      return "This is my object";
  }
  

2. @Deprecated​

• 用途：标记一个元素（类、方法或字段）为不推荐使用，可能在将来的版本中被删除。

• 示例：

  @Deprecated
  public void oldMethod() {
      // 不推荐使用
  }
  

3. @SuppressWarnings​

• 用途：抑制编译器发出的特定警告。可以指定警告类型，如未使用的变量、未检查的转换等。

• 示例：

  @SuppressWarnings("unchecked")
  public void myMethod() {
      List list = new ArrayList(); // 编译器可能会发出未检查的转换警告
  }
  

4. @FunctionalInterface​

• 用途：用于指示一个接口是函数式接口，即该接口只包含一个抽象方法。

• 示例：

  @FunctionalInterface
  public interface MyFunctionalInterface {
      void execute();
  }
  

5. @SafeVarargs​

• 用途：用于指示可变参数方法是类型安全的，适用于不可变的泛型。

• 示例：

  @SafeVarargs
  public static <T> void safeMethod(T... elements) {
      // 处理元素
  }
  

6. @Native​

• 用途：标记一个字段为本地常量，通常用于与 C/C++ 代码交互。

• 示例：

  @Native
  public static final int NATIVE_CONSTANT = 100;
  

‍

‍

四、示例

示例1—使用注解（标记过时的方法）

在 Java 中，使用 @Deprecated​ 注解可以标记一个方法或类已经过时，鼓励开发者使用新的实现或方法。

class DeprecatedExample {

    @Deprecated
    public void oldMethod() {
        System.out.println("This method is deprecated.");
    }

    public void newMethod() {
        System.out.println("This is the new method.");
    }

    public static void main(String[] args) {
        DeprecatedExample obj = new DeprecatedExample();

        // 调用过时的方法
        obj.oldMethod();

        // 调用新方法
        obj.newMethod();
    }
}

在这个示例中，oldMethod​ 被标记为过时的，当我们调用它时会得到编译器警告，提醒我们不要继续使用这个方法。

​

‍

‍

示例2—自定义注解

1.定义注解

‍

​

‍

‍

​

//自定义注解必须的元注解target，指明注解的作用域（此处指明的是在类和方法上起作用）
@Target({ElementType.TYPE, ElementType.METHOD})
//元注解retention声明该注解在何时起作用（此处指明的是在运行时起作用）
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {

    //注解中需声明参数，格式为：参数类型 + 参数名();
    String value() default "";

}

‍

2.使用注解

​

public class CustomAnnotation {

    @MyAnnotation(value = "这是一个测试方法")
    public void test() {
        System.out.println("执行 test 方法");
    }

}

‍

3.获取和使用注解信息

​

‍

public class AnnotationDemo {

    public static void main(String[] args) {

        try {
            // 获取 CustomAnnotation 类的 Class 对象
            Class<CustomAnnotation> clazz = CustomAnnotation.class;

            // 获取 test 方法
            Method method = clazz.getMethod("test");

            // 检查该方法是否有 MyAnnotation 注解
            if (method.isAnnotationPresent(MyAnnotation.class)) {
                // 获取 MyAnnotation 注解
                MyAnnotation annotation = method.getAnnotation(MyAnnotation.class);
                // 打印注解的 value 值
                System.out.println("注解的值: " + annotation.value());
            }

            // 调用 test 方法
            CustomAnnotation customAnnotation = new CustomAnnotation();
            customAnnotation.test();

        } catch (NoSuchMethodException e) {
            throw new RuntimeException(e);
        }

    }
}

‍