Java注解详解 - 技术栈

概述

注解是对程序代码进行标注和解释的一种方式。在Java中，注解提供了一种元数据形式，能够在程序中嵌入有关程序的信息，以便进行进一步的处理。注解通过使用@符号来声明，如@Override、@Deprecated等。

注解和注释的区别

注释：是给程序员看的，不会对程序产生任何影响。
注解：是给编译器或其他工具看的，可以在编译、运行时进行一些特殊操作。

使用注解进行配置的优势

使用注解进行配置能使代码更简洁、方便，而不再需要繁琐的配置文件。注解能够直观地标识出程序中的关键信息，提高代码的可读性和可维护性。

自定义注解

格式

java 复制代码

javaCopy codepublic @interface 注解名称 {
    public 属性类型 属性名() default 默认值;
}

属性类型

基本数据类型
String
Class
注解
枚举
以上类型的一维数组

示例代码

java 复制代码

javaCopy codepublic @interface Anno2 {
}

public enum Season {
    SPRING, SUMMER, AUTUMN, WINTER;
}

public @interface Anno1 {

    // 定义一个基本类型的属性
    int a() default 23;

    // 定义一个String类型的属性
    String name() default "shizhanban";

    // 定义一个Class类型的属性
    Class clazz() default Anno2.class;

    // 定义一个注解类型的属性
    Anno2 anno() default @Anno2;

    // 定义一个枚举类型的属性
    Season season() default Season.SPRING;

    // 以上类型的一维数组
    // int数组
    int[] arr() default {1, 2, 3, 4, 5};

    // 枚举数组
    Season[] seasons() default {Season.SPRING, Season.SUMMER};

    // value。后期我们在使用注解的时候，如果我们只需要给注解的value属性赋值。
    // 那么value就可以省略
    String value();
}

// 在使用注解的时候如果注解里面的属性没有指定默认值。
// 那么我们就需要手动给出注解属性的设置值。
//@Anno1(name = "shizhanban")
@Anno1("abc")
public class AnnoDemo {
}

注意

如果只有一个属性需要赋值，并且属性的名称是value，则value可以省略，直接定义值即可。

自定义注解案例

需求

自定义一个注解@Test，用于指定类的方法上，如果某一个类的方法上使用了该注解，就执行该方法。

实现步骤

自定义一个注解Test，并在类的某几个方法上加上注解。
在测试类中，获取注解所在类的Class对象。
获取类中所有的方法对象。
遍历每一个方法对象，判断是否有对应的注解。

java 复制代码

javaCopy code// 表示Test这个注解的存活时间
@Retention(value = RetentionPolicy.RUNTIME)
public @interface Test {
}

public class UseTest {

    // 没有使用Test注解
    public void show() {
        System.out.println("UseTest....show....");
    }

    // 使用Test注解
    @Test
    public void method() {
        System.out.println("UseTest....method....");
    }

    // 没有使用Test注解
    @Test
    public void function() {
        System.out.println("UseTest....function....");
    }
}

public class AnnoDemo {
    public static void main(String[] args) throws ClassNotFoundException, IllegalAccessException, InstantiationException, InvocationTargetException {
        // 1.通过反射获取UseTest类的字节码文件对象
        Class clazz = Class.forName("com.shizhanban.UseTest");

        // 创建对象
        UseTest useTest = (UseTest) clazz.newInstance();

        // 2.通过反射获取这个类里面所有的方法对象
        Method[] methods = clazz.getDeclaredMethods();

        // 3.遍历数组，得到每一个方法对象
        for (Method method : methods) {
            // method依次表示每一个方法对象。
            // isAnnotationPresent(Class<? extends Annotation> annotationClass)
            // 判断当前方法上是否有指定的注解。
            // 参数：注解的字节码文件对象
            // 返回值：布尔结果。  true 存在  false 不存在
            if (method.isAnnotationPresent(Test.class)) {
                method.invoke(useTest);
            }
        }
    }
}

元注解

概述

元注解是描述注解的注解。

元注解介绍

@Target：指定了注解能在哪里使用。
@Retention：可以理解为保留时间（生命周期）。
@Inherited：表示修饰的自定义注解可以被子类继承。
@Documented：表示该自定义注解会出现在API文档里面。

示例代码

java 复制代码

javaCopy code@Target({ElementType.FIELD, ElementType.TYPE, ElementType.METHOD}) // 指定注解使用的位置（成员变量，类，方法）
@Retention(RetentionPolicy.RUNTIME) // 指定该注解的存活时间
// @Inherited // 指定该注解可以被继承
public @interface Anno {
}

@Anno
public class Person {
}

public class Student extends Person {
    public void show() {
        System.out.println("student.......show..........");
    }
}

public class StudentDemo {
    public static void main(String[] args) throws ClassNotFoundException {
        // 获取到Student类的字节码文件对象
        Class clazz = Class.forName("com.shizhanban.Student");

        // 获取注解。
        boolean result = clazz.isAnnotationPresent(Anno.class);
        System.out.println(result);
    }
}

通过元注解，我们可以更加灵活地定义和使用自定义注解，控制注解的生命周期和作用范围。