Java 注解

小巫编程室
137 阅读4分钟

Java注解又称Java标注，是在 JDK5 时引入的新特性，注解（也被称为元数据）。Java注解它提供了一种安全的类似注释的机制，用来将任何的信息或元数据（metadata）与程序元素（类、方法、成员变量等）进行关联。

在 Java 5 之前，开发者通常使用 XML 配置 或 标记接口 进行元数据管理。然而，这些方式存在以下问题：

  • XML 配置繁琐：对于 Spring、EJB、Struts 等框架来说，需要大量的 XML 进行配置，难以管理。
  • 标记接口局限性：如 Serializable 接口，只能用于类型检查，无法携带更多元信息。
  • 代码与元数据分离：导致可读性下降，不直观。

Java 注解 通过在代码中直接添加元数据，使编译器和运行时能够方便地解析，提高了可读性和开发效率。

快速实践

示例 1：自定义注解

import java.lang.annotation.*;

@Retention(RetentionPolicy.RUNTIME) // 运行时可用
@Target(ElementType.METHOD) // 作用于方法
public @interface MyAnnotation {
    String value() default "Default Value";
}

示例 2：应用自定义注解

public class Test {
    @MyAnnotation("Hello Annotation")
    public void annotatedMethod() {
        System.out.println("Method with annotation");
    }
}

Java注解详解

注解处理流程

  1. 编写注解：使用 @interface 定义自定义注解。
  2. 元注解配置：@Retention、@Target、@Documented 等。
  3. 编译时解析：Java 编译器或注解处理器解析注解。
  4. 运行时处理：使用反射机制动态读取和处理注解。

核心类与派生关系

  • java.lang.annotation.Annotation：所有注解的基类。
  • java.lang.reflect.AnnotatedElement：用于反射获取注解。
  • javax.annotation.processing：注解处理器（APT，Annotation Processing Tool）。

内置的注解

Java 定义了一套注解，共有 7 个，3 个在 java.lang 中，剩下 4 个在 java.lang.annotation 中。

# 作用在代码的注解

 @Override         - 检查该方法是否是重写方法。如果发现其父类，或者是引用的接口中并没有该方法时，会报编译错误。
 @Deprecated       - 标记过时方法。如果使用该方法，会报编译警告。
 @SuppressWarnings - 指示编译器去忽略注解中声明的警告。
   Unused :     变量位被使用
     Deprecation：使用了不赞成使用的类或方法时的警告
     Unchecked：  执行了未检测的转换时的警告，比如没有使用泛型
     Falthrough： 当switch程序块直接通往下一个情况而没有break时候的警告
     Path：       在类路径，源文件路径等中有不存在的路径时的警告
     Serial：     单在可序列化类尚缺少serialVersionID定义时警告
     Finnally：   任何finnally子句不能正常完成时的警告
     All：        关于以上所有的警告。

# 作用在其他注解的注解(或者说 元注解)

 @Retention     - 标识这个注解怎么保存，是只在代码中，还是编入class文件中，或者是在运行时可以通过反射访问。
   RetentionPolicy.SOURCE:  注解保存在于源文件中
     RetentionPolicy.ClASS:   注解保存在于源字节码中
     RetentionPolicy.RUNTIME: 注解存在于运行时
     
 @Documented    - 标记这些注解是否包含在用户文档中。
 @Target        - 标记这个注解应该是哪种 Java 成员。
 @Inherited     - 标记这个注解是继承于哪个注解类(默认 注解并没有继承于任何子类)

# 从 Java 7 开始额外添加了 3 个注解

 @SafeVarargs         - Java 7 开始支持，忽略任何使用参数为泛型变量的方法或构造函数调用产生的警告。
 @FunctionalInterface - Java 8 开始支持，标识一个匿名函数或函数式接口。
 @Repeatable          - Java 8 开始支持，标识某注解可以在同一个声明上使用多次。
 

自定义注解的语法

特别注意：注解的属性的类型只能是：基本类型，String，Class，枚举，注解类型以及以上类型的数组。

# 注解本身

 public @interface MyAnnotation{
     String name();
 }

# 使用关键字@interface 定义一个类而已，这个类就是注解。

 基本形式： 类型  属性名称();
 
  比如： String name();
  注解属性的默认值：
  类型  属性名称() default 默认值；

反射获取注解信息

# **反射获取注解信息**

 1. 获取类的字节码
 Class clazz = Demo.class
 2. 反射其中的成员
 Method [] methods =clazz.getMethods(); 获取所有的公有方法
 3. 查看那个方法上有注解
 Methods.isAnnotationPresent(MyAnnotation.class);
 4. 获取注解属性
 MyAnnotation my =Methods.getAnnotatetion(MyAnnotation.class);
 My.Name();  获取注解的属性
 5. Methods.invoke(clazz.newInstance(),null);

总结

Java 注解的作用和解决的问题

  • 提升代码可读性：将元数据直接与代码关联。
  • 减少 XML 配置：减少繁琐的外部配置文件。
  • 增强类型安全性：避免因 XML 配置出错导致的运行时错误。
  • 支持编译时检查：如 @Override 避免误写方法名。

应用场景

  • 编译时检查：@Override、@Deprecated。
  • 运行时元数据：Spring 注解（@Service、@Autowired）。
  • 代码生成：Lombok @Getter、@Setter。
  • AOP（面向切面编程） ：如 Spring AOP @Transactional。

本文使用 markdown.com.cn 排版

avatar
文章
阅读
粉丝