Java注解

一、什么是注解

注解是J2SE5.0中的新特性之一。加了注解就等于打上了某种标记,没加,则等于没有某种标记,以后,javac编译器,开发工具包和其他程序可以用反射来了解你的类以及各种元素上有何种标记,看你有什么标记,就去干相应的事,标记可以加载包,类,字段,方法,方法的参数以及局部变量上。

二、J2SE5.0中预定义的注解

在J2SE5.0的java.lang包中预定义了三个注解。它们是Override、Deprecated和SuppressWarnings。下面分别解解它们的含义。

(1) @SuppressWarnings   再程序前面加上可以在javac编译中去除警告–阶段是SOURCE
(2) @Deprecated   带有标记的包,方法,字段说明其过时—-阶段是SOURCE
(3)@Overricle   打上这个标记说明该方法是将父类的方法重写–阶段是SOURCE

三、如何自定义注解

注解的强大之处是它不仅可以使java程序变成自描述的,而且允许程序员自定义注解。注解的定义和接口差不多,只是在interface前面多了一个“@”。

1
2
3
4
public @interface MyAnnotation
{

}

上面的代码是一个最简单的注解。这个注解没有属性。也可以理解为是一个标记注解。就象Serializable接口一样是一个标记接口,里面未定义任何方法。

当然,也可以定义而有属性的注解。

1
2
3
4
public @interface MyAnnotation
{
    String value();
}

可以按如下格式使用MyAnnotation

1
2
3
4
@MyAnnotation(“abc”)
public void myMethod()
{
}

看了上面的代码,大家可能有一个疑问。怎么没有使用value,而直接就写”abc”了。那么”abc”到底传给谁了。其实这里有一个约定。如果没有写属性名的值,而这个注解又有value属性,就将这个值赋给value属性,如果没有,就出现编译错误。

除了可以省略属性名,还可以省略属性值。这就是默认值。

1
2
3
4
public @interface MyAnnotation
{
     public String myMethod() default "xyz";
}

可以直接使用MyAnnotation

1
2
3
4
5
@MyAnnotation // 使用默认值xyz
public void myMethod()
{

}

如果要使用多个属性的话。可以参考如下代码。

1
2
3
4
5
6
public @interface MyAnnotation
{
   public enum MyEnum{A, B, C}
   public MyEnum value1();
   public String value2();
}
1
2
3
4
@MyAnnotation(value1=MyAnnotation.MyEnum.A, value2 = “xyz”)
public void myMethod()
{
}

四、如何对注解进行注解

使用普通注解对注解进行注解的方法和对类、接口进行注解的方法一样。所不同的是,J2SE5.0为注解单独提供了4种注解,即元注解。

元注解理解:

注解可以用于注解类(annotate Classes)

可以用于注解接口(annotate Interfaces)

可以用于注解枚举类型(annotate Enums)

因此注解同样也可以用于注解注解(annotate Annotations)

它们是Target、Retention、Documented和Inherited。下面就分别介绍这4种注解。

@Target

未设置@Target,则表示适用于所有的程序元素。枚举类ElementType中的枚举常量用来设置@Targer,枚举类ElementType中的枚举常量如下:

ANNOTATION_TYPE–表示用于Annotation类型
TYPE–表示用于类,接口和枚举,以及Annotation类型
CONSTRUCTOR–用于构造方法
FIELD–用于枚举常量或成员变量
METHOD–表示用于方法
FARAMETER–表示用于参数
LOCAL_VARIABLE–表示用于局部变量
PACKAGE–表示用于包

@Retention

设置Annotation的有效范围,也就是Annotation有三个阶段如下
@Retention(RetentionPolicy.RUNTIME)
枚举类RetentionPolicy中的枚举常量
(1)SOURCE–表示不编译Annotation到类文件中。有效范围最小
(2)CLASS–表示编译Annotation到类文件中,但在运行时不加载Annotation到jvm中(默认值再CLASS阶段)
(3)0RUNTIME–表示运行时加载Annotation到JVM中,有效范围最大。

@Documented

这个注解和它的名子一样和文档有关。在默认的情况下在使用javadoc自动生成文档时,注解将被忽略掉。如果想在文档中也包含注解,必须使用Documented为文档注解。

@Inherited

继承是java主要的特性之一。在类中的protected和public成员都将会被子类继承,但是父类的注解会不会被子类继承呢?很遗憾的告诉大家,在默认的情况下,父类的注解并不会被子类继承。如果要继承,就必须加上Inherited注解。

五、如何使用反射读取注解

在以前的JDK版本中,我们可以使用反射得到类的方法、方法的参数以及其它的类成员等信息。那么在J2SE5.0中同样也可以象方法一样得到注解的各种信息。

在使用反射之前必须使用import java.lang.reflect.* 来导入和反射相关的类。

如果要得到某一个类或接口的注解信息,可以使用如下代码:

Annotation annotation = TestAnnotation.class.getAnnotation(MyAnnotation.class);

如果要得到全部的注解信息可使用如下语句:

Annotation[] annotations = TestAnnotation.class.getAnnotations();

Annotation[] annotations = TestAnnotation.class.getDeclaredAnnotations();

getDeclaredAnnotations与getAnnotations类似,但它们不同的是getDeclaredAnnotations得到的是当前成员所有的注解,不包括继承的。而getAnnotations得到的是包括继承的所有注解。

注:要想使用反射得到注解信息,这个注解必须使用

@Retention(RetentionPolicy.RUNTIME)进行注解。

六、注解的本质:注解是一种类型

JDK5.0中的类型:1、类(class)2、接口(interface)3、枚举(enum)4、注解(Annotation)

因此,注解与其他3种类型一样,都可以定义、使用,以及包含有自己的属性、方法。

七、注解的分类:

(1)标记注释:注解的内部没有属性,称作标记注解

使用方法:@注解名

使用例子:@MarkAnnotation

(2)单值注解:注解的内部只有一个属性,称作单值注解

使用方法:@注解名(属性名=属性值)

使用例子:@SingleAnnotation(value=”abc”)  //也可以写成@SingleAnnotation(“abc”)

*(属性名=属性值)可以简化为(属性值),但是需要满足以下两个条件:

1、该注解必须为单值注解

2、该注解的属性名必须为value

(3)多值注解:注解的内部有多个属性,称作多值注解

使用方法:@注解名(属性名1=属性值1, 属性名2=属性值2……)

使用例子:@MultipliedAnnotation(value1 = “abc”, value2 = 30……)

八、自动测试机的写法:

自动测试机的原理:

使用Annotation来Annotate元素的实质是:每一个ElementType内部的元素都有两个方法,分别为

(注:为方便理解,以下使用的TestCase为某个特定的自定义注释)

(1)isAnnotationPresent(TestCase.class)  //判断该元素是否被TestCase所注释

(2)getAnnotation(TestCase.class)  //获得TestCase的类对象

因此,自动测试机的工作过程是:

(1)首先通过反射,获得被测类o中的每一个方法

(2)对每一个方法通过使用isAnnotationPresent(TestCase.class)判断其是否被TestCase所注释(注意是.class!)

(3)如果某方法method被TestCase所注释,则通过method的getAnnotation(TestCase.class)获得TestCase的类对象tc

(4)通过tc的value()方法,获得该类对象的属性value

(注:此处使用的value()方法,正是在TestCase中定义的value属性,再次理解在注释中定义的value既是属性,也是方法

(5)调用method方法的invoke(o,value),用value对method进行测试

总结

注解是J2SE5.0提供的一项非常有趣的功能。它不但有趣,而且还非常有用。如即将出台的EJB3.0规范就是借助于注解实现的。这样将使EJB3.0在实现起来更简单,更人性化。还有Hibernate3.0除了使用传统的方法生成hibernate映射外,也可以使用注解来生成hibernate映射。总之,如果能将注解灵活应用到程序中,将会使你的程序更加简洁和强大。

 

以上部分摘自网络。

除非注明,饮水思源博客文章均为原创,转载请以链接形式标明本文地址

本文地址:http://www.alonemonkey.com/java-annotation.html

本文链接:http://www.alonemonkey.com/java-annotation.html