Annotation注解 总结

       annotation（注解）并不直接影响代码语义，但是它能够工作的方式被看作类似程序的工具或者类库，它会反过来对正在运行的程序语义有所影响。annotation可以从源文件、class文件或者以在运行时反射的多种方式被读取。
      JDK5内建的annotation 有@Override @Deprecated @SuppressWarnings

       @Override 当子类重写父类的方法时，在子类的方法上面加上此注释，可以检查重写的方法是否正确。

       @Deprecated 标示此方法已经过时。

       @SuppressWarnings 将警告忽略。@SuppressWarnings({"unchecked","deprecation"})

       

例如：Map map = new Map();会出现警告，应为没有应用泛型，
正确的为Map<?,?> map = new Map<?,?>();此方法前加上@SuppressWarnings("unchecked")警告会消失。

  

自定义annotation

使用@interface自行定义Annotation型态时，实际上是自动继承了java.lang.annotation.Annotation接口
由编译程序自动为您完成其它产生的细节

 

1、创建一个自定义的annotation名为MyAnnotation

public @interface MyAnnotation
{
	String hello() default "wangjie";
	String world();
}

    annotation 方法中默认为 String value(); 如果为默认属性时，可以使用@MyAnnotation("XXX") 否则得使用@MyAnnotation(hello="XXX",world="XXX") .hello的值将覆盖default中的值"wangjie".另外hello()有默认值所以@MyAnnotation(world="XXX")也是正确的。

2、创建一个测试类

//annotation 可以放在类、方法、属性前面。
@MyAnnotation(hello = "beijing", world = "shanghai")
public class MyTest
{
	@MyAnnotation(hello = "beijing", world = "shanghai")
	public void output()
	{
		System.out.println("output something");
	}
}

 2.1 这样就完成了注释的编写。注释会在程序代码、编译、运行时都会保留吗？这还需要自己来设定。

        java.lang.annotation.Retention型态可以在您定义Annotation型态时，指示编译程序该如何对待您的自定义的    Annotation型态
         预设上编译程序会将Annotation信息留在.class档案中，但不被虚拟机读取，而仅用于编译程序或工具程序运行时提供信息
         在使用Retention型态时，需要提供java.lang.annotation.RetentionPolicy的枚举型态
package java.lang.annotation;
public enum RetentionPolicy
 {
     SOURCE, //编译程序处理完Annotation信息后就完成任务
     CLASS,  //编译程序将Annotation储存于class档中，缺省
     RUNTIME //编译程序将Annotation储存于class檔中，可由VM读入
}

所以要指示annotation可以保留在何种方式中，需要用到：@Retention(XXX) xxx为RetentionPolicy.RUNTIME 或

RetentionPolicy.SOURCE 默认为RetentionPolicy.CLASS

 

例如将上面可以MyAnnotation修改为

@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation
{
	String hello() default "wangjie";
	String world();
}

 这样在程序运行时就可以调用MyAnnotation 中的值了。调用采用反射。

例如：

import java.lang.annotation.Annotation;
import java.lang.reflect.Method;

public class MyReflection
{
	public static void main(String[] args) throws Exception
	{
		MyTest myTest = new MyTest();
		
		Class<MyTest> c = MyTest.class;
		
		Method method = c.getMethod("output",new Class[]{});
		
		if(method.isAnnotationPresent(MyAnnotation.class))
		{
			MyAnnotation myAnnotation = method.getAnnotation(MyAnnotation.class);
			
			String hello = myAnnotation.hello();
			String world = myAnnotation.world();
			
			System.out.println(hello);
			System.out.println(world);
			
		}
		//打印出方法上面所使用的所以annotation的类型名称。 
		Annotation[] annotations = method.getAnnotations();
		
		for(Annotation annotation : annotations)
		{
			System.out.println(annotation.annotationType().getName());
		}
		
	}
}	

 结果为：

beijing
shanghai
com.langsin.annotation.MyAnnotation

 2.2 如果要限定annotation放置的位置 可以使用@Target()

例如

@Target(ElementType.METHOD)  //这里加入了，则表示MyAnnotation只能放在方法的前面。
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation
{
	String hello() default "langsin";
	String world();
}

 Target的参数有：

package java.lang.annotation;
public enum ElementType 
{
     TYPE, //适用class, interface, enum
     FIELD, //适用field
     METHOD, //适用method
     PARAMETER, //适用method上之parameter
     CONSTRUCTOR, //适用constructor
     LOCAL_VARIABLE, //适用局部变量
     ANNOTATION_TYPE, //适用annotation型态
     PACKAGE //适用package
}

 2.3 如果一个父类加入了@MyAnnotation() 他的子类也想继承父类的这个注释。则在MyAnnotation中需要加入@Inherited()  这样在子类中才能得到这个注释的内容。（运用反射）。

 

@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface MyAnnotation
{
	String hello() default "wangjie";
	String world();
}

 

 2.4 想要在使用者制作JavaDoc文件的同时，也一并将Annotation的讯息加入至API文件中
使用java.lang.annotation.Documented

即在annotation  前加入@Documented

例如：

@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyAnnotation
{
	String hello() default "wangjie";
	String world();
}