Annotation（注解）基础知识

本文转发自Jason’s Blog&＃xff0c;原文链接　http://www.jasongj.com/2016/01/17/Java1_注解Annotation

Annotation是Java5开始引入的特性。它提供了一种安全的类似于注释和Java doc的机制。实事上&＃xff0c;Annotation已经被广泛用于各种Java框架&＃xff0c;如Spring&＃xff0c;Jersey&＃xff0c;JUnit&＃xff0c;TestNG。注解相当于是一种嵌入在程序中的元数据&＃xff0c;可以使用注解解析工具或编译器对其进行解析&＃xff0c;也可以指定注解在编译期或运行期有效。这些元数据与程序业务逻辑无关&＃xff0c;并且是供指定的工具或框架使用的。

元注解的作用就是负责注解其他注解。Java5定义了4个标准的Meta Annotation类型&＃xff0c;它们被用来提供对其它 Annotation类型作说明。

&＃64;Target

&＃64;Target说明了Annotation所修饰的对象范围&＃xff1a;Annotation可被用于 packages、types&＃xff08;类、接口、枚举、Annotation类型&＃xff09;、类型成员&＃xff08;方法、构造方法、成员变量、枚举值&＃xff09;、方法参数和本地变量&＃xff08;如循环变量、catch参数&＃xff09;。在Annotation类型的声明中使用了&＃64;Target可更加明晰其修饰的目标。

&＃64;Target作用&＃xff1a;用于描述注解的使用范围&＃xff0c;即被描述的注解可以用在什么地方

&＃64;Target取值(ElementType)

• CONSTRUCTOR&＃xff1a;用于描述构造器
• FIELD&＃xff1a;用于描述域
• LOCAL_VARIABLE&＃xff1a;用于描述局部变量
• METHOD&＃xff1a;用于描述方法
• PACKAGE&＃xff1a;用于描述包
• PARAMETER&＃xff1a;用于描述参数
• TYPE&＃xff1a;用于描述类、接口(包括注解类型) 或enum声明

&＃64;Retention

&＃64;Retention定义了该Annotation的生命周期&＃xff1a;某些Annotation仅出现在源代码中&＃xff0c;而被编译器丢弃&＃xff1b;而另一些却被编译在class文件中&＃xff1b;编译在class文件中的Annotation可能会被虚拟机忽略&＃xff0c;而另一些在class被装载时将被读取&＃xff08;请注意并不影响class的执行&＃xff0c;因为Annotation与class在使用上是被分离的&＃xff09;。&＃64;Retention有唯一的value作为成员。

&＃64;Retention作用&＃xff1a;表示需要在什么级别保存该注释信息&＃xff0c;用于描述注解的生命周期&＃xff08;即&＃xff1a;被描述的注解在什么范围内有效&＃xff09;

&＃64;Retention取值来自java.lang.annotation.RetentionPolicy的枚举类型值

• SOURCE:在源文件中有效&＃xff08;即源文件保留&＃xff09;
• CLASS:在class文件中有效&＃xff08;即class保留&＃xff09;
• RUNTIME:在运行时有效&＃xff08;即运行时保留&＃xff09;

&＃64;Documented

&＃64;Documented用于描述其它类型的annotation应该被作为被标注的程序成员的公共API&＃xff0c;因此可以被例如javadoc此类的工具文档化。&＃64;Documented是一个标记注解&＃xff0c;没有成员。

&＃64;Inherited

&＃64;Inherited 是一个标记注解。如果一个使用了&＃64;Inherited修饰的annotation类型被用于一个class&＃xff0c;则这个Annotation将被用于该class的子类。

在实际项目中&＃xff0c;经常会碰到下面这种场景&＃xff0c;一个接口的实现类或者抽象类的子类很多&＃xff0c;经常需要根据不同情况&＃xff08;比如根据配置文件&＃xff09;实例化并使用不同的子类。典型的例子是结合工厂使用职责链模式。

此时&＃xff0c;可以为每个实现类加上特定的Annotation&＃xff0c;并在Annotation中给该类取一个标识符&＃xff0c;应用程序可通过该标识符来判断应该实例化哪个子类。

下面这个例子&＃xff0c;定义了一个名为Component的Annotation&＃xff0c;它包含一个名为identifier的成员变量。

package com.jasongj.annotation;import java.lang.annotation.Documented;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;&＃64;Target(ElementType.TYPE)
&＃64;Retention(RetentionPolicy.RUNTIME)
&＃64;Documented
&＃64;Inherited
public &＃64;interface Component {String identifier () default "";
}

对于上文所说的实现类加上&＃64;Component

package com.jasongj;import com.jasongj.annotation.Component;&＃64;Component(identifier&＃61;"upper")
public class UpperCaseComponent {public String doWork(String input) {if(input !&＃61; null) {return input.toUpperCase();} else {return null;}}
}

应用程序中可以通过反射获取UpperCaseComponent对应的identifier

package com.jasongj;import com.jasongj.annotation.Component;public class Client {public static void main(String[] args) {try {Class componentClass &＃61; Class.forName("com.jasongj.UpperCaseComponent");if(componentClass.isAnnotationPresent(Component.class)) {Component component &＃61; (Component)componentClass.getAnnotation(Component.class);String identifier &＃61; component.identifier();System.out.println(String.format("Identifier for "&＃43; "com.jasongj.UpperCaseComponent is &＃39; %s &＃39;", identifier));} else {System.out.println("com.jasongj.UpperCaseComponent is not annotated by"&＃43; " com.jasongj.annotation.Component");}} catch (ClassNotFoundException ex) {ex.printStackTrace();}}
}

结果如下

Identifier for com.jasongj.UpperCaseComponent is &＃39; upper &＃39;


如果把&＃64;Component的&＃64;Retention设置为 RetentionPolicy.SOURCE或者RetentionPolicy.CLASS&＃xff0c;则会得到如下结果&＃xff0c;验证了上文中对&＃64;Retention的描述

com.jasongj.UpperCaseComponent is not annotated by com.jasongj.annotation.Component
Java内置Annotation

Annotation的语法比较简单&＃xff0c;除了&＃64;符号的使用外&＃xff0c;他基本与Java固有的语法一致&＃xff0c;JavaSE中内置三个标准Annotation&＃xff0c;定义在java.lang中&＃xff1a;

1. &＃64;Override 是一个标记型Annotation&＃xff0c;说明了被标注的方法覆盖了父类的方法&＃xff0c;起到了断言的作用。如果给一个非覆盖父类方法的方法添加该Annotation&＃xff0c;编译器将报编译错误。它有两个典型的使用场景&＃xff0c;一是在试图覆盖父类方法却写错了方法名时报错&＃xff0c;二是删除已被子类覆盖&＃xff08;且用Annotation修饰&＃xff09;的父类方法时报错。
2. &＃64;Deprecated 标记型Annotation&＃xff0c;说明被修改的元素已被废弃并不推荐使用&＃xff0c;编译器会在该元素上加一条横线以作提示。该修饰具有一定的“传递性”&＃xff1a;如果我们通过继承的方式使用了这个弃用的元素&＃xff0c;即使继承后的元素&＃xff08;类&＃xff0c;成员或者方法&＃xff09;并未被标记为&＃64;Deprecated&＃xff0c;编译器仍然会给出提示。
3. &＃64;SuppressWarnnings 用于通知Java编译器关闭对特定类、方法、成员变量、变量初始化的警告。此种警告一般代表了可能的程序错误&＃xff0c;例如当我们使用一个generic collection类而未提供它的类型时&＃xff0c;编译器将提示“unchecked warning”的警告。通常当这种情况发生时&＃xff0c;我们需要查找引起警告的代码&＃xff0c;如果它真的表示错误&＃xff0c;我们就需要纠正它。然而&＃xff0c;有时我们无法避免这种警告&＃xff0c;例如&＃xff0c;我们使用必须和非generic的旧代码交互的generic collection类时&＃xff0c;我们无法避免这个unchecked warning&＃xff0c;此时可以在调用的方法前增加&＃64;SuppressWarnnings通知编译器关闭对此方法的警告。

&＃64;SuppressWarnnings不是标记型Annotation&＃xff0c;它有一个类型为String[]的成员&＃xff0c;这个成员的值为被禁止的警告名。常见的警告名为下。

• unchecked 执行了未检查的转换时的警告。例如当使用集合时没有用泛型来指定集合的类型
• finally finally子句不能正常完成时的警告
• fallthrough 当switch程序块直接通往下一种情况而没有break时的警告
• deprecation 使用了弃用的类或者方法时的警告
• seriel 在可序列化的类上缺少serialVersionUID时的警告
• path 在类路径、源文件路径等中有不存在的路径时的警告
• all 对以上所有情况的警告

• Annotation类型使用关键字&＃64;interface而非interface。注意开头的&＃64;符号
• Annotataion的方法定义是受限制的。其方法必须声明为无参数、无异常抛出的。这些方法同时也定义了Annotation的成员——方法名即为成员名&＃xff0c;而方法返回类型即为成员类型。方法返回类型必须为Java基础类型、Class类型、枚举类型、Annotation类型或者相应的一维数组。方法后面可以使用default关键字和一个默认数值来声明成员的默认值&＃xff0c;null不能作为成员默认值。成员一般不能是泛型&＃xff0c;只有当其类型是Class时可以使用泛型&＃xff0c;因为此方法能够用类型转换将各种类型转换为Class
• Annotation和interface都可以定义常量、静态成员类型&＃xff0c;也都可以被实现或者继承