Java 注解自定义注解 ( 使用注解实现简单测试框架 )

Posted 2021-05-22 韩曙亮

文章目录

• 一、定义注解
• 二、使用注解
• 三、解析注解

在 【Java 注解】自定义注解 ( 注解属性定义与赋值 ) 博客中讲解了 注解属性 ;

在 【Java 注解】自定义注解 ( 元注解 ) 博客中讲解了注解中的元注解如何描述注解 ;

在 【Java 注解】自定义注解 ( 注解解析 ) 博客中进行了注解的解析 ;

本篇博客实现一个简单的注解测试框架 , 主要进行以下几个步骤的操作 :

定义注解 : 定义用于添加到测试方法上的注解 ;

使用注解 : 在要测试的方法上添加注解 ;

解析注解 : 执行检测主方法 , 自动执行被添加注解的方法 ;

一、定义注解

---

定义注解 , 只用于标注函数 , 暂时不定义注解属性 ;

使用 元注解 标注 , @Target(ElementType.METHOD) 表示该注解作用于方法上 , @Retention(RetentionPolicy.RUNTIME) 表示保留到运行时 ;

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

二、使用注解

---

在 Function 类中 , 定义若干方法 , 在需要测试的方法上添加 @Test 注解 ;

package test;

public class Function {

    @Test
    public void fun1(){
        System.out.println("fun1");
    }

    @Test
    public void fun2() throws Exception {
        System.out.println("fun2");
        throw new Exception("出现异常");
    }

    private void fun3(){
        System.out.println("fun3");
    }
}

三、解析注解

---

首先 , 创建要测试的对象 , 之后的 获取注解 , 解析注解 , 反射并方法 , 都是基于该对象的 ;

// 1. 创建要测试的对象
Function function = new Function();

然后 , 获取该 Function 对象的字节码对象 , 获取 Function 对象中所有方法 ;

// 2. 获取该测试对象的字节码对象
//      哪个类上添加了注解 , 就获取哪个类的字节码文件
Class clazz = function.getClass();

// 3. 获取 Function 中所有方法
Method[] methods = clazz.getMethods();

最后 , 遍历该方法数组 Method[] methods , 检查每个方法上是否有注解 , 如果有就执行该方法 ;

// 4. 遍历方法 , 检查方法是否有注解, 如果有就执行该方法
for (Method method : methods){
    // 判断该方法上是否有 Test 注解
    boolean isTest = method.isAnnotationPresent(Test.class);
    
    // 如果有注解, 那么执行该方法
    if (isTest){
        try {
            // 设置可见性, 防止私有方法访问不到
            method.setAccessible(true);
            method.invoke(function);
        } catch (Exception e) {
            // 出现异常将其打印出来即可
            e.printStackTrace();
        }finally {
            System.out.println(method.toString() + "测试完毕");
        }
    }
}

完整代码示例 :

package test;

import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;

public class Main {
    public static void main(String[] args) {
        // 1. 创建要测试的对象
        Function function = new Function();

        // 2. 获取该测试对象的字节码对象
        //      哪个类上添加了注解 , 就获取哪个类的字节码文件
        Class clazz = function.getClass();

        // 3. 获取 Function 中所有方法
        Method[] methods = clazz.getMethods();

        // 4. 遍历方法 , 检查方法是否有注解, 如果有就执行该方法
        for (Method method : methods){
            // 判断该方法上是否有 Test 注解
            boolean isTest = method.isAnnotationPresent(Test.class);

            // 如果有注解, 那么执行该方法
            if (isTest){
                try {
                    // 设置可见性, 防止私有方法访问不到
                    method.setAccessible(true);
                    method.invoke(function);
                } catch (Exception e) {
                    // 出现异常将其打印出来即可
                    e.printStackTrace();
                }finally {
                    System.out.println(method.toString() + "测试完毕");
                }
            }
        }
    }
}

执行结果 :