Annotation: 入门

Annotation的目的主要是减少源代码和配置文件中的重复，增强系统的一致性，以免修改配置忘了修改代码

Annotation本意是要加强原配置与代码的自动联系（把原来的配置写进代码，提高修改的便捷），完全符合软件工程指导

个人认为对那些与代码不存在联系的信息最好还是写在配置文件中，这样修改是不至于要重新编译

 

 

最常见的annotation
    ● @Override: 用在方法之上，用来告诉别人这一个方法是改写父类的
    ● @Deprecated: 建议别人不要使用旧的API的时候用的,编译的时候会用产生警告信息,可以设定在程序里的所有的元素上.
    ● @SuppressWarnings: 暂时把一些警告信息消息关闭
    ● @Entity: 表示该类是可持久化的类

 

1. 只有一个参数的Annotation实现

package com.wei.peng.annotation;

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;

/**
 * @author WPeng
 * @time  2011-2-17 下午02:01:05
 * @email [email protected]
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyAnnotation1 {
	String value();
}

 2. 有两个参数的Annotation实现

package com.wei.peng.annotation;

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;

/**
 * @author WPeng
 * @time  2011-2-17 下午02:01:12
 * @email [email protected]
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyAnnotation2 {
	String decription();
	boolean isAnnotation();
}

 3. Annotation实验类

package com.wei.peng.annotation;

/**
 * @author WPeng
 * @time  2011-2-17 下午02:00:57
 * @email [email protected]
 */
@MyAnnotation1("this is annotation1")
public class AnnotationDemo {
	
	@MyAnnotation2(decription="this is annotation2", isAnnotation=true)
	public void sayHello(){
		System.out.println("Hello World!");
	}

}

 4.Annotation测试说明类

package com.wei.peng.annotation;

import java.lang.reflect.Method;

/**
 * @author WPeng
 * @time  2011-2-17 下午02:00:50
 * @email [email protected]
 */
public class TestAnnotation {
	
	public static void main(String[] args){
		try{
			Class<?> cls = Class.forName("com.wei.peng.annotation.AnnotationDemo");
			boolean flag = cls.isAnnotationPresent(MyAnnotation1.class);
			
			if(flag){
				System.out.println("判断类是annotation");
				MyAnnotation1 annotation1 = cls.getAnnotation(MyAnnotation1.class);
				System.out.println(annotation1.value());
				
				/////////
				
				Method method = cls.getMethod("sayHello");
				flag = method.isAnnotationPresent(MyAnnotation2.class);
				if(flag){
					System.out.println("判断类是annotation");
					MyAnnotation2 annotation2 = method.getAnnotation(MyAnnotation2.class);
					System.out.println(annotation2.decription() + "\t" + annotation2.isAnnotation());
				}
			}
		}catch (Exception e) {
			// TODO: handle exception
		}
		
	}
}

  实验结果，控制台打出如下信息：

判断类是annotation
this is annotation1
判断方法也是annotation
this is annotation2     true

 

 

MyAnnotation1中的@Target(ElementType.TYPE)

＠Target里面的ElementType是用来指定Annotation类型可以用在哪些元素上的.例如：

TYPE(类型)、FIELD(属性)、METHOD(方法)、PARAMETER(参数)、CONSTRUCTOR(构造函 数)、LOCAL_VARIABLE(局部变量),、PACKAGE(包),其中的TYPE(类型)是指可以用在 Class,Interface,Enum和Annotation类型上。

 

MyAnnotation1中的@Retention(RetentionPolicy.RUNTIME)

RetentionPolicy 共有三种策略，分别为：

• SOURCE:这个Annotation类型的信息只会保留在程序源码里，源码如果经过了编译之后，Annotation的数据就会消失,并不会保留在编译好的.class文件里面
• CLASS:这个Annotation类型的信息保留在程序源码里,同时也会保留在编译好的.class文件里面,在执行的时候，并不会把这些信息加载到JVM中。注：默认策略为CLASS类型
• RUNTIME:表示在源码、编译好的.class文件中保留信息，在执行的时候会把这一些信息加载到JVM中去的

 

MyAnnotation1中的@Documented

目的就是将这一Annotation的信息显示在JAVA API文档上，如果没有增加@Documented的话，JAVA API文档上不会显示相关annotation信息

 

MyAnnotation1中的@interface

关键字，表示该类为Annotation定义

 

MyAnnotation1中的 String value();

表示有一个成员参数，名字为value，访问权为默认(default)修饰符，注意以下两点：

• 访问权只能用public和默认（default）修饰
• 参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和String,Enum,Class,annotations等数据类型,以及这一些类型的数组

AnnotationDemo中的@MyAnnotation1("this is annotation1")

因为MyAnnotation1只有一个参数，因此可以直接在括号中写上value值。注：如果Annotation只有一个参数，则建议最好将该参数名称定义为value

 

TestAnnotation中的cls.isAnnotationPresent(MyAnnotation1.class)

判断该类是否使用了MyAnnotation1的注释

 

TestAnnotation中的MyAnnotation1 annotation1 = cls.getAnnotation(MyAnnotation1.class)

返回该类针对MyAnnotation1的注释

 

TestAnnotation中的method.isAnnotationPresent(MyAnnotation2.class)

判断该方法是否使用了MyAnnotation2的注释