Java 的注解 Annotation

注解目前非常的流行，很多主流框架都支持注解，而且自己编写代码的时候也会尽量的去用注解，一时方便，而是代码更加简洁。

     注解的语法比较简单，除了@符号的使用之外，它基本与Java固有语法一致。Java SE5内置了三种标准注解：

     @Override，表示当前的方法定义将覆盖超类中的方法。

     @Deprecated，使用了注解为它的元素编译器将发出警告，因为注解@Deprecated是不赞成使用的代码，被弃用的代码。

     @SuppressWarnings，关闭不当编译器警告信息。

上面这三个注解多少我们都会在写代码的时候遇到。Java还提供了4中注解，专门负责新注解的创建。

 

@Target （控制注解的作用域）	表示该注解可以用于什么地方，可能的ElementType参数有： CONSTRUCTOR：构造器的声明 FIELD：域声明（包括enum实例） LOCAL_VARIABLE：局部变量声明 METHOD：方法声明 PACKAGE：包声明 PARAMETER：参数声明 TYPE：类、接口（包括注解类型）或enum声明
@Retention （控制注解的寿命）	表示需要在什么级别保存该注解信息。可选的RetentionPolicy参数包括： SOURCE：注解将被编译器丢弃 CLASS：注解在class文件中可用，但会被VM丢弃 RUNTIME：VM将在运行期间保留注解，因此可以通过反射机制读取注解的信息。
@Document	将注解包含在Javadoc中
@Inherited	允许子类继承父类中的注解

---

定义自己的注解：

/**
 * @author 超
 * Create by fengc on  2018/7/23 22:06
 * 这是一个自定义的注解(Annotation)类 在定义注解(Annotation)类时使用了另一个注解类Retention
 * 在注解类上使用另一个注解类，那么被使用的注解类就称为元注解
 *
 * ElementType.TYPE 类、接口（包括注解类型）或enum声明

 * @Retention(RetentionPolicy.SOURCE)
 * 这个注解的意思是让MyAnnotation注解只在java源文件中存在，编译成.class文件后注解就不存在了
 * @Retention(RetentionPolicy.CLASS)
 * 这个注解的意思是让MyAnnotation注解在java源文件(.java文件)中存在，编译成.class文件后注解也还存在，
 * 被MyAnnotation注解类标识的类被类加载器加载到内存中后MyAnnotation注解就不存在了
 * 这里是在注解类MyAnnotation上使用另一个注解类，这里的Retention称为元注解。
 * Retention注解括号中的"RetentionPolicy.RUNTIME"意思是让MyAnnotation这个注解的生命周期一直程序运行时都存在
  */

//Retention注解决定MyAnnotation注解的生命周期
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD,ElementType.TYPE})
public @interface MyAnnotation {
    /**
     * 注解可以看成是一种特殊的类，既然是类，那自然可以为类添加属性
     * 定义基本属性
     * @return
     */
    String color() default "red";
    //定义一个名称为value的属性
    String value();

    int[] arrayAttr() default {1,2,4};

    EnumTraficLamp lamp() default EnumTraficLamp.GREEN;

    MetaAnnotation annotationAttr() default @MetaAnnotation("xdp");
}

枚举型的属性

/**
 * @author 超
 * Create by fengc on  2018/7/23 22:57
 */
public enum EnumTraficLamp {
    //红
    RED,
    //黄
    YELLOW,
    //绿
    GREEN
}

 

注解类型的属性

/**
 * @author 超
 * Create by fengc on  2018/7/23 22:57
 */
public @interface MetaAnnotation {

    String value();
}

运行注解类

package com.annotation.example;

/**
 * @author 超
 * Create by fengc on  2018/7/23 22:23
 */
@MyAnnotation(color = "green",
        value = "Hello word",
        arrayAttr = {8,9,10,11,21,12,122},
        lamp = EnumTraficLamp.YELLOW,
        annotationAttr = @MetaAnnotation("gclss")
)
public class AnnotationUse {
    public static void main(String[] args) {
        // 这里是检查Annotation类是否有注解，这里需要使用反射才能完成对Annotation类的检查
        if (AnnotationUse.class.isAnnotationPresent(MyAnnotation.class)) {
            /**
             *  MyAnnotation是一个类，这个类的实例对象annotation是通过反射得到的，这个实例对象是如何创建的呢？
             * 一旦在某个类上使用了@MyAnnotation，那么这个MyAnnotation类的实例对象annotation就会被创建出来了。
            */
            MyAnnotation myAnnotation = AnnotationUse.class.getAnnotation(MyAnnotation.class);
            System.out.println(myAnnotation);
            //用反射方式获得注解对应的实例对象后，在通过该对象调用属性对应的方法
            System.out.println(myAnnotation.color());
            System.out.println(myAnnotation.value());
            System.out.println(myAnnotation.arrayAttr().length);
            System.out.println(myAnnotation.annotationAttr().value());
            System.out.println(myAnnotation.lamp());


        }
    }
}