首页 > 软件编程 > java > Java注解

Java注解(annotation)简述

2021-08-31 10:19:44 作者：刘瑜澄

这篇文章主要介绍了使用java的注解(用在java类的方法上的注解)方法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧

Java注解(annotation)简单上手

反射reflect：https://www.jb51.net/article/221282.htm

1、什么是注解？

注解就像商场的商品上都贴有自己的标签一样，它提供了关于这个商品的许多额外信息。你可以根据这些信息对其进行附加的处理。

“打上标签” 以后，框架就可以利用Java的反射能力，扫描、获取各Class/Method/Field上的注解，据此对其进行额外的处理。

2、java内置注解

java中有一些java原生就定义的注解，像@Override

注解可以辅助反射机制，例如帮助我们快速筛选在反射中操作的目标，它在如今流行的框架中被大量使用

java内置了一些注解，有些是辅助编译器一起编译时做验证使用，下面两个注解就是java内置的注解，他们用于为我们定义的注解指定某些特性：

@Target
用于指定我们定义的注解可以被应用在哪里，具体的位置被枚举类型ElementType定义，例如：
     TYPE：在类上可以使用当前注解,即只能标注在类上
     METHOD：在方法上可以使用当前注解,即只能标注在方法上
     FIELD：在属性上可以使用当前注解,即只能标注在属性上
     还有一些其他，可参见API手册
@Retention
用于我们定义的注解的保留级别
      RetentionPolice.RUNTIME：最常用，保留在字节码文件中且在该类运行时可被反射机制利用
      RetentionPolice.CLASS：保留在字节码中，但是反射机制不可用，如若不写默认@Retention就是该级别
      RetentionPolice.SOURCE：保留在源码中

3、注解的基本运

创建注解

在这里插入图片描述

创建两个注解类AutoRunClass和TestMethod

/*
    @Target()可以指定在哪使用这个注解
    这个表示是给类(Type)使用的注解，表示只能在类上使用，不能在其他地方使用
    @Target({ElementType.TYPE,ElementType.FIELD})也可以使用数组的方式使用多个
 */
@Target(ElementType.TYPE)
//保留级别
@Retention(RetentionPolicy.RUNTIME)

public @interface AutoRunClass {//这个注解的作用于筛选类
}

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestMethod {//这个注解的作用于筛选方法
    /*
        注解里可以定义参数，格式：
        类型 参数名()
        注意：如果当前注解只有一个参数时，通常参数名叫value

        当我们定义了参数，那么在使用当前注释时需要为参数指定值，格式：
        @注解名(参数1=参数值1,参数1=参数值1,...)
        参数指定的顺序可以与注解中定义的顺序不一样

        例如:
        @TestMethod(5)
        注：上述注解没有指定参数名的原因是该注解只有一个参数，并且参数名叫value
        即:int value();

        如果该参数定义时为:int sum();
        那么使用注解时要写成:@TestMethod(sum=5)
        
        注：使用default可以初始化定义值
     */
    int value() default 1;
}

创建一个实体类Person，在其中使用注解标识类和方法

package reflect_text;

/**
 * 用于测试反射-注解机制
 */
@AutoRunClass//-----------------------
public class Person {
    private String name = "刘瑜澄";
    private int age = 22;

    public Person() {
    }

    public Person(String name, int age) {
        this.name = name;
        this.age = age;
    }

    //有了初始值，加不加参数都可以
    @TestMethod//-----------------------
    public void sayHi() {
        System.out.println(name + "Hi!!!");
    }

    @TestMethod(3)//-----------------------
    public void sayHello() {
        System.out.println(name + "大家好！");
    }

    @TestMethod(5)//-----------------------
    public void sayGoodBye() {
        System.out.println(name + "再见！");
    }

    public void say(String info) {
        System.out.println(name + ":" + info);
    }

    public void say(String info, int sum) {
        for (int i = 0; i < sum; i++) {
            System.out.println(name + ":" + info);
        }
    }

    @Override
    public String toString() {
        return "Person{" +
                "name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
}

使用注解

要求判断Person是否被AutoRunClass注解修饰，如果是则遍历Person中所有方法，遍历判断这些方法是否被TestMethod注解修饰，是则根据注解传入的参数去遍历执行该方法。

如果对反射不是很了解，可以看看https://www.jb51.net/article/221282.htm

		//加载Person的类对象
        Class cls = Class.forName("reflect_text.Person");

        /*
            boolean isAnnotationPresent(Class annoCls)
            检查是否又被annoCls指定的注解修饰
         */
        if (cls.isAnnotationPresent(AutoRunClass.class)) {
            System.out.println(cls.getName() + "被AutoRunClass注解修饰");
            //实例化
            Object obj = cls.newInstance();
            //扫描当前类定义的所有方法
            Method[] methods = cls.getDeclaredMethods();
            for (Method method : methods) {
                if (method.isAnnotationPresent(TestMethod.class)) {
                    System.out.println(method.getName()+"被TestMethod注解修饰");
                    //通过getAnnotation方法获取method方法上的注解@TestMethod
                    TestMethod tm = method.getAnnotation(TestMethod.class);
                    //调用其参数名，获取注解 参数value的值
                    int sum = tm.value();
                    //然后根据注解传入的参数重复调用该方法
                    for (int i = 0; i < sum; i++) {
                        method.invoke(obj);
                    }
                }else{
                    System.out.println(method.getName() + "不被@TestMethod注解修饰");
                }
            }
        } else {
            System.out.println(cls.getName() + "没有被AutoRunClass注解修饰");
        }