【JavaSE-06】：注解（Annotation）

一、概述

JDK 5.0 引入的一种注释机制, Java 对元数据(MetaData) 的支持, 也就是 Annotation(注解) 。

Annotation 其实就是代码里的特殊标记, 这些标记可以在编译、类加载、运行时被读取, 并执行相应的处理。通过使用Annotation, 程序员可以在不改变原有逻辑的情况下, 在源文件中嵌入一些补充信息。代码分析工具、开发工具和部署工具可以通过这些补充信息进行验证或者进行部署。

Annotation 可以像修饰符一样被使用, 可用于修饰包、类、构造器、方 法、成员变量、参数、局部变量的声明, 这些信息被保存在Annotation 的 “name=value” 对中。

注解是一种趋势，一定程度上可以说：框架 = 注解 + 反射 + 设计模式。

二、Annotation 架构和组成部分

Annotation 有许多实现类，Annotation 的每一个实现类，都 “和 1 个 RetentionPolicy 关联” 并且 " 和 1~n 个 ElementType 关联"。

2.1 Annotation组成部分

java Annotation 的组成中，有 3 个非常重要的主干类。它们分别是：
(1) Annotation 就是个接口。每 1 个 Annotation 对象，都会有唯一的 RetentionPolicy 属性；至于 ElementType 属性，则有 1~n 个。

package java.lang.annotation;

public interface Annotation {
    boolean equals(Object var1);

    int hashCode();

    String toString();

    Class<? extends Annotation> annotationType();
}

(2) ElementType 是 Enum 枚举类型，它用来指定 Annotation 的类型。

package java.lang.annotation;

public enum ElementType {
    TYPE,
    FIELD,
    METHOD,
    PARAMETER,
    CONSTRUCTOR,
    LOCAL_VARIABLE,
    ANNOTATION_TYPE,
    PACKAGE,
    TYPE_PARAMETER,
    TYPE_USE,
    MODULE;

    private ElementType() {
    }
}

(3) RetentionPolicy 是 Enum 枚举类型，它用来指定 Annotation 的策略。也就是不同 RetentionPolicy 类型的 Annotation 的作用域不同。

package java.lang.annotation;

public enum RetentionPolicy {
    SOURCE,
    CLASS,
    RUNTIME;

    private RetentionPolicy() {
    }
}

2.2常见的Annotation示例

使用 Annotation 时要在其前面增加 @ 符号, 并把该 Annotation 当成 一个修饰符使用。用于修饰它支持的程序元素

示例一：生成文档相关的注解

@author 标明开发该类模块的作者，多个作者之间使用,分割
@version 标明该类模块的版本 
@see 参考转向，也就是相关主题 
@since 从哪个版本开始增加的 
@param 对方法中某参数的说明，如果没有参数就不能写 
@return 对方法返回值的说明，如果方法的返回值类型是void就不能写 
@exception 对方法可能抛出的异常进行说明 ，如果方法没有用throws显式抛出的异常就不能写 

其中：
@param @return 和 @exception 这三个标记都是只用于方法的。
@param的格式要求：@param 形参名 形参类型 形参说明 
@return 的格式要求：@return 返回值类型 返回值说明 
@exception的格式要求：@exception 异常类型 异常说明 
@param和@exception可以并列多个

代码示例：

package com.annotation.javadoc; 
/** 
	* @author shkstart 
	* @version 1.0 
	* @see Math.java 
*/ 

public class JavadocTest { 
	/** 
	* 程序的主方法，程序的入口 
	* @param args String[] 命令行参数 
	*/ 
	public static void main(String[] args) { 

}
/** 
* 求圆面积的方法 
* @param radius double 半径值 
*  @return double 圆的面积 
*/ 
public static double getArea(double radius){ 
		return Math.PI * radius * radius; 
		}
		
}

示例二：**编译检查 **在编译时进行格式检查(JDK内置的三个基本注解)

@Override: 限定重写父类方法, 该注解只能用于方法
@Deprecated: 用于表示所修饰的元素(类, 方法等)已过时。通常是因为所修饰的结构危险或存在更好的选择
@SuppressWarnings: 让编译器对"它所标注的内容"的某些警告保持静默，抑制编译器警告

代码示例：

package com.annotation.javadoc;

public class AnnotationTest{
	public static void main(String[] args) { 
			@SuppressWarnings("unused") 
			int a = 10; 
			} 
			
			@Deprecated 
			public void print(){ 
				System.out.println("过时的方法"); 
				}
		@Override 
		public String toString() { 
				return "重写的toString方法()"; 
				}
		
}

补充：SuppressWarnings 常用的关键字的表格

value	作用
deprecation	使用了不赞成使用的类或方法时的警告
unchecked	执行了未检查的转换时的警告，例如当使用集合时没有用泛型 (Generics) 来指定集合保存的类型。
fallthrough	当 Switch 程序块直接通往下一种情况而没有 Break 时的警告。
path	在类路径、源文件路径等中有不存在的路径时的警告。
serial	当在可序列化的类上缺少 serialVersionUID 定义时的警告。
finally	任何 finally 子句不能正常完成时的警告。
all	关于以上所有情况的警告。

示例三：跟踪代码依赖性，实现替代配置文件功能

Servlet3.0提供了注解(annotation),使得不再需要在web.xml文件中进行Servlet的部署。

@WebServlet("/login") 
public class LoginServlet extends HttpServlet { 
		private static final long serialVersionUID = 1L;
		protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { 
		} 
		protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { 
		doGet(request, response); 
		} 
}

<servlet> 
	<servlet-name>LoginServlet</servlet-name> 
	<servlet-class>com.servlet.LoginServlet</servlet-class> 
</servlet> 

<servlet-mapping> 
		<servlet-name>LoginServlet</servlet-name> 
		<url-pattern>/login</url-pattern> 
</servlet-mapping>

三、JDK中的元注解（Annotation 通用定义）

● JDK 的元Annotation 用于修饰其他Annotation 定义，对现有注解进行解释说明的注解。

● JDK5.0提供了4个标准的meta-annotation类型，分别是：
@Retention
@Target
@Documented
@Inherited

1.@Retention

@Retention: 只能用于修饰一个 Annotation 定义, 用于指定该 Annotation 的生命周期, @Rentention 包含一个 RetentionPolicy 类型的成员变量, 使用 @Rentention 时必须为该 value 成员变量指定值:

RetentionPolicy.SOURCE:在源文件中有效（即源文件保留），仅存在于编译器处理期间，编译器处理完之后，该 Annotation 就没用了，编译器直接丢弃这种策略的注释 。
RetentionPolicy.CLASS:在class文件中有效（即class保留）默认值 ， 当运行 Java 程序时, JVM 不会保留注解。
RetentionPolicy.RUNTIME:在运行时有效（即运行时保留），当运行 Java 程序时, JVM 会 保留注释。程序可以通过反射获取该注释。

@Retention(RetentionPolicy.SOURCE) 
@interface MyAnnotation1{  }

@Retention(RetentionPolicy.RUNTIME) 
@interface MyAnnotation2{  }

2.@Target

@Target: 用于修饰 Annotation 定义, 用于指定被修饰的 Annotation 能用于修饰哪些程序元素，即指定 Annotation 的类型属性。 @Target 也包含一个名为 value 的成员变量。

3.@Documented (出现较少)

@Documented: 用于指定被该元 Annotation 修饰的 Annotation 类将被 javadoc 工具提取成文档。默认情况下，javadoc是不包括注解的。

定义为Documented的注解必须设置Retention值为RUNTIME。

4.@Inherited (出现较少)

@Inherited: 被它修饰的 Annotation 将具有继承性。如果某个类使用了被 @Inherited 修饰的 Annotation, 则其子类将自动具有该注解。

比如：如果把标有@Inherited注解的自定义的注解标注在类级别上，子类则可以继承父类类级别的注解 。
实际应用中，使用较少

四、自定义 Annotation

● 定义新的 Annotation 类型使用 @interface 关键字

● 自定义注解自动继承了java.lang.annotation.Annotation接口

● Annotation 的成员变量在 Annotation 定义中以无参数方法的形式来声明。其方法名和返回值定义了该成员的名字和类型。我们称为配置参数。类型只能是八种基本数据类型、String类型、Class类型、enum类型、Annotation类型、 以上所有类型的数组。

● 可以在定义 Annotation 的成员变量时为其指定初始值, 指定成员变量的初始值可使用 default 关键字

● 如果只有一个参数成员，建议使用参数名为value

● 如果定义的注解含有配置参数，那么使用时必须指定参数值，除非它有默认值。格式是“参数名 = 参数值”，如果只有一个参数成员，且名称为value， 可以省略“value=”

● 没有成员定义的 Annotation 称为标记，表明是一个标识作用; 包含成员变量的 Annotation 称为元数据 Annotation

注意：自定义注解必须配上注解的信息处理流程（使用反射）才有意义。

代码示例：

@MyAnnotation(value="你好") 
public class MyAnnotationTest { 
		public static void main(String[] args) { 
			Class clazz = MyAnnotationTest.class; 
			Annotation a = clazz.getAnnotation(MyAnnotation.class); 
			MyAnnotation m = (MyAnnotation) a; 
			String info = m.value();
			 System.out.println(info); 
			 }
		} 
		@Retention(RetentionPolicy.RUNTIME) 
		@Target(ElementType.TYPE) 
		@interface MyAnnotation{ 
				String value() default "hello"; 
				}

五、利用反射获取注解信息

见链接: 反射机制.

六、JDK8注解的新特性

Java 8对注解处理提供了两点改进：
● 可重复的注解
● 可用于类型的注解

此外， 反射也得到了加强，在Java8中能够得到方法参数的名称。这会简化标注在方法参数上的注解。

可重复注解示例：
1、在MyAnntation上声明@Repeatable，成员值为MyAnnotation.class
2、MyAnntation的Targer和Retention等元注解与MyAnntation相同

类型注解示例：

JDK1.8之后，关于元注解@Target的参数类型ElementType枚举值多了两个： TYPE_PARAMETER,TYPE_USE。

在Java 8之前，注解只能是在声明的地方所使用，Java8开始，注解可以应用 在任何地方。

ElementType.TYPE_PARAMETER 表示该注解能写在类型变量的声明语 句中（如：泛型声明）。

ElementType.TYPE_USE 表示该注解能写在使用类型的任何语句中。