java annotation使用

http://hi.baidu.com/yangkunlhaoyun/blog/item/1ea9e37fdc6c1e330dd7dad7.html

 

(0)
JAVA从J2SE5开始提供名为annotation（注释，标注）的功能。Java的annotation，可以附加在package, class, method, field等上面，相当于给它们添加了额外的辅助信息。 附加在package, class, method, field等上的Annotation，如果没有外部解析工具等对其加以解析和处理的情况，本身不会对Java的源代码或class等产生任何影响，也不会对它们的执行产生任何影响。

这样说来，annotation到底能起什么作用呢？
1，     编译工具或其他工具可以根据被附加在代码里的annotation信息 自动生成配置文件或文档等外部文件。
比如，sun公司就提供了apt（Annotation Processing Tool）工具，apt工具是一个可以处理annotation的命令行工具，apt提供了在编译期针对源代码级别的解析，并可以在解析时生成新的源代码和其他文件，同时还可以对生成的源代码进行编译。
2，     其他程序可以在 运行时动态解析将要被执行的程序里的annotation信息，并根据被附加的annotation信息来执行不同的操作。
比如，EJB3规范就比较广泛地使用了annotation特性。比如只要在POJO为class注明@Stateless注释，EJB容器便会根据此 annotation把该POJO注册为无状态的Session Bean。EJB3使用了annotation大大地简化了EJB的开发和配置过程。我们会在其他文章里专门介绍EJB Annotation的原理与使用方法，这里不做详述。

(1)
Java标准Annotation
@Deprecated 相当于Javadoc的@deprecated，被@Deprecated标注的对象class, method等被注明为不推荐使用。主要用于javac等编译工具。
@Override 注明对象method重载了父类的方法。javac等编译工具编译时会根据此Annotation判断重载方法是否正确。
@SuppressWarnings 告诉javac等编译器忽略所指定的特定的警告信息。
@Target 被定义的annotation可以附加在那些对象上。
@Retention annotation的作用期间。

如：
@Deprecated
public class TestBean {
    …
}

--------
    @SuppressWarnings("unchecked")
    @Test
    public void testtList() throws Exception {
        Map param = new HashMap();
        param.put("Date", "20100505");
        param.put("mde", "HKEX");
        param.put("inode", "0002");
        param.put("aId", "6");
        param.put("rFormat", "yyyymmdd");
        .....
    }
若不添加@SuppressWarnings("unchecked")，系统会提示map没泛化(Map<String,String> param = ...)的警告信息。

@SuppressWarnings("serial")
public class TestBean implements java.io.Serializable {
    …
}

@SuppressWarnings(value = {"serial", "unchecked"})
public String doSth() {
    …
}

----------
@Override
public String doSth() {
    …
}

(2)
定义方法：
@interface Annotation名 {定义体}
public @interface MyAnnotation {}  该例定义了一个无任何属性/方法的Annotation。

public @interface MyAnnotation {
    public String value();
}
该例定义了只有一个方法为value()的Annotation。一般来说，只有一个方法的Annotation，方法名一定定义为value。

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface MyAnnotation {
    public String value();
    public String [] multiValues();
    int number() default 0;
   
}
该例定义了一个具有多方法的Annotation。并设置其中一个方法number的默认值为0。multiValues 方法定义为数组类型。Annotation定义可以用MetaAnnotation（元注释）修饰。MetaAnnotation有以下2个：
@Retention
@Target

我们将在以下对@Retention与@Target加以说明。
请看： http://www.lifevv.com/tenyo/doc/20070711191153711.html

(3)
具有一个value方法Annotation范例：
public @interface MyAnnotation1 {   
    public String value();
}

@MyAnnotation1("hello")
public class TestMyAnnotation1 {
    @MyAnnotation1(value="world")
    public void testMethod() {
    }
}
可以通过@Annotation名(方法名1=值1, 方法名2=值2, …)的形式给annotation赋值。只有一个方法的时候，可以直接省略为：@Annotation名(值1) 的赋值形式。当方法返回一个数组时，可以用 方法名={值1, 值2, …}给其赋值。

(4)
复杂型annotation的定义与使用
public @interface MyAnnotation3 {
    public String value();
    public String[] multiValues();
    int number() default 0;
}
MyAnnotation3具有一个返回String的value方法，返回String[]的multiValues 方法；还有一个返回int 的number方法。其中number方法具有默认值0。

class TestMyAnnotation3 {
    @MyAnnotation3(value = "call testMethod1", multiValues={"1", "2"}, number = 1)
    public void testMethod1() {

    }

    @MyAnnotation3(value = "call testMethod2", multiValues={"1", "2"})
    public void testMethod2() {

    }
}
number具有默认值，所以标注时可以不为其赋值。其余方法则必须通过上面介绍的方法赋值。multiValues返回一个String[]数组，所以可以通过multiValues={"1", "2"}为其赋值。