Java注解详解及应用-优快云博客

本文链接：https://blog.youkuaiyun.com/qq_38350635/article/details/124198568

在这里插入图片描述

简介

注解Annotation，可以理解为java代码的一个标签，这个标签为被标记的代码提供一些数据。

java的哪些东西可以被贴上标签？

包
类
接口
方法
字段
变量
方法参数
等等

Java内置的注解

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

1、三个常见的注解

@Override ：检查该方法是否是重写方法。如果发现其父类，或者是引用的接口中并没有该方法时，会报编译错误。
@Deprecated ：标记过时方法。如果使用该方法，会报编译警告。
@SuppressWarnings ：指示编译器去忽略注解中声明的警告。

2、四个元注解

这四个注解一般作用于自定义的注解类上，注解自定义注解的注解故称为元注解。如下，一般前两个常用，后两个用的较少。

@Retention - 标识这个注解怎么保存，是只存在在代码中，还是编入class文件中，或者是在运行时也存在。
@Target - 标记这个注解应该作用的对象（字段、方法、类、包、方法参数等）。
@Inherited - 标记这个注解是继承于哪个注解类(默认注解并没有继承于任何子类)
@Documented - 标记这些注解是否包含在用户文档中。

//@Retention的值可以为下列枚举值

public enum RetentionPolicy {

/* 
    注解只保留在源文件中，当 Java 文件被编译成 class 文件的时候，注解被丢弃。
    常用于做一些检查性的操作，比如 @Override、@SuppressWarnings 。  
*/
    SOURCE,            
/*  
  注解被保留在 class 文件，但 JVM 加载 class 文件时被遗弃，这是默认的生命周期。
  未进行元注解时默认@Retention为CLASS。常用于在编译时进行一些预处理，比如生成一些辅助代码，例如安卓ButterKnife框架。
*/
    CLASS,   
              
/**
   注解不仅被保存到 class 文件中，JVM 加载 class 文件之后，仍然存在。常用于在运行时动态获取注解信息，一般会与反射一起使用。
*/
    RUNTIME 
}

//@Target的值可以为下列枚举值

public enum ElementType {
    TYPE,               /* 类、接口（包括注释类型）或枚举声明  */

    FIELD,              /* 字段声明（包括枚举常量）  */

    METHOD,             /* 方法声明  */

    PARAMETER,          /* 参数声明  */

    CONSTRUCTOR,        /* 构造方法声明  */

    LOCAL_VARIABLE,     /* 局部变量声明  */

    ANNOTATION_TYPE,    /* 注释类型声明  */

    PACKAGE             /* 包声明  */
}

3、从java7开始新增的注解

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

注解的作用

1、编译检查

Annotation 具有"让编译器进行编译检查的作用"。例如，@SuppressWarnings, @Deprecated 和 @Override 都具有编译检查作用。

2、提供信息

注解可以为标记的对象提供信息。要想获取信息就涉及到注解的处理了。注解的处理主要有两种手段。编译期注解的处理使用APT也即注解处理器，运行期注解的处理使用反射。

自定义&注解的处理

这里就简单的自定义一个注解，并且以反射处理下注解。至于注解的编译时处理可以参考下APT~

1、定义注解

/**
 * Create by SunnyDay on 2022/04/15 17:08
 * 定义个处理字段的注解
 * 1、注解作用期间为运行时，这样反射可以处理。
 * 2、注解作用的对象为字段。
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface FieldInject {
    int value();// 注解的参数 int类型的值。
}

2、处理注解


/**
 * Create by SunnyDay on 2022/04/15 17:45
 */
public class FieldInjectUtil {
    /**
     * 处理注解，吧注解信息设置给相应的字段。
     * ps:这里有个弊端，类的字段使用了@FieldInject注解后，此类所有对象的这个字段值相同，除非后续手动更改。
     */
    public static <T> void inject(T t) {
        if (t == null) return;
        Class cl = t.getClass();
        Field[] arr = cl.getDeclaredFields();
        if (arr == null || arr.length <= 0) return;
        for (Field field : arr) {
            try {
                // 1、获取字段上的注解对象
                FieldInject fieldInject = field.getAnnotation(FieldInject.class);
                // 暴力反射
                field.setAccessible(true);
                // 2、把注解信息设置给相应的对象
                field.set(t, fieldInject.value());
            } catch (IllegalAccessException e) {
                e.printStackTrace();
            }
        }
    }
}

4、测试下

/**
 * Create by SunnyDay on 2022/04/15 17:38
 */
public class User {
    @FieldInject(18)
    private int age;
    @FieldInject(20)
    private int number;
    @FieldInject(22)
    private int total;

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public int getNumber() {
        return number;
    }

    public void setNumber(int number) {
        this.number = number;
    }

    public int getTotal() {
        return total;
    }

    public void setTotal(int total) {
        this.total = total;
    }
}

/**
 * Create by SunnyDay on 2022/04/15 17:14
 */
public class Test {

    public static void main(String[] args) {
        User test = new User();
        FieldInjectUtil.inject(test);

        // test
        System.out.println("age:"+test.getAge());
        System.out.println("number:"+test.getNumber());
        System.out.println("total:"+test.getTotal());
        //log
        //age:18
        //number:20
        //total:22
    }

}