java 注解,从名字上看是注释,解释。但功能却不仅仅是注释那么简单。注解(Annotation) 为我们在代码中添加信息提供了一种形式化的方法,是我们可以在稍后 某个时刻方便地使用这些数据(通过 解析注解 来使用这些数据),常见的作用有以下几种:
- 生成文档。这是最常见的,也是java 最早提供的注解。常用的有@see @param @return 等
- 跟踪代码依赖性,实现替代配置文件功能。比较常见的是spring 2.5 开始的基于注解配置。作用就是减少配置。现在的框架基本都使用了这种配置来减少配置文件的数量。也是
- 在编译时进行格式检查。如@Override 放在方法前,如果你这个方法并不是覆盖了超类方法,则编译时就能检查出。
包 java.lang.annotation 中包含所有定义自定义注解所需用到的原注解和接口。如接口 java.lang.annotation.Annotation 是所有注解继承的接口,并且是自动继承,不需要定义时指定,类似于所有类都自动继承Object。
该包同时定义了四个元注解,Documented,Inherited,Target(作用范围,方法,属性,构造方法等),Retention(生命范围,源代码,class,runtime)。下面将在实例中逐个讲解他们的作用,及使用方法。
Inherited : 在您定义注解后并使用于程序代码上时,预设上父类别中的注解并不会被继承至子类别中,您可以在定义注解时加上java.lang.annotation.Inherited 限定的Annotation,这让您定义的Annotation型别被继承下来。注意注解继承只针对class 级别注解有效(这段建议看完全文后在来回顾)。 多说无益,下面就一步步从零开始建一个我们自己的注解。
建第一个注解
- package com.tmser.annotation;
- /**
- *
- *@interface用来声明一个注解,其中的每一个方法实际上是声明了一个配置参数。
- *方法的名称就是参数的名称,返回值类型就是参数的类型。
- *可以通过default来声明参数的默认值。
- *在这里可以看到@Retention和@Target这样的元注解,用来声明注解本身的行为。
- *@Retention用来声明注解的保留策略,有CLASS、RUNTIME和SOURCE这三种,
- *分别表示注解保存在类文件、JVM运行时刻和源代码中。
- *只有当声明为RUNTIME的时候,才能够在运行时刻通过反射API来获取到注解的信息。
- *@Target用来声明注解可以被添加在哪些类型的元素上,如类型、方法和域等。
- *就可以定义一个注解了,它将自动继承Annotation
- */
- public@interfaceTestA{
- //这里定义了一个空的注解,它能干什么呢。我也不知道,但他能用。
- }
在下面这个程序中使用它:
- package com.tmser.annotation;
- import java.util.HashMap;
- import java.util.Map;
- /**
- * 这个类专门用来测试注解使用
- * @author tmser
- */
- @TestA //使用了类注解
- publicclassUserAnnotation{
- @TestA//使用了类成员注解
- privateInteger age;
- @TestA//使用了构造方法注解
- publicUserAnnotation(){
- }
- @TestA//使用了类方法注解
- publicvoid a(){
- @TestA//使用了局部变量注解
- Map m =newHashMap(0);
- }
- publicvoid b(@TestAInteger a){//使用了方法参数注解
- }
- }
编译没有报错,ok,一个注解实验完成。这个注解也太简单了吧,好像什么信息也不能传递。别急下面就来一步步完善它,也该四位元注解依次开始上场了。
四个元注解分别是:@Target,@Retention,@Documented,@Inherited ,再次强调下元注解是java API提供,是专门用来定义注解的注解,其作用分别如下。
@Target 表示该注解用于什么地方,可能的值在枚举类 ElemenetType 中,包括:
ElemenetType.CONSTRUCTOR 构造器声明
ElemenetType.FIELD 域声明(包括 enum 实例)
ElemenetType.LOCAL_VARIABLE 局部变量声明
ElemenetType.METHOD 方法声明
ElemenetType.PACKAGE 包声明
ElemenetType.PARAMETER 参数声明
ElemenetType.TYPE 类,接口(包括注解类型)或enum声明
@Retention 表示在什么级别保存该注解信息。可选的参数值在枚举类型 RetentionPolicy 中,包括:
RetentionPolicy.SOURCE 注解将被编译器丢弃
RetentionPolicy.CLASS 注解在class文件中可用,但会被VM丢弃
RetentionPolicy.RUNTIME VM将在运行期也保留注释,因此可以通过反射机制读取注解的信息。
@Documented 将此注解包含在 javadoc 中 ,它代表着此注解会被javadoc工具提取成文档。在doc文档中的内容会因为此注解的信息内容不同而不同。相当与@see,@param 等。
@Inherited 允许子类继承父类中的注解,例子中补充。
学习最忌好高骛远,我们就一个一个来实验。
第一个:@Target,动手在前面我们编写的注解上加上元注解。
- package com.tmser.annotation;
- import java.lang.annotation.ElementType;
- import java.lang.annotation.Target;
- /*
- * 定义注解 Test
- * 首先使用ElementType.TYPE
- */
- @Target(ElementType.PACKAGE)
- public@interfaceTestA{
- }
ctrl+ s 保存,今天电脑比较给力,我们的测试类那边立马出现了一堆错误,除了类注解。我想到这,聪明的你立刻明白了这个元注解的意义了。是不是想当然的偷起懒来了。?难道还有意外?细心的朋友应该发现了,我们的测试类少了一个属性没用,就是ElemenetType.PACKAGE。在我们的注解加上这个属性的元注解后,我们测试程序的元注解全部阵亡,不对,还有一个没加呢,好加上。package 包,想当然是加载 package 前面。即
- @TestApackage com.tmser.annotation;
什么也报错。这就搞不明白了,不加在这加哪去呢。我也不知道了,不过这是编译错误,我们的eclipse 将错误给我们指出了,就是
Package annotations must be in file package-info.java ,e 文虽然不好,但这个简单的还是难不倒几个人的,package 注解必须定义在 package-info.java 中。package-info 又是什么东西,好了为节省你们的时间帮你百度好了,传送门。ok,到此 target 元注解就全部完成了。
第二个元注解: @Retention 参数 RetentionPolicy。有了前面的经验这个注解理解起来就简单多了,并且幸运的是这个注解还没有特殊的属性值。 简单演示下如何使用:
package com.tmser.annotation; import java.lang.annotation.ElementType; import java.lang.annotation.Target; /* * 定义注解 Test * 首先使用ElementType.TYPE * 运行级别定为 运行时,以便后面测试解析 */ @Target(ElementType.PACKAGE)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestA { }
第三和第四个元注解就不再举例了。比较简单,也没有值,相信看过上面的解释也就清楚了。下面我们还是继续来深入的探讨下注解的使用。上面的例子都非常简单,注解连属性都没有。ok,下面我们就来定义一个有属性的注解,并在例子程序中获取都注解中定义的值。
开始之前将下定义属性的规则:
@interface用来声明一个注解,其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是基本类型、Class、String、enum)。可以通过default来声明参数的默认值。
代码:
/* * 定义注解 Test * 为方便测试:注解目标为类 方法,属性及构造方法 * 注解中含有三个元素 id ,name和 gid; * id 元素 有默认值 0 */ @Target({TYPE,METHOD,FIELD,CONSTRUCTOR}) @Retention(RetentionPolicy.RUNTIME) public @interface TestA { String name(); int id() default 0; Class<Long> gid(); }
下面改下我们的测试类:
- package com.tmser.annotation;
- import java.util.HashMap;
- import java.util.Map;
- /**
- * 这个类专门用来测试注解使用
- * @author tmser
- */
- @TestA(name="type",gid=Long.class)//类成员注解
- publicclassUserAnnotation{
- @TestA(name="param",id=1,gid=Long.class)//类成员注解
- privateInteger age;
- @TestA(name="construct",id=2,gid=Long.class)//构造方法注解
- publicUserAnnotation(){
- }
- @TestA(name="public method",id=3,gid=Long.class)//类方法注解
- publicvoid a(){
- Map<String,String> m =newHashMap<String,String>(0);
- }
- @TestA(name="protected method",id=4,gid=Long.class)//类方法注解
- protectedvoid b(){
- Map<String,String> m =newHashMap<String,String>(0);
- }
- @TestA(name="private method",id=5,gid=Long.class)//类方法注解
- privatevoid c(){
- Map<String,String> m =newHashMap<String,String>(0);
- }
- publicvoid b(Integer a){
- }
- }
下面到了最重要的一步了,就是如何读取我们在类中定义的注解。只要读取出来了使用的话就简单了。
jdk1.5 既然增加了注解,肯定就增加了相关读取的api
在java.lang.reflect包中新增了AnnotatedElement接口,JDK源码如下:
- public interface AnnotatedElement{
- boolean isAnnotationPresent(Class<?extendsAnnotation> annotationClass);
- <T extendsAnnotation> T getAnnotation(Class<T> annotationClass);
- Annotation[] getAnnotations();
- Annotation[] getDeclaredAnnotations();
- }
- isAnnotationPresent:判断是否标注了指定注解
- getAnnotation:获取指定注解,没有则返回null
- getAnnotations:获取所有注解,包括继承自基类的,没有则返回长度为0的数组
- getDeclaredAnnotations:获取自身显式标明的所有注解,没有则返回长度为0的数组
- package com.tmser.annotation;
- import java.lang.annotation.Annotation;
- import java.lang.reflect.Constructor;
- import java.lang.reflect.Method;
- publicclassParseAnnotation{
- /**
- * 简单打印出UserAnnotation 类中所使用到的类注解
- * 该方法只打印了 Type 类型的注解
- * @throws ClassNotFoundException
- */
- publicstaticvoid parseTypeAnnotation()throwsClassNotFoundException{
- Class clazz =Class.forName("com.tmser.annotation.UserAnnotation");
- Annotation[] annotations = clazz.getAnnotations();
- for(Annotation annotation : annotations){
- TestA testA =(TestA)annotation;
- System.out.println("id= \""+testA.id()+"\"; name= \""+testA.name()+"\"; gid = "+testA.gid());
- }
- }
- /**
- * 简单打印出UserAnnotation 类中所使用到的方法注解
- * 该方法只打印了 Method 类型的注解
- * @throws ClassNotFoundException
- */
- publicstaticvoid parseMethodAnnotation(){
- Method[] methods =UserAnnotation.class.getDeclaredMethods();
- for(Method method : methods){
- /*
- * 判断方法中是否有指定注解类型的注解
- */
- boolean hasAnnotation = method.isAnnotationPresent(TestA.class);
- if(hasAnnotation){
- /*
- * 根据注解类型返回方法的指定类型注解
- */
- TestA annotation = method.getAnnotation(TestA.class);
- System.out.println("method = "+ method.getName()
- +" ; id = "+ annotation.id()+" ; description = "
- + annotation.name()+"; gid= "+annotation.gid());
- }
- }
- }
- /**
- * 简单打印出UserAnnotation 类中所使用到的方法注解
- * 该方法只打印了 Method 类型的注解
- * @throws ClassNotFoundException
- */
- publicstaticvoid parseConstructAnnotation(){
- Constructor[] constructors =UserAnnotation.class.getConstructors();
- for(Constructor constructor : constructors){
- /*
- * 判断构造方法中是否有指定注解类型的注解
- */
- boolean hasAnnotation = constructor.isAnnotationPresent(TestA.class);
- if(hasAnnotation){
- /*
- * 根据注解类型返回方法的指定类型注解
- */
- TestA annotation =(TestA) constructor.getAnnotation(TestA.class);
- System.out.println("constructor = "+ constructor.getName()
- +" ; id = "+ annotation.id()+" ; description = "
- + annotation.name()+"; gid= "+annotation.gid());
- }
- }
- }
- publicstaticvoid main(String[] args)throwsClassNotFoundException{
- parseTypeAnnotation();
- parseMethodAnnotation();
- parseConstructAnnotation();
- }
- }
先别说话,运行:
- id="0"; name="type"; gid =class java.lang.Long
- method = c ; id =5; description =private method; gid=class java.lang.Long
- method = a ; id =3; description =public method; gid=class java.lang.Long
- method = b ; id =4; description =protected method; gid=class java.lang.Long
- constructor = com.tmser.annotation.UserAnnotation; id =2; description = construct; gid=class java.lang.Long
看到了吧,我们定义的注解都完整的输出了,你要使用哪个,直接拿去用就好了。
为了不让这篇文章打开太慢,我省略了类属性注解,及参数注解的解析。其实都大同小异。
另外,我也没有举使用例子。因为我认为好的教程是讲的详细的同时,还会留有扩展。如果我全部写出来,而你只是学习的话,那基本不会自己去动脑了,而是复制粘贴运行一遍完事。
最后提醒下:
1. 要用好注解,必须熟悉java 的反射机制,从上面的例子可以看出,注解的解析完全依赖于反射。
2. 不要滥用注解。平常我们编程过程很少接触和使用注解,只有做设计,且不想让设计有过多的配置时。
疑问:
即 ElementType. ANNOTATION_TYPE:注解类型,到底什么作用,我发现即使不使用这个类型,我们自定义的注解也可以用来注释其他注解(eclipse 报错,但仍可以编译,也仍可以在测试类中读取出报错的注解,使用TYPE编译器都不报错),难道只是标示注解是个元注解,知道的麻烦告知一下。
相关推荐
Java 注解技术详解
Java 注解详解 Java 注解(Annotation)是 JDK 5.0 及以后版本引入的一个特性。它是一个新的类型,与接口类似,位于同一个层次,称为 Java 的一个类型(TYPE)。注解可以声明在包、类、字段、方法、局部变量、方法...
Java 元注解详解 Java 元注解是 Java 注解的重要特性,它们是用于修饰注解的注解。Java 元注解的作用是通过使用 Java 元注解,可以为注解指定:作用范围、生命周期、是否可重复和是否继承等信息,从而提高注解的...
java程序使用JPA注解详解 JPA注解详解 java 程序使用 JPA注解 详解
在这个教程当中,我们将学习Java的注解,如何定制注解,注解的使用以及如何通过反射解析注解。 Java1.5引入了注解,当前许多java框架中大量使用注解,如Hibernate、Jersey、Spring。注解作为程序的元数据嵌入到程序...
java或Java框架中常用的注解及其作用详解:Java 注解(Annotation)又称 Java 标注,是 JDK5.0 引入的一种注释机制。 Java 语言中的类、方法、变量、参数和包等都可以被标注。和 Javadoc 不同,Java 标注可以通过...
java程序使用JPA注解详解.zip java程序使用JPA注解详解.zip java程序使用JPA注解详解.zip java程序使用JPA注解详解.zip java程序使用JPA注解详解.zip
这是一个java注解的详解demo,详细对你很有用
Java 程序使用 JPA 注解详解 Java 持久层 API(Java Persistence API)是一种 Java 应用程序接口,用于访问、管理和持久化数据之间的关系。JPA 使用注解来定义实体类与数据库表之间的映射关系,本文将详细介绍 JPA ...
Java 注解详解 Java 注解(Annotation)是 JDK 5.0 及以后版本引入的一个特性,它是一个新的类型,与类、接口、枚举是在同一个层次。注解可以声明在包、类、字段、方法、局部变量、方法参数等的前面,用来对这些...
本文档内容包括: 1.注解详细内容(五个内置注解、...2.java动态性(静态语言、动态语言、反射机制操作(类、属性、注解、构造器)、动态编译、脚本引擎Rhino动态执行JavaScript代码、动态Java字节码操作) --author:
1.注解(Annotation)简介 2.JDK提供几个常用注解 3.元注解 4.注解的生命周期 5.注解的定义 6.注解的使用
NULL 博文链接:https://wangming2012.iteye.com/blog/1941123
"Java 注解详解" Java 注解是 Java 中最重要却最容易被人遗忘的知识点。很多人不明白它是怎么起作用的,甚至有人把它和注释混淆。实际上,Java 注解是 Java 中一种特殊的元数据,提供了关于程序元素的信息。 注解...
Java开发自定义注解详解 Java中的注解(Annotation)是一种元数据,提供了一种形式化的方式来associate元数据与程序元素,使得程序元素可以携带更多的信息。在Java中,注解可以用来标记某个程序元素,例如类、方法...
java注解详解demo具体博客:http://blog.csdn.net/wzgiceman/article/details/53406248
Java注解详解,思维导图模式说明Java注解的各种方式。
springmvc常用注解标签详解,总结,常用注解,标签详解,springmvc
最全Java注解图文超详解(建议收藏)
Java注解特性详解[汇编].pdf