Java注解详解和自定义注解

最新推荐文章于 2024-08-08 08:30:00 发布

爱修复bug的同志

最新推荐文章于 2024-08-08 08:30:00 发布

阅读量422

点赞数

分类专栏：笔记文章标签： java

本文链接：https://blog.csdn.net/weixin_46145858/article/details/126727113

版权

笔记专栏收录该内容

1 篇文章 0 订阅

订阅专栏

本文详细介绍了Java注解的定义、作用、内置注解和元注解，以及如何自定义注解和通过反射获取注解信息。注解用于在编译时或运行时进行代码处理，如在Spring中实现配置管理，或者在编译时进行格式检查。@Deprecated、@Override、@SuppressWarnings等是常见的JDK内置注解。自定义注解时，可以指定其作用范围、生命周期等。通过反射，可以在运行时获取注解信息并进行相应处理。

摘要由CSDN通过智能技术生成

1 注解

注解的定义**

注解（Annotation），也叫元数据。一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性，与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面，用来对这些元素进行说明，注释。概念描述：JDK1.5之后的新特性说明程序的使用注解：@注解名称
Annotion(注解)是一个接口，程序可以通过反射来获取指定程序元素的Annotion对象，然后通过Annotion对象来获取注解里面的元数据。

注解出现的位置

Java代码中的包、类型、构造方法、方法、成员变量、参数、本地变量的声明都可以用注解来修饰。注解本质上可以看作是一种特殊的标记，程序在编译或者运行时可以检测到这些标记而进行一些特殊的处理。
注解的处理
利用反射来处理注解的方式称之为运行时注解。另外一种是编译时注解，例如我们经常使用的lombok里面的注解，@Data，它能够帮我们省略set/get方法，我们在Class上加上这个注解后，在编译的时候，lombok其实是修改了.class文件的，将set/get方法放进去了，不然的话，你可以看看编译完后的.class文件。诸如这种，我们常称为编译时注解，也就是使用javac处理注解。

注解的目的和作用

生成文档跟踪代码依赖性，实现替代配置文件的功能，如spring 中 bean的装载过程。
在编译期间进行格式检查，如@override 放到方法面前。如果你这个方法并不是覆盖了超类方法，则编译时就能检查出。
标识作用，当java编译时或运行时，检测到这里的注解，做什么处理，自定义注解一般如此。

2 JDK内置注解

Java中内置的注解有5类，具体包括：

@Deprecated：过时注解，用于标记已过时 & 被抛弃的元素（类、方法等）
@Override：复写注解，用于标记该方法需要被子类复写
@SuppressWarnings：阻止警告注解，用于标记的元素会阻止编译器发出警告提醒
@SafeVarargs：参数安全类型注解，用于提醒开发者不要用参数做不安全的操作 & 阻止编译器产生 unchecked警告，Java
1.7 后引入

3 元注解

@Target
对于定义的注解的添加一个解释说明
在 @Target 注解中指定的每一个 ElementType 就是一个约束，它告诉编译器，这个自定义的注解只能用于指定的类型。

说明了注解所修饰的对象范围：注解可被用于 packages、（类、接口、枚举、Annotation类型）、类型成员（方法、构造方法、成员变量、枚举值）、方法参数和本地变量。

@Target({ElementType.METHOD,ElementType.TYPE})  // 标识当前注解只能放在类和方法上
ElementType.TYPE：能修饰类、接口或枚举类型(理解为对象引用类型，所以叫Type)
ElementType.FIELD：能修饰成员变量(属性)
ElementType.METHOD：能修饰方法
ElementType.PARAMETER：能修饰参数
ElementType.CONSTRUCTOR：能修饰构造器
ElementType.LOCAL_VARIABLE：能修饰局部变量
ElementType.ANNOTATION_TYPE：能修饰注解（annotaion 类型）
ElementType.PACKAGE：能修饰包

@Retention

定义了该注解的生命周期即当前表示的注解在（源码、编译、运行）那个范围起作用，且只有一个值。

public enum RetentionPolicy {
  /**
     * 注解只在源代码中存在，编译成class之后，就没了。@Override 就是这种注解。
     */
    SOURCE,
    /**
     * 注解在java文件编程成.class文件后，依然存在，但是运行起来后就没了。
     * @Retention的默认值，没有指定@Retention的value值的时候，就会是这种类型。
     */
    CLASS,
    /**
     * 注解在运行起来之后依然存在，可以通过反射获取这些信息
     */
    RUNTIME

@Documented

用于描述其它类型的annotation应该被作为被标注的程序成员的公共API，因此可以被例如 javadoc此类的工具文档化。是一个标记注解，没有成员。
@Inherited
是一个标记注解阐述了某个被标注的类型是被继承的。使用了@Inherited修饰的注解类型被用于一个class时该class的子类也有了该注解。
@Repeatable
允许一个注解可以被使用一次或者多次（Java 8）。

4 自定义注解

定义注解

import java.lang.annotation.*;
@Documented
@Retention(RetentionPolicy.RUNTIME) // 运行时生效
@Target(ElementType.FIELD) // 生效范围
public @interface MyAnnotation {
    String name() default "defaultName";
    String value() default "defaultValue";
}

注解成员变量

成员以无参数无异常的方式声明 String constructorName() default “”;

可以使用default为成员指定一个默认值 public String name() default “defaultName”;

成员类型是受限的，合法的类型包括原始类型以及String、Class、Annotation、Enumeration （JAVA的基本数据类型有8种：byte(字节)、short(短整型)、int(整数型)、long(长整型)、float(单精度浮点数类型)、double(双精度浮点数类型)、char(字符类型)、boolean(布尔类型）

注解类可以没有成员，没有成员的注解称为标识注解，例如JDK注解中的@Override、@Deprecation

如果注解只有一个成员，并且把成员取名为value()，则在使用时可以忽略成员名和赋值号“=”

使用注解

public class Student {

    public String name;

    @MyAnnotation(name = "年龄",value = " This is a age")
    public String age;
}

利用反射获取注解

了解Class对象：

类是程序的一部分，每个类都有一个 Class 对象。换言之，每当我们编写并且编译了一个新类，就会产生一个 Class 对象（更恰当的说，是被保存在一个同名的 .class 文件中）。为了生成这个类的对象，Java 虚拟机 (JVM) 先会调用 “类加载器” 子系统把这个类加载到内存中。

Class类：简单说就是用来描述类对象的信息的

类对象的信息包括：

类的基本信息：包名、修饰符、类名、基类，实现的接口

属性的信息：修饰符、属性类型、属性名称、属性值，

方法信息：修饰符、返回类型、方法名称、参数列表、抛出的异常

构造方法的信息：修饰符、类名、参数列表、抛出的异常

注解的相关信息：

因为：类对象的相关信息全部保存在Class类

所以：Class类会提供获取这些信息的方法

一旦某个类的 Class 对象被载入内存，它就可以用来创建这个类的所有对象。

通过 Class 获取类的相关信息，通过Class创建对象，通过 Class 调用对象上面的属性，调用对象上面的方法，这种操作就称为反射，要想执行反射操作，必须先要获取到指定的类名的 Class

获取Class的不同方式

获取基本类型的Class

基本类型Class：如 int.Class获取的就是 int 类型的 Class

获取引用类型的Class：

1）引用类型的Class：如String.Class获取的就是String类对应的Class

2）通过对象来获取：如：String obj=“hello”，Class calz = obj.getClass()，获取的就是String类对应的Class

3）Class.forName(“java.lang.String”)，获取的就是对应的Class

提取注解

import java.lang.annotation.Annotation;
import java.lang.reflect.Field;
public class TestAnnotation {
    public static void main(String []args){
        Student student = new Student();
        Class<?> studentClass = student.getClass();
        Field[] fields = studentClass.getDeclaredFields();
        // 获取成员变量上的注解
        for (Field field : fields) {
            if (field.isAnnotationPresent(MyAnnotation.class)){
                MyAnnotation annotation = field.getAnnotation(MyAnnotation.class);
                System.out.println(annotation.name());
                System.out.println(annotation.value());
                // 反射设置字段值
                field.set(student,"age:18");
            }
        }
        String age = student.getAge();
        System.out.println(age);
    }
}