Java Annotation之应用篇 – 运行期动态解析annotation (3)

annotation。

我们在前2篇文章中：

Java Annotation之介绍篇 （1）

Java Annotation之自定义篇 （2）

分别介绍了annotation的基本概念，以及怎么样自定义annotation。

本文介绍怎么在运行期（runtime）动态解析annotation。

上面我们介绍过，annotation只是附加在代码里的附加信息，annotation本身不会对代码的执行产生任何影响。

这样说来，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的原理与使用方法，这里不做详述。

本文通过一个简单地例子来说明怎么在运行期动态解析annotation。Apt工具的使用我们会在近期其他文章里对其加以介绍。

比如，我们定义了MyAnnotation3注释： MyAnnotation3.java view plaincopy to clipboardprint? 1. package com.test.annotation; 2. 3. import java.lang.annotation.Annotation; 4. import java.lang.annotation.Inherited; 5. import java.lang.annotation.Retention; 6. import java.lang.annotation.RetentionPolicy; 7. 8. @Retention(RetentionPolicy.RUNTIME) 9. public @interface MyAnnotation3 { 10. public String value(); 11. public String[] multiValues(); 12. int number() default 0; 13. } 上面定义了一个名为MyAnnotation3的注释。 我们再定义一个GetMyAnnotation类，该类使用了MyAnnotation3注释： GetMyAnnotation.java： view plaincopy to clipboardprint? 1. package com.test.annotation.test; 2. 3. import java.lang.annotation.Annotation; 4. import java.lang.reflect.Field; 5. import java.lang.reflect.Method; 6. 7. import javax.ejb.EJB; 8. import javax.naming.InitialContext; 9. import javax.naming.NamingException; 10. 11. import com.test.annotation.MyAnnotation3; 12. 13. // 为GetMyAnnotation类附加MyAnnotation3 注释 14. @MyAnnotation3(value = \"Class GetMyAnnotation\", multiValues = {\"1\",\"2\"}) 15. public class GetMyAnnotation { 16. // 为testField1属性附加MyAnnotation3 注释 17. @MyAnnotation3(value = \"call testField1\", multiValues={\"1\"}, number = 1) 18. private String testField1; 19. 20. // 为testMethod1方法附加MyAnnotation3 注释 21. @MyAnnotation3(value = \"call testMethod1\", multiValues={\"1\", \"2\"}, number = 1) 22. public void testMethod1() { 23. 24. } 25. 26. @Deprecated 27. @MyAnnotation3(value = \"call testMethod2\", multiValues={\"3\", \"4\", \"5\"}) 28. public void testMethod2() { 29. 30. } 31. } 上面的例子GetMyAnnotation非常简单，里面没有任何功能，但是分别为类（class），属性（field），方法（method）申明（附加）了MyAnnotation3 注释。 下面我们用程序TestMyAnnotation3对GetMyAnnotation里MyAnnotation3注释进行解析。 运行时解析annotation TestMyAnnotation3.java view plaincopy to clipboardprint? 1. public class TestMyAnnotation3 { 2. 3. public static void main(String[] args) { 4. System.out.println(\"--Class Annotations--\"); 5. if (GetMyAnnotation.class.isAnnotationPresent(MyAnnotation3.class)) { 6. System.out.println(\"[GetMyAnnotation].annotation:\"); 7. MyAnnotation3 classAnnotation = GetMyAnnotation.class.getAnnotation(MyAnnotation3.class); 8. printMyAnnotation3(classAnnotation); 9. } 10. 11. 12. System.out.println(\"--Fields Annotations--\"); 13. Field [] fields = GetMyAnnotation.class.getDeclaredFields(); 14. for (Field field : fields) { 15. if (field.isAnnotationPresent(MyAnnotation3.class)) { 16. System.out.println(\"[GetMyAnnotation.\" + field.getName() + \"].annotation:\"); 17. MyAnnotation3 fieldAnnotation = field.getAnnotation(MyAnnotation3.class); 18. printMyAnnotation3(fieldAnnotation); 19. } 20. } 21. 22. System.out.println(\"--Methods Annotations--\"); 23. Method[] methods = GetMyAnnotation.class.getDeclaredMethods(); 24. for (Method method : methods) { 25. System.out.println(\"[GetMyAnnotation.\" + method.getName() + \"].annotation:\"); 26. if (method.isAnnotationPresent(MyAnnotation3.class)) { 27. MyAnnotation3 methodAnnotation = method.getAnnotation(MyAnnotation3.class); 28. printMyAnnotation3(methodAnnotation); 29. } 30. } 31. } 32. 33. private static void printMyAnnotation3(MyAnnotation3 annotation3) { 34. if (annotation3 == null) { 35. return; 36. } 37. 38. System.out.println(\"{value=\" + annotation3.value()); 39. 40. String multiValues = \"\"; 41. for (String value: annotation3.multiValues()) { 42. multiValues += \ + value; 43. } 44. 45. System.out.println(\"multiValues=\" + multiValues); 46. 47. System.out.println(\"number=\" + annotation3.number() + \); 48. } 49. }

输出：

--Class Annotations--

[GetMyAnnotation].annotation:

{value=Class GetMyAnnotation

multiValues=,1,2

number=0}

--Fields Annotations--

[GetMyAnnotation.testField1].annotation:

{value=call testField1

multiValues=,1

number=1}

--Methods Annotations--

[GetMyAnnotation.testMethod1].annotation:

{value=call testMethod1

multiValues=,1,2

number=1}

[GetMyAnnotation.testMethod2].annotation:

{value=call testMethod2

multiValues=,3,4,5

number=0}

JDK1.5以后的版本提供的跟annotation有关的接口：

view plaincopy to clipboardprint?

1. interface java.lang.reflect.AnnotatedElement {

2. boolean isAnnotationPresent(Class annotationClass); 3. T getAnnotation(Class annotationClass); 4. Annotation[] getAnnotations();

5. Annotation[] getDeclaredAnnotations(); 6. }

该接口主要用来取得附加在类（class），构造方法（constructor），属性（field），方法（method），包（package）上的annotation

信息。

JDK1.5与此有关的几个类都实现了AnnotatedElement接口：

java.lang.reflect.AccessibleObject,

java.lang.reflect.Class,

java.lang.reflect.Constructor,

java.lang.reflect.Field,

java.lang.reflect.Method,

java.lang.reflect.Package

所以可以利用反射（reflection）功能在程序里动态解析附加的annotation信息。

总结：

本文通过举例简单地说明了怎么动态解析annotation，大家可以举一反三，利用Java的annotation特性，完成更复杂功能等。