平常,我们大部分人使用Junit运行大测试代码, 都是通过通过IDE的界面手动运行,或者通过maven命令来运行的多. 这些方式对于使用来说很直观, 但是我们没法直接了解Junit的运行方式.
所以如果我们要研究源码学习Junit的话,最好结合我们的测试代码,先了解测试代码如果被调用.那么JUnitCore这个类,就是我们需要最新研究的类.按照我的理解,它是运行所有测试类的核心入口类. 以下请看例子.
首先,我们有一个常规的测试类:
public class HelloJunit { @Test public void helloTest(){ System.out.println("Hello Test"); } }
然后,我们可以通过JUnitCore类来执行调用这个测试类,达到运行它的目的:
public class JunitCoreDemo { public static void main(String[] args) { Result result = JUnitCore.runClasses(HelloJunit.class); System.out.println(result.getRunCount()); } }
这样我们可以看到测试类被成功地执行了.
通过以上很简单的例子,我们就可以开始我们的源码解读之旅了.
追踪JUnitCore的源代码进去,发现最终runClasses()方法调用到了run()方法, 它的参数是一个Runner
public Result run(Runner runner) { Result result = new Result(); RunListener listener = result.createListener(); notifier.addFirstListener(listener); try { notifier.fireTestRunStarted(runner.getDescription()); runner.run(notifier); notifier.fireTestRunFinished(result); } finally { removeListener(listener); } return result; }
以下是Runner的继承关系图:
其中较为重要的Runner有:
- Suite: JUnitCore.run()方法引用的就是一个Suite的实例
- BlockJUnit4ClassRunner: 默认的Junit runner, 可以继承它来扩展功能
再往回看代码:
- Runner是从request.getRunner()来的
- 然后它又是Computer类的getSuite()方法来的:
/** * Create a suite for {@code classes}, building Runners with {@code builder}. * Throws an InitializationError if Runner construction fails */ public Runner getSuite(final RunnerBuilder builder, Class<?>[] classes) throws InitializationError { return new Suite(new RunnerBuilder() { @Override public Runner runnerForClass(Class<?> testClass) throws Throwable { return getRunner(builder, testClass); } }, classes); }
Runner是一个Suite, 它包含了一个RunnerBuilder的匿名子类 - RunnerBuilder子类的runnerForClass()方法,可以根据builder.runnerForClass(testClass)来获取具体的Runer
- 再回看代码发现builder的值是 AllDefaultPossibilitiesBuilder的实例
AllDefaultPossibilitiesBuilder类的代码比较简单,但是非常重要.它的核心方法org.junit.internal.builders.AllDefaultPossibilitiesBuilder.runnerForClass(Class<?>)的作用就是根据传入的测试类.class返回该测试类的Runner, 它返回的Runner有:
- BlockJUnit4ClassRunner
- IgnoredClassRunner
- SuiteMethod
- JUnit38ClassRunner
- AnnotatedBuilder中取到的自定义Runner
这里值得一说有是AnnotatedBuilder, 如果某个测试类带上了@RunWith(MyTestRunner.class)注解,表明它需要通过MyTestRunner去运行,而不是默认的BlockJUnit4ClassRunner.
AnnotatedBuilder.runnerForClass(Class<?>)方法里可以看到获取自定义Runner的逻辑:
@Override public Runner runnerForClass(Class<?> testClass) throws Exception { for (Class<?> currentTestClass = testClass; currentTestClass != null; currentTestClass = getEnclosingClassForNonStaticMemberClass(currentTestClass)) { RunWith annotation = currentTestClass.getAnnotation(RunWith.class); if (annotation != null) { return buildRunner(annotation.value(), testClass); } } return null; }
首先,它获取了RunWIth的值, 然后在buildRunner中创建的Runner的实例, 这个是反射的最基本应用:
public Runner buildRunner(Class<? extends Runner> runnerClass, Class<?> testClass) throws Exception { try { return runnerClass.getConstructor(Class.class).newInstance(testClass); } catch (NoSuchMethodException e) { try { return runnerClass.getConstructor(Class.class, RunnerBuilder.class).newInstance(testClass, suiteBuilder); } catch (NoSuchMethodException e2) { String simpleName = runnerClass.getSimpleName(); throw new InitializationError(String.format( CONSTRUCTOR_ERROR_FORMAT, simpleName, simpleName)); } } }
到此位置JUnitCore的代码逻辑基本清楚了.再小结一下:
- JUnitCore最终运行的是JUnitCore.run(Runner)方法
- 1中的Runer是一个Suite, 它含有一个RunnerBuilder的匿名子类
- RunnerBuilder会根据runnerForClass()方法,取到测试类的真正的Runner
- JUnitCore.run()方法可以执行使用自定义Runner的测试类
下一节将介绍如何扩展具体的Runner,比如BlockJUnit4ClassRunner, 来增强Junit的功能