了解JUnit的Runner架构

几周前，我开始创建一个小的JUnit Runner（ Oleaster ），它允许您使用Jasmine方式在JUnit中编写单元测试。我了解到，创建自定义JUnit Runners实际上非常简单。在本文中，我想向您展示JUnit Runner在内部如何工作以及如何使用自定义Runner来修改JUnit的测试执行过程。

那么什么是JUnit Runner？

JUnit Runner是扩展JUnit抽象Runner类的类。运行程序用于运行测试类。可以使用@RunWith注释设置应该用于运行测试的Runner 。

@RunWith(MyTestRunner.class)
public class MyTestClass {@Testpublic void myTest() {..}
}

JUnit测试是使用JUnitCore类开始的。可以通过从命令行运行它，也可以使用其各种run（）方法之一来完成此操作（如果您按run test按钮，这就是您的IDE所做的事情）。

JUnitCore.runClasses(MyTestClass.class);

然后，JUnitCore使用反射为通过的测试类找到合适的Runner。此处的一个步骤是在测试类上查找@RunWith批注。如果未找到其他运行程序，则将使用默认运行程序（ BlockJUnit4ClassRunner ）。将实例化Runner，并将测试类传递给Runner。现在，实例化并运行通过的测试类是Runner的工作。

跑步者如何工作？

让我们看一下标准JUnit Runners的类层次结构：

跑步者

Runner是一个非常简单的类，实现了Describable接口，并具有两个抽象方法：

public abstract class Runner implements Describable {public abstract Description getDescription();public abstract void run(RunNotifier notifier);
}

方法getDescription（）从Describable继承，并且必须返回Description 。描述包含了各种工具以后导出和使用的信息。例如，您的IDE可能会使用此信息来显示测试结果。 run（）是一种非常通用的方法， 可以运行某些内容 （例如测试类或测试套件）。我认为通常Runner并不是您要扩展的类（它太慷慨了）。

在ParentRunner中，事情变得更加具体。 ParentRunner是具有多个子代的Runner的抽象基类。在这里重要的是要理解，测试是按层次结构（例如树）构造和执行的。

例如：您可能运行包含其他测试套件的测试套件。这些测试套件可能包含多个测试类。最后，每个测试类可以包含多个测试方法。

ParentRunner具有以下三种抽象方法：

public abstract class ParentRunner<T> extends Runner implements Filterable, Sortable {    protected abstract List<T> getChildren();protected abstract Description describeChild(T child);protected abstract void runChild(T child, RunNotifier notifier);
}

子类需要在getChildren（）中返回泛型T的列表。然后，ParentRunner要求子类为每个孩子（describeChild（））创建一个Description，最后运行每个孩子（runChild（））。

现在，让我们看一下两个标准的ParentRunners：BlockJUnit4ClassRunner和Suite。

如果未提供其他Runner，则使用BlockJUnit4ClassRunner为默认Runner。因此，这是运行单个测试类时通常使用的Runner。如果您查看BlockJUnit4ClassRunner的来源，您将看到类似以下内容：

public class BlockJUnit4ClassRunner extends ParentRunner<FrameworkMethod> {@Overrideprotected List<FrameworkMethod> getChildren() {// scan test class for methonds annotated with @Test}@Overrideprotected Description describeChild(FrameworkMethod method) {// create Description based on method name}@Overrideprotected void runChild(final FrameworkMethod method, RunNotifier notifier) {if (/* method not annotated with @Ignore */) {// run methods annotated with @Before// run test method// run methods annotated with @After}}
}

当然，这被过度简化了，但是它说明了BlockJUnit4ClassRunner的基本功能。通用类型参数FrameworkMethod基本上是java.lang.reflect.Method的包装，提供了一些方便的方法。在getChildren（）中，扫描测试类以查找使用@Test进行反射的方法。找到的方法包装在FrameworkMethod对象中并返回。 describeChildren（）从方法名称创建一个Description，然后runChild（）最终运行测试方法。 BlockJUnit4ClassRunner在内部使用了很多受保护的方法。根据您要确切执行的操作，最好检查BlockJUnit4ClassRunner中可以覆盖的方法。您可以在GitHub上查看BlockJUnit4ClassRunner的源代码。

Suite Runner用于创建测试套件。套件是测试（或其他套件）的集合。一个简单的套件定义如下所示：

@RunWith(Suite.class)
@Suite.SuiteClasses({MyJUnitTestClass1.class,MyJUnitTestClass2.class,MyOtherTestSuite.class
})
public class MyTestSuite {}

通过选择带有@RunWith批注的Suite Runner来创建测试套件。如果查看Suite的实现，您会发现它实际上非常简单。 Suite唯一要做的就是从使用@SuiteClasses批注定义的类中创建Runner实例。因此，getChildren（）返回Runners列表，runChild（）将执行委托给相应的Runner。

例子

使用提供的信息，创建您自己的JUnit Runner并不难（至少我希望如此）。如果您正在寻找一些示例自定义Runner实现，则可以查看以下列表：

Fabio Strozzi创建了一个非常简单明了的GuiceJUnitRunner项目。它使您可以选择在JUnit测试中注入Guice组件。来源GitHub
Spring的SpringJUnit4ClassRunner可帮助您测试Spring框架应用程序。它允许您在测试类中使用依赖项注入或创建事务性测试方法。来源GitHub
Mockito为自动模拟初始化提供了MockitoJUnitRunner 。来源GitHub
Oleaster的 Java 8茉莉花赛跑者。源自GitHub （无耻的自我推广）