如何在TestNG测试用例中获取并解析TestCaseKey的值？

问题场景 #

你有如下TestNG测试用例，希望在verify()方法内部获取并解析@TestCaseKey注解中的testCaseKey值：

@TestCaseKey(testCaseKey = "TestCase-001")
@Test(groups = {WEB}, description = "Verify this and That")
public void verify(){
    System.out.println("Print this");
}

实现步骤 #

核心是利用Java反射机制读取运行时注解，具体分两步：

1. 确保自定义注解支持运行时读取

你的@TestCaseKey注解必须添加@Retention(RetentionPolicy.RUNTIME)声明，否则运行时反射无法获取到。如果还没定义该注解，示例代码如下：

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

@Retention(RetentionPolicy.RUNTIME) // 关键：让注解在运行时可被反射读取
public @interface TestCaseKey {
    String testCaseKey();
}

2. 在测试方法内通过反射提取注解值

修改verify()方法，通过反射获取当前方法的注解实例，进而提取testCaseKey值：

@TestCaseKey(testCaseKey = "TestCase-001")
@Test(groups = {WEB}, description = "Verify this and That")
public void verify(){
    try {
        // 获取当前方法的反射对象
        java.lang.reflect.Method method = this.getClass().getMethod("verify");
        // 获取方法上的TestCaseKey注解实例
        TestCaseKey testCaseAnnotation = method.getAnnotation(TestCaseKey.class);
        
        if (testCaseAnnotation != null) {
            // 提取注解中的testCaseKey值
            String testCaseKey = testCaseAnnotation.testCaseKey();
            System.out.println("当前测试用例Key: " + testCaseKey);
            // 这里可以添加对testCaseKey的后续业务逻辑处理
        }
    } catch (NoSuchMethodException e) {
        e.printStackTrace();
    }
    
    System.out.println("Print this");
}

优化：避免硬编码方法名

如果不想固定写死方法名，可以通过堆栈动态获取当前执行的方法名：

@TestCaseKey(testCaseKey = "TestCase-001")
@Test(groups = {WEB}, description = "Verify this and That")
public void verify(){
    try {
        // 通过堆栈跟踪获取当前方法名
        String currentMethodName = Thread.currentThread().getStackTrace()[1].getMethodName();
        java.lang.reflect.Method method = this.getClass().getMethod(currentMethodName);
        TestCaseKey testCaseAnnotation = method.getAnnotation(TestCaseKey.class);
        
        if (testCaseAnnotation != null) {
            String testCaseKey = testCaseAnnotation.testCaseKey();
            System.out.println("当前测试用例Key: " + testCaseKey);
        }
    } catch (NoSuchMethodException e) {
        e.printStackTrace();
    }
    
    System.out.println("Print this");
}

运行结果 #

执行测试方法后，控制台会输出：

当前测试用例Key: TestCase-001
Print this

内容的提问来源于stack exchange，提问作者Taimoor Pasha