【Java】注解，注解的使用方法，用注解写框架类，自定义测试框架

注解的定义

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

注解的使用

使用注解：@注解名称

注解的作用分类

①编写文档：通过代码里标识的注解生成文档【生成文档doc文档】
②代码分析：通过代码里标识的注解对代码进行分析【使用反射】
③编译检查：通过代码里标识的注解让编译器能够实现基本的编译检查【Override】

JDK中预定义的一些注解

* @Override ：检测被该注解标注的方法是否是继承自父类(接口)的
* @Deprecated：该注解标注的内容，表示已过时
* @SuppressWarnings：压制警告
* 一般传递参数all @SuppressWarnings("all")@SuppressWarnings("all")
public class AnnoDemo2 {

@Override
public String toString() {
return super.toString();
}

@Deprecated
public void show1(){
//有缺陷
}

public void show2(){
//替代show1方法
}

public void demo(){
show1();
Date date = new Date();
}
}

自定义注解格式

元注解
public @interface 注解名称{
属性列表;
}

• 本质：注解本质上就是一个接口，该接口默认继承Annotation接口

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

注解组成部分1，属性

• 属性是注解（接口）中的抽象方法
• 属性的返回值类型有下列取值：
  （1）基本数据类型
  （2）String
  （3）枚举
  （4）注解
  （5）前4种类型的数组

public @interface MyAnno2 {
}public enum Person {
P1,P2;
}public @interface MyAnno {

int value(); //注解实质是接口，value为抽象方法，省略了abstract关键字，返回值为int类型
Person per(); //Person为枚举类
MyAnno2 anno2(); //MyAnno2也是注解
String[] strs();
/*String name() default "张三";*/
//String show2();
}

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

@MyAnno(value=12,per = Person.P1,anno2 = @MyAnno2,strs="bbb")
@MyAnno3
public class Worker {
@MyAnno3
public String name = "aaa";
@MyAnno3
public void show(){
}
}

注解的组成部分2，元注解

元注解用于描述注解的注解

*@Target：描述注解能够作用的位置
* ElementType取值：
* TYPE：可以作用于类上
* METHOD：可以作用于方法上
* FIELD：可以作用于成员变量上
* @Retention：描述注解被保留的阶段
* @Retention(RetentionPolicy.RUNTIME)：当前被描述的注解，会保留到class字节码文件中，并被JVM读取到
* @Documented：描述注解是否被抽取到api文档中
* @Inherited：描述注解是否被子类继承，如上work类有被MyAnno3修饰，有另外一个类继承了work类，那么该注解也会被继承，暂无法演示@Target({ElementType.TYPE,ElementType.METHOD,ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
public @interface MyAnno3 {
}

在程序使用(解析)注解：获取注解中定义的属性值

获取注解定义的位置的对象 （Class，Method,Field）

获取指定的注解

getAnnotation(Class)
//其实就是在内存中生成了一个该注解接口的子类实现对象
public class ProImpl implements Pro{
public String className(){
return "cn.itcast.annotation.Demo1";
}
public String methodName(){
return "show";
}
}

调用注解中的抽象方法获取配置的属性值
具体的注解解析示例代码见下面的框架类的实现代码

使用注解转化程序的API文档

/**
* 注解javadoc演示
*
* @author itcat
* @version 1.0
* @since 1.5
*/
public class AnnoDemo1 {

/**
* 计算两数的和
* @param a 整数
* @param b 整数
* @return 两数的和
*/
public int add(int a, int b ){
return a + b;
}
}

cmd跳转到java文件所在的目录，使用javadoc命令生成API文档

javadoc xxx.java

定义框架类

使用注解调用类中的方法，而不是再使用配置文件（在文章名为**反射**中，有使用通过更改配置文件信息的方式，调用类和类中的方法）

public class Demo1 {
public void show(){
System.out.println("demo1...show...");
}
}import java.lang.reflect.Method;


/**
* 框架类
*/

//该注解调用上述demo1类中得show方法
@Pro(className = "cn.itcast.annotation.Demo1",methodName = "show")
public class ReflectTest {
public static void main(String[] args) throws Exception {

/*
前提：不能改变该类的任何代码。可以创建任意类的对象，可以执行任意方法
*/

//1.解析注解
//1.1获取该类的字节码文件对象
Class<ReflectTest> reflectTestClass = ReflectTest.class;
//2.获取上边的注解对象
//其实就是在内存中生成了一个该注解接口的子类实现对象
/*

public class ProImpl implements Pro{
public String className(){
return "cn.itcast.annotation.Demo1";
}
public String methodName(){
return "show";
}

}
*/

Pro an = reflectTestClass.getAnnotation(Pro.class);
//3.调用注解对象中定义的抽象方法，获取返回值
String className = an.className();
String methodName = an.methodName();
System.out.println(className);
System.out.println(methodName);


//3.加载该类进内存
Class cls = Class.forName(className);
//4.创建对象
Object obj = cls.newInstance();
//5.获取方法对象
Method method = cls.getMethod(methodName);
//6.执行方法
method.invoke(obj);
}
}import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
* 描述需要执行的类名，和方法名
*/

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Pro {

String className();
String methodName();
}

案例：简单的测试框架

加了注解Check的方法，可以用于判断是否方法的执行有异常

/**
* 小明定义的计算器类
*/
public class Calculator {

//加法
@Check
public void add(){
String str = null;
str.toString();
System.out.println("1 + 0 =" + (1 + 0));
}
//减法
@Check
public void sub(){
System.out.println("1 - 0 =" + (1 - 0));
}
//乘法
@Check
public void mul(){
System.out.println("1 * 0 =" + (1 * 0));
}
//除法
@Check
public void div(){
System.out.println("1 / 0 =" + (1 / 0));
}


public void show(){
System.out.println("永无bug...");
}

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

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Check {
}import java.io.BufferedWriter;
import java.io.FileWriter;
import java.io.IOException;
import java.lang.reflect.Method;

/**
* 简单的测试框架
*
* 当主方法执行后，会自动自行被检测的所有方法(加了Check注解的方法)，判断方法是否有异常，记录到文件中
*/
public class TestCheck {


public static void main(String[] args) throws IOException {
//1.创建计算器对象
Calculator c = new Calculator();
//2.获取字节码文件对象
Class cls = c.getClass();
//3.获取所有方法
Method[] methods = cls.getMethods();

int number = 0;//出现异常的次数
BufferedWriter bw = new BufferedWriter(new FileWriter("bug.txt"));


for (Method method : methods) {
//4.判断方法上是否有Check注解
if(method.isAnnotationPresent(Check.class)){
//5.有，执行
try {
method.invoke(c);
} catch (Exception e) {
//6.捕获异常

//记录到文件中
number ++;

bw.write(method.getName()+ " 方法出异常了");
bw.newLine();
bw.write("异常的名称:" + e.getCause().getClass().getSimpleName());
bw.newLine();
bw.write("异常的原因:"+e.getCause().getMessage());
bw.newLine();
bw.write("--------------------------");
bw.newLine();

}
}
}

bw.write("本次测试一共出现 "+number+" 次异常");
bw.flush();
bw.close();
}
}