`

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

    博客分类:
  • Java
阅读更多

我们在前2篇文章中:

分别介绍了annotation的基本概念,以及怎么样自定义annotation
本文介绍怎么在运行期(runtime)动态解析annotation
上面我们介绍过,annotation只是附加在代码里的附加信息,annotation本身不会对代码的执行产生任何影响。

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

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

比如,我们定义了MyAnnotation3注释:
MyAnnotation3.java

  

package com.test.annotation;
import java.lang.annotation.Annotation;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation3 {
 public String value();
 public String[] multiValues();
 int number() default 0;
}

 

上面定义了一个名为MyAnnotation3的注释。
我们再定义一个GetMyAnnotation类,该类使用了MyAnnotation3注释:
GetMyAnnotation.java

 

 

package com.test.annotation.test;

import java.lang.annotation.Annotation;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import javax.ejb.EJB;
import javax.naming.InitialContext;
import javax.naming.NamingException;
import com.test.annotation.MyAnnotation3;

// 为GetMyAnnotation类附加MyAnnotation3 注释   
@MyAnnotation3(value = "Class GetMyAnnotation", multiValues = { "1", "2" })
public class GetMyAnnotation {

	// 为testField1属性附加MyAnnotation3 注释
	@MyAnnotation3(value = "call testField1", multiValues = { "1" }, number = 1)
	private String testField1;

	// 为testMethod1方法附加MyAnnotation3 注释
	@MyAnnotation3(value = "call testMethod1", multiValues = { "1", "2" }, number = 1)
	public void testMethod1() {
	}

	@Deprecated
	@MyAnnotation3(value = "call testMethod2", multiValues = { "3", "4", "5" })
	public void testMethod2() {
	}
}

  

上面的例子GetMyAnnotation非常简单,里面没有任何功能,但是分别为类(class),属性(field),方法(method)申明(附加)了MyAnnotation3 注释。
下面我们用程序TestMyAnnotation3GetMyAnnotationMyAnnotation3注释进行解析。
运行时解析annotation
TestMyAnnotation3.java

 

 

 

public class TestMyAnnotation3 {

	public static void main(String[] args) {

		System.out.println("--Class Annotations--");

		if (GetMyAnnotation.class.isAnnotationPresent(MyAnnotation3.class)) {
			System.out.println("[GetMyAnnotation].annotation:");

			MyAnnotation3 classAnnotation = GetMyAnnotation.class
					.getAnnotation(MyAnnotation3.class);
			printMyAnnotation3(classAnnotation);
		}
		System.out.println("--Fields Annotations--");

		Field[] fields = GetMyAnnotation.class.getDeclaredFields();

		for (Field field : fields) {

			if (field.isAnnotationPresent(MyAnnotation3.class)) {

				System.out.println("[GetMyAnnotation." + field.getName()
						+ "].annotation:");

				MyAnnotation3 fieldAnnotation = field
						.getAnnotation(MyAnnotation3.class);

				printMyAnnotation3(fieldAnnotation);
			}
		}
		System.out.println("--Methods Annotations--");

		Method[] methods = GetMyAnnotation.class.getDeclaredMethods();

		for (Method method : methods) {

			System.out.println("[GetMyAnnotation." + method.getName()
					+ "].annotation:");

			if (method.isAnnotationPresent(MyAnnotation3.class)) {

				MyAnnotation3 methodAnnotation = method
						.getAnnotation(MyAnnotation3.class);

				printMyAnnotation3(methodAnnotation);
			}
		}
	}

	private static void printMyAnnotation3(MyAnnotation3 annotation3) {

		if (annotation3 == null) {
			return;
		}
		System.out.println("{value=" + annotation3.value());
		String multiValues = "";

		for (String value : annotation3.multiValues()) {
			multiValues += "," + value;
		}

		System.out.println("multiValues=" + multiValues);

		System.out.println("number=" + annotation3.number() + "}");
	}
}

 

 

输出:

 

 

--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有关的接口:

 

 interface java.lang.reflect.AnnotatedElement {   

     boolean isAnnotationPresent(Class<? extends Annotation> annotationClass);   

    <T extends Annotation> T getAnnotation(Class<T> annotationClass);   

    Annotation[] getAnnotations();   

    Annotation[] getDeclaredAnnotations();   

 }   

 

 

该接口主要用来取得附加在类(class),构造方法(constructor),属性(field),方法(method),包(package)上的annotation信息。
JDK1.5
与此有关的几个类都实现了AnnotatedElement接口:
  

 

所以可以利用反射(reflection)功能在程序里动态解析附加的annotation信息。
总结:
本文通过举例简单地说明了怎么动态解析annotation,大家可以举一反三,利用Javaannotation特性,完成更复杂功能等。    

 

 

分享到:
评论

相关推荐

    Java annotation元注解原理实例解析

    Java annotation是Java语言中的一种元编程技术,用于在编译期或运行期提供元数据,以便简化代码、提高开发效率和程序的可读性。在这篇文章中,我们将深入探讨Java annotation的原理和实例解析,包括元注解的定义、...

    Annotation工作原理

    这些信息可以在编译期、运行期或加载期被读取和处理。 3.Annotation不能影响程序代码的执行,无论增加、删除Annotation,代码都始终如一的执行。这是因为Java虚拟机忽略了Annotation,只有通过某种配套的工具才会对...

    annotation详解

    注解(Annotation)是Java编程语言中的一个重要特性,自Java 5版本引入,它提供了一种安全的方法来将元数据与代码关联。元数据是关于数据的数据,可以用来提供程序的额外信息,如编译器提示、运行时检查、代码生成等...

    自定义运行期注解

    在Java编程语言中,自定义运行期注解(也称为元数据)是一种强大的工具,它允许程序员在代码中添加信息,这些信息可以在程序运行时被读取和处理。这种技术通常用于实现各种目的,如代码的验证、日志记录、性能分析等...

    java学习路径三篇

    11. **注解(Annotation)**:理解注解的作用,知道如何自定义注解以及如何在编译期或运行期处理注解。 12. **枚举(Enum)**:学习枚举类型,了解其优于常量的特性。 四、框架与工具 13. **Java EE**:了解Java...

    JAVA程序员必读基础篇.zip

    12. **枚举与注解**:枚举类型的应用,注解(Annotation)的基本使用及其在编译期和运行期的作用。 13. **泛型**:理解泛型的引入,泛型类,泛型方法,通配符和边界。 14. **反射API**:如何在运行时获取类的信息...

    java注解之运行时修改字段的注解值操作

    Java 注解是一种用来标注Java代码的方式,它可以在编译期、运行期对代码进行处理和修改。本文主要介绍了 Java 注解之运行时修改字段的注解值操作,具有很好的参考价值,希望对大家有所帮助。 什么是 Java 注解 ...

    Annotation的关联关系

    在Java编程语言中,注解(Annotation)是一种元数据,它提供了一种安全的方法来将信息附加到代码中,而不直接影响代码的运行。注解在软件开发中扮演着重要的角色,用于编译时检查、运行时处理、文档生成等场景。这篇...

    Java语言程序设计(复习题,课后习题答案)第十版

    7. **注解(Annotation)**:用于提供元数据,可以被编译器或JVM在编译期或运行期处理。 8. **枚举(Enum)**:一种特殊的类,用于表示有限的固定集合。 9. **Java 8及更高版本的新特性**:如Lambda表达式、Stream...

    java学习资料 英文版

    9. **注解(Annotation)**:解释注解的定义、使用及元注解的概念,以及其在编译期和运行期的作用。 10. **垃圾收集与内存管理**:讨论Java的内存模型,以及垃圾收集器的工作原理,帮助优化内存使用。 11. **设计...

    JAVA编程语言在计算机软件开发中运用.docx

    2. **JAVA Annotation(注解)技术**:JAVA Annotation用于提供元数据,可以用于代码的编译期和运行期处理。注解可以标记代码的不同部分,帮助开发者更好地理解和维护代码,同时还可以用于代码的自动验证和生成文档...

    java-annotation:Java注解入门教程

    Java注解是Java编程语言中的一个重要特性,它提供了一种元数据的方式,使得开发者可以在代码中添加额外的信息,这些信息可以被编译器或者运行时环境用来进行代码分析、验证或者自动化处理。本教程将带你深入理解Java...

    疯狂java讲义源码

    注解(Annotation)则提供了一种元数据,用于在编译期或运行期向编译器或JVM提供信息。源码将展示它们的实际应用。 8. **Swing与JavaFX**:这两是Java GUI编程的主要库。源码将包含各种组件(JButton、JLabel、...

    annotation.rar

    在Java编程语言中,注解(Annotation)是一种元数据,它提供了向编译器或JVM提供信息的方式,这些信息可以用于代码分析、编译时验证或者运行时处理。"annotation.rar"这个压缩包文件很可能包含了关于JDK内置注解的...

    Android代码生成技术JavaPoet的使用

    在Android开发中,有时我们需要在运行时或者编译期动态生成代码,以简化我们的工作,提高效率。JavaPoet就是这样一款强大的工具,它由Square公司开发,主要用于在Java编程环境中生成高质量的源代码。本篇将详细介绍...

    corejava Java核心内容

    《CoreJava:深入解析Java核心技术》 Java编程语言以其跨平台、面向对象和高效安全的特性,成为全球软件开发领域的主流选择。CoreJava是Java学习的核心部分,它涵盖了语言基础、面向对象编程、集合框架、多线程、...

    java-reflection-annotation-test:探索java反射和注解之美

    Java反射和注解是Java编程语言中的两个强大特性,它们为开发者提供了深入程序运行时行为的能力,以及在编译期和运行期增加元数据的功能。本文将深入探讨这两个概念,帮助你更好地理解和利用它们。 首先,让我们从...

    java从入门到提升

    还有注解(Annotation),这是一种元数据,用于提供编译器或JVM在编译期或运行期处理信息的方式。 最后,不要忘记Java的库,如JDBC(Java Database Connectivity)用于数据库操作,Servlet和JSP用于Web开发,Spring...

    java爱好者的好帮手——java类库

    9. **注解(Annotation)**:`java.lang.annotation`包提供了元数据功能,注解可以用来标记代码,提供编译期或运行期的额外信息,如Spring框架中的@Service和@Autowired。 10. **国际化(i18n)**:`java.text`和`...

    learn-java-master_java_知识点_

    13. **注解(Annotation)**:注解提供了一种元数据方式,可以用于编译期检查、运行时处理等。自定义注解可以增强代码的可读性和维护性。 14. **模块系统(Java 9+)**:Java 9引入了模块系统,有助于大型项目管理...

Global site tag (gtag.js) - Google Analytics