Java 注解与自定义注解

注解的定义

• Annontation是Java5开始引入的新特征，中文名称为注解。
• 它提供了一种安全的类似注释的机制，用来将任何的信息戒元数据（metadata）与程序
  元素（类、方法、成员变量等）进行关联。
• 为程序的元素（类、方法、成员变量）加上更直观更明了的说明，这些说明信息是与程
  序的业务逻辑无关，并且供指定的工具戒框架使用。
• Annontation像一种修饰符一样，应用于包、类型、构造方法、方法、成员变量、参数
  及本地变量的声明语句中。
• Java注解是附加在代码中的一些元信息，用于一些工具在编译、运行时进行解析和使用，
  起到说明、配置的功能。
• 注解不会也不能影响代码的实际逻辑，仅仅起到辅劣性的作用。包含在
  java.lang.annotation 包中。

太长不看：跟注释差不多，但能起到提示 包、类型、构造方法、方法、成员变量、参数、返回值 的 使用、声明、实现 等 是否有误或是否标准及规范

---

注解的作用

• 生成文档。这是最常见的，也是java 最早提供的注解。常用的有 @param @return 等
• 跟踪代码依赖性，实现替代配置文件功能。
• 在编译时进行格式检查。如@override 放在方法前，如果这个方法并不是覆盖了超类方法，则编译时就能检查出。

---

常用内置注解

• @Override：定义在java.lang.Override中，此注释叧适用于修饰方法，表示一个方法声明打算重写超类中的另一个方法声明
• @Deprecated：定义在java.lang.Deprecated中，此注解可以修饰方法、属性、类，表示不鼓励程序员使用这样的元素，通常是因为它很危险戒者存在更好的选择
• @SuppressWarnings：定义java.lang.SuppressWarnings中，用来抑制编写编译时的警告信息

---

元注解

• 元注解的作用是负责注解其他注解，java中定义了四个标准的meta-annotation(元注解)类型，他们被用来提供对其他annotation类型作说明
• 这些类型和它们所支持的类在java.lang.annotation包中
  1. @Target：用来描述注解的使用范围（注解可以用在什么地方）用ElementType.java内的ElementType枚举数值区分范围
  2. @Retention：表示需要在什么级别保存该注释信息用RetentionPolicy.java下的RetentionPolicy枚举类型进行区分，描述注解的生命周期 Source < Class < Runtime
  3. @Document：说明该注解将被包含在javadoc中
  4. @Inherited：说明子类可以继承父类中的该注解

---

ElementType.java

package java.lang.annotation;

public enum ElementType {
    TYPE,               /* 类、接口（包括注释类型）或枚举声明  */

    FIELD,              /* 字段声明（包括枚举常量）  */

    METHOD,             /* 方法声明  */

    PARAMETER,          /* 参数声明  */

    CONSTRUCTOR,        /* 构造方法声明  */

    LOCAL_VARIABLE,     /* 局部变量声明  */

    ANNOTATION_TYPE,    /* 注释类型声明  */

    PACKAGE             /* 包声明  */
}

---

RetentionPolicy.java

package java.lang.annotation;
public enum RetentionPolicy {
    SOURCE,            /* Annotation信息仅存在于编译器处理期间，编译器处理完之后就没有该Annotation信息了  */

    CLASS,             /* 编译器将Annotation存储于类对应的.class文件中。默认行为  */

    RUNTIME            /* 编译器将Annotation存储于class文件中，并且可由JVM读入 */
}

---

自定义注解

import java.lang.annotation.*;

//@MyAnnotation(name="hehe",age=12,id=3,likes = {"book","lol","movie"})
    @MyAnnotation
public class MetaAnnotation {
    public void test(){

    }
}

//target用来声明当前自定义的注解适合适用于什么地方，类，方法，变量，包。。。。
@Target({ElementType.METHOD,ElementType.TYPE})
//retention用来表示当前注解适用于什么环境，是源码级别还是类级别还是运行时环境，一般都是运行时环境
@Retention(RetentionPolicy.CLASS)
//表示该注解是否是显示在javadoc中
@Documented
//表示当前注解是否能够被继承
@Inherited
@interface MyAnnotation{

    //定义的方式看起来像是方法
    //但是实际上是在使用该注解的时，需要填写的参数的名称
    //如果属性的名称是value(),且只有value()时
    //则使用注解时可以省略"value="不写
    //但如果有多于一个属性时则必须以“属性名=值”的方式写出
    //自定义注解中填写的所有属性都需要在使用注解的时候手动赋值很麻烦
	//因此可以包含默认值
	//没有default的属性使用注解时则必须手动赋值
    String name() default "zhangsan";
    int age() default 12;
    int id() default 1;
    String[] likes() default {"a","b","c"};
}

自定义注解使用

@MyAnnotation(name="lisi",id=2,likes={"game","movie"})//省略了age
public class TestClass{
	//@MyAnnotation //类方法也可以用参数全省略
	public void test(){
	}
}

annotation注解， 其实就是带个@号的注释，注解其实是类反射的一些延伸，在一些需要配置文件的Java应用中，可以使用注解替代配置文件配置，从而提高应用的灵活

拓展阅读
Java 自定义注解及使用场景
Java 注解（Annotation）
Java Annotation认知(包括框架图、详细介绍、示例说明)