注解

注解

概念
说明程序的,给计算机看的.
注释
用文字描述程序的,给程序员看的.

定义:注解（Annotation），也叫元数据。一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性，与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面，用来对这些元素进行说明，注释。
概念描述:

1. JDK1.5之后的新特性
2. 说明程序的
3. 使用注解:@注解名称

作用分类:

1.编写文档:通过代码里标识的注解生成文档[ 生成文档doc文档]
2.代码分析:通过代码里标识的注解对代码进行分析[使用反射]
3.编译检查::通过代码里标识的注解让编译器能够实现基本的编译检查[Override]

内建注解（JDK预定义的）
@Override：检测被该注解标注的方法是否是继承(重写)自父类(接口)的某方法
@Deprecated：该注解标注的内容，表示已过时.
如果使用,编译器会该程序元素上画一条斜线,标识已过时.
@SuppressWarnings ：压制警告
被用于有选择的关闭编译器对类,方法,成员变量等程序元素及其子类元素的警告
@SuppressWarnings方法包括:
deprecation:使用了过时的程序元素
unchecked:执行了未检查的转换
unused:有程序元素为被使用
fallthrough:switch程序块直接通往下一种情况而没有break;
path:在类路径,源文件路径等中有不存在的路径
serial:在可序列化的类上缺少serialVersionUID定义
finally;任何finally子局不能正常执行
all:所有情况
一般传递参数all @SuppressWarnings(“all”)

全部代码块

package com.atbdqn.annotation;
import java.util.Date;
/**
* @Override：检测被该注解标注的方法是否是继承父类的
* @Deprecated：该注解标注的内容，表示已过时 
* @SuppressWarnings ：压制警告
* @author Administator 
*
*/
抑制所有类型的警告
@SuppressWarnings("all")
public class AnnoDemo1 {
@Override
public String toString() {
	return super.toString();
}

@Deprecated
public void show() {
	//发现有缺陷
	//如果直接删除，会导致低版本的程序不兼容
	//此时可以用标注为过时
}

//当前方法的警告没有了，一般情况放在类上，压制类所有警告
//@SuppressWarnings("all")
public void show1() {
	//新方法替代上面的show
}

//注解测试方法
public void test() {
	show();//自定义的过时方法
	Date date=new Date();
	date.setDate(3);//api 里过时的
}
}

还有几种压制方法
抑制单类型的警告

@SuppressWarnings("unchecked")
public void addItems(String item){
  @SuppressWarnings("rawtypes")
   List items = new ArrayList();
   items.add(item);
}

抑制多类型的警告

@SuppressWarnings(value={"unchecked", "rawtypes"})
public void addItems(String item){
   List items = new ArrayList();
   items.add(item);
}

自定义注解
格式:

元注解
如:
@Target(value = {ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface 注解名称{ 
	属性列表
	}

本质:
注解本质就是一个接口，该接口默认继承了Annotation 接口

public interface MyAnno extends java.lang.annotation.Annotation {
}

属性:接口中的抽象方法
要求:

• 属性的返回值类型有下列取值
  基本数据类型
  String类型
  枚举
  注解
  以上类型的数组

• 定义了属性,在使用时需要给属性赋值
  如果定义属性时,使用default关键字给属性默认初始化值,则使用注解时,可以不进行属性的赋值.
  如果只有一个属性需要赋值,并且属性的名称是Value,则Value
  可以省略,直接定义值即可.
  数组赋值时,值使用{ }包裹起来,如果数组中有一个值,则{ }省略

定义了属性时，在使用时需要给属性赋值

如果定义属性时，使用defalut关键字给属性默认初始化值，则使用注解时，可以不进行属性的赋值

只有一个属性需要赋值，并且属性名称是value,则value可以省略，直接定义值即可

元注解(用于描述注解的注解）
@Target:描述注解能够作用的位置
ElementType 取值:
/** 类，接口（包括注解类型）或枚举的声明 /
TYPE,
/* 属性的声明 */
FIELD,

		    /** 方法的声明 */
		    METHOD,
		
		    /** 方法形式参数声明 */
		    PARAMETER,
		
		    /** 构造方法的声明 */
		    CONSTRUCTOR,
		
		    /** 局部变量声明 */
		    LOCAL_VARIABLE,
		
		    /** 注解类型声明 */
		    ANNOTATION_TYPE,
		
		    /** 包的声明 */
		    PACKAGE

//当前注解既可以作用于类上，又可以作用于方法上，也可以作用于成员变量上
//如果只需要作用于某一个上，写一个即可
@Target(value= {ElementType.TYPE,ElementType.METHOD,ElementType.FIELD})
public @interface AnnoDemo2 { 
}

@AnnoDemo2//作用于类上
 public class Student { 
 @AnnoDemo2//作用于成员变量 
 private String name; 
 @AnnoDemo2//作用于方法上
 public void show() { 
 } 
 }

@Retention:描述注解被保留的阶段
@Retention(RetentionPolicy.RUNTIME) 当前被描述的注解,会保留到class字节码文件中,并被JVM读取到
还有两种是
如果一个注解被定义为RetentionPolicy.SOURCE，则它将被限定在Java源文件中，那么这个注解即不会参与编译也不会在运行期起任何作用，这个注解就和一个注释是一样的效果，只能被阅读Java文件的人看到；
如果一个注解被定义为RetentionPolicy.CLASS，则它将被编译到Class文件中，那么编译器可以在编译时根据注解做一些处理动作，但是运行时JVM（Java虚拟机）会忽略它，我们在运行期也不能读取到；

@Documented注解:描述注解是否被抽取到api文档中
@Documented注解是被用来指定自定义注解是否能随着被定义的java文件生成到JavaDoc文档当中。

@Inherited：描述注解是否被子类继承
@Inherited注解是指定某个自定义注解如果写在了父类的声明部分，那么子类的声明部分也能自动拥有该注解。

在程序使用（解析）注解(获取注解里定义的属性值）
1.获取注解定义的位置的对象 (Class,Method,field,Package,Constructor)
2.获取直接的注解
java.lang.rflect.AnnontatedElement接口是所有程序元素的父接口,程序通过反射获得某个类的AnnontatedElement对象(如类,方法,成员变量),调用该对象的3个方法就可以来访问注解信息
getAnnontation()方法:用于返回该程序元素上存在的,指定类型的注解,如果该类型的注解不存在,则返回null;
getAnnontations()方法:用来返回该程序元素上存在的所有注解
isAnnontationPresent()方法:用来判断该程序元素上是否包含指定类型的注解,如果存在返回true.否则返回false

/**
getAnnontation(Class)
//其实就是在内存中生成了一个该注释接口的子类实现对象
* public class ProAnnoImpl implements ProAnno{
* public String className(){
* 	return "com.atbdqn.annotation.Worker";
* }
* public String methodName(){
* 	return "show";
* }
* }
*/ 

3.调用注解中的抽象方法获取配置的属性值
案例

package com.atbdqn.annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* 描述需要去执行的类名和方法名
*  @author Administator
* /

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface ProAnno {
	String className();
	String methodName();
}

package com.atbdqn.annotation;

public class Worker {
	public void show() {
		System.out.println("worker....show");
		}
	}

package com.atbdqn.annotation;
import java.lang.reflect.Method;
/**
* @author Administator 
*/

@ProAnno(className="com.atbdqn.annotation.Worker",methodName="show")
public class ReflectTest {
	public static void main(String[] args) throws Exception{
	//解析注解
	//获得该类的字节码文件对象
	Class<ReflectTest> reflectTest=ReflectTest.class;
	//获取上面注解对象
	//其实就是在内存中生成一个该注解接口的子类实现对象
	/**
/**
* public class ProAnnoImpl implements ProAnno{
* public String className(){
* 	return "com.atbdqn.annotation.Worker";
* }
* public String methodName(){
* 	return "show";
* }
* }
*/

//获取指定注解上的类型
ProAnno pro=reflectTest.getAnnotation(ProAnno.class);
//调用 注解对象中定义的抽象方法，获取返回值
String className=pro.className(); 
String methodName=pro.methodName(); 
//System.out.println(className); 
//System.out.println(methodName); 
//类加载到内存 
Class cls=Class.forName(className);
 //创建对象 
 Object obj=cls.newInstance(); 
 //获取方法对象 
 Method method=cls.getMethod(methodName); 
 //执行方法
 method.invoke(obj);
 }
 }