Java的注解

Java的注解

---

注解： 向程序的调用者说明类或方法的一些信息，我们大概从以下五个方面了解一下就可以了。

---

1.jdk中自带的三个注解(其实下面仨情况直接用IDE工具点一下就行了。)

• @Deprecated 声明方法已过时
• @SuppressWarnings 取消编译器警告(该警告修饰任何成员，字段方法构造函数等都可以，而且这是可带多个参数的，因为SuppressWarnings注解类中，封装了一个value数组)
• @Override 声明方法是继承自父类

public class Demo {
    @SuppressWarnings({ "deprecation", "unchecked" })   // 取消编译器警告,即取消runFinalizersOnExit()已过时 和 List不加泛型的检查 两个警告
    public static void main(String[] args) {
        System.runFinalizersOnExit(true);

        run();

        @SuppressWarnings("unused") //取消编译器list未使用的警告
        List list = new ArrayList();
    }

    @Deprecated // 告诉调用者方法已过时
    public static void run() {}

    @Override   // 让编译器检查方法是否覆写了父类的方法
    public boolean equals(Object obj) {
        return false;
    }
}

---

2.什么是注解

• 注解就是java代码中的特殊标记，它用于告诉调用者类应该如何被运行
• 注解相当于配置文件的功能

---

3.自定义注解

• 使用 @interface 关键字可以声明一个注解
  例：public @interface MyAnnotation1
• 注解中可以定义默认属性，用default关键字
  例：public String name() default “aaa”;
• value是注解中的特殊属性
  当注解中只定义了一个属性，并且属性名为value时，使用注解的时候value可以不写，即在使用时可以省写属性名.
  例：public String value();

---

4.元注解 元Annotation

• 元注解简单理解为 注解的注解 类似于描述一个注解的信息的配置文件
• @Retention 指定注解的作用域:
  RetentionPolicy.SOURCE
  RetentionPolicy.CLASS 若注解类不加这个Retention，默认就是它
  RetentionPolicy.RUNTIME

下面俩看看就行了，一般不用!!

• @Target：指定注解用于修饰类的哪个成员.
  @Target 包含了一个名为 value，类型为ElementType的成员变量。
• @Inherited: 被它修饰的 Annotation 将具有继承性.
  如果某个类使用了被 @Inherited 修饰的 Annotation, 则其子类将自动具有该注解

---

5.反射注解

• 在程序可以通过反射来获取注解中封装的值

下面通过一个demo展示一下3 4 5是怎么回事

// 注解是一种特殊的java类，我们定义一个MyAnnotation注解类

@Retention(RetentionPolicy.RUNTIME) //让该注解在运行时也可以使用。
public @interface MyAnnotation {

    // 注解相当于配置文件  properties name=value
    // 属性作为配置项，要被访问使用，最好加上public 并且要写成getter方法的形式，其实就是一种规定。
    //所以下面定义了name属性，age属性和preArr字符串属性
    public String name() default "xxxx";    

    public int age();

    public String[] preArr();
}

//自定义只一个带value属性的注解类，这样在使用它的时候就可以不加属性名了
public @interface MyAnnotation1 {
    public String value();
}    

public class Test {

    //自定义注解中有多少个属性，都必须赋值，除非有默认属性值
    @MyAnnotation(name="bbb", age=19, preArr={"sing", "dance"})
    @MyAnnotation1("aaaa") //不用加属性名了
    public void run() {}

    public static void main(String[] args) throws Exception {
        // 因为上面的注解是修饰在run方法上，所以我们可以通过反射拿到run方法，进而拿到该run方法上的注解，然后使用注解属性就可以了。
        Method runMethod = Test.class.getMethod("run");

        MyAnnotation myannotation = runMethod.getAnnotation(MyAnnotation.class);

        //若不在MyAnnotation注解类添加@Retention(RetentionPolicy.RUNTIME)，下面的语句编译能通过，但是运行就通过不了。
        String name = myannotation.name();

        System.out.println(name);//结果为：bbb
    }
}