Java学习笔记（52）-----------Annotation（注释）第一篇

从JDK1.5开始，Java中增加了对元数据(MetaData)的支持，也就是Annotation(注释)，这种Annotation与Java程序中的单行注释和文本注释是有一定区别，也有一定联系的。其实，我们现在说的Annotation是代码里的特殊标记，这些标记可以在编译，类加载，运行时被读取，并执行相应的处理。通过Annotation，程序开发人员可以在不改变原来逻辑的情况下，在源文件嵌入一些补充的信息。代码分析工具，开发工具和部署工具可通过这些补充信息进行验正或者部署。

　　Annotation提供了一条为程序元素设置元素的方法，从某些方面来看，Annotation就象修饰符一样被使用，可用于修饰包，类，构造器，方法，成员变量，参数，局部变量的声明，这些信息被存在Annotation的"name=value"对中。

注意

  　　Annotation是的一个接口，程序可以通过反射来获取指定程序元素的Annotation对象，然后通过Annotation对象来取得注释里的元数据。我们需要注意使用Annotation的地方，有的Annotation指的是java.lang.Annotation接口，有的指的是注释本身.
  
　　Annotation能被用来为程序元素(类，方法，成员变量)设置元数据。值得指出的是：Annotation不能影响程序代码的执行，无论增加，删除Annotation，代码都始终如一地执行。如果希望让程序中的Annotation能在运行时起一定的作用，只有通过某种配套的工具对Annotation中的信息进行访问和处理，访问和处理Annotation的工具统称为APT(Annotation Processing Tool).

一.基本Annotation
　　Annotation必须使用工具来处理，工具负责读取Annotation里包含的元数据，工具还会根据这些元数据增加额外的功能。在系统学习新的Annotation语法之前，先看一下Java提供的三个基本Annotation的用法:使用Annotation时要在其前面增加@符号，并把该Annotation当成一个修饰符使用，用于修饰它支持的程序元素.

三个基础的Annotation如下

@Override
@Deprecated
@SuppressWarings

 

(这三个基本的Annotation都定义在java.lang包下)

下面我们来依次这三个Annotation的用法

(1)限定重写父类方法 @Override
　　@Override就是用来指定方法覆盖的，它可以强制一个子类必须覆盖父类的方法。如下程序中使用@Override指定子类Apple的info方法必须重写父类方法
注意： @Override Annotation只能用于作用于方法，不能用于作用于其它程序元素

实例：

[java] view plaincopy

1. <span style="font-size:18px;">class Shape{  
2.    
3.    void draw(){  
4.    
5.       System.out.println("形状");  
6.    
7.    }  
8.    
9. }  
10.    
11. class Circle extends Shape{  
12.    
13.    //将@Override省略效果相同  
14.    
15.    @Override  
16.    
17.    void draw() {  
18.    
19.       System.out.println("圆形");  
20.    
21.    }  
22.    
23. }  
24. </span>  

 

[java] view plaincopy

1. <span style="font-size:18px;">public class  Fruit  
2. {  
3.  public void info()  
4.  {  
5.   System.out.println("水果的info方法...");  
6.  }  
7. }  
8.   
9.   
10. class Apple extends Fruit  
11. {  
12.  @Override  
13.  public void info()  
14.  {  
15.   System.out.println("苹果重写水果的info方法...");  
16.  }  
17. }  
18.   
19. </span>  

作用：

编译上面程序，可能丝毫看不出程序中@Override有任何作用。因为@Override Annotation的作用是告诉编译器检查这个方法，并从父类查找是否包含一个被该方法重写的方法，否则就编译出错。这个Annotation主要是帮助我们避免一些低级错务，例如我们把上面的Apple类中的info方法不小心写成inf0()方法，这样的“低级错务”，可能导致后期排错时的巨大障碍。

 

(2)标记已过时 @Deprecated
@Deprecated 用于表示某个程序元素(类，方法等)已过时，当其它程序使用已过时的类，方法时，编译器将会出现警告。如下程序指定Apple类中的info方法已过时，其它程序中使用Apple类的info方法时编译器将会出给出警告。

 

实例：

[java] view plaincopy

1. <span style="font-size:18px;">public classTest{  
2.    
3.    public static void main(String[] args) {  
4.    
5.       //下面调用shape的draw方法时，编译器会给出警告  
6.    
7.       new Shape().draw();  
8.    
9.    }  
10.    
11. }  
12.    
13.    
14.    
15. class Shape{  
16.    
17.    @Deprecated  
18.    
19.    void draw(){  
20.    
21.       System.out.println("画一个形状");  
22.    
23.    }  
24.    
25. }  
26. </span>  

 

 

[java] view plaincopy

1. <span style="font-size:18px;">class Apple  
2. {  
3.  //定义info方法已过时  
4.  @Deprecated  
5.  public void info()  
6.  {  
7.   System.out.println("Apple的info方法");  
8.  }  
9. }  
10. public class DeprecatedTest  
11. {  
12.  public static void main(String[] args)  
13.  {  
14.   //下面使用info方法时将会被编译器警告  
15.   new Apple().info();  
16.  }   
17. }  
18. </span>  

[java] view plaincopy

1. <span style="font-size:18px;"> </span>  

　

(3)@SuppressWarnings 抑制编译器警告
　　@SupressWarnings指示被Annotation标识的程序元素(以及在程序元素中的所有子元素)取消显示指定的编译器警告。 @SuppressWarnings会一直作用于该程序元素的所有子元素，例如使用@SuppressWarning标识一个类来取消某个编译器警告，同时又标识该类里某个方法取消另一个编译器警告，那么将在此方法中同时取消这两个编译器警告。

　　通常情况下，如果程序中使用没有泛型限制的集合将会引起编译器警告，为了避免这种编译器警告，可以使用@SuppressWarnings Annotation，下面程序取消了没有使用泛型的编译器警告。

 

[java] view plaincopy

1. <span style="font-size:18px;color:#000000;">@SuppressWarnings(value="unchecked")  
2. public class SuppressWarningsTest  
3. {  
4.  public static void main(String[] args)  
5.  {  
6.   List<String> myList = new ArrayList();    
7.  }   
8. }</span>  

 

[java] view plaincopy

1. <span style="font-size:18px;">//关闭整个类里的编译器警告  
2.    
3. @SuppressWarnings("unchecked")  
4.    
5. public class Test{  
6.    
7.    public static void main(String[]args) {  
8.    
9.       List<String> tempList = new ArrayList();  
10.    
11.    }  
12.    
13. }  
14. </span>  

 

说明：
　　a.程序中使用@SuppressWarnings来关闭SuppressWarningTest类里的所有编译器警告，编译上面程序时将不会看到任何编译器警告。

 

       b.当我们使用@SuppressWarnings Annotation来关闭编译器警告时，一定要在插号里使用name=value对来为该Annotation的成员变量设置值.

 

 

二.自定义Annotation
　　前面已经介绍了如何使用java.lang包下的三个标准Annotation。下面介绍如何定义 Annotation，并利用Annotation完成一些实际的功能。

(1)定义Annotation
　　定义新的Annotation类型时使用@interface关健字(在原有的interface关健字前增加@符号),它用于定义新的Annotation类型。定义一个新的Annotation类型与定义一个接口非常像。

如下代码定义一个简单的Annotation

[java] view plaincopy

1. <span style="font-size:18px;">//使用@Test修饰类定义  
2. @Test  
3. public class MyClass  
4. {  
5. ...  
6. }</span>  

　　定义该Annotation之后，就可以在程序任何地方使用该Annotation ,使用Annotation时的语法非常类似于public ,final这样的修饰符，通常可以用于修饰程序中的类，方法，变量，接口等定义。
　　通常我们会把Annotation放在所有修饰符之前，而且由于使用Annotation时可能还需要为其它成员变量指定值，因而Annotation的长度可能较长，所以通常把Annotaion另放一行.
如

[java] view plaincopy

1. <span style="font-size:18px;">//使用@Test修饰类定义  
2. @Test  
3. public class MyClass  
4. {  
5. ...  
6. }</span>  

 默认情况下，Annotation可用于修饰任何元素，包括类，接口，方法等。如下程序使用@TestAnnotation来修饰方法

 

[java] view plaincopy

1. public class MyClass  
2. {  
3.    //使用@TestAnnotation修饰方法  
4.    @Test  
5.    public void info()  
6.    {  
7.  ...  
8.    }  
9. }  

Annotation不仅可以是这种简单的Annotation,Annotation还可以带用员变量，Annotation的成员变量在Annotation定义中以无参数来声明。其方法和返回值定义了该成员的名字和类型。

如下代码可以定义一个有成员变量的Annotation
public @interface MyTag
{
    //定义两个成员变量Annotation
    //Annotation中的成员变量以方法的形式来定义
    String name();
    int age();
}

　

 

　仔细观察：上面定义Annotation的代码与定义接口的语法非常像，只是上面MyTag使用@interface关健字来定义，而接口使用interface来定义

　一旦在Annotation里定义了成员变量之后，使用该Annotation时应该为该Annotation的成员变量指定值，

 

如下代码所示

public class Test
{
    //使用带成员变量的Annotation时，需要为成员变量付值
    MyTag(name='heyitang',age=30)
    public void info()
    {
 ...
    }
}

　　我们还可以在定义Annotation的成员变量时为其指定初始值，指定成员变量的初始值可使用default关健字。如下代码定义了MyTag Annotaion，该Annotation里包含了两个成员:name和age,这两个成元变量使用default指定了默认值
public @interface MyTag
{
   //定义了两个成员变量的Annotaion
   //以default为两个成员变量指定初始值
   String name() default "yeeku";
   int age() default 32;
}
 
　　如果为Annotation的成员变量指定了默认值，使用该Annotation则可以不为这些成员变量指定值，而是直接使用默认值，如下代码所示
public class Test
{
    //使用带成员变量的Annotation
    //因为它的成员变量有默认值，所以可以无须为成员变量指定值
    @MyTag
    public void info()
    {
        ...
    }
}

    当然我们介绍的Annotation是否可以包含成员指定值，如果MyTag为的成员变量指定了值，则默认值不会起作用

    总结
       根据我们介绍的Annotation是否可以包含成员变量，我们可以把Annotation分为如下两类
       1.标记Annotation:一个没有成员变量的Annotation类型被称为标记。这种Annotation仅合使用自身的存在与否来为我们提供信息。如前面介绍的@Override,@Test等Annotation
       2.元数据Annotation:那些包含成员变量的Annotation,因为它们可接受更多元数据，所以也被称为元数据Annotation

 

(2)提取Annotation
　　前面已经提到：JAVA使用Annotation接口来代表元素前面的注释，该接品是所有Annotation类型的父接口。除此之外，JAVA在java.lang.reflect包下新增了AnnotationElement接口，该接口代表程序中可以接受注释的程序元素，该接口主要有如下几个实现类.

    Class:类定义
    Constructor:构造器定义
    Field:类的成员变量定义
    Method:类的方法定义
    Package:类的包定义

    AnnotationElement接口是所有程序元素(如Class,Method,Constructor)的父接口，所以程序通过反射获取某个类的了AnnotationElement对象(如Class,Method,和Constructor)之后，程序就可以调用该对象的如下三个方法来访问Annotation信息

    getAnnotation(Class<T> annotationClass):返回该程序元素上存在的，指定类型的注释
    Annotation[] getAnnotations:返回该程序元素上存在的所有注释
    boolean isAnnotationPreset(Class<? extends Annotation> annotationClass):判断该程序元素上是否包含指定类型的注释，存在则返回true,否则返回false

 

(3)使用Annotation的例子
　　下面介绍两个使用Annotation的例子，第一个Annotation Testable没有任何成员变量，仅是一个标记Annotation，它的作用是标记哪些方法是可测试的.
Testable.java源文件。

 

[java] view plaincopy

1. Testable.java源文件  
2.   
3. import java.lang.annotation.*;  
4.    
5. @Retention(RetentionPolicy.RUNTIME)     
6. @Target(ElementType.METHOD)  
7. //定义Testable Annotation将被javadoc工具提取  
8. @Documented  
9. public @interface Testable  
10. {  
11. }  

 

上面程序定义了一个标记Testable Annotation，定义该Annotation时使用了@Retention和@Target两个系统元注释，其中@Retention注释指明Testabel注释可以保留多久，而@Target注释指定Testable能修饰的目标（只能是方法）。

 

 

　　如下MyTest测试用例里定义了8个方法，这8个方法没有太大的区别，其中四个方法使用@testable注释来标记这些方法是可测试的

 

[java] view plaincopy

1. public class MyTest  
2. {  
3.  //使用@Testable标记注释指定该方法是可测试的  
4.  @Testable  
5.  public static void m1()  
6.  {  
7.  }  
8.  public static void m2()  
9.  {  
10.  }    
11.  //使用@Testable标记注释指定该方法是可测试的  
12.  @Testable  
13.  public static void m3()  
14.  {         
15.   throw new RuntimeException("Boom");   
16.  }  
17.  public static void m4()  
18.  {  
19.  }        
20.  //使用@Testable标记注释指定该方法是可测试的  
21.  @Testable  
22.  public static void m5()  
23.  {  
24.  }   
25.     public static void m6()  
26.  {  
27.  }  
28.  //使用@Testable标记注释指定该方法是可测试的  
29.  @Testable  
30.  public static void m7()  
31.  {             
32.   throw new RuntimeException("Crash");    
33.  }         
34.  public static void m8()  
35.  {  
36.  }  
37. }  

 

正如前面提到的，仅仅使用注释来标记程序元素对程序是不会有任何影响的，这也是注释的一条重要原则，为了让程序中这些注释起作用，我们必须为这些注释提供一个注释处理工具。

 

下面的注释处理工具分析目标类，如果目标类中方法使用了@Testable注释修饰，则通过反射来运行该测试方法

 

[java] view plaincopy

1. import java.lang.reflect.*;  
2. public class TestProcessor  
3. {  
4.  public static void process(String clazz)  
5.   throws ClassNotFoundException  
6.  {  
7.   int passed = 0;  
8.   int failed = 0;  
9.   //遍历obj对象的所有方法  
10.   for (Method m : Class.forName(clazz).getMethods())  
11.   {  
12.    //如果包含@Testable标记注释  
13.    if (m.isAnnotationPresent(Testable.class))  
14.    {  
15.     try  
16.     {  
17.      //调用m方法  
18.      m.invoke(null);  
19.      //passed加1  
20.      passed++;  
21.     }  
22.     catch (Exception ex)  
23.     {  
24.      System.out.printf("方法" + m + "运行失败，异常：" + ex.getCause() + "\n");  
25.      failed++;  
26.     }  
27.    }  
28.   }  
29.   //统计测试结果  
30.   System.out.printf("共运行了:" + (passed + failed)+ "个方法，其中：\n" +  
31.    "失败了:" + failed + "个，\n" +   
32.    "成功了:" + passed + "个！\n");  
33.  }  
34. }  

 

参考博文：http://blog.sina.com.cn/s/blog_4c925dca0100hseu.html

                 http://blog.csdn.net/zhai56565/article/details/40503743