本文转发自技术世界,原文连接 http://www.jasongj.com/2016/01/17/Java1_注解Annotationjava
本文介绍了Java Annotation的概念以及Java提供的四种Meta Annotation的功能,并结合实例详解了自定义Annotation的方法和注意事项。web
Annotation是Java5开始引入的特性。它提供了一种安全的相似于注释和Java doc的机制。事实上,Annotation已经被普遍用于各类Java框架,如Spring,Jersey,JUnit,TestNG。注解至关因而一种嵌入在程序中的元数据,可使用注解解析工具或者编译器对其进行解析,也能够指定注解在编译期或者运行期有效。这些元数据与程序业务逻辑无关,而且是提供指定的工具或者框架使用的。数组
元注解的做用就是负责注解其余注解。Java5定义了4个标准的Meta Annotation类型做说明。安全
@Target
说明了Annotation所修饰对象的范围:Annotation可被用于 packages、types(类、接口、枚举、Annotation类型)、类型成员(方法、构造方法、成员变量、枚举值)、方法参数和本地变量(如循环变量、catch参数)。在Annotation类型的声明中使用了@Target
可更加明晰其修饰的目标。
@Target
做用:用于描述注解的使用范围,即被描述的注解能够用在什么地方。
@Target
取值(ElementType)框架
CONSTRUCTOR:用于描述构造器 FIELD:用于描述域 LOCAL_VARIABLE:用于描述局部变量 METHOD:用于描述方法 PACKAGE:用于描述包 PARAMETER:用于描述参数 TYPE:用于描述类、接口(包括注解类型) 或enum声明
@Documented
用于描述其余类型的annotation应该被做为被标注的程序成员的公共API,所以能够被例如javadoc此类的工具文档化。@Documented
是一个标记注解,没有成员。ide
@Inherited是一个标记注解。若是一个使用了@Inherited修饰的annotation类型被用于一个class,则这个Annotation将被用于该class的子类。svg
在实际项目中,常常会碰到下面这种场景,一个接口的实现类或者抽象类的子类不少,常常须要根据不一样状况(好比根据配置文件)实例化并使用不一样的子类。典型的例子是结合工厂使用职责链模式。工具
此时,能够为每一个实现类加上特定的Annotation,并在Annotation中给该类取一个标识符,应用程序可经过该标识符来判断应该实例化哪一个子类。spa
下面这个例子,定义了一个名为Component的Annotation,它包含一个名为identifier的成员变量。code
/** * */
package com.IamWiam.annotation;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
import java.lang.annotation.Documented;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
@Inherited
@Documented
@Retention(RUNTIME)
@Target(TYPE)
/** * @author NST_Xx * */
public @interface Component {
String identifier() default "";
}
对于上文所说的实现类加上@Component
package com.IamWia;
import com.IamWiam.annotation.Component;
@Component(identifier="upper")
public class UpperCaseComponent {
public String doWork(String input){
if(input != null) {
return input.toUpperCase();
} else {
return null;
}
}
}
应用程序能够经过反射获取UpperCaseComponent对应的identifier
package com.IamWia;
import com.IamWiam.annotation.Component;
public class Client {
public static void main(String[] args) {
try {
Class<?> componentClass = Class.forName("com.IamWia.UpperCaseComponent");
if(componentClass.isAnnotationPresent(Component.class)) {
Component component = (Component)componentClass.getAnnotation(Component.class);
String identifier = component.identifier();
System.out.println(String.format("Identifier for "
+ "com.IamWia.UpperCaseComponent is ' %s '", identifier));
} else {
System.out.println("com.jasongj.UpperCaseComponent is not annotated by"
+ " com.jasongj.annotation.Component");
}
} catch (ClassNotFoundException ex) {
ex.printStackTrace();
}
}
}
结果以下:
若是把@Component的@Retention设置为 RetentionPolicy.SOURCE或者RetentionPolicy.CLASS,则会获得以下结果,验证了上文中对@Retention的描述
Annotation的语法比较简单,除了@符号的使用外,他基本与Java固有的语法一致,JavaSE中内置三个标准Annotation,定义在java.lang中:
一、@Override
是一个标记型Annotation,说明了被标注的方法覆盖了父类的方法,起到了断言的做用。若是给一个非覆盖父类方法的方法添加该Annotation,编译器将报编译错误。它有两个典型的使用场景,一是在试图覆盖父类方法却写错了方法名时报错,二是删除已被子类覆盖(且用Annotation修饰)的父类方法时报错。
二、@Deprecated
标记型Annotation,说明被修改的元素已被废弃并不推荐使用,编译器会在该元素上加一条横线以做提示。该修饰具备必定的“传递性”:若是咱们经过继承的方式使用了这个弃用的元素,即便继承后的元素(类,成员或者方法)并未被标记为@Deprecated,编译器仍然会给出提示。
三、@SuppressWarnnings
用于通知Java编译器关闭对特定类、方法、成员变量、变量初始化的警告。此种警告通常表明了可能的程序错误,例如当咱们使用一个generic collection类而未提供它的类型时,编译器将提示“unchecked warning”的警告。一般当这种状况发生时,咱们须要查找引发警告的代码,若是它真的表示错误,咱们就须要纠正它。然而,有时咱们没法避免这种警告,例如,咱们使用必须和非generic的旧代码交互的generic collection类时,咱们没法避免这个unchecked warning,此时能够在调用的方法前增长@SuppressWarnnings
通知编译器关闭对此方法的警告。
@SuppressWarnnings
不是标记型Annotation,它有一个类型为String[]的成员,这个成员的值为被禁止的警告名。常见的警告名为下。
unchecked 执行了未检查的转换时的警告。例如当使用集合时没有用泛型来指定集合的类型 finally finally子句不能正常完成时的警告 fallthrough 当switch程序块直接通往下一种状况而没有break时的警告 deprecation 使用了弃用的类或者方法时的警告 seriel 在可序列化的类上缺乏serialVersionUID时的警告 path 在类路径、源文件路径等中有不存在的路径时的警告 all 对以上全部状况的警告
Annotation与Interface的异同
@interface
而非interface。注意开头的@
符号