`

Java Annotation (二)

    博客分类:
  • java
阅读更多

      首先分析jdk自带的java.lang.annotation包里的源文件:

 

      1、Target.java

 

@Documented  
@Retention(RetentionPolicy.RUNTIME)   
@Target(ElementType.ANNOTATION_TYPE)   
public @interface  Target {   
      ElementType[] value();   
}  

 

 

       其中的@interface是一个关键字,在设计annotations的时候必须把一个类型定义为@interface,而不能用class或interface关键字

说明:所有的Annotation会自动继承java.lang.annotation这一个接口,所以不能再去继承别的类或是接口.

 

       2、Retention.java

 

@Documented  
@Retention(RetentionPolicy.RUNTIME)   
@Target(ElementType.ANNOTATION_TYPE)   
public @interface Retention {   
      RetentionPolicy value();   
}  

 

       3、RetentionPolicy.java

 

public enum RetentionPolicy {   
      OURCE,   
      CLASS,   
      RUNTIME   
}  

 

      这是一个enum类型,共有三个值,分别是SOURCE,CLASS 和 RUNTIME.
      SOURCE代表的是这个Annotation类型的信息只会保留在程序源码里,源码如果经过了编译之后,Annotation的数据就会消失,并不会保留在编译好的.class文件里面。
      ClASS的意思是这个Annotation类型的信息保留在程序源码里,同时也会保留在编译好的.class文件里面,在执行的时候,并不会把这一些信息加载到虚拟机(JVM)中去.注意一下,当你没有设定一个Annotation类型的Retention值时,系统默认值是CLASS.
       第三个,是RUNTIME,表示在源码、编译好的.class文件中保留信息,在执行的时候会把这一些信息加载到JVM中去的. 举一个例子,如@Override里面的Retention设为SOURCE,编译成功了就不要这一些检查的信息;相反,@Deprecated里面的Retention设为RUNTIME,表示除了在编译时会警告我们使用了哪个被Deprecated的方法,在执行的时候也可以查出该方法是否被Deprecated.

       4、ElementType.java

 

public enum ElementType {   
     TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR,   
     LOCAL_VARIABLE, ANNOTATION_TYPE,PACKAGE   
}

 

   @Target里面的ElementType是用来指定Annotation类型可以用在哪一些元素上的.说明一下:TYPE(类型), FIELD(属性), METHOD(方法), PARAMETER(参数), CONSTRUCTOR(构造函数),LOCAL_VARIABLE(局部变量), ANNOTATION_TYPE,PACKAGE(包),其中的TYPE(类型)是指可以用在Class,Interface,Enum和Annotation类型上.
   另外,从1的源代码可以看出,@Target自己也用了自己来声明自己,只能用在ANNOTATION_TYPE之上.
   如果一个Annotation类型没有指明@Target使用在哪些元素上,那么它可以使用在任何元素之上,这里的元素指的是上面的八种类型.
   举几个正确的例子:
   @Target(ElementType.METHOD)
   @Target(value=ElementType.METHOD)
   @Target(ElementType.METHOD,ElementType.CONSTRUCTOR)  
   具体参考一下javadoc文档

 

举个 Annotation实例

  创建以下几个类文件:

   1、 Description.java

 

   

 

package com.annotation.demo;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import java.lang.annotation.ElementType;
import java.lang.annotation.RetentionPolicy;

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Description {

	String value();
}

 

    说明:所有的Annotation会自动继承java.lang.annotation这一个接口,所以不能再去继承别的类或是接口.
   最重要的一点,Annotation类型里面的参数该怎么设定:
   第一,只能用public或默认(default)这两个访问权修饰.例如,String value();这里把方法设为defaul默认类型.
   第二,参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和String,Enum,Class,annotations等数据类型,以及这一些类型的数组.例如,String value();这里的参数成员就为String.
   第三,如果只有一个参数成员,最好把参数名称设为"value",后加小括号.例:上面的例子就只有一个参数成员.

 

 

    2、Name.java

 

   

package com.annotation.demo;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Name {

	String originate();
	String community();
	public enum CommunityNumber{LITTle,ORDINARY,WELL}
	CommunityNumber number() default CommunityNumber.WELL;
}

 

 

  3、JavaEyer.java

  

  

package com.annotation.demo;

@Description("javaeye, is good!")
public class JavaEyer {
	@Name(originate="创始人:robbin",community="javaeye")
	public String getName(){
		return null;
	}
}

 

 

  4、写一个可以运行提取JavaEyer信息的类AnnotationTest.java

 

  

package com.annotation.demo;

import java.lang.reflect.Method;
import java.util.HashSet;
import java.util.Set;

public class AnnotationTest {

	public static void main(String[] args) throws Exception{
		String CLASS_NAME = "com.annotation.demo.JavaEyer";
		Class test = Class.forName(CLASS_NAME);
		Method[] method =test.getMethods();
		boolean flag = test.isAnnotationPresent(Description.class);
		if(flag){
			Description des = (Description)test.getAnnotation(Description.class);
			System.out.println("描述: "+des.value());
		}
		
		Set<Method> set = new HashSet<Method>();
		for(int i=0;i<method.length;i++){
			boolean otherFlag = method[i].isAnnotationPresent(Name.class);
			if(otherFlag)
				set.add(method[i]);
		}
		
		for(Method m : set){
			Name name = m.getAnnotation(Name.class);
			System.out.println(name.originate());
			System.out.println("创建的社区: "+name.community());
		}
			
	}
}

 

 

测试结果:

 

描述: javaeye, is good!
创始人:robbin
创建的社区: javaeye

 

转载于:http://lighter.iteye.com

分享到:
评论

相关推荐

Global site tag (gtag.js) - Google Analytics