Java注解笔记(带代码案例)

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

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

3、JDK中预定义的一些注解
* @Override ：检测被该注解标注的方法是否是继承自父类(接口)的；
* @Deprecated：该注解标注的内容，表示已过时；
* @SuppressWarnings：压制警告，一般传递参数all @SuppressWarnings("all")。

4、自定义注解
* 格式：
元注解
public @interface 注解名称{
属性列表;
}

* 本质：注解本质上就是一个接口，该接口默认继承Annotation接口
* public interface MyAnno extends java.lang.annotation.Annotation {}

* 属性：接口中的抽象方法
* 要求：
（1）属性的返回值类型有下列取值
* 基本数据类型
* String
* 枚举
* 注解
* 以上类型的数组

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

（3）元注解：用于描述注解的注解
* @Target：描述注解能够作用的位置；
　　ElementType取值：TYPE：可以作用于类上， METHOD：可以作用于方法上，FIELD：可以作用于成员变量上；
* @Retention：描述注解被保留的阶段
* @Retention(RetentionPolicy.RUNTIME)：当前被描述的注解，会保留到class字节码文件中，并被JVM读取到
* @Documented：描述注解是否被抽取到api文档中
* @Inherited：描述注解是否被子类继承

5、案例：简单测试框架

package com.lidaochen.test;


/**
 * 小明定义的计算器类
 */
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...");
    }

}

package com.lidaochen.test;

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 {
}

package com.lidaochen.test;

import java.io.BufferedWriter;
import java.io.FileWriter;
import java.lang.reflect.Method;

public class CTestCheck {
    public static void main(String[] args) throws Exception {
        // 1、创建计算器对象
        Calculator calculator = new Calculator();
        // 2、获取计算器 Class 字节码 文件对象
        Class cls = calculator.getClass();
        // 3、获取计算器类的所有方法
        Method[] methods = cls.getMethods();
        // 出现异常的次数
        int number = 0;
        BufferedWriter bufferedWriter = new BufferedWriter(new FileWriter("bug.txt"));
        for (Method method : methods) {
            // 判断方法上是否有 Check 注解
            if(method.isAnnotationPresent(Check.class))
            {
                try {
                    // 有 Check 注解 执行方法
                    method.invoke(calculator);
                }
                catch (Exception e)
                {
                    // 捕获异常
                    number++;
                    bufferedWriter.write(method.getName() + "方法出现了异常！");
                    bufferedWriter.newLine();
                    bufferedWriter.write("异常名称：" + e.getCause().getClass().getSimpleName());
                    bufferedWriter.newLine();
                    bufferedWriter.write("异常原因：" + e.getCause().getMessage());
                    bufferedWriter.newLine();
                    bufferedWriter.write("--------------------------------------");
                    bufferedWriter.newLine();
                }
            }
        }
        bufferedWriter.write("本次测试一共出现了" + number + "次异常！");
        bufferedWriter.flush();
        bufferedWriter.close();
    }
}

6、案例：

package com.lidaochen.test;

public class CJavaTest {
    public void eat()
    {
        System.out.println("我喜欢吃西瓜！");
    }
}

package com.lidaochen.test;

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.TYPE)
public @interface Pro {
    String className();
    String methodName();
}

package com.lidaochen.test;

import java.io.BufferedReader;
import java.io.FileReader;
import java.lang.reflect.Method;
import java.util.Properties;

@Pro(className = "com.lidaochen.test.CJavaTest", methodName = "eat")
public class CJavaDemo {
    public static void main(String[] args) throws Exception{
        // 1、获取该类的字节码对象
        Class cls = CJavaDemo.class;
        // 2、获取上边的注解对象
        Pro an = (Pro) cls.getAnnotation(Pro.class);
        // 3、调用注解对象中定义的抽象方法，获取返回值
        String className = an.className();
        String methodName = an.methodName();
        System.out.println(className);
        System.out.println(methodName);
        // 4、加载该类进内存
        Class mJavaTest = Class.forName(className);
        // 创建对象
        Object obj = mJavaTest.newInstance();
        // 获取方法对象
        Method method = mJavaTest.getMethod(methodName);
        // 执行方法
        method.invoke(obj);
    }
}