Java Annotation

http://www.javachen.com/2010/01/java5-annotation/

 

http://www.blogjava.net/ericwang/archive/2005/12/13/23743.html

 

 

 

3 Built-in annotation:

• Override
• Deprecated
• SuppressWarnings - @SuppressWarnings(value={"unchecked"})

 

Java中还提供了四种 meta-annotations，专门负责释其他的注释

 

@Target 表示该注释可以用于什么地方。可用的ElementType参数包括：
CONSTRUCTOR : 构造器的声明
FIELD : 域声明（包括enum实例）
LOCAL_VARIABLE : 局部变量声明
METHOD : 方法声明
PACKAGE : 包声明
PARAMETER : 参数声明
TYPE : 类、接口 （包括注解类型) 或enum声明

 

 

@Retention 表示需要在什么级别保存该注释信息。可选的RetentionPoicy参数包括：
SOURCE : 注释将被编译器丢掉
CLASS : 注释在class文件中可用，但会被VM丢弃
RUNTIME : VM将在运行时也保留注释，因此可以通过反射机制读取注释的信息。要想使用反射得到注释信息，这个注释必须使用

 

@Documented 将注释包含在JavaDoc中

@Inheried 允许子类继承父类中的注释。

 

 

 

自定义Annotation

 

package com.javachen.annotation; import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Inherited; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** * 用户自定义标签,带有成员变量的MyTag */ @Documented //将注释包含在JavaDoc中 @Inherited //允许子类继承父类中的注释。 @Target(value = {ElementType.METHOD,ElementType.CONSTRUCTOR})//标注这个注释使用的范围 @Retention(value = RetentionPolicy.RUNTIME)//要想使用反射得到注释信息，这个注释必须使用 public @interface MyTag { String name() default "javachen";//给自定义注释类的成员加上默认值 int age() default 24; } package com.javachen.annotation; import java.lang.annotation.Annotation; public class TagTest { @MyTag(name = "MyTag", age = 1) public void test() { } @Override //可以保证编译时候Override函数的声明正确性 public String toString() { return super.toString(); } @Deprecated //对不应再使用的方法进行注解 public String notToUse() { return super.toString(); } public static void main(String[] args) { TagTest tt = new TagTest(); try { Annotation[] annotation = tt.getClass().getMethod("test") .getAnnotations(); for (Annotation tag : annotation) { System.out.println("Tag is:" + tag); System.out.println("tag.name()" + ((MyTag) tag).name()); System.out.println("tag.age()" + ((MyTag) (tag)).age()); } } catch (NoSuchMethodException e) { e.printStackTrace(); } } }

 

Customized Annotation

/** * Describes the Request-For-Enhancement(RFE) that led * to the presence of the annotated API element. */ public @interface RequestForEnhancement { int id(); String synopsis(); String engineer() default "[unassigned]"; String date(); default "[unimplemented]"; } @RequestForEnhancement( id = 2868724, synopsis = "Enable time-travel", engineer = "Mr. Peabody", date = "4/1/3007" ) public static void travelThroughTime(Date destination) { ... }

 

 

 

Simple Annotation

public @interface Preliminary { } @Preliminary public class TimeTravel { ... }

 

 

如果在annotations中只有唯一一个成员，则该成员应命名为value

public @interface Copyright { String value(); } @Copyright("2002 Yoyodyne Propulsion Systems") public class OscillationOverthruster { ... }