testNG监听器

有几个接口允许您修改 TestNG 的行为。这些接口被广泛地称为“TestNG Listeners”。以下是一些监听器：

• IAnnotationTransformer (文档, javadoc )
• IAnnotationTransformer2 (文档, javadoc )
• IHookable (文档, javadoc )
• IInvokedMethodListener (doc, javadoc )
• IMethodInterceptor (文档, javadoc )
• IReporter (文档, javadoc )
• ISuiteListener (doc, javadoc )
• ITestListener (文档, javadoc )

当您实现其中一个接口时，您可以通过以下任一方式让 TestNG 知道它：

• 在命令行上使用 -listener。
• 将 与 ant 一起使用。
• 在testng.xml文件中使用 。
• 在您的任何测试类上使用@Listeners注释。
• 使用服务加载器。

使用testng.xml或 Java指定监听器

以下是在testng.xml文件中定义侦听器的方法：

<suite>
  <listeners>
    <listener class-name="com.example.MyListener" />
    <listener class-name="com.example.MyMethodInterceptor" />
  </listeners>
...

或者，如果您更喜欢在 Java 中定义这些侦听器：

@Listeners({ com.example.MyListener.class, com.example.MyMethodInterceptor.class })
public class MyTest {
  // ...
}

该@Listeners注释可以包含任何扩展类org.testng.ITestNGListener 除了 IAnnotationTransformer和IAnnotationTransformer2。原因是这些侦听器需要在流程的早期就知道，以便 TestNG 可以使用它们来重写您的注解，因此您需要在testng.xml文件中指定这些侦听器。
请注意，@Listeners注解将应用于您的整个套件文件，就像您在testng.xml文件中指定它一样。如果你想限制它的范围（例如，只在当前类上运行），你的监听器中的代码可以首先检查即将运行的测试方法并决定接下来要做什么。这是如何做到：
首先定义一个新的自定义注解，可以用来指定这个限制：

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

在您的常规监听器Listener中添加如下编辑检查：

public void beforeInvocation(IInvokedMethod iInvokedMethod, ITestResult iTestResult) {
  ConstructorOrMethod consOrMethod =iInvokedMethod.getTestMethod().getConstructorOrMethod();
  DisableListener disable = consOrMethod.getMethod().getDeclaringClass().getAnnotation(DisableListener.class);
  if (disable != null) {
    return;
  }
  // else resume your normal operations
}

注解不调用侦听器的测试类：

@DisableListener
@Listeners({ com.example.MyListener.class, com.example.MyMethodInterceptor.class })
public class MyTest {
  // ...
}

使用ServiceLoader指定侦听器

JDK 提供了一种非常优雅的机制来通过ServiceLoader类在类路径上指定接口的实现。
使用 ServiceLoader，您需要做的就是创建一个 jar 文件，其中包含您的侦听器和一些配置文件，当您运行 TestNG 时将该 jar 文件放在类路径中，TestNG 会自动找到它们。
它如何工作的具体示例:
创建一个监听器

package test.tmp;
public class TmpSuiteListener implements ISuiteListener {
  @Override
  public void onFinish(ISuite suite) {
    System.out.println("Finishing");
  }
  @Override
  public void onStart(ISuite suite) {
    System.out.println("Starting");
  }
}

编译此文件，然后在META-INF/services/org.testng.ITestNGListener位置创建一个文件，该文件将命名此接口所需的实现。
最终应该得到以下目录结构，其中只有两个文件：

$ tree
|____META-INF
| |____services
| | |____org.testng.ITestNGListener
|____test
| |____tmp
| | |____TmpSuiteListener.class
$ cat META-INF/services/org.testng.ITestNGListener
test.tmp.TmpSuiteListener

创建此目录的 jar：

$ jar cvf ../sl.jar .
added manifest
ignoring entry META-INF/
adding: META-INF/services/(in = 0) (out= 0)(stored 0%)
adding: META-INF/services/org.testng.ITestNGListener(in = 26) (out= 28)(deflated -7%)
adding: test/(in = 0) (out= 0)(stored 0%)
adding: test/tmp/(in = 0) (out= 0)(stored 0%)
adding: test/tmp/TmpSuiteListener.class(in = 849) (out= 470)(deflated 44%)

接下来，在调用 TestNG 时将此 jar 文件放在类路径中：

$ java -classpath sl.jar:testng.jar org.testng.TestNG testng-single.yaml
Starting
f2 11 2
PASSED: f2("2")
Finishing

这种机制允许您将相同的侦听器集应用于整个组织，只需将 jar 文件添加到类路径，而不是要求每个开发人员记住在他们的 testng.xml 文件中指定这些侦听器。