java基础之注解

87 阅读4分钟

开启掘金成长之旅!这是我参与「掘金日新计划 · 2 月更文挑战」的第 1 天,点击查看活动详情

一、认识注解

想像代码具有生命,注解就是对于代码中某些鲜活个体的贴上去的一张标签。简化来讲,注解如同一张标签。

注解通过 @interface 关键字进行定义。它的形式跟接口很类似,不过前面多了一个 @ 符号。

注解可以在类上,构造器上,方法上,成员变量上,参数上等位置处。

注解的格式如下

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

特殊属性名:value | 如果注解中只有value一个属性,使用注解时,value名称可以不写

二、元注解

元注解是可以注解到注解上的注解,或者说元注解是一种基本注解,但是它能够应用到其它的注解上面。

如果难于理解的话,你可以这样理解。元注解也是一张标签,但是它是一张特殊的标签,它的作用和目的就是给其他普通的标签进行解释说明的。

元标签有 @Retention、@Documented、@Target、@Inherited、@Repeatable 5 种。

@Target

Target 是目标的意思,@Target 指定了注解运用的地方。

你可以这样理解,当一个注解被 @Target 注解时,这个注解就被限定了运用的场景。

类比到标签,原本标签是你想张贴到哪个地方就到哪个地方,但是因为 @Target 的存在,它张贴的地方就非常具体了,比如只能张贴到方法上、类上、方法参数上等等。@Target 有下面的取值

  • ElementType.ANNOTATION_TYPE 可以给一个注解进行注解
  • ElementType.CONSTRUCTOR 可以给构造方法进行注解
  • ElementType.FIELD 可以给属性进行注解
  • ElementType.LOCAL_VARIABLE 可以给局部变量进行注解
  • ElementType.METHOD 可以给方法进行注解
  • ElementType.PACKAGE 可以给一个包进行注解
  • ElementType.PARAMETER 可以给一个方法内的参数进行注解
  • ElementType.TYPE 可以给一个类型进行注解,比如类、接口、枚举

@Retention

Retention 的英文意为保留期的意思。当 @Retention 应用到一个注解上的时候,它解释说明了这个注解的的存活时间。

它的取值如下:

  • RetentionPolicy.SOURCE 注解只在源码阶段保留,在编译器进行编译时它将被丢弃忽视。
  • RetentionPolicy.CLASS 注解只被保留到编译进行的时候,它并不会被加载到 JVM 中。
  • RetentionPolicy.RUNTIME 注解可以保留到程序运行的时候,它会被加载进入到 JVM 中,所以在程序运行时可以获取到它们。(开发常用)

@Documented

顾名思义,这个元注解肯定是和文档有关。它的作用是能够将注解中的元素包含到 Javadoc 中去。

@Inherited

Inherited 是继承的意思,但是它并不是说注解本身可以继承,而是说如果一个超类被 @Inherited 注解过的注解进行注解的话,那么如果它的子类没有被任何注解应用的话,那么这个子类就继承了超类的注解。

举个例子:当注解 Test 被 @Inherited 修饰,之后类 A 被 Test 注解,类 B 继承 A,类 B 也拥有 Test 这个注解。

三、获取注解的内容

首先自定义一个注解

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyTest {

    String value();

    double num() default 100;

    String[] names();

}

在类和方法上对其进行使用

@MyTest(value = "java", names = {"odin", "dog"})
public class TestAnnotation {

    @MyTest(value = "spring",names = {"jack","tom"})
    public void test() {

    }
}

通过反射获取注解的值

public class AnnotationTest {

    @Test
    public void parseClass() {
        // 1、先得到class对象
        Class<TestAnnotation> demo = TestAnnotation.class;
        // 2、解析类上的注解
        // 判断是否包含某个注解
        if (demo.isAnnotationPresent(MyTest.class)) {
            MyTest myTest = demo.getDeclaredAnnotation(MyTest.class);
            System.out.println(myTest.value());
            System.out.println(myTest.num());
            System.out.println(Arrays.toString(myTest.names()));

        }
    }

    @Test
    public void parseMethod() throws NoSuchMethodException {
        // 1、先得到class对象
        Class<TestAnnotation> demo = TestAnnotation.class;
        Method test = demo.getDeclaredMethod("test");
        // 2、解析类上的注解
        // 判断是否包含某个注解
        if (test.isAnnotationPresent(MyTest.class)) {
            MyTest myTest = test.getDeclaredAnnotation(MyTest.class);
            System.out.println(myTest.value());
            System.out.println(myTest.num());
            System.out.println(Arrays.toString(myTest.names()));

        }

    }
}

四、模拟实现Junit注解

创建MyTest注解

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyTest {

}

创建类,类中部分方法使用MyTest注解

public class TestClass {

    public void test1() {
        System.out.println("=======test1=========");
    }

    @MyTest
    public void test2() {
        System.out.println("=======test2=========");
    }

    public void test3() {
        System.out.println("=======test3=========");
    }

    @MyTest
    public void test4() {
        System.out.println("=======test4=========");
    }

    public static void main(String[] args) throws InvocationTargetException, IllegalAccessException {

        TestClass testClass = new TestClass();

        // 1.得到Class对象
        Class<TestClass> testClassClass = TestClass.class;
        // 2.提取类中的所有成员方法
        Method[] declaredMethods = testClassClass.getDeclaredMethods();
        // 3.遍历方法,查询是否有MyTest注解,如果有则触发该方法
        for (Method declaredMethod : declaredMethods) {
            if (declaredMethod.isAnnotationPresent(MyTest.class)) {
                // 该方法含有MyTest注解
                declaredMethod.invoke(testClass);
            }
        }
    }
}

运行结果如下

image-20221220214307178