一、基本概念
在开发Java程序,尤其是Java EE应用的时候,总是免不了与各种配置文件打交道。以Java EE中典型的S(pring)S(truts)H(ibernate)架构来说,Spring、Struts和Hibernate这三个框架都有自己的XML格式的配置文件。这些配置文件需要与Java源代码保存同步,否则的话就可能出现错误。而且这些错误有可能到了运行时刻才被发现。把同一份信息保存在两个地方,总是个坏的主意。理想的情况是在一个地方维护这些信息就好了。其它部分所需的信息则通过自动的方式来生成。JDK 5中引入了源代码中的注解(annotation)这一机制。注解使得Java源代码中不但可以包含功能性的实现代码,还可以添加元数据。注解的功能类似于代码中的注释,所不同的是注解不是提供代码功能的说明,而是实现程序功能的重要组成部分。Java注解已经在很多框架中得到了广泛的使用,用来简化程序中的配置。
二、常用的Java内置注解
Java中常用的内置注解是以下三种:
- @Override:表示当前方法将重写父类的相同签名的方法;
- @Deprecated:表示该类或者方法是不建议被使用的,当用户使用时编译器会给出警告;
- @SuppressWarnings:表示暂时关闭指定的编译器警告。
三、自定义注解
自定义注解的定义与接口定义相似,当注解定义后也会被编译为class文件。
定义自己的注解需要用到Java提供的元注解去修饰自定义注解:
@Target:表示该自定义注解所适用的程序元素的种类(方法,局部变量,类等),省略则表示该注解能应用于所有程序元素,其值为java.lang.annotation.ElementType枚举类型:
- TYPE:类、接口或枚举类型的定义;
- FIELD:成员变量(包括enum实例)的声明;
- METHOD:方法声明;
- PARAMETER:方法参数声明;
- CONSTRUCTOR:构造函数声明;
- LOCAL_VARIABLE:局部变量声明;
- ANNOTATION_TYPE:注解的定义;
- PACKAGE:包声明。
@Retention:表示要在什么级别保存自定义注解信息,即该自定义注解需要保存多久。其值为java.lang.annotation.RetentionPolicy枚举类型:
- SOURCE:自定义的注解信息只会保存在源代码,当编译时会被编译器忽略;
- CLASS:自定义的注解信息会被编译器保存进class文件,但会在运行时被VM忽略(默认行为);
- RUNTIME:在CLASS的基础上,VM同时会在运行时保存注解信息,因此可以通过反射读取。
@Documented:表示自定义注解需要包含在javadoc中;
@Inherited:表示允许子类继承父类的自定义注解。
示例一:
package annotation; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** * 自定义注解@MyAnnotation,能用于方法定义,并能在运行时获取。 * 注解中有一个属性value。 */ @Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) public @interface MyAnnotation { public String value(); }
package annotation; import java.lang.reflect.Method; /** * 使用自定义的注解 */ public class AnnotationTest { //当注解中只有唯一的名叫value的属性时,可以只写属性值传参 @MyAnnotation("test") public static void main(String[] args) { //使用反射获取main方法的Method对象 Method mainMethod = AnnotationTest.class.getMethods()[0]; //在Method对象上获取@MyAnnotation注解 MyAnnotation myAnnotation = mainMethod.getAnnotation(MyAnnotation.class); //获取注解的value属性 System.out.println("@MyAnnotation: " + myAnnotation.value()); } }
输出:
@MyAnnotation: test
示例二:
package annotation; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** * 自定义注解@MyAnnotation,能用于方法定义,并能在运行时获取。 * 注解中有两个属性id和message,message使用default提供默认值。 */ @Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) public @interface MyAnnotation { public int id(); public String message() default "None"; }
package annotation; import java.lang.reflect.Method; public class AnnotationTest { //当value不是注解中的唯一属性时,需要以 //属性名=属性值的形式赋值 @MyAnnotation(id = 1) public static void main(String[] args) { Method mainMethod = AnnotationTest.class.getMethods()[0]; MyAnnotation testAnnotation = mainMethod.getAnnotation(MyAnnotation.class); System.out.println("id: " + testAnnotation.id()); //message会输出默认值None System.out.println("message: " + testAnnotation.message()); } }
输出:
id: 1 message: None
相关推荐
主要介绍了java 注解annotation的使用以及反射如何获取注解的相关资料,需要的朋友可以参考下
java注解annotation
Java注解Annotation用起来很方便,也越来越流行,由于其简单、简练且易于使用等特点,很多开发工具都提供了注解功能,不好的地方就是代码入侵比较严重,所以使用的时候要有一定的选择性。 这篇文章将利用注解,来做...
Java基础复习笔记12Java自定义注解Annotation的使用
JPA、EJB、Spring零配置等等怎么使用相信各位读者都能掌握,这里主要是说如何自定义自己的注解,自己使用自定义的注解。
JAVA注解(Annotation).doc JAVA注解(Annotation).doc
Java 注解(Annotation) - 请认准 ih0qtq
Java Annotation注解技术
新手学Java注解的最好资料,15分钟迅速开发
本文全面讲述了Java注解Annotation与Java自定义注解及相关内容,大家可以认真看看
如果你想知道java annotation是什么?你可以看看
主要介绍了java注解annotation使用方法,注解可以定义到方法上,类上,一个注解相当与一个类,就相当于实例了一个对象,加上了注解,就相当于加了一个标志
Java.Annotation注解.part4
annotation 注解 annotation的资料 JAVA注解 个人整理很有实用价值
Java.Annotation注解.part3
Java.Annotation注解.part2
Java.Annotation注解.part1
主要为大家详细介绍了Java注解Annotation,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
学习java自定义注解的小例子,处理运行时注解方法,可以结合博客学习,博客地址: http://blog.csdn.net/liuyonglei1314/article/details/59494503