如何编写TestNG自定义注解在@Test方法执行前执行操作？

这个需求其实可以通过@TestNG的监听器机制完美解决，不用局限于自带的@BeforeTest这类全局注解。下面给你一步步拆解实现方案：

1. 确认自定义注解定义 #

你已经写了基础的@doSmthg注解，这里再确认下完整定义（确保保留运行时可见性，因为需要在运行时通过反射读取）：

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 doSmthg {
    String value(); // 可用来传递参数，比如测试用户的用户名
}

2. 实现@TestNG方法监听器 #

创建一个监听器类，实现IInvokedMethodListener接口，重写beforeInvocation方法——这个方法会在每个测试方法执行前被调用，我们在这里判断当前方法是否标注了@doSmthg注解，如果有就执行你的前置操作（比如创建测试用户）：

import org.testng.IInvokedMethod;
import org.testng.IInvokedMethodListener;
import org.testng.ITestResult;

public class CustomAnnotationListener implements IInvokedMethodListener {

    @Override
    public void beforeInvocation(IInvokedMethod method, ITestResult testResult) {
        // 获取当前测试方法的反射对象
        java.lang.reflect.Method testMethod = testResult.getMethod().getConstructorOrMethod().getMethod();
        // 检查方法上是否存在@doSmthg注解
        doSmthg annotation = testMethod.getAnnotation(doSmthg.class);
        if (annotation != null) {
            // 执行你的特定操作，比如创建测试用户
            String userName = annotation.value(); // 可以获取注解传递的参数
            createTestUser(userName);
            System.out.println("已为测试方法[" + testMethod.getName() + "]创建测试用户：" + userName);
        }
    }

    // 模拟创建测试用户的方法，替换成你的实际业务逻辑
    private void createTestUser(String userName) {
        // 这里写创建用户的代码，比如调用接口、操作数据库等
        // 示例逻辑：
        // User user = new User(userName, "123456");
        // userService.save(user);
    }

    // 可选：如果需要后置操作可以实现此方法
    @Override
    public void afterInvocation(IInvokedMethod method, ITestResult testResult) {
        // 方法执行后的自定义操作
    }
}

3. 注册监听器 #

有三种方式可以注册这个监听器，选适合你的一种：

方式一：在测试类上添加@Listeners注解 #

直接在测试类上标注@Listeners，指定我们的监听器类：

import org.testng.Listeners;
import org.testng.annotations.Test;

@Listeners(CustomAnnotationListener.class)
public class UserTest {

    @Test
    @doSmthg("testUser001") // 传递参数给注解
    public void userTest() {
        // 你的测试逻辑
        System.out.println("执行userTest测试方法");
    }

    @Test
    public void normalTest() {
        // 这个方法没有@doSmthg注解，不会触发前置操作
        System.out.println("执行normalTest测试方法");
    }
}

方式二：在testng.xml配置文件中添加监听器 #

如果你的测试用testng.xml管理，可以在<suite>标签下添加<listeners>配置：

<suite name="TestSuite">
    <listeners>
        <listener class-name="com.yourpackage.CustomAnnotationListener"/>
    </listeners>
    <test name="UserTests">
        <classes>
            <class name="com.yourpackage.UserTest"/>
        </classes>
    </test>
</suite>

方式三：使用ServiceLoader自动注册（全局生效） #

在项目的src/main/resources/META-INF/services目录下创建一个名为org.testng.ITestNGListener的文件，文件内容写你的监听器全类名：

com.yourpackage.CustomAnnotationListener

这样@TestNG会自动加载这个监听器，不需要在测试类或xml中额外配置。

4. 验证效果 #

运行测试后，你会发现只有标注了@doSmthg的userTest方法执行前会触发创建测试用户的操作，而normalTest方法不会，完全符合你的需求。

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