自定义注解及注解的解析

一、注解的概念

1、注解是JDK1.5开始的概念
2、注解相当于一种标记，是类的组成部分，可以给类携带一些额外的信息。但是去掉注解，该类依然是一个完整的类。
3、注解是给编译器或JVM看的，编译器或JVM可以根据注解来完成对应的功能。

二、自定义注解

2.1、定义格式

public @interface 注解名{
}
如：定义一个名为Student的注解
public @interface Student {
}

2.2、注解的属性

1、属性的作用：

• 可以让用户在使用注解时传递参数，让注解的功能更加强大

2、属性的格式：

• 格式1：数据类型 属性名();
• 格式2：数据类型 属性名() default 默认值；

3、属性定义示例

public @interface Student {
	String name(); // 姓名
	int age() default 18; // 年龄
	String gender() default "男"; // 性别
} 
// 该注解就有了三个属性：name，age，gender

4、属性适用的数据类型

• 八种基本数据类型(byte,short,int,long,char,float,double,boolean)
• String类型，Class类型，枚举类型，注解类型
• 以上类型的一维数组

2.3 使用自定义注解

//自定义注解
public @interface Book {
	// 书名
	String value();
	// 价格
	double price() default 100;
	// 多位作者
	String[] authors();
}

//使用注解Book
public class BookShelf{
	@Book(value="西游记",price=998,authors={"吴承恩","白求恩"})
	public void showBook(){
	}
}

• 如果属性有默认值，则使用注解的时候，这个属性可以不用赋值
• 如果属性没有默认值，那么在使用注解是一定要给属性赋值

特殊属性value

1、当注解中只有一个属性且名称是value,在使用注解时给value属性赋值可以直接给属性值，无论value是单值元素还是数组类型

// 定义注解Book
public @interface Book {
	// 书名
	String value();
} 
// 使用注解Book
public class BookShelf {
	@Book("西游记")
	public void showBook(){
	}
}

• 如果注解中除了value属性还有其他属性，且至少有一个属性没有默认值，则在使用注解给属性赋值时，value属性名不能省略

2.4注解之元注解

是java API提供的注解，是专门用来定义注解的注解

1、常用元注解

@Target

//作用：指明此注解用在哪个位置，如果不写默认是任何地方都可以使用
//可选的参数值在枚举类ElementType中包括：
TYPE： 用在类,接口上
FIELD：用在成员变量上
METHOD： 用在方法上
PARAMETER：用在参数上
CONSTRUCTOR：用在构造方法上
LOCAL_VARIABLE：用在局部变量上

@Retention

//作用：定义该注解的生命周期（有效范围）
//可选的参数值在枚举类型RetentionPolicy中包括
SOURCE：注解只存在于Java源代码中，编译生成的字节码文件中就不存在了。
CLASS：注解存在于Java源代码、编译以后的字节码文件中，运行的时候内存中没有(默认值)
RUNTIME：注解存在于Java源代码中、编译以后的字节码文件中、运行时内存中，程序可以通过反射获取该注解。

2、元注解使用案例

@Target({ElementType.METHOD,ElementType.TYPE})
@interface Stu{
	String name();
}

//类
@Stu(name="jack")
public class AnnotationDemo{
	@Stu(name = "rose")      //编译失败
	private String gender;
}

2.5注解解析

概念：通过Java技术获取注解数据的过程则成为注解解析

1、与注解解析相关的接口

• Annotation:所有注解类型的公共接口
• AnnotationElement:定义了与注解解析相关的方法，常用方法有以下四个：

boolean isAnnotationPresent(Class annotationClass); 判断当前对象是否有指定的注解，有则返回true，否则返回false。
T getAnnotation(Class<T> annotationClass); 获得当前对象上指定的注解对象。
Annotation[] getAnnotations(); 获得当前对象及其从父类上继承的所有的注解对象。
Annotation[] getDeclaredAnnotations();获得当前对象上所有的注解对象，不包括父类的。

2、获取注解数据的原理

注解作用在哪个成员上，就通过反射获得该成员的对象来得到它的注解。
如：如果注解作用在方法上，就通过方法(Method)对象得到它的注解

//得到方法对象
Method method = clazz.getDeclaredMethod("方法名");
// 根据注解名得到方法上的注解对象
Book book = method.getAnnotation(Book.class);

//如果注解作用到类上
// 获得Class对象
Class c = 类名.class;
// 根据注解的Class获得使用在类上的注解对象
Book book = c.getAnnotation(Book.class);

3、使用反射获取注解的数据

（1）定义注解Book

@Target({ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Book{
	//书名
	String value();
	//价格
	double price() default 100;
	//作者
	String[] authors();
}

（2）使用注解BookStore类

public class BookStore{
	@Book(value="西游记",authors="吴承恩")
	public void buyBook(){
	}
}

（3）解析注解

public class testAnnotation{
	public static void main(String[] args){
		//获得BookStore类对应的Class对象
		Class c = BookStore.class;
		//获得成员方法buyBook对应的Mthod对象
		Method m = c.getMethod("buyBook");
		//判断成员方法buyBook上是否使用了Book注解
		if(m.isAnnotationPresent(Book.class)){
			//根据注解Class对象获取注解对象
			Book book = (Book)m.getAnnotation(Book.class);
			//输出book注解的属性值
			System.out.println("书名：" + book.value());
			System.out.println("价格：" + book.price());
			System.out.println("作者：" + Arrays.toString(book.authors()));
		}
	}
}

三、自定义注解案例

模拟Junit测试的@Tes

1、 注解MyTest

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyTest {
}

2、 目标类MyTestDemo

public class MyTestDemo {
	@MyTest
	public void test01(){
		System.out.println("test01");
	} 
	public void test02(){
		System.out.println("test02");
	} 
	@MyTest
	public void test03(){
		System.out.println("test03");
	}
}

3、 调用类TestMyTest

public class TestMyTest {
	public static void main(String[] args) throws Exception{
		// 获得MyTestDemo类Class对象
		Class c = MyTestDemo.class;
		// 获得所有的成员方法对象
		Method[] methods = c.getMethods();
		// 创建MyTestDemo类对象
		Object obj = c.newInstance();
		// 遍历数组
		for (Method m:methods) {
			// 判断方法m上是否使用注解MyTest
			if(m.isAnnotationPresent(MyTest.class)){
				// 执行方法m
				m.invoke(obj);
			}
		}
	}
}