JAVA 注解的几大做用及使用方法详解

2020年05月18日 阅读数:102
这篇文章主要向大家介绍JAVA 注解的几大做用及使用方法详解,主要内容包括基础应用、实用技巧、原理机制等方面,希望对大家有所帮助。
转自:http://blog.sina.com.cn/s/blog_93dc666c0101gzn5.html
java 注解,从名字上看是注释,解释。但功能却不只仅是注释那么简单。注解(Annotation) 为咱们在代码中添加信息提供了一种形式化的方法,是咱们能够在稍后 某个时刻方便地使用这些数据(经过 解析注解 来使用这些数据),常见的做用有如下几种:
1.生成文档。这是最多见的,也是java 最先提供的注解。经常使用的有@see @param @return 等;
2.跟踪代码依赖性,实现替代配置文件功能。比较常见的是spring 2.5 开始的基于注解配置。做用就是减小配置。如今的框架基本都使用了这种配置来减小配置文件的数量;
3.在编译时进行格式检查。如@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;
public @interface TestA {
//这里定义了一个空的注解,它能干什么呢。我也不知道,但他能用。
}

在下面这个程序中使用它:

package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
@TestA    //使用了类注解
public class UserAnnotation {
    
    @TestA //使用了类成员注解
    private Integer age;
    
    @TestA //使用了构造方法注解
    public UserAnnotation(){
        
    }
    @TestA //使用了类方法注解
    public void a(){
        @TestA //使用了局部变量注解
        Map m = new HashMap(0);
    }
    
    public void b(@TestA Integer 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;
 
@Target(ElementType.PACKAGE)  //与前面定义的注解不一样的地方,这里使用了元注解Target
public @interface TestA {
 
}
ctrl+ s 保存,今天电脑比较给力,咱们的测试类那边立马出现了一堆错误,除了类注解。我想到这,聪明的你马上明白了这个元注解的意义了。是否是想固然的偷起懒来了。?难道还有意外?细心的朋友应该发现了,咱们的测试类少了一个属性没用,就是ElemenetType.PACKAGE。在咱们的注解加上这个属性的元注解后,咱们测试程序的元注解所有阵亡,不对,还有一个没加呢,好加上。package 包,想固然是加载 package 前面。即
@TestA package 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;
 
@Target(ElementType.PACKAGE)
@Retention(RetentionPolicy.RUNTIME)
 
public @interface TestA {
 
}
第三和第四个元注解就再也不举例了。比较简单,也没有值,相信看过上面的解释也就清楚了。下面咱们仍是继续来深刻的探讨下注解的使用。上面的例子都很是简单,注解连属性都没有。ok,下面咱们就来定义一个有属性的注解,并在例子程序中获取都注解中定义的值。

开始以前将下定义属性的规则:
        @interface用来声明一个注解,其中的每个方法其实是声明了一个配置参数。方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是基本类型、Class、String、enum)。能够经过default来声明参数的默认值。

代码:
 
@Target({TYPE,METHOD,FIELD,CONSTRUCTOR})
@Retention(RetentionPolicy.RUNTIME)
public @interface TestA {
String name();
int id() default 0;
Class gid();
}

下面改下咱们的测试类:
package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
 
@TestA(name="type",gid=Long.class) //类成员注解
public class UserAnnotation {
@TestA(name="param",id=1,gid=Long.class) //类成员注解
private Integer age;
@TestA (name="construct",id=2,gid=Long.class)//构造方法注解
public UserAnnotation(){
}
@TestA(name="public method",id=3,gid=Long.class) //类方法注解
public void a(){
Map m = new HashMap(0);
}
@TestA(name="protected method",id=4,gid=Long.class) //类方法注解
protected void b(){
Map m = new HashMap(0);
}
@TestA(name="private method",id=5,gid=Long.class) //类方法注解
private void c(){
Map m = new HashMap(0);
}
public void b(Integer a){ 
}
}
 
下面到了最重要的一步了,就是如何读取咱们在类中定义的注解。只要读取出来了使用的话就简单了。
package com.tmser.annotation;
 
import java.lang.annotation.Annotation;
import java.lang.reflect.Constructor;
import java.lang.reflect.Method;
 
public class ParseAnnotation {
 
public static void parseTypeAnnotation() throws ClassNotFoundException {  
        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());  
        }  
    } 

public static void 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());  
            }  
        }  
}

public static void 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());  
            }  
        }  
}
public static void main(String[] args) throws ClassNotFoundException {
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. 不要滥用注解。日常咱们编程过程不多接触和使用注解,只有作设计,且不想让设计有过多的配置时
这个网址能够给你参考一些注解的例子:http://blog.sina.com.cn/s/blog_7540bf5f0100t3mv.html java 注解,从名字上看是注释,解释。但功能却不只仅是注释那么简单。注解(Annotation) 为咱们在代码中添加信息提供了一种形式化的方法,是咱们能够在稍后 某个时刻方便地使用这些数据(经过 解析注解 来使用这些数据),常见的做用有如下几种:
1.生成文档。这是最多见的,也是java 最先提供的注解。经常使用的有@see @param @return 等;
2.跟踪代码依赖性,实现替代配置文件功能。比较常见的是spring 2.5 开始的基于注解配置。做用就是减小配置。如今的框架基本都使用了这种配置来减小配置文件的数量;
3.在编译时进行格式检查。如@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;
public @interface TestA {
//这里定义了一个空的注解,它能干什么呢。我也不知道,但他能用。
}

在下面这个程序中使用它:

package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
@TestA    //使用了类注解
public class UserAnnotation {
    
    @TestA //使用了类成员注解
    private Integer age;
    
    @TestA //使用了构造方法注解
    public UserAnnotation(){
        
    }
    @TestA //使用了类方法注解
    public void a(){
        @TestA //使用了局部变量注解
        Map m = new HashMap(0);
    }
    
    public void b(@TestA Integer 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;
 
@Target(ElementType.PACKAGE)  //与前面定义的注解不一样的地方,这里使用了元注解Target
public @interface TestA {
 
}
ctrl+ s 保存,今天电脑比较给力,咱们的测试类那边立马出现了一堆错误,除了类注解。我想到这,聪明的你马上明白了这个元注解的意义了。是否是想固然的偷起懒来了。?难道还有意外?细心的朋友应该发现了,咱们的测试类少了一个属性没用,就是ElemenetType.PACKAGE。在咱们的注解加上这个属性的元注解后,咱们测试程序的元注解所有阵亡,不对,还有一个没加呢,好加上。package 包,想固然是加载 package 前面。即
@TestA package 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;
 
@Target(ElementType.PACKAGE)
@Retention(RetentionPolicy.RUNTIME)
 
public @interface TestA {
 
}
第三和第四个元注解就再也不举例了。比较简单,也没有值,相信看过上面的解释也就清楚了。下面咱们仍是继续来深刻的探讨下注解的使用。上面的例子都很是简单,注解连属性都没有。ok,下面咱们就来定义一个有属性的注解,并在例子程序中获取都注解中定义的值。

开始以前将下定义属性的规则:
        @interface用来声明一个注解,其中的每个方法其实是声明了一个配置参数。方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是基本类型、Class、String、enum)。能够经过default来声明参数的默认值。

代码:
 
@Target({TYPE,METHOD,FIELD,CONSTRUCTOR})
@Retention(RetentionPolicy.RUNTIME)
public @interface TestA {
String name();
int id() default 0;
Class gid();
}

下面改下咱们的测试类:
package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
 
@TestA(name="type",gid=Long.class) //类成员注解
public class UserAnnotation {
@TestA(name="param",id=1,gid=Long.class) //类成员注解
private Integer age;
@TestA (name="construct",id=2,gid=Long.class)//构造方法注解
public UserAnnotation(){
}
@TestA(name="public method",id=3,gid=Long.class) //类方法注解
public void a(){
Map m = new HashMap(0);
}
@TestA(name="protected method",id=4,gid=Long.class) //类方法注解
protected void b(){
Map m = new HashMap(0);
}
@TestA(name="private method",id=5,gid=Long.class) //类方法注解
private void c(){
Map m = new HashMap(0);
}
public void b(Integer a){ 
}
}
 
下面到了最重要的一步了,就是如何读取咱们在类中定义的注解。只要读取出来了使用的话就简单了。
package com.tmser.annotation;
 
import java.lang.annotation.Annotation;
import java.lang.reflect.Constructor;
import java.lang.reflect.Method;
 
public class ParseAnnotation {
 
public static void parseTypeAnnotation() throws ClassNotFoundException {  
        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());  
        }  
    } 

public static void 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());  
            }  
        }  
}

public static void 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());  
            }  
        }  
}
public static void main(String[] args) throws ClassNotFoundException {
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. 不要滥用注解。日常咱们编程过程不多接触和使用注解,只有作设计,且不想让设计有过多的配置时
这个网址能够给你参考一些注解的例子:http://blog.sina.com.cn/s/blog_7540bf5f0100t3mv.html
java 注解,从名字上看是注释,解释。但功能却不只仅是注释那么简单。注解(Annotation) 为咱们在代码中添加信息提供了一种形式化的方法,是咱们能够在稍后 某个时刻方便地使用这些数据(经过 解析注解 来使用这些数据),常见的做用有如下几种:
1.生成文档。这是最多见的,也是java 最先提供的注解。经常使用的有@see @param @return 等;
2.跟踪代码依赖性,实现替代配置文件功能。比较常见的是spring 2.5 开始的基于注解配置。做用就是减小配置。如今的框架基本都使用了这种配置来减小配置文件的数量;
3.在编译时进行格式检查。如@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;
public @interface TestA {
//这里定义了一个空的注解,它能干什么呢。我也不知道,但他能用。
}

在下面这个程序中使用它:

package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
@TestA    //使用了类注解
public class UserAnnotation {
    
    @TestA //使用了类成员注解
    private Integer age;
    
    @TestA //使用了构造方法注解
    public UserAnnotation(){
        
    }
    @TestA //使用了类方法注解
    public void a(){
        @TestA //使用了局部变量注解
        Map m = new HashMap(0);
    }
    
    public void b(@TestA Integer 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;
 
@Target(ElementType.PACKAGE)  //与前面定义的注解不一样的地方,这里使用了元注解Target
public @interface TestA {
 
}
ctrl+ s 保存,今天电脑比较给力,咱们的测试类那边立马出现了一堆错误,除了类注解。我想到这,聪明的你马上明白了这个元注解的意义了。是否是想固然的偷起懒来了。?难道还有意外?细心的朋友应该发现了,咱们的测试类少了一个属性没用,就是ElemenetType.PACKAGE。在咱们的注解加上这个属性的元注解后,咱们测试程序的元注解所有阵亡,不对,还有一个没加呢,好加上。package 包,想固然是加载 package 前面。即
@TestA package 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;
 
@Target(ElementType.PACKAGE)
@Retention(RetentionPolicy.RUNTIME)
 
public @interface TestA {
 
}
第三和第四个元注解就再也不举例了。比较简单,也没有值,相信看过上面的解释也就清楚了。下面咱们仍是继续来深刻的探讨下注解的使用。上面的例子都很是简单,注解连属性都没有。ok,下面咱们就来定义一个有属性的注解,并在例子程序中获取都注解中定义的值。

开始以前将下定义属性的规则:
        @interface用来声明一个注解,其中的每个方法其实是声明了一个配置参数。方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是基本类型、Class、String、enum)。能够经过default来声明参数的默认值。

代码:
 
@Target({TYPE,METHOD,FIELD,CONSTRUCTOR})
@Retention(RetentionPolicy.RUNTIME)
public @interface TestA {
String name();
int id() default 0;
Class gid();
}

下面改下咱们的测试类:
package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
 
@TestA(name="type",gid=Long.class) //类成员注解
public class UserAnnotation {
@TestA(name="param",id=1,gid=Long.class) //类成员注解
private Integer age;
@TestA (name="construct",id=2,gid=Long.class)//构造方法注解
public UserAnnotation(){
}
@TestA(name="public method",id=3,gid=Long.class) //类方法注解
public void a(){
Map m = new HashMap(0);
}
@TestA(name="protected method",id=4,gid=Long.class) //类方法注解
protected void b(){
Map m = new HashMap(0);
}
@TestA(name="private method",id=5,gid=Long.class) //类方法注解
private void c(){
Map m = new HashMap(0);
}
public void b(Integer a){ 
}
}
 
下面到了最重要的一步了,就是如何读取咱们在类中定义的注解。只要读取出来了使用的话就简单了。
package com.tmser.annotation;
 
import java.lang.annotation.Annotation;
import java.lang.reflect.Constructor;
import java.lang.reflect.Method;
 
public class ParseAnnotation {
 
public static void parseTypeAnnotation() throws ClassNotFoundException {  
        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());  
        }  
    } 

public static void 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());  
            }  
        }  
}

public static void 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());  
            }  
        }  
}
public static void main(String[] args) throws ClassNotFoundException {
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. 不要滥用注解。日常咱们编程过程不多接触和使用注解,只有作设计,且不想让设计有过多的配置时
这个网址能够给你参考一些注解的例子:http://blog.sina.com.cn/s/blog_7540bf5f0100t3mv.html java 注解,从名字上看是注释,解释。但功能却不只仅是注释那么简单。注解(Annotation) 为咱们在代码中添加信息提供了一种形式化的方法,是咱们能够在稍后 某个时刻方便地使用这些数据(经过 解析注解 来使用这些数据),常见的做用有如下几种:
1.生成文档。这是最多见的,也是java 最先提供的注解。经常使用的有@see @param @return 等;
2.跟踪代码依赖性,实现替代配置文件功能。比较常见的是spring 2.5 开始的基于注解配置。做用就是减小配置。如今的框架基本都使用了这种配置来减小配置文件的数量;
3.在编译时进行格式检查。如@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;
public @interface TestA {
//这里定义了一个空的注解,它能干什么呢。我也不知道,但他能用。
}

在下面这个程序中使用它:

package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
@TestA    //使用了类注解
public class UserAnnotation {
    
    @TestA //使用了类成员注解
    private Integer age;
    
    @TestA //使用了构造方法注解
    public UserAnnotation(){
        
    }
    @TestA //使用了类方法注解
    public void a(){
        @TestA //使用了局部变量注解
        Map m = new HashMap(0);
    }
    
    public void b(@TestA Integer 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;
 
@Target(ElementType.PACKAGE)  //与前面定义的注解不一样的地方,这里使用了元注解Target
public @interface TestA {
 
}
ctrl+ s 保存,今天电脑比较给力,咱们的测试类那边立马出现了一堆错误,除了类注解。我想到这,聪明的你马上明白了这个元注解的意义了。是否是想固然的偷起懒来了。?难道还有意外?细心的朋友应该发现了,咱们的测试类少了一个属性没用,就是ElemenetType.PACKAGE。在咱们的注解加上这个属性的元注解后,咱们测试程序的元注解所有阵亡,不对,还有一个没加呢,好加上。package 包,想固然是加载 package 前面。即
@TestA package 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;
 
@Target(ElementType.PACKAGE)
@Retention(RetentionPolicy.RUNTIME)
 
public @interface TestA {
 
}
第三和第四个元注解就再也不举例了。比较简单,也没有值,相信看过上面的解释也就清楚了。下面咱们仍是继续来深刻的探讨下注解的使用。上面的例子都很是简单,注解连属性都没有。ok,下面咱们就来定义一个有属性的注解,并在例子程序中获取都注解中定义的值。

开始以前将下定义属性的规则:
        @interface用来声明一个注解,其中的每个方法其实是声明了一个配置参数。方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是基本类型、Class、String、enum)。能够经过default来声明参数的默认值。

代码:
 
@Target({TYPE,METHOD,FIELD,CONSTRUCTOR})
@Retention(RetentionPolicy.RUNTIME)
public @interface TestA {
String name();
int id() default 0;
Class gid();
}

下面改下咱们的测试类:
package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
 
@TestA(name="type",gid=Long.class) //类成员注解
public class UserAnnotation {
@TestA(name="param",id=1,gid=Long.class) //类成员注解
private Integer age;
@TestA (name="construct",id=2,gid=Long.class)//构造方法注解
public UserAnnotation(){
}
@TestA(name="public method",id=3,gid=Long.class) //类方法注解
public void a(){
Map m = new HashMap(0);
}
@TestA(name="protected method",id=4,gid=Long.class) //类方法注解
protected void b(){
Map m = new HashMap(0);
}
@TestA(name="private method",id=5,gid=Long.class) //类方法注解
private void c(){
Map m = new HashMap(0);
}
public void b(Integer a){ 
}
}
 
下面到了最重要的一步了,就是如何读取咱们在类中定义的注解。只要读取出来了使用的话就简单了。
package com.tmser.annotation;
 
import java.lang.annotation.Annotation;
import java.lang.reflect.Constructor;
import java.lang.reflect.Method;
 
public class ParseAnnotation {
 
public static void parseTypeAnnotation() throws ClassNotFoundException {  
        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());  
        }  
    } 

public static void 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());  
            }  
        }  
}

public static void 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());  
            }  
        }  
}
public static void main(String[] args) throws ClassNotFoundException {
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. 不要滥用注解。日常咱们编程过程不多接触和使用注解,只有作设计,且不想让设计有过多的配置时
这个网址能够给你参考一些注解的例子:http://blog.sina.com.cn/s/blog_7540bf5f0100t3mv.html java 注解,从名字上看是注释,解释。但功能却不只仅是注释那么简单。注解(Annotation) 为咱们在代码中添加信息提供了一种形式化的方法,是咱们能够在稍后 某个时刻方便地使用这些数据(经过 解析注解 来使用这些数据),常见的做用有如下几种:
1.生成文档。这是最多见的,也是java 最先提供的注解。经常使用的有@see @param @return 等;
2.跟踪代码依赖性,实现替代配置文件功能。比较常见的是spring 2.5 开始的基于注解配置。做用就是减小配置。如今的框架基本都使用了这种配置来减小配置文件的数量;
3.在编译时进行格式检查。如@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;
public @interface TestA {
//这里定义了一个空的注解,它能干什么呢。我也不知道,但他能用。
}

在下面这个程序中使用它:

package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
@TestA    //使用了类注解
public class UserAnnotation {
    
    @TestA //使用了类成员注解
    private Integer age;
    
    @TestA //使用了构造方法注解
    public UserAnnotation(){
        
    }
    @TestA //使用了类方法注解
    public void a(){
        @TestA //使用了局部变量注解
        Map m = new HashMap(0);
    }
    
    public void b(@TestA Integer 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;
 
@Target(ElementType.PACKAGE)  //与前面定义的注解不一样的地方,这里使用了元注解Target
public @interface TestA {
 
}
ctrl+ s 保存,今天电脑比较给力,咱们的测试类那边立马出现了一堆错误,除了类注解。我想到这,聪明的你马上明白了这个元注解的意义了。是否是想固然的偷起懒来了。?难道还有意外?细心的朋友应该发现了,咱们的测试类少了一个属性没用,就是ElemenetType.PACKAGE。在咱们的注解加上这个属性的元注解后,咱们测试程序的元注解所有阵亡,不对,还有一个没加呢,好加上。package 包,想固然是加载 package 前面。即
@TestA package 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;
 
@Target(ElementType.PACKAGE)
@Retention(RetentionPolicy.RUNTIME)
 
public @interface TestA {
 
}
第三和第四个元注解就再也不举例了。比较简单,也没有值,相信看过上面的解释也就清楚了。下面咱们仍是继续来深刻的探讨下注解的使用。上面的例子都很是简单,注解连属性都没有。ok,下面咱们就来定义一个有属性的注解,并在例子程序中获取都注解中定义的值。

开始以前将下定义属性的规则:
        @interface用来声明一个注解,其中的每个方法其实是声明了一个配置参数。方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是基本类型、Class、String、enum)。能够经过default来声明参数的默认值。

代码:
 
@Target({TYPE,METHOD,FIELD,CONSTRUCTOR})
@Retention(RetentionPolicy.RUNTIME)
public @interface TestA {
String name();
int id() default 0;
Class gid();
}

下面改下咱们的测试类:
package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
 
@TestA(name="type",gid=Long.class) //类成员注解
public class UserAnnotation {
@TestA(name="param",id=1,gid=Long.class) //类成员注解
private Integer age;
@TestA (name="construct",id=2,gid=Long.class)//构造方法注解
public UserAnnotation(){
}
@TestA(name="public method",id=3,gid=Long.class) //类方法注解
public void a(){
Map m = new HashMap(0);
}
@TestA(name="protected method",id=4,gid=Long.class) //类方法注解
protected void b(){
Map m = new HashMap(0);
}
@TestA(name="private method",id=5,gid=Long.class) //类方法注解
private void c(){
Map m = new HashMap(0);
}
public void b(Integer a){ 
}
}
 
下面到了最重要的一步了,就是如何读取咱们在类中定义的注解。只要读取出来了使用的话就简单了。
package com.tmser.annotation;
 
import java.lang.annotation.Annotation;
import java.lang.reflect.Constructor;
import java.lang.reflect.Method;
 
public class ParseAnnotation {
 
public static void parseTypeAnnotation() throws ClassNotFoundException {  
        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());  
        }  
    } 

public static void 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());  
            }  
        }  
}

public static void 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());  
            }  
        }  
}
public static void main(String[] args) throws ClassNotFoundException {
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. 不要滥用注解。日常咱们编程过程不多接触和使用注解,只有作设计,且不想让设计有过多的配置时
这个网址能够给你参考一些注解的例子:http://blog.sina.com.cn/s/blog_7540bf5f0100t3mv.html java 注解,从名字上看是注释,解释。但功能却不只仅是注释那么简单。注解(Annotation) 为咱们在代码中添加信息提供了一种形式化的方法,是咱们能够在稍后 某个时刻方便地使用这些数据(经过 解析注解 来使用这些数据),常见的做用有如下几种:
1.生成文档。这是最多见的,也是java 最先提供的注解。经常使用的有@see @param @return 等;
2.跟踪代码依赖性,实现替代配置文件功能。比较常见的是spring 2.5 开始的基于注解配置。做用就是减小配置。如今的框架基本都使用了这种配置来减小配置文件的数量;
3.在编译时进行格式检查。如@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;
public @interface TestA {
//这里定义了一个空的注解,它能干什么呢。我也不知道,但他能用。
}

在下面这个程序中使用它:

package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
@TestA    //使用了类注解
public class UserAnnotation {
    
    @TestA //使用了类成员注解
    private Integer age;
    
    @TestA //使用了构造方法注解
    public UserAnnotation(){
        
    }
    @TestA //使用了类方法注解
    public void a(){
        @TestA //使用了局部变量注解
        Map m = new HashMap(0);
    }
    
    public void b(@TestA Integer 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;
 
@Target(ElementType.PACKAGE)  //与前面定义的注解不一样的地方,这里使用了元注解Target
public @interface TestA {
 
}
ctrl+ s 保存,今天电脑比较给力,咱们的测试类那边立马出现了一堆错误,除了类注解。我想到这,聪明的你马上明白了这个元注解的意义了。是否是想固然的偷起懒来了。?难道还有意外?细心的朋友应该发现了,咱们的测试类少了一个属性没用,就是ElemenetType.PACKAGE。在咱们的注解加上这个属性的元注解后,咱们测试程序的元注解所有阵亡,不对,还有一个没加呢,好加上。package 包,想固然是加载 package 前面。即
@TestA package 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;
 
@Target(ElementType.PACKAGE)
@Retention(RetentionPolicy.RUNTIME)
 
public @interface TestA {
 
}
第三和第四个元注解就再也不举例了。比较简单,也没有值,相信看过上面的解释也就清楚了。下面咱们仍是继续来深刻的探讨下注解的使用。上面的例子都很是简单,注解连属性都没有。ok,下面咱们就来定义一个有属性的注解,并在例子程序中获取都注解中定义的值。

开始以前将下定义属性的规则:
        @interface用来声明一个注解,其中的每个方法其实是声明了一个配置参数。方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是基本类型、Class、String、enum)。能够经过default来声明参数的默认值。

代码:
 
@Target({TYPE,METHOD,FIELD,CONSTRUCTOR})
@Retention(RetentionPolicy.RUNTIME)
public @interface TestA {
String name();
int id() default 0;
Class gid();
}

下面改下咱们的测试类:
package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
 
@TestA(name="type",gid=Long.class) //类成员注解
public class UserAnnotation {
@TestA(name="param",id=1,gid=Long.class) //类成员注解
private Integer age;
@TestA (name="construct",id=2,gid=Long.class)//构造方法注解
public UserAnnotation(){
}
@TestA(name="public method",id=3,gid=Long.class) //类方法注解
public void a(){
Map m = new HashMap(0);
}
@TestA(name="protected method",id=4,gid=Long.class) //类方法注解
protected void b(){
Map m = new HashMap(0);
}
@TestA(name="private method",id=5,gid=Long.class) //类方法注解
private void c(){
Map m = new HashMap(0);
}
public void b(Integer a){ 
}
}
 
下面到了最重要的一步了,就是如何读取咱们在类中定义的注解。只要读取出来了使用的话就简单了。
package com.tmser.annotation;
 
import java.lang.annotation.Annotation;
import java.lang.reflect.Constructor;
import java.lang.reflect.Method;
 
public class ParseAnnotation {
 
public static void parseTypeAnnotation() throws ClassNotFoundException {  
        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());  
        }  
    } 

public static void 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());  
            }  
        }  
}

public static void 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());  
            }  
        }  
}
public static void main(String[] args) throws ClassNotFoundException {
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. 不要滥用注解。日常咱们编程过程不多接触和使用注解,只有作设计,且不想让设计有过多的配置时
这个网址能够给你参考一些注解的例子:http://blog.sina.com.cn/s/blog_7540bf5f0100t3mv.html java 注解,从名字上看是注释,解释。但功能却不只仅是注释那么简单。注解(Annotation) 为咱们在代码中添加信息提供了一种形式化的方法,是咱们能够在稍后 某个时刻方便地使用这些数据(经过 解析注解 来使用这些数据),常见的做用有如下几种:
1.生成文档。这是最多见的,也是java 最先提供的注解。经常使用的有@see @param @return 等;
2.跟踪代码依赖性,实现替代配置文件功能。比较常见的是spring 2.5 开始的基于注解配置。做用就是减小配置。如今的框架基本都使用了这种配置来减小配置文件的数量;
3.在编译时进行格式检查。如@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;
public @interface TestA {
//这里定义了一个空的注解,它能干什么呢。我也不知道,但他能用。
}

在下面这个程序中使用它:

package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
@TestA    //使用了类注解
public class UserAnnotation {
    
    @TestA //使用了类成员注解
    private Integer age;
    
    @TestA //使用了构造方法注解
    public UserAnnotation(){
        
    }
    @TestA //使用了类方法注解
    public void a(){
        @TestA //使用了局部变量注解
        Map m = new HashMap(0);
    }
    
    public void b(@TestA Integer 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;
 
@Target(ElementType.PACKAGE)  //与前面定义的注解不一样的地方,这里使用了元注解Target
public @interface TestA {
 
}
ctrl+ s 保存,今天电脑比较给力,咱们的测试类那边立马出现了一堆错误,除了类注解。我想到这,聪明的你马上明白了这个元注解的意义了。是否是想固然的偷起懒来了。?难道还有意外?细心的朋友应该发现了,咱们的测试类少了一个属性没用,就是ElemenetType.PACKAGE。在咱们的注解加上这个属性的元注解后,咱们测试程序的元注解所有阵亡,不对,还有一个没加呢,好加上。package 包,想固然是加载 package 前面。即
@TestA package 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;
 
@Target(ElementType.PACKAGE)
@Retention(RetentionPolicy.RUNTIME)
 
public @interface TestA {
 
}
第三和第四个元注解就再也不举例了。比较简单,也没有值,相信看过上面的解释也就清楚了。下面咱们仍是继续来深刻的探讨下注解的使用。上面的例子都很是简单,注解连属性都没有。ok,下面咱们就来定义一个有属性的注解,并在例子程序中获取都注解中定义的值。

开始以前将下定义属性的规则:
        @interface用来声明一个注解,其中的每个方法其实是声明了一个配置参数。方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是基本类型、Class、String、enum)。能够经过default来声明参数的默认值。

代码:
 
@Target({TYPE,METHOD,FIELD,CONSTRUCTOR})
@Retention(RetentionPolicy.RUNTIME)
public @interface TestA {
String name();
int id() default 0;
Class gid();
}

下面改下咱们的测试类:
package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
 
@TestA(name="type",gid=Long.class) //类成员注解
public class UserAnnotation {
@TestA(name="param",id=1,gid=Long.class) //类成员注解
private Integer age;
@TestA (name="construct",id=2,gid=Long.class)//构造方法注解
public UserAnnotation(){
}
@TestA(name="public method",id=3,gid=Long.class) //类方法注解
public void a(){
Map m = new HashMap(0);
}
@TestA(name="protected method",id=4,gid=Long.class) //类方法注解
protected void b(){
Map m = new HashMap(0);
}
@TestA(name="private method",id=5,gid=Long.class) //类方法注解
private void c(){
Map m = new HashMap(0);
}
public void b(Integer a){ 
}
}
 
下面到了最重要的一步了,就是如何读取咱们在类中定义的注解。只要读取出来了使用的话就简单了。
package com.tmser.annotation;
 
import java.lang.annotation.Annotation;
import java.lang.reflect.Constructor;
import java.lang.reflect.Method;
 
public class ParseAnnotation {
 
public static void parseTypeAnnotation() throws ClassNotFoundException {  
        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());  
        }  
    } 

public static void 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());  
            }  
        }  
}

public static void 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());  
            }  
        }  
}
public static void main(String[] args) throws ClassNotFoundException {
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. 不要滥用注解。日常咱们编程过程不多接触和使用注解,只有作设计,且不想让设计有过多的配置时
这个网址能够给你参考一些注解的例子:http://blog.sina.com.cn/s/blog_7540bf5f0100t3mv.html java 注解,从名字上看是注释,解释。但功能却不只仅是注释那么简单。注解(Annotation) 为咱们在代码中添加信息提供了一种形式化的方法,是咱们能够在稍后 某个时刻方便地使用这些数据(经过 解析注解 来使用这些数据),常见的做用有如下几种:
1.生成文档。这是最多见的,也是java 最先提供的注解。经常使用的有@see @param @return 等;
2.跟踪代码依赖性,实现替代配置文件功能。比较常见的是spring 2.5 开始的基于注解配置。做用就是减小配置。如今的框架基本都使用了这种配置来减小配置文件的数量;
3.在编译时进行格式检查。如@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;
public @interface TestA {
//这里定义了一个空的注解,它能干什么呢。我也不知道,但他能用。
}

在下面这个程序中使用它:

package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
@TestA    //使用了类注解
public class UserAnnotation {
    
    @TestA //使用了类成员注解
    private Integer age;
    
    @TestA //使用了构造方法注解
    public UserAnnotation(){
        
    }
    @TestA //使用了类方法注解
    public void a(){
        @TestA //使用了局部变量注解
        Map m = new HashMap(0);
    }
    
    public void b(@TestA Integer 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;
 
@Target(ElementType.PACKAGE)  //与前面定义的注解不一样的地方,这里使用了元注解Target
public @interface TestA {
 
}
ctrl+ s 保存,今天电脑比较给力,咱们的测试类那边立马出现了一堆错误,除了类注解。我想到这,聪明的你马上明白了这个元注解的意义了。是否是想固然的偷起懒来了。?难道还有意外?细心的朋友应该发现了,咱们的测试类少了一个属性没用,就是ElemenetType.PACKAGE。在咱们的注解加上这个属性的元注解后,咱们测试程序的元注解所有阵亡,不对,还有一个没加呢,好加上。package 包,想固然是加载 package 前面。即
@TestA package 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;
 
@Target(ElementType.PACKAGE)
@Retention(RetentionPolicy.RUNTIME)
 
public @interface TestA {
 
}
第三和第四个元注解就再也不举例了。比较简单,也没有值,相信看过上面的解释也就清楚了。下面咱们仍是继续来深刻的探讨下注解的使用。上面的例子都很是简单,注解连属性都没有。ok,下面咱们就来定义一个有属性的注解,并在例子程序中获取都注解中定义的值。

开始以前将下定义属性的规则:
        @interface用来声明一个注解,其中的每个方法其实是声明了一个配置参数。方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是基本类型、Class、String、enum)。能够经过default来声明参数的默认值。

代码:
 
@Target({TYPE,METHOD,FIELD,CONSTRUCTOR})
@Retention(RetentionPolicy.RUNTIME)
public @interface TestA {
String name();
int id() default 0;
Class gid();
}

下面改下咱们的测试类:
package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
 
@TestA(name="type",gid=Long.class) //类成员注解
public class UserAnnotation {
@TestA(name="param",id=1,gid=Long.class) //类成员注解
private Integer age;
@TestA (name="construct",id=2,gid=Long.class)//构造方法注解
public UserAnnotation(){
}
@TestA(name="public method",id=3,gid=Long.class) //类方法注解
public void a(){
Map m = new HashMap(0);
}
@TestA(name="protected method",id=4,gid=Long.class) //类方法注解
protected void b(){
Map m = new HashMap(0);
}
@TestA(name="private method",id=5,gid=Long.class) //类方法注解
private void c(){
Map m = new HashMap(0);
}
public void b(Integer a){ 
}
}
 
下面到了最重要的一步了,就是如何读取咱们在类中定义的注解。只要读取出来了使用的话就简单了。
package com.tmser.annotation;
 
import java.lang.annotation.Annotation;
import java.lang.reflect.Constructor;
import java.lang.reflect.Method;
 
public class ParseAnnotation {
 
public static void parseTypeAnnotation() throws ClassNotFoundException {  
        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());  
        }  
    } 

public static void 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());  
            }  
        }  
}

public static void 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());  
            }  
        }  
}
public static void main(String[] args) throws ClassNotFoundException {
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. 不要滥用注解。日常咱们编程过程不多接触和使用注解,只有作设计,且不想让设计有过多的配置时
这个网址能够给你参考一些注解的例子:http://blog.sina.com.cn/s/blog_7540bf5f0100t3mv.html java 注解,从名字上看是注释,解释。但功能却不只仅是注释那么简单。注解(Annotation) 为咱们在代码中添加信息提供了一种形式化的方法,是咱们能够在稍后 某个时刻方便地使用这些数据(经过 解析注解 来使用这些数据),常见的做用有如下几种:
1.生成文档。这是最多见的,也是java 最先提供的注解。经常使用的有@see @param @return 等;
2.跟踪代码依赖性,实现替代配置文件功能。比较常见的是spring 2.5 开始的基于注解配置。做用就是减小配置。如今的框架基本都使用了这种配置来减小配置文件的数量;
3.在编译时进行格式检查。如@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;
public @interface TestA {
//这里定义了一个空的注解,它能干什么呢。我也不知道,但他能用。
}

在下面这个程序中使用它:

package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
@TestA    //使用了类注解
public class UserAnnotation {
    
    @TestA //使用了类成员注解
    private Integer age;
    
    @TestA //使用了构造方法注解
    public UserAnnotation(){
        
    }
    @TestA //使用了类方法注解
    public void a(){
        @TestA //使用了局部变量注解
        Map m = new HashMap(0);
    }
    
    public void b(@TestA Integer 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;
 
@Target(ElementType.PACKAGE)  //与前面定义的注解不一样的地方,这里使用了元注解Target
public @interface TestA {
 
}
ctrl+ s 保存,今天电脑比较给力,咱们的测试类那边立马出现了一堆错误,除了类注解。我想到这,聪明的你马上明白了这个元注解的意义了。是否是想固然的偷起懒来了。?难道还有意外?细心的朋友应该发现了,咱们的测试类少了一个属性没用,就是ElemenetType.PACKAGE。在咱们的注解加上这个属性的元注解后,咱们测试程序的元注解所有阵亡,不对,还有一个没加呢,好加上。package 包,想固然是加载 package 前面。即
@TestA package 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;
 
@Target(ElementType.PACKAGE)
@Retention(RetentionPolicy.RUNTIME)
 
public @interface TestA {
 
}
第三和第四个元注解就再也不举例了。比较简单,也没有值,相信看过上面的解释也就清楚了。下面咱们仍是继续来深刻的探讨下注解的使用。上面的例子都很是简单,注解连属性都没有。ok,下面咱们就来定义一个有属性的注解,并在例子程序中获取都注解中定义的值。

开始以前将下定义属性的规则:
        @interface用来声明一个注解,其中的每个方法其实是声明了一个配置参数。方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是基本类型、Class、String、enum)。能够经过default来声明参数的默认值。

代码:
 
@Target({TYPE,METHOD,FIELD,CONSTRUCTOR})
@Retention(RetentionPolicy.RUNTIME)
public @interface TestA {
String name();
int id() default 0;
Class gid();
}

下面改下咱们的测试类:
package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
 
@TestA(name="type",gid=Long.class) //类成员注解
public class UserAnnotation {
@TestA(name="param",id=1,gid=Long.class) //类成员注解
private Integer age;
@TestA (name="construct",id=2,gid=Long.class)//构造方法注解
public UserAnnotation(){
}
@TestA(name="public method",id=3,gid=Long.class) //类方法注解
public void a(){
Map m = new HashMap(0);
}
@TestA(name="protected method",id=4,gid=Long.class) //类方法注解
protected void b(){
Map m = new HashMap(0);
}
@TestA(name="private method",id=5,gid=Long.class) //类方法注解
private void c(){
Map m = new HashMap(0);
}
public void b(Integer a){ 
}
}
 
下面到了最重要的一步了,就是如何读取咱们在类中定义的注解。只要读取出来了使用的话就简单了。
package com.tmser.annotation;
 
import java.lang.annotation.Annotation;
import java.lang.reflect.Constructor;
import java.lang.reflect.Method;
 
public class ParseAnnotation {
 
public static void parseTypeAnnotation() throws ClassNotFoundException {  
        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());  
        }  
    } 

public static void 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());  
            }  
        }  
}

public static void 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());  
            }  
        }  
}
public static void main(String[] args) throws ClassNotFoundException {
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. 不要滥用注解。日常咱们编程过程不多接触和使用注解,只有作设计,且不想让设计有过多的配置时
这个网址能够给你参考一些注解的例子:http://blog.sina.com.cn/s/blog_7540bf5f0100t3mv.html java 注解,从名字上看是注释,解释。但功能却不只仅是注释那么简单。注解(Annotation) 为咱们在代码中添加信息提供了一种形式化的方法,是咱们能够在稍后 某个时刻方便地使用这些数据(经过 解析注解 来使用这些数据),常见的做用有如下几种:
1.生成文档。这是最多见的,也是java 最先提供的注解。经常使用的有@see @param @return 等;
2.跟踪代码依赖性,实现替代配置文件功能。比较常见的是spring 2.5 开始的基于注解配置。做用就是减小配置。如今的框架基本都使用了这种配置来减小配置文件的数量;
3.在编译时进行格式检查。如@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;
public @interface TestA {
//这里定义了一个空的注解,它能干什么呢。我也不知道,但他能用。
}

在下面这个程序中使用它:

package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
@TestA    //使用了类注解
public class UserAnnotation {
    
    @TestA //使用了类成员注解
    private Integer age;
    
    @TestA //使用了构造方法注解
    public UserAnnotation(){
        
    }
    @TestA //使用了类方法注解
    public void a(){
        @TestA //使用了局部变量注解
        Map m = new HashMap(0);
    }
    
    public void b(@TestA Integer 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;
 
@Target(ElementType.PACKAGE)  //与前面定义的注解不一样的地方,这里使用了元注解Target
public @interface TestA {
 
}
ctrl+ s 保存,今天电脑比较给力,咱们的测试类那边立马出现了一堆错误,除了类注解。我想到这,聪明的你马上明白了这个元注解的意义了。是否是想固然的偷起懒来了。?难道还有意外?细心的朋友应该发现了,咱们的测试类少了一个属性没用,就是ElemenetType.PACKAGE。在咱们的注解加上这个属性的元注解后,咱们测试程序的元注解所有阵亡,不对,还有一个没加呢,好加上。package 包,想固然是加载 package 前面。即
@TestA package 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;
 
@Target(ElementType.PACKAGE)
@Retention(RetentionPolicy.RUNTIME)
 
public @interface TestA {
 
}
第三和第四个元注解就再也不举例了。比较简单,也没有值,相信看过上面的解释也就清楚了。下面咱们仍是继续来深刻的探讨下注解的使用。上面的例子都很是简单,注解连属性都没有。ok,下面咱们就来定义一个有属性的注解,并在例子程序中获取都注解中定义的值。

开始以前将下定义属性的规则:
        @interface用来声明一个注解,其中的每个方法其实是声明了一个配置参数。方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是基本类型、Class、String、enum)。能够经过default来声明参数的默认值。

代码:
 
@Target({TYPE,METHOD,FIELD,CONSTRUCTOR})
@Retention(RetentionPolicy.RUNTIME)
public @interface TestA {
String name();
int id() default 0;
Class gid();
}

下面改下咱们的测试类:
package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
 
@TestA(name="type",gid=Long.class) //类成员注解
public class UserAnnotation {
@TestA(name="param",id=1,gid=Long.class) //类成员注解
private Integer age;
@TestA (name="construct",id=2,gid=Long.class)//构造方法注解
public UserAnnotation(){
}
@TestA(name="public method",id=3,gid=Long.class) //类方法注解
public void a(){
Map m = new HashMap(0);
}
@TestA(name="protected method",id=4,gid=Long.class) //类方法注解
protected void b(){
Map m = new HashMap(0);
}
@TestA(name="private method",id=5,gid=Long.class) //类方法注解
private void c(){
Map m = new HashMap(0);
}
public void b(Integer a){ 
}
}
 
下面到了最重要的一步了,就是如何读取咱们在类中定义的注解。只要读取出来了使用的话就简单了。
package com.tmser.annotation;
 
import java.lang.annotation.Annotation;
import java.lang.reflect.Constructor;
import java.lang.reflect.Method;
 
public class ParseAnnotation {
 
public static void parseTypeAnnotation() throws ClassNotFoundException {  
        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());  
        }  
    } 

public static void 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());  
            }  
        }  
}

public static void 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());  
            }  
        }  
}
public static void main(String[] args) throws ClassNotFoundException {
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. 不要滥用注解。日常咱们编程过程不多接触和使用注解,只有作设计,且不想让设计有过多的配置时
这个网址能够给你参考一些注解的例子:http://blog.sina.com.cn/s/blog_7540bf5f0100t3mv.html
java 注解,从名字上看是注释,解释。但功能却不只仅是注释那么简单。注解(Annotation) 为咱们在代码中添加信息提供了一种形式化的方法,是咱们能够在稍后 某个时刻方便地使用这些数据(经过 解析注解 来使用这些数据),常见的做用有如下几种:
1.生成文档。这是最多见的,也是java 最先提供的注解。经常使用的有@see @param @return 等;
2.跟踪代码依赖性,实现替代配置文件功能。比较常见的是spring 2.5 开始的基于注解配置。做用就是减小配置。如今的框架基本都使用了这种配置来减小配置文件的数量;
3.在编译时进行格式检查。如@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;
public @interface TestA {
//这里定义了一个空的注解,它能干什么呢。我也不知道,但他能用。
}

在下面这个程序中使用它:

package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
@TestA    //使用了类注解
public class UserAnnotation {
    
    @TestA //使用了类成员注解
    private Integer age;
    
    @TestA //使用了构造方法注解
    public UserAnnotation(){
        
    }
    @TestA //使用了类方法注解
    public void a(){
        @TestA //使用了局部变量注解
        Map m = new HashMap(0);
    }
    
    public void b(@TestA Integer 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;
 
@Target(ElementType.PACKAGE)  //与前面定义的注解不一样的地方,这里使用了元注解Target
public @interface TestA {
 
}
ctrl+ s 保存,今天电脑比较给力,咱们的测试类那边立马出现了一堆错误,除了类注解。我想到这,聪明的你马上明白了这个元注解的意义了。是否是想固然的偷起懒来了。?难道还有意外?细心的朋友应该发现了,咱们的测试类少了一个属性没用,就是ElemenetType.PACKAGE。在咱们的注解加上这个属性的元注解后,咱们测试程序的元注解所有阵亡,不对,还有一个没加呢,好加上。package 包,想固然是加载 package 前面。即
@TestA package 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;
 
@Target(ElementType.PACKAGE)
@Retention(RetentionPolicy.RUNTIME)
 
public @interface TestA {
 
}
第三和第四个元注解就再也不举例了。比较简单,也没有值,相信看过上面的解释也就清楚了。下面咱们仍是继续来深刻的探讨下注解的使用。上面的例子都很是简单,注解连属性都没有。ok,下面咱们就来定义一个有属性的注解,并在例子程序中获取都注解中定义的值。

开始以前将下定义属性的规则:
        @interface用来声明一个注解,其中的每个方法其实是声明了一个配置参数。方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是基本类型、Class、String、enum)。能够经过default来声明参数的默认值。

代码:
 
@Target({TYPE,METHOD,FIELD,CONSTRUCTOR})
@Retention(RetentionPolicy.RUNTIME)
public @interface TestA {
String name();
int id() default 0;
Class gid();
}

下面改下咱们的测试类:
package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
 
@TestA(name="type",gid=Long.class) //类成员注解
public class UserAnnotation {
@TestA(name="param",id=1,gid=Long.class) //类成员注解
private Integer age;
@TestA (name="construct",id=2,gid=Long.class)//构造方法注解
public UserAnnotation(){
}
@TestA(name="public method",id=3,gid=Long.class) //类方法注解
public void a(){
Map m = new HashMap(0);
}
@TestA(name="protected method",id=4,gid=Long.class) //类方法注解
protected void b(){
Map m = new HashMap(0);
}
@TestA(name="private method",id=5,gid=Long.class) //类方法注解
private void c(){
Map m = new HashMap(0);
}
public void b(Integer a){ 
}
}
 
下面到了最重要的一步了,就是如何读取咱们在类中定义的注解。只要读取出来了使用的话就简单了。
package com.tmser.annotation;
 
import java.lang.annotation.Annotation;
import java.lang.reflect.Constructor;
import java.lang.reflect.Method;
 
public class ParseAnnotation {
 
public static void parseTypeAnnotation() throws ClassNotFoundException {  
        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());  
        }  
    } 

public static void 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());  
            }  
        }  
}

public static void 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());  
            }  
        }  
}
public static void main(String[] args) throws ClassNotFoundException {
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. 不要滥用注解。日常咱们编程过程不多接触和使用注解,只有作设计,且不想让设计有过多的配置时
这个网址能够给你参考一些注解的例子:http://blog.sina.com.cn/s/blog_7540bf5f0100t3mv.html java 注解,从名字上看是注释,解释。但功能却不只仅是注释那么简单。注解(Annotation) 为咱们在代码中添加信息提供了一种形式化的方法,是咱们能够在稍后 某个时刻方便地使用这些数据(经过 解析注解 来使用这些数据),常见的做用有如下几种:
1.生成文档。这是最多见的,也是java 最先提供的注解。经常使用的有@see @param @return 等;
2.跟踪代码依赖性,实现替代配置文件功能。比较常见的是spring 2.5 开始的基于注解配置。做用就是减小配置。如今的框架基本都使用了这种配置来减小配置文件的数量;
3.在编译时进行格式检查。如@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;
public @interface TestA {
//这里定义了一个空的注解,它能干什么呢。我也不知道,但他能用。
}

在下面这个程序中使用它:

package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
@TestA    //使用了类注解
public class UserAnnotation {
    
    @TestA //使用了类成员注解
    private Integer age;
    
    @TestA //使用了构造方法注解
    public UserAnnotation(){
        
    }
    @TestA //使用了类方法注解
    public void a(){
        @TestA //使用了局部变量注解
        Map m = new HashMap(0);
    }
    
    public void b(@TestA Integer 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;
 
@Target(ElementType.PACKAGE)  //与前面定义的注解不一样的地方,这里使用了元注解Target
public @interface TestA {
 
}
ctrl+ s 保存,今天电脑比较给力,咱们的测试类那边立马出现了一堆错误,除了类注解。我想到这,聪明的你马上明白了这个元注解的意义了。是否是想固然的偷起懒来了。?难道还有意外?细心的朋友应该发现了,咱们的测试类少了一个属性没用,就是ElemenetType.PACKAGE。在咱们的注解加上这个属性的元注解后,咱们测试程序的元注解所有阵亡,不对,还有一个没加呢,好加上。package 包,想固然是加载 package 前面。即
@TestA package 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;
 
@Target(ElementType.PACKAGE)
@Retention(RetentionPolicy.RUNTIME)
 
public @interface TestA {
 
}
第三和第四个元注解就再也不举例了。比较简单,也没有值,相信看过上面的解释也就清楚了。下面咱们仍是继续来深刻的探讨下注解的使用。上面的例子都很是简单,注解连属性都没有。ok,下面咱们就来定义一个有属性的注解,并在例子程序中获取都注解中定义的值。

开始以前将下定义属性的规则:
        @interface用来声明一个注解,其中的每个方法其实是声明了一个配置参数。方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是基本类型、Class、String、enum)。能够经过default来声明参数的默认值。

代码:
 
@Target({TYPE,METHOD,FIELD,CONSTRUCTOR})
@Retention(RetentionPolicy.RUNTIME)
public @interface TestA {
String name();
int id() default 0;
Class gid();
}

下面改下咱们的测试类:
package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
 
@TestA(name="type",gid=Long.class) //类成员注解
public class UserAnnotation {
@TestA(name="param",id=1,gid=Long.class) //类成员注解
private Integer age;
@TestA (name="construct",id=2,gid=Long.class)//构造方法注解
public UserAnnotation(){
}
@TestA(name="public method",id=3,gid=Long.class) //类方法注解
public void a(){
Map m = new HashMap(0);
}
@TestA(name="protected method",id=4,gid=Long.class) //类方法注解
protected void b(){
Map m = new HashMap(0);
}
@TestA(name="private method",id=5,gid=Long.class) //类方法注解
private void c(){
Map m = new HashMap(0);
}
public void b(Integer a){ 
}
}
 
下面到了最重要的一步了,就是如何读取咱们在类中定义的注解。只要读取出来了使用的话就简单了。
package com.tmser.annotation;
 
import java.lang.annotation.Annotation;
import java.lang.reflect.Constructor;
import java.lang.reflect.Method;
 
public class ParseAnnotation {
 
public static void parseTypeAnnotation() throws ClassNotFoundException {  
        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());  
        }  
    } 

public static void 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());  
            }  
        }  
}

public static void 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());  
            }  
        }  
}
public static void main(String[] args) throws ClassNotFoundException {
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. 不要滥用注解。日常咱们编程过程不多接触和使用注解,只有作设计,且不想让设计有过多的配置时
这个网址能够给你参考一些注解的例子:http://blog.sina.com.cn/s/blog_7540bf5f0100t3mv.html java 注解,从名字上看是注释,解释。但功能却不只仅是注释那么简单。注解(Annotation) 为咱们在代码中添加信息提供了一种形式化的方法,是咱们能够在稍后 某个时刻方便地使用这些数据(经过 解析注解 来使用这些数据),常见的做用有如下几种:
1.生成文档。这是最多见的,也是java 最先提供的注解。经常使用的有@see @param @return 等;
2.跟踪代码依赖性,实现替代配置文件功能。比较常见的是spring 2.5 开始的基于注解配置。做用就是减小配置。如今的框架基本都使用了这种配置来减小配置文件的数量;
3.在编译时进行格式检查。如@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;
public @interface TestA {
//这里定义了一个空的注解,它能干什么呢。我也不知道,但他能用。
}

在下面这个程序中使用它:

package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
@TestA    //使用了类注解
public class UserAnnotation {
    
    @TestA //使用了类成员注解
    private Integer age;
    
    @TestA //使用了构造方法注解
    public UserAnnotation(){
        
    }
    @TestA //使用了类方法注解
    public void a(){
        @TestA //使用了局部变量注解
        Map m = new HashMap(0);
    }
    
    public void b(@TestA Integer 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;
 
@Target(ElementType.PACKAGE)  //与前面定义的注解不一样的地方,这里使用了元注解Target
public @interface TestA {
 
}
ctrl+ s 保存,今天电脑比较给力,咱们的测试类那边立马出现了一堆错误,除了类注解。我想到这,聪明的你马上明白了这个元注解的意义了。是否是想固然的偷起懒来了。?难道还有意外?细心的朋友应该发现了,咱们的测试类少了一个属性没用,就是ElemenetType.PACKAGE。在咱们的注解加上这个属性的元注解后,咱们测试程序的元注解所有阵亡,不对,还有一个没加呢,好加上。package 包,想固然是加载 package 前面。即
@TestA package 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;
 
@Target(ElementType.PACKAGE)
@Retention(RetentionPolicy.RUNTIME)
 
public @interface TestA {
 
}
第三和第四个元注解就再也不举例了。比较简单,也没有值,相信看过上面的解释也就清楚了。下面咱们仍是继续来深刻的探讨下注解的使用。上面的例子都很是简单,注解连属性都没有。ok,下面咱们就来定义一个有属性的注解,并在例子程序中获取都注解中定义的值。

开始以前将下定义属性的规则:
        @interface用来声明一个注解,其中的每个方法其实是声明了一个配置参数。方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是基本类型、Class、String、enum)。能够经过default来声明参数的默认值。

代码:
 
@Target({TYPE,METHOD,FIELD,CONSTRUCTOR})
@Retention(RetentionPolicy.RUNTIME)
public @interface TestA {
String name();
int id() default 0;
Class gid();
}

下面改下咱们的测试类:
package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
 
@TestA(name="type",gid=Long.class) //类成员注解
public class UserAnnotation {
@TestA(name="param",id=1,gid=Long.class) //类成员注解
private Integer age;
@TestA (name="construct",id=2,gid=Long.class)//构造方法注解
public UserAnnotation(){
}
@TestA(name="public method",id=3,gid=Long.class) //类方法注解
public void a(){
Map m = new HashMap(0);
}
@TestA(name="protected method",id=4,gid=Long.class) //类方法注解
protected void b(){
Map m = new HashMap(0);
}
@TestA(name="private method",id=5,gid=Long.class) //类方法注解
private void c(){
Map m = new HashMap(0);
}
public void b(Integer a){ 
}
}
 
下面到了最重要的一步了,就是如何读取咱们在类中定义的注解。只要读取出来了使用的话就简单了。
package com.tmser.annotation;
 
import java.lang.annotation.Annotation;
import java.lang.reflect.Constructor;
import java.lang.reflect.Method;
 
public class ParseAnnotation {
 
public static void parseTypeAnnotation() throws ClassNotFoundException {  
        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());  
        }  
    } 

public static void 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());  
            }  
        }  
}

public static void 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());  
            }  
        }  
}
public static void main(String[] args) throws ClassNotFoundException {
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. 不要滥用注解。日常咱们编程过程不多接触和使用注解,只有作设计,且不想让设计有过多的配置时
这个网址能够给你参考一些注解的例子:http://blog.sina.com.cn/s/blog_7540bf5f0100t3mv.html java 注解,从名字上看是注释,解释。但功能却不只仅是注释那么简单。注解(Annotation) 为咱们在代码中添加信息提供了一种形式化的方法,是咱们能够在稍后 某个时刻方便地使用这些数据(经过 解析注解 来使用这些数据),常见的做用有如下几种:
1.生成文档。这是最多见的,也是java 最先提供的注解。经常使用的有@see @param @return 等;
2.跟踪代码依赖性,实现替代配置文件功能。比较常见的是spring 2.5 开始的基于注解配置。做用就是减小配置。如今的框架基本都使用了这种配置来减小配置文件的数量;
3.在编译时进行格式检查。如@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;
public @interface TestA {
//这里定义了一个空的注解,它能干什么呢。我也不知道,但他能用。
}

在下面这个程序中使用它:

package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
@TestA    //使用了类注解
public class UserAnnotation {
    
    @TestA //使用了类成员注解
    private Integer age;
    
    @TestA //使用了构造方法注解
    public UserAnnotation(){
        
    }
    @TestA //使用了类方法注解
    public void a(){
        @TestA //使用了局部变量注解
        Map m = new HashMap(0);
    }
    
    public void b(@TestA Integer 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;
 
@Target(ElementType.PACKAGE)  //与前面定义的注解不一样的地方,这里使用了元注解Target
public @interface TestA {
 
}
ctrl+ s 保存,今天电脑比较给力,咱们的测试类那边立马出现了一堆错误,除了类注解。我想到这,聪明的你马上明白了这个元注解的意义了。是否是想固然的偷起懒来了。?难道还有意外?细心的朋友应该发现了,咱们的测试类少了一个属性没用,就是ElemenetType.PACKAGE。在咱们的注解加上这个属性的元注解后,咱们测试程序的元注解所有阵亡,不对,还有一个没加呢,好加上。package 包,想固然是加载 package 前面。即
@TestA package 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;
 
@Target(ElementType.PACKAGE)
@Retention(RetentionPolicy.RUNTIME)
 
public @interface TestA {
 
}
第三和第四个元注解就再也不举例了。比较简单,也没有值,相信看过上面的解释也就清楚了。下面咱们仍是继续来深刻的探讨下注解的使用。上面的例子都很是简单,注解连属性都没有。ok,下面咱们就来定义一个有属性的注解,并在例子程序中获取都注解中定义的值。

开始以前将下定义属性的规则:
        @interface用来声明一个注解,其中的每个方法其实是声明了一个配置参数。方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是基本类型、Class、String、enum)。能够经过default来声明参数的默认值。

代码:
 
@Target({TYPE,METHOD,FIELD,CONSTRUCTOR})
@Retention(RetentionPolicy.RUNTIME)
public @interface TestA {
String name();
int id() default 0;
Class gid();
}

下面改下咱们的测试类:
package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
 
@TestA(name="type",gid=Long.class) //类成员注解
public class UserAnnotation {
@TestA(name="param",id=1,gid=Long.class) //类成员注解
private Integer age;
@TestA (name="construct",id=2,gid=Long.class)//构造方法注解
public UserAnnotation(){
}
@TestA(name="public method",id=3,gid=Long.class) //类方法注解
public void a(){
Map m = new HashMap(0);
}
@TestA(name="protected method",id=4,gid=Long.class) //类方法注解
protected void b(){
Map m = new HashMap(0);
}
@TestA(name="private method",id=5,gid=Long.class) //类方法注解
private void c(){
Map m = new HashMap(0);
}
public void b(Integer a){ 
}
}
 
下面到了最重要的一步了,就是如何读取咱们在类中定义的注解。只要读取出来了使用的话就简单了。
package com.tmser.annotation;
 
import java.lang.annotation.Annotation;
import java.lang.reflect.Constructor;
import java.lang.reflect.Method;
 
public class ParseAnnotation {
 
public static void parseTypeAnnotation() throws ClassNotFoundException {  
        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());  
        }  
    } 

public static void 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());  
            }  
        }  
}

public static void 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());  
            }  
        }  
}
public static void main(String[] args) throws ClassNotFoundException {
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. 不要滥用注解。日常咱们编程过程不多接触和使用注解,只有作设计,且不想让设计有过多的配置时
这个网址能够给你参考一些注解的例子:http://blog.sina.com.cn/s/blog_7540bf5f0100t3mv.html java 注解,从名字上看是注释,解释。但功能却不只仅是注释那么简单。注解(Annotation) 为咱们在代码中添加信息提供了一种形式化的方法,是咱们能够在稍后 某个时刻方便地使用这些数据(经过 解析注解 来使用这些数据),常见的做用有如下几种:
1.生成文档。这是最多见的,也是java 最先提供的注解。经常使用的有@see @param @return 等;
2.跟踪代码依赖性,实现替代配置文件功能。比较常见的是spring 2.5 开始的基于注解配置。做用就是减小配置。如今的框架基本都使用了这种配置来减小配置文件的数量;
3.在编译时进行格式检查。如@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;
public @interface TestA {
//这里定义了一个空的注解,它能干什么呢。我也不知道,但他能用。
}

在下面这个程序中使用它:

package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
@TestA    //使用了类注解
public class UserAnnotation {
    
    @TestA //使用了类成员注解
    private Integer age;
    
    @TestA //使用了构造方法注解
    public UserAnnotation(){
        
    }
    @TestA //使用了类方法注解
    public void a(){
        @TestA //使用了局部变量注解
        Map m = new HashMap(0);
    }
    
    public void b(@TestA Integer 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;
 
@Target(ElementType.PACKAGE)  //与前面定义的注解不一样的地方,这里使用了元注解Target
public @interface TestA {
 
}
ctrl+ s 保存,今天电脑比较给力,咱们的测试类那边立马出现了一堆错误,除了类注解。我想到这,聪明的你马上明白了这个元注解的意义了。是否是想固然的偷起懒来了。?难道还有意外?细心的朋友应该发现了,咱们的测试类少了一个属性没用,就是ElemenetType.PACKAGE。在咱们的注解加上这个属性的元注解后,咱们测试程序的元注解所有阵亡,不对,还有一个没加呢,好加上。package 包,想固然是加载 package 前面。即
@TestA package 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;
 
@Target(ElementType.PACKAGE)
@Retention(RetentionPolicy.RUNTIME)
 
public @interface TestA {
 
}
第三和第四个元注解就再也不举例了。比较简单,也没有值,相信看过上面的解释也就清楚了。下面咱们仍是继续来深刻的探讨下注解的使用。上面的例子都很是简单,注解连属性都没有。ok,下面咱们就来定义一个有属性的注解,并在例子程序中获取都注解中定义的值。

开始以前将下定义属性的规则:
        @interface用来声明一个注解,其中的每个方法其实是声明了一个配置参数。方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是基本类型、Class、String、enum)。能够经过default来声明参数的默认值。

代码:
 
@Target({TYPE,METHOD,FIELD,CONSTRUCTOR})
@Retention(RetentionPolicy.RUNTIME)
public @interface TestA {
String name();
int id() default 0;
Class gid();
}

下面改下咱们的测试类:
package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
 
@TestA(name="type",gid=Long.class) //类成员注解
public class UserAnnotation {
@TestA(name="param",id=1,gid=Long.class) //类成员注解
private Integer age;
@TestA (name="construct",id=2,gid=Long.class)//构造方法注解
public UserAnnotation(){
}
@TestA(name="public method",id=3,gid=Long.class) //类方法注解
public void a(){
Map m = new HashMap(0);
}
@TestA(name="protected method",id=4,gid=Long.class) //类方法注解
protected void b(){
Map m = new HashMap(0);
}
@TestA(name="private method",id=5,gid=Long.class) //类方法注解
private void c(){
Map m = new HashMap(0);
}
public void b(Integer a){ 
}
}
 
下面到了最重要的一步了,就是如何读取咱们在类中定义的注解。只要读取出来了使用的话就简单了。
package com.tmser.annotation;
 
import java.lang.annotation.Annotation;
import java.lang.reflect.Constructor;
import java.lang.reflect.Method;
 
public class ParseAnnotation {
 
public static void parseTypeAnnotation() throws ClassNotFoundException {  
        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());  
        }  
    } 

public static void 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());  
            }  
        }  
}

public static void 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());  
            }  
        }  
}
public static void main(String[] args) throws ClassNotFoundException {
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. 不要滥用注解。日常咱们编程过程不多接触和使用注解,只有作设计,且不想让设计有过多的配置时
这个网址能够给你参考一些注解的例子:http://blog.sina.com.cn/s/blog_7540bf5f0100t3mv.html java 注解,从名字上看是注释,解释。但功能却不只仅是注释那么简单。注解(Annotation) 为咱们在代码中添加信息提供了一种形式化的方法,是咱们能够在稍后 某个时刻方便地使用这些数据(经过 解析注解 来使用这些数据),常见的做用有如下几种:
1.生成文档。这是最多见的,也是java 最先提供的注解。经常使用的有@see @param @return 等;
2.跟踪代码依赖性,实现替代配置文件功能。比较常见的是spring 2.5 开始的基于注解配置。做用就是减小配置。如今的框架基本都使用了这种配置来减小配置文件的数量;
3.在编译时进行格式检查。如@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;
public @interface TestA {
//这里定义了一个空的注解,它能干什么呢。我也不知道,但他能用。
}

在下面这个程序中使用它:

package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
@TestA    //使用了类注解
public class UserAnnotation {
    
    @TestA //使用了类成员注解
    private Integer age;
    
    @TestA //使用了构造方法注解
    public UserAnnotation(){
        
    }
    @TestA //使用了类方法注解
    public void a(){
        @TestA //使用了局部变量注解
        Map m = new HashMap(0);
    }
    
    public void b(@TestA Integer 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;
 
@Target(ElementType.PACKAGE)  //与前面定义的注解不一样的地方,这里使用了元注解Target
public @interface TestA {
 
}
ctrl+ s 保存,今天电脑比较给力,咱们的测试类那边立马出现了一堆错误,除了类注解。我想到这,聪明的你马上明白了这个元注解的意义了。是否是想固然的偷起懒来了。?难道还有意外?细心的朋友应该发现了,咱们的测试类少了一个属性没用,就是ElemenetType.PACKAGE。在咱们的注解加上这个属性的元注解后,咱们测试程序的元注解所有阵亡,不对,还有一个没加呢,好加上。package 包,想固然是加载 package 前面。即
@TestA package 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;
 
@Target(ElementType.PACKAGE)
@Retention(RetentionPolicy.RUNTIME)
 
public @interface TestA {
 
}
第三和第四个元注解就再也不举例了。比较简单,也没有值,相信看过上面的解释也就清楚了。下面咱们仍是继续来深刻的探讨下注解的使用。上面的例子都很是简单,注解连属性都没有。ok,下面咱们就来定义一个有属性的注解,并在例子程序中获取都注解中定义的值。

开始以前将下定义属性的规则:
        @interface用来声明一个注解,其中的每个方法其实是声明了一个配置参数。方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是基本类型、Class、String、enum)。能够经过default来声明参数的默认值。

代码:
 
@Target({TYPE,METHOD,FIELD,CONSTRUCTOR})
@Retention(RetentionPolicy.RUNTIME)
public @interface TestA {
String name();
int id() default 0;
Class gid();
}

下面改下咱们的测试类:
package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
 
@TestA(name="type",gid=Long.class) //类成员注解
public class UserAnnotation {
@TestA(name="param",id=1,gid=Long.class) //类成员注解
private Integer age;
@TestA (name="construct",id=2,gid=Long.class)//构造方法注解
public UserAnnotation(){
}
@TestA(name="public method",id=3,gid=Long.class) //类方法注解
public void a(){
Map m = new HashMap(0);
}
@TestA(name="protected method",id=4,gid=Long.class) //类方法注解
protected void b(){
Map m = new HashMap(0);
}
@TestA(name="private method",id=5,gid=Long.class) //类方法注解
private void c(){
Map m = new HashMap(0);
}
public void b(Integer a){ 
}
}
 
下面到了最重要的一步了,就是如何读取咱们在类中定义的注解。只要读取出来了使用的话就简单了。
package com.tmser.annotation;
 
import java.lang.annotation.Annotation;
import java.lang.reflect.Constructor;
import java.lang.reflect.Method;
 
public class ParseAnnotation {
 
public static void parseTypeAnnotation() throws ClassNotFoundException {  
        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());  
        }  
    } 

public static void 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());  
            }  
        }  
}

public static void 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());  
            }  
        }  
}
public static void main(String[] args) throws ClassNotFoundException {
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. 不要滥用注解。日常咱们编程过程不多接触和使用注解,只有作设计,且不想让设计有过多的配置时
这个网址能够给你参考一些注解的例子:http://blog.sina.com.cn/s/blog_7540bf5f0100t3mv.html java 注解,从名字上看是注释,解释。但功能却不只仅是注释那么简单。注解(Annotation) 为咱们在代码中添加信息提供了一种形式化的方法,是咱们能够在稍后 某个时刻方便地使用这些数据(经过 解析注解 来使用这些数据),常见的做用有如下几种:
1.生成文档。这是最多见的,也是java 最先提供的注解。经常使用的有@see @param @return 等;
2.跟踪代码依赖性,实现替代配置文件功能。比较常见的是spring 2.5 开始的基于注解配置。做用就是减小配置。如今的框架基本都使用了这种配置来减小配置文件的数量;
3.在编译时进行格式检查。如@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;
public @interface TestA {
//这里定义了一个空的注解,它能干什么呢。我也不知道,但他能用。
}

在下面这个程序中使用它:

package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
@TestA    //使用了类注解
public class UserAnnotation {
    
    @TestA //使用了类成员注解
    private Integer age;
    
    @TestA //使用了构造方法注解
    public UserAnnotation(){
        
    }
    @TestA //使用了类方法注解
    public void a(){
        @TestA //使用了局部变量注解
        Map m = new HashMap(0);
    }
    
    public void b(@TestA Integer 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;
 
@Target(ElementType.PACKAGE)  //与前面定义的注解不一样的地方,这里使用了元注解Target
public @interface TestA {
 
}
ctrl+ s 保存,今天电脑比较给力,咱们的测试类那边立马出现了一堆错误,除了类注解。我想到这,聪明的你马上明白了这个元注解的意义了。是否是想固然的偷起懒来了。?难道还有意外?细心的朋友应该发现了,咱们的测试类少了一个属性没用,就是ElemenetType.PACKAGE。在咱们的注解加上这个属性的元注解后,咱们测试程序的元注解所有阵亡,不对,还有一个没加呢,好加上。package 包,想固然是加载 package 前面。即
@TestA package 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;
 
@Target(ElementType.PACKAGE)
@Retention(RetentionPolicy.RUNTIME)
 
public @interface TestA {
 
}
第三和第四个元注解就再也不举例了。比较简单,也没有值,相信看过上面的解释也就清楚了。下面咱们仍是继续来深刻的探讨下注解的使用。上面的例子都很是简单,注解连属性都没有。ok,下面咱们就来定义一个有属性的注解,并在例子程序中获取都注解中定义的值。

开始以前将下定义属性的规则:
        @interface用来声明一个注解,其中的每个方法其实是声明了一个配置参数。方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是基本类型、Class、String、enum)。能够经过default来声明参数的默认值。

代码:
 
@Target({TYPE,METHOD,FIELD,CONSTRUCTOR})
@Retention(RetentionPolicy.RUNTIME)
public @interface TestA {
String name();
int id() default 0;
Class gid();
}

下面改下咱们的测试类:
package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
 
@TestA(name="type",gid=Long.class) //类成员注解
public class UserAnnotation {
@TestA(name="param",id=1,gid=Long.class) //类成员注解
private Integer age;
@TestA (name="construct",id=2,gid=Long.class)//构造方法注解
public UserAnnotation(){
}
@TestA(name="public method",id=3,gid=Long.class) //类方法注解
public void a(){
Map m = new HashMap(0);
}
@TestA(name="protected method",id=4,gid=Long.class) //类方法注解
protected void b(){
Map m = new HashMap(0);
}
@TestA(name="private method",id=5,gid=Long.class) //类方法注解
private void c(){
Map m = new HashMap(0);
}
public void b(Integer a){ 
}
}
 
下面到了最重要的一步了,就是如何读取咱们在类中定义的注解。只要读取出来了使用的话就简单了。
package com.tmser.annotation;
 
import java.lang.annotation.Annotation;
import java.lang.reflect.Constructor;
import java.lang.reflect.Method;
 
public class ParseAnnotation {
 
public static void parseTypeAnnotation() throws ClassNotFoundException {  
        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());  
        }  
    } 

public static void 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());  
            }  
        }  
}

public static void 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());  
            }  
        }  
}
public static void main(String[] args) throws ClassNotFoundException {
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. 不要滥用注解。日常咱们编程过程不多接触和使用注解,只有作设计,且不想让设计有过多的配置时
这个网址能够给你参考一些注解的例子:http://blog.sina.com.cn/s/blog_7540bf5f0100t3mv.html java 注解,从名字上看是注释,解释。但功能却不只仅是注释那么简单。注解(Annotation) 为咱们在代码中添加信息提供了一种形式化的方法,是咱们能够在稍后 某个时刻方便地使用这些数据(经过 解析注解 来使用这些数据),常见的做用有如下几种:
1.生成文档。这是最多见的,也是java 最先提供的注解。经常使用的有@see @param @return 等;
2.跟踪代码依赖性,实现替代配置文件功能。比较常见的是spring 2.5 开始的基于注解配置。做用就是减小配置。如今的框架基本都使用了这种配置来减小配置文件的数量;
3.在编译时进行格式检查。如@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;
public @interface TestA {
//这里定义了一个空的注解,它能干什么呢。我也不知道,但他能用。
}

在下面这个程序中使用它:

package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
@TestA    //使用了类注解
public class UserAnnotation {
    
    @TestA //使用了类成员注解
    private Integer age;
    
    @TestA //使用了构造方法注解
    public UserAnnotation(){
        
    }
    @TestA //使用了类方法注解
    public void a(){
        @TestA //使用了局部变量注解
        Map m = new HashMap(0);
    }
    
    public void b(@TestA Integer 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;
 
@Target(ElementType.PACKAGE)  //与前面定义的注解不一样的地方,这里使用了元注解Target
public @interface TestA {
 
}
ctrl+ s 保存,今天电脑比较给力,咱们的测试类那边立马出现了一堆错误,除了类注解。我想到这,聪明的你马上明白了这个元注解的意义了。是否是想固然的偷起懒来了。?难道还有意外?细心的朋友应该发现了,咱们的测试类少了一个属性没用,就是ElemenetType.PACKAGE。在咱们的注解加上这个属性的元注解后,咱们测试程序的元注解所有阵亡,不对,还有一个没加呢,好加上。package 包,想固然是加载 package 前面。即
@TestA package 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;
 
@Target(ElementType.PACKAGE)
@Retention(RetentionPolicy.RUNTIME)
 
public @interface TestA {
 
}
第三和第四个元注解就再也不举例了。比较简单,也没有值,相信看过上面的解释也就清楚了。下面咱们仍是继续来深刻的探讨下注解的使用。上面的例子都很是简单,注解连属性都没有。ok,下面咱们就来定义一个有属性的注解,并在例子程序中获取都注解中定义的值。

开始以前将下定义属性的规则:
        @interface用来声明一个注解,其中的每个方法其实是声明了一个配置参数。方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是基本类型、Class、String、enum)。能够经过default来声明参数的默认值。

代码:
 
@Target({TYPE,METHOD,FIELD,CONSTRUCTOR})
@Retention(RetentionPolicy.RUNTIME)
public @interface TestA {
String name();
int id() default 0;
Class gid();
}

下面改下咱们的测试类:
package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
 
@TestA(name="type",gid=Long.class) //类成员注解
public class UserAnnotation {
@TestA(name="param",id=1,gid=Long.class) //类成员注解
private Integer age;
@TestA (name="construct",id=2,gid=Long.class)//构造方法注解
public UserAnnotation(){
}
@TestA(name="public method",id=3,gid=Long.class) //类方法注解
public void a(){
Map m = new HashMap(0);
}
@TestA(name="protected method",id=4,gid=Long.class) //类方法注解
protected void b(){
Map m = new HashMap(0);
}
@TestA(name="private method",id=5,gid=Long.class) //类方法注解
private void c(){
Map m = new HashMap(0);
}
public void b(Integer a){ 
}
}
 
下面到了最重要的一步了,就是如何读取咱们在类中定义的注解。只要读取出来了使用的话就简单了。
package com.tmser.annotation;
 
import java.lang.annotation.Annotation;
import java.lang.reflect.Constructor;
import java.lang.reflect.Method;
 
public class ParseAnnotation {
 
public static void parseTypeAnnotation() throws ClassNotFoundException {  
        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());  
        }  
    } 

public static void 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());  
            }  
        }  
}

public static void 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());  
            }  
        }  
}
public static void main(String[] args) throws ClassNotFoundException {
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. 不要滥用注解。日常咱们编程过程不多接触和使用注解,只有作设计,且不想让设计有过多的配置时
这个网址能够给你参考一些注解的例子:http://blog.sina.com.cn/s/blog_7540bf5f0100t3mv.html java 注解,从名字上看是注释,解释。但功能却不只仅是注释那么简单。注解(Annotation) 为咱们在代码中添加信息提供了一种形式化的方法,是咱们能够在稍后 某个时刻方便地使用这些数据(经过 解析注解 来使用这些数据),常见的做用有如下几种:
1.生成文档。这是最多见的,也是java 最先提供的注解。经常使用的有@see @param @return 等;
2.跟踪代码依赖性,实现替代配置文件功能。比较常见的是spring 2.5 开始的基于注解配置。做用就是减小配置。如今的框架基本都使用了这种配置来减小配置文件的数量;
3.在编译时进行格式检查。如@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;
public @interface TestA {
//这里定义了一个空的注解,它能干什么呢。我也不知道,但他能用。
}

在下面这个程序中使用它:

package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
@TestA    //使用了类注解
public class UserAnnotation {
    
    @TestA //使用了类成员注解
    private Integer age;
    
    @TestA //使用了构造方法注解
    public UserAnnotation(){
        
    }
    @TestA //使用了类方法注解
    public void a(){
        @TestA //使用了局部变量注解
        Map m = new HashMap(0);
    }
    
    public void b(@TestA Integer 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;
 
@Target(ElementType.PACKAGE)  //与前面定义的注解不一样的地方,这里使用了元注解Target
public @interface TestA {
 
}
ctrl+ s 保存,今天电脑比较给力,咱们的测试类那边立马出现了一堆错误,除了类注解。我想到这,聪明的你马上明白了这个元注解的意义了。是否是想固然的偷起懒来了。?难道还有意外?细心的朋友应该发现了,咱们的测试类少了一个属性没用,就是ElemenetType.PACKAGE。在咱们的注解加上这个属性的元注解后,咱们测试程序的元注解所有阵亡,不对,还有一个没加呢,好加上。package 包,想固然是加载 package 前面。即
@TestA package 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;
 
@Target(ElementType.PACKAGE)
@Retention(RetentionPolicy.RUNTIME)
 
public @interface TestA {
 
}
第三和第四个元注解就再也不举例了。比较简单,也没有值,相信看过上面的解释也就清楚了。下面咱们仍是继续来深刻的探讨下注解的使用。上面的例子都很是简单,注解连属性都没有。ok,下面咱们就来定义一个有属性的注解,并在例子程序中获取都注解中定义的值。

开始以前将下定义属性的规则:
        @interface用来声明一个注解,其中的每个方法其实是声明了一个配置参数。方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是基本类型、Class、String、enum)。能够经过default来声明参数的默认值。

代码:
 
@Target({TYPE,METHOD,FIELD,CONSTRUCTOR})
@Retention(RetentionPolicy.RUNTIME)
public @interface TestA {
String name();
int id() default 0;
Class gid();
}

下面改下咱们的测试类:
package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
 
@TestA(name="type",gid=Long.class) //类成员注解
public class UserAnnotation {
@TestA(name="param",id=1,gid=Long.class) //类成员注解
private Integer age;
@TestA (name="construct",id=2,gid=Long.class)//构造方法注解
public UserAnnotation(){
}
@TestA(name="public method",id=3,gid=Long.class) //类方法注解
public void a(){
Map m = new HashMap(0);
}
@TestA(name="protected method",id=4,gid=Long.class) //类方法注解
protected void b(){
Map m = new HashMap(0);
}
@TestA(name="private method",id=5,gid=Long.class) //类方法注解
private void c(){
Map m = new HashMap(0);
}
public void b(Integer a){ 
}
}
 
下面到了最重要的一步了,就是如何读取咱们在类中定义的注解。只要读取出来了使用的话就简单了。
package com.tmser.annotation;
 
import java.lang.annotation.Annotation;
import java.lang.reflect.Constructor;
import java.lang.reflect.Method;
 
public class ParseAnnotation {
 
public static void parseTypeAnnotation() throws ClassNotFoundException {  
        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());  
        }  
    } 

public static void 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());  
            }  
        }  
}

public static void 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());  
            }  
        }  
}
public static void main(String[] args) throws ClassNotFoundException {
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. 不要滥用注解。日常咱们编程过程不多接触和使用注解,只有作设计,且不想让设计有过多的配置时
这个网址能够给你参考一些注解的例子:http://blog.sina.com.cn/s/blog_7540bf5f0100t3mv.html java 注解,从名字上看是注释,解释。但功能却不只仅是注释那么简单。注解(Annotation) 为咱们在代码中添加信息提供了一种形式化的方法,是咱们能够在稍后 某个时刻方便地使用这些数据(经过 解析注解 来使用这些数据),常见的做用有如下几种:
1.生成文档。这是最多见的,也是java 最先提供的注解。经常使用的有@see @param @return 等;
2.跟踪代码依赖性,实现替代配置文件功能。比较常见的是spring 2.5 开始的基于注解配置。做用就是减小配置。如今的框架基本都使用了这种配置来减小配置文件的数量;
3.在编译时进行格式检查。如@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;
public @interface TestA {
//这里定义了一个空的注解,它能干什么呢。我也不知道,但他能用。
}

在下面这个程序中使用它:

package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
@TestA    //使用了类注解
public class UserAnnotation {
    
    @TestA //使用了类成员注解
    private Integer age;
    
    @TestA //使用了构造方法注解
    public UserAnnotation(){
        
    }
    @TestA //使用了类方法注解
    public void a(){
        @TestA //使用了局部变量注解
        Map m = new HashMap(0);
    }
    
    public void b(@TestA Integer 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;
 
@Target(ElementType.PACKAGE)  //与前面定义的注解不一样的地方,这里使用了元注解Target
public @interface TestA {
 
}
ctrl+ s 保存,今天电脑比较给力,咱们的测试类那边立马出现了一堆错误,除了类注解。我想到这,聪明的你马上明白了这个元注解的意义了。是否是想固然的偷起懒来了。?难道还有意外?细心的朋友应该发现了,咱们的测试类少了一个属性没用,就是ElemenetType.PACKAGE。在咱们的注解加上这个属性的元注解后,咱们测试程序的元注解所有阵亡,不对,还有一个没加呢,好加上。package 包,想固然是加载 package 前面。即
@TestA package 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;
 
@Target(ElementType.PACKAGE)
@Retention(RetentionPolicy.RUNTIME)
 
public @interface TestA {
 
}
第三和第四个元注解就再也不举例了。比较简单,也没有值,相信看过上面的解释也就清楚了。下面咱们仍是继续来深刻的探讨下注解的使用。上面的例子都很是简单,注解连属性都没有。ok,下面咱们就来定义一个有属性的注解,并在例子程序中获取都注解中定义的值。

开始以前将下定义属性的规则:
        @interface用来声明一个注解,其中的每个方法其实是声明了一个配置参数。方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是基本类型、Class、String、enum)。能够经过default来声明参数的默认值。

代码:
 
@Target({TYPE,METHOD,FIELD,CONSTRUCTOR})
@Retention(RetentionPolicy.RUNTIME)
public @interface TestA {
String name();
int id() default 0;
Class gid();
}

下面改下咱们的测试类:
package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
 
@TestA(name="type",gid=Long.class) //类成员注解
public class UserAnnotation {
@TestA(name="param",id=1,gid=Long.class) //类成员注解
private Integer age;
@TestA (name="construct",id=2,gid=Long.class)//构造方法注解
public UserAnnotation(){
}
@TestA(name="public method",id=3,gid=Long.class) //类方法注解
public void a(){
Map m = new HashMap(0);
}
@TestA(name="protected method",id=4,gid=Long.class) //类方法注解
protected void b(){
Map m = new HashMap(0);
}
@TestA(name="private method",id=5,gid=Long.class) //类方法注解
private void c(){
Map m = new HashMap(0);
}
public void b(Integer a){ 
}
}
 
下面到了最重要的一步了,就是如何读取咱们在类中定义的注解。只要读取出来了使用的话就简单了。
package com.tmser.annotation;
 
import java.lang.annotation.Annotation;
import java.lang.reflect.Constructor;
import java.lang.reflect.Method;
 
public class ParseAnnotation {
 
public static void parseTypeAnnotation() throws ClassNotFoundException {  
        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());  
        }  
    } 

public static void 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());  
            }  
        }  
}

public static void 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());  
            }  
        }  
}
public static void main(String[] args) throws ClassNotFoundException {
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. 不要滥用注解。日常咱们编程过程不多接触和使用注解,只有作设计,且不想让设计有过多的配置时
这个网址能够给你参考一些注解的例子:http://blog.sina.com.cn/s/blog_7540bf5f0100t3mv.html java 注解,从名字上看是注释,解释。但功能却不只仅是注释那么简单。注解(Annotation) 为咱们在代码中添加信息提供了一种形式化的方法,是咱们能够在稍后 某个时刻方便地使用这些数据(经过 解析注解 来使用这些数据),常见的做用有如下几种:
1.生成文档。这是最多见的,也是java 最先提供的注解。经常使用的有@see @param @return 等;
2.跟踪代码依赖性,实现替代配置文件功能。比较常见的是spring 2.5 开始的基于注解配置。做用就是减小配置。如今的框架基本都使用了这种配置来减小配置文件的数量;
3.在编译时进行格式检查。如@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;
public @interface TestA {
//这里定义了一个空的注解,它能干什么呢。我也不知道,但他能用。
}

在下面这个程序中使用它:

package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
@TestA    //使用了类注解
public class UserAnnotation {
    
    @TestA //使用了类成员注解
    private Integer age;
    
    @TestA //使用了构造方法注解
    public UserAnnotation(){
        
    }
    @TestA //使用了类方法注解
    public void a(){
        @TestA //使用了局部变量注解
        Map m = new HashMap(0);
    }
    
    public void b(@TestA Integer 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;
 
@Target(ElementType.PACKAGE)  //与前面定义的注解不一样的地方,这里使用了元注解Target
public @interface TestA {
 
}
ctrl+ s 保存,今天电脑比较给力,咱们的测试类那边立马出现了一堆错误,除了类注解。我想到这,聪明的你马上明白了这个元注解的意义了。是否是想固然的偷起懒来了。?难道还有意外?细心的朋友应该发现了,咱们的测试类少了一个属性没用,就是ElemenetType.PACKAGE。在咱们的注解加上这个属性的元注解后,咱们测试程序的元注解所有阵亡,不对,还有一个没加呢,好加上。package 包,想固然是加载 package 前面。即
@TestA package 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;
 
@Target(ElementType.PACKAGE)
@Retention(RetentionPolicy.RUNTIME)
 
public @interface TestA {
 
}
第三和第四个元注解就再也不举例了。比较简单,也没有值,相信看过上面的解释也就清楚了。下面咱们仍是继续来深刻的探讨下注解的使用。上面的例子都很是简单,注解连属性都没有。ok,下面咱们就来定义一个有属性的注解,并在例子程序中获取都注解中定义的值。

开始以前将下定义属性的规则:
        @interface用来声明一个注解,其中的每个方法其实是声明了一个配置参数。方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是基本类型、Class、String、enum)。能够经过default来声明参数的默认值。

代码:
 
@Target({TYPE,METHOD,FIELD,CONSTRUCTOR})
@Retention(RetentionPolicy.RUNTIME)
public @interface TestA {
String name();
int id() default 0;
Class gid();
}

下面改下咱们的测试类:
package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
 
@TestA(name="type",gid=Long.class) //类成员注解
public class UserAnnotation {
@TestA(name="param",id=1,gid=Long.class) //类成员注解
private Integer age;
@TestA (name="construct",id=2,gid=Long.class)//构造方法注解
public UserAnnotation(){
}
@TestA(name="public method",id=3,gid=Long.class) //类方法注解
public void a(){
Map m = new HashMap(0);
}
@TestA(name="protected method",id=4,gid=Long.class) //类方法注解
protected void b(){
Map m = new HashMap(0);
}
@TestA(name="private method",id=5,gid=Long.class) //类方法注解
private void c(){
Map m = new HashMap(0);
}
public void b(Integer a){ 
}
}
 
下面到了最重要的一步了,就是如何读取咱们在类中定义的注解。只要读取出来了使用的话就简单了。
package com.tmser.annotation;
 
import java.lang.annotation.Annotation;
import java.lang.reflect.Constructor;
import java.lang.reflect.Method;
 
public class ParseAnnotation {
 
public static void parseTypeAnnotation() throws ClassNotFoundException {  
        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());  
        }  
    } 

public static void 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());  
            }  
        }  
}

public static void 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());  
            }  
        }  
}
public static void main(String[] args) throws ClassNotFoundException {
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. 不要滥用注解。日常咱们编程过程不多接触和使用注解,只有作设计,且不想让设计有过多的配置时
这个网址能够给你参考一些注解的例子:http://blog.sina.com.cn/s/blog_7540bf5f0100t3mv.html java 注解,从名字上看是注释,解释。但功能却不只仅是注释那么简单。注解(Annotation) 为咱们在代码中添加信息提供了一种形式化的方法,是咱们能够在稍后 某个时刻方便地使用这些数据(经过 解析注解 来使用这些数据),常见的做用有如下几种:
1.生成文档。这是最多见的,也是java 最先提供的注解。经常使用的有@see @param @return 等;
2.跟踪代码依赖性,实现替代配置文件功能。比较常见的是spring 2.5 开始的基于注解配置。做用就是减小配置。如今的框架基本都使用了这种配置来减小配置文件的数量;
3.在编译时进行格式检查。如@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;
public @interface TestA {
//这里定义了一个空的注解,它能干什么呢。我也不知道,但他能用。
}

在下面这个程序中使用它:

package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
@TestA    //使用了类注解
public class UserAnnotation {
    
    @TestA //使用了类成员注解
    private Integer age;
    
    @TestA //使用了构造方法注解
    public UserAnnotation(){
        
    }
    @TestA //使用了类方法注解
    public void a(){
        @TestA //使用了局部变量注解
        Map m = new HashMap(0);
    }
    
    public void b(@TestA Integer 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;
 
@Target(ElementType.PACKAGE)  //与前面定义的注解不一样的地方,这里使用了元注解Target
public @interface TestA {
 
}
ctrl+ s 保存,今天电脑比较给力,咱们的测试类那边立马出现了一堆错误,除了类注解。我想到这,聪明的你马上明白了这个元注解的意义了。是否是想固然的偷起懒来了。?难道还有意外?细心的朋友应该发现了,咱们的测试类少了一个属性没用,就是ElemenetType.PACKAGE。在咱们的注解加上这个属性的元注解后,咱们测试程序的元注解所有阵亡,不对,还有一个没加呢,好加上。package 包,想固然是加载 package 前面。即
@TestA package 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;
 
@Target(ElementType.PACKAGE)
@Retention(RetentionPolicy.RUNTIME)
 
public @interface TestA {
 
}
第三和第四个元注解就再也不举例了。比较简单,也没有值,相信看过上面的解释也就清楚了。下面咱们仍是继续来深刻的探讨下注解的使用。上面的例子都很是简单,注解连属性都没有。ok,下面咱们就来定义一个有属性的注解,并在例子程序中获取都注解中定义的值。

开始以前将下定义属性的规则:
        @interface用来声明一个注解,其中的每个方法其实是声明了一个配置参数。方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是基本类型、Class、String、enum)。能够经过default来声明参数的默认值。

代码:
 
@Target({TYPE,METHOD,FIELD,CONSTRUCTOR})
@Retention(RetentionPolicy.RUNTIME)
public @interface TestA {
String name();
int id() default 0;
Class gid();
}

下面改下咱们的测试类:
package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
 
@TestA(name="type",gid=Long.class) //类成员注解
public class UserAnnotation {
@TestA(name="param",id=1,gid=Long.class) //类成员注解
private Integer age;
@TestA (name="construct",id=2,gid=Long.class)//构造方法注解
public UserAnnotation(){
}
@TestA(name="public method",id=3,gid=Long.class) //类方法注解
public void a(){
Map m = new HashMap(0);
}
@TestA(name="protected method",id=4,gid=Long.class) //类方法注解
protected void b(){
Map m = new HashMap(0);
}
@TestA(name="private method",id=5,gid=Long.class) //类方法注解
private void c(){
Map m = new HashMap(0);
}
public void b(Integer a){ 
}
}
 
下面到了最重要的一步了,就是如何读取咱们在类中定义的注解。只要读取出来了使用的话就简单了。
package com.tmser.annotation;
 
import java.lang.annotation.Annotation;
import java.lang.reflect.Constructor;
import java.lang.reflect.Method;
 
public class ParseAnnotation {
 
public static void parseTypeAnnotation() throws ClassNotFoundException {  
        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());  
        }  
    } 

public static void 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());  
            }  
        }  
}

public static void 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());  
            }  
        }  
}
public static void main(String[] args) throws ClassNotFoundException {
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. 不要滥用注解。日常咱们编程过程不多接触和使用注解,只有作设计,且不想让设计有过多的配置时
这个网址能够给你参考一些注解的例子:http://blog.sina.com.cn/s/blog_7540bf5f0100t3mv.html java 注解,从名字上看是注释,解释。但功能却不只仅是注释那么简单。注解(Annotation) 为咱们在代码中添加信息提供了一种形式化的方法,是咱们能够在稍后 某个时刻方便地使用这些数据(经过 解析注解 来使用这些数据),常见的做用有如下几种:
1.生成文档。这是最多见的,也是java 最先提供的注解。经常使用的有@see @param @return 等;
2.跟踪代码依赖性,实现替代配置文件功能。比较常见的是spring 2.5 开始的基于注解配置。做用就是减小配置。如今的框架基本都使用了这种配置来减小配置文件的数量;
3.在编译时进行格式检查。如@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;
public @interface TestA {
//这里定义了一个空的注解,它能干什么呢。我也不知道,但他能用。
}

在下面这个程序中使用它:

package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
@TestA    //使用了类注解
public class UserAnnotation {
    
    @TestA //使用了类成员注解
    private Integer age;
    
    @TestA //使用了构造方法注解
    public UserAnnotation(){
        
    }
    @TestA //使用了类方法注解
    public void a(){
        @TestA //使用了局部变量注解
        Map m = new HashMap(0);
    }
    
    public void b(@TestA Integer 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;
 
@Target(ElementType.PACKAGE)  //与前面定义的注解不一样的地方,这里使用了元注解Target
public @interface TestA {
 
}
ctrl+ s 保存,今天电脑比较给力,咱们的测试类那边立马出现了一堆错误,除了类注解。我想到这,聪明的你马上明白了这个元注解的意义了。是否是想固然的偷起懒来了。?难道还有意外?细心的朋友应该发现了,咱们的测试类少了一个属性没用,就是ElemenetType.PACKAGE。在咱们的注解加上这个属性的元注解后,咱们测试程序的元注解所有阵亡,不对,还有一个没加呢,好加上。package 包,想固然是加载 package 前面。即
@TestA package 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;
 
@Target(ElementType.PACKAGE)
@Retention(RetentionPolicy.RUNTIME)
 
public @interface TestA {
 
}
第三和第四个元注解就再也不举例了。比较简单,也没有值,相信看过上面的解释也就清楚了。下面咱们仍是继续来深刻的探讨下注解的使用。上面的例子都很是简单,注解连属性都没有。ok,下面咱们就来定义一个有属性的注解,并在例子程序中获取都注解中定义的值。

开始以前将下定义属性的规则:
        @interface用来声明一个注解,其中的每个方法其实是声明了一个配置参数。方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是基本类型、Class、String、enum)。能够经过default来声明参数的默认值。

代码:
 
@Target({TYPE,METHOD,FIELD,CONSTRUCTOR})
@Retention(RetentionPolicy.RUNTIME)
public @interface TestA {
String name();
int id() default 0;
Class gid();
}

下面改下咱们的测试类:
package com.tmser.annotation;
 
import java.util.HashMap;
import java.util.Map;
 
 
@TestA(name="type",gid=Long.class) //类成员注解
public class UserAnnotation {
@TestA(name="param",id=1,gid=Long.class) //类成员注解
private Integer age;
@TestA (name="construct",id=2,gid=Long.class)//构造方法注解
public UserAnnotation(){
}
@TestA(name="public method",id=3,gid=Long.class) //类方法注解
public void a(){
Map m = new HashMap(0);
}
@TestA(name="protected method",id=4,gid=Long.class) //类方法注解
protected void b(){
Map m = new HashMap(0);
}
@TestA(name="private method",id=5,gid=Long.class) //类方法注解
private void c(){
Map m = new HashMap(0);
}
public void b(Integer a){ 
}
}
 
下面到了最重要的一步了,就是如何读取咱们在类中定义的注解。只要读取出来了使用的话就简单了。
package com.tmser.annotation;
 
import java.lang.annotation.Annotation;
import java.lang.reflect.Constructor;
import java.lang.reflect.Method;
 
public class ParseAnnotation {
 
public static void parseTypeAnnotation() throws ClassNotFoundException {  
        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());  
        }  
    } 

public static void 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());  
            }  
        }  
}

public static void 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());  
            }  
        }  
}
public static void main(String[] args) throws ClassNotFoundException {
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. 不要滥用注解。日常咱们编程过程不多接触和使用注解,只有作设计,且不想让设计有过多的配置时
这个网址能够给你参考一些注解的例子:http://blog.sina.com.cn/s/blog_7540bf5f0100t3mv.html java 注解,从名字上看是注释,解释。但功能却不只仅是注释那么简单。注解(Annotation) 为咱们在代码中添加信息提供了一种形式化的方法,是咱们能够在稍后 某个时刻方便地使用这些数据(经过 解析注解 来使用这些数据),常见的做用有如下几种:
1.生成文档。这是最多见的,也是java 最先提供的注解。经常使用的有@see @param @return 等;
2.跟踪代码依赖性,实现替代配置文件功能。比较常见的是spring 2.5 开始的基于注解配置。做用就是减小配置。如今的框架基本都使用了这种配置来减小配置文件的数量;
3.在编译时进行格式检查。如@Override放在方法前,若是你这个方法并非覆盖了超类方法,则编译时就能检查出;

包 java.lang.annotation 中包含全部定义自定义注解所需用到的原注解和接口。如接口 java.lang.annotation.Annotation 是全部注解继承的接口,而且是自动继承,不须要定义时指定,相似于全部类都自动继承Object。

该包同时定义了四个元注解,Documented,Inherited,Target(做用范围,方法,属性,构造方法等),Retention(生命范围,源代码,class,runtime)。下面将在实例中逐个讲解他们的做用,及使用方法。