Junit源碼閱讀筆記二(Runner構(gòu)建)

1.Runner

上一節(jié)講到了Junit的運(yùn)行實(shí)際上是調(diào)用Runner中的run方法執(zhí)行的官撼,那么接下來總結(jié)一下Runner,首先我們看下Runner的類圖

Runner

2.Runner的構(gòu)建

讓我們回到類Request.class中的classes方法

public static Request classes(Computer computer, Class<?>... classes) {
    try {
        AllDefaultPossibilitiesBuilder builder = new AllDefaultPossibilitiesBuilder(true);
        Runner suite = computer.getSuite(builder, classes);
        return runner(suite);
    } catch (InitializationError e) {
        throw new RuntimeException(
                "Bug in saff's brain: Suite constructor, called as above, should always complete");
    }
}

由此可知第一個(gè)Runner是由computer.getSuite(builder, classes)中獲得医男,參數(shù)builder是直接new AllDefaultPossibilitiesBuilder,從名稱可以看出,這個(gè)builder是所有默認(rèn)的可能builder佑稠,看起來很牛逼的樣子,點(diǎn)進(jìn)去可以發(fā)現(xiàn)構(gòu)造方法只有一個(gè)屬性賦值旗芬,先忽略讶坯,繼續(xù)看computer.getSuite(builder, classes)

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);
}

protected Runner getRunner(RunnerBuilder builder, Class<?> testClass) throws Throwable {
    return builder.runnerForClass(testClass);
}

由此可見這個(gè)Runner是直接new的一個(gè)Suite,進(jìn)入 Suite類看該處調(diào)用的構(gòu)造方法岗屏,

public Suite(RunnerBuilder builder, Class<?>[] classes) throws InitializationError {
    this(null, builder.runners(null, classes));
}
protected Suite(Class<?> klass, List<Runner> runners) throws InitializationError {
    super(klass);
    this.runners = Collections.unmodifiableList(runners);
}
  • 可見最終是調(diào)用Suiteprotected Suite(Class<?> klass, List<Runner> runners)構(gòu)造方法構(gòu)建的Suite辆琅,

  • 該參數(shù)中的List<Runner> runners是由builder.runners而來漱办,而由前而的調(diào)用鏈可知,這個(gè)builder是在Computer類中getSuite的方法中婉烟,在new Suite時(shí)直接new的一個(gè)匿名的RunnerBuilder

  • RunnerBuilder實(shí)現(xiàn)了runnerForClass方法娩井,而該方法的具體實(shí)現(xiàn)是由上文(Requestclasses方法)中AllDefaultPossibilitiesBuilder來實(shí)現(xiàn)的,該處又是一個(gè)鉤子方法似袁,即當(dāng)調(diào)用這個(gè)Suite對(duì)象的runnerForClass方法時(shí)洞辣,實(shí)際調(diào)用的是AllDefaultPossibilitiesBuilderrunnerForClass

  • 讓我們回到Suite的構(gòu)建中昙衅,由剛才的構(gòu)造方法可以看出扬霜,在構(gòu)建Suite之前先調(diào)用了匿名RunnerBuilder實(shí)例中的runners,繼續(xù)看這個(gè)RunnerBuilder.runners都做了什么

      public List<Runner> runners(Class<?> parent, Class<?>[] children)
          throws InitializationError {
          //添加父class而涉,此時(shí)由Suite調(diào)用過來時(shí)為null
          addParent(parent);
          try {
              //此時(shí)的children是從開始一路傳遞下來的測(cè)試類的class
              return runners(children);
          } finally {
              //移除父class
              removeParent(parent);
          }
      }
    

繼續(xù)看該方法中調(diào)用的runners方法

 private List<Runner> runners(Class<?>[] children) {
    ArrayList<Runner> runners = new ArrayList<Runner>();
    for (Class<?> each : children) {
        //循環(huán)遍歷所有測(cè)試類的class著瓶,構(gòu)建Runner
        //由此可以發(fā)現(xiàn)每個(gè)測(cè)試類對(duì)應(yīng)一個(gè)Runner
        Runner childRunner = safeRunnerForClass(each);
        if (childRunner != null) {
            runners.add(childRunner);
        }
    }
    return runners;
}

繼續(xù)看safeRunnerForClass方法

public Runner safeRunnerForClass(Class<?> testClass) {
    try {
        return runnerForClass(testClass);
    } catch (Throwable e) {
        return new ErrorReportingRunner(testClass, e);
    }
}
  • 該方法實(shí)際是調(diào)用的runnerForClass來得到的Runner,再看下方法所在類:抽象類RunnerBuilder方法中
  • 還記得我們現(xiàn)在是哪個(gè)環(huán)節(jié)中嘛啼县,正是在new Suite的構(gòu)建方法中材原,所以這個(gè)地方的玄機(jī)就在于,該處的RunnerBuilder是前創(chuàng)建new Suite時(shí)創(chuàng)建的匿名RunnerBuilder季眷,而這個(gè)匿名RunnerBuilderrunnerForClass正是由Request.classes方法中newAllDefaultPossibilitiesBuilder對(duì)象來實(shí)現(xiàn)的余蟹。
    這就是鉤子方法的妙用,也稱為模板方法
    接下來就讓我們看下AllDefaultPossibilitiesBuilderrunnerForClass
    讓我們來看下調(diào)用時(shí)序
Suite創(chuàng)建時(shí)Builder的調(diào)用

3.RunnerBuilder

首先來看上文中調(diào)用的AllDefaultPossibilitiesBuilder.runnerForClass

public Runner runnerForClass(Class<?> testClass) throws Throwable {
            //初始化RunnerBuilder列表
            //該處將Junit所有的RunnerBuilder都創(chuàng)建好放入集合
            //從該處可以以知道該類為什么叫AllDefaultPossibilitiesBuilder了

    List<RunnerBuilder> builders= Arrays.asList(
            ignoredBuilder(),  //IgnoredBuilder需要忽略測(cè)試的RunnerBuilder
            annotatedBuilder(),  //AnnotatedBuilder帶有注解的RunnerBuilder
            suiteMethodBuilder(),  //SuiteMethodBuilder
            junit3Builder(),  //JUnit3Builder(目測(cè)是為了兼容junit3)
            junit4Builder());  //JUnit4Builder

    for (RunnerBuilder each : builders) {
        Runner runner= each.safeRunnerForClass(testClass);
        if (runner != null)
            return runner;
    }
    return null;
}
  • 由以上代碼可以發(fā)現(xiàn)子刮,在AllDefaultPossibilitiesBuilder中威酒,首先把所有RunnerBuilder都構(gòu)建好
  • 然后循環(huán)遍歷,調(diào)用每一個(gè)buildersafeRunnerForClass方法
  • 進(jìn)入該方法不難發(fā)現(xiàn)實(shí)際是調(diào)用每一個(gè)builder的runnerForClass方法挺峡,只要命中任何一個(gè)builder的構(gòu)建規(guī)則兼搏,即使用該builder創(chuàng)建Rnner,然后退出循環(huán)
  • 該處應(yīng)用正是一個(gè)責(zé)任鏈模式

讓我們逐個(gè)看看各個(gè)builderrunnerForClass

  1. IgnoredBuilder:

     public Runner runnerForClass(Class<?> testClass) {
         if (testClass.getAnnotation(Ignore.class) != null)
             return new IgnoredClassRunner(testClass);
         }
         return null;
     }
    

可見如果測(cè)試類中加上了@Ignore則會(huì)使用該builder

  1. AnnotatedBuilder

     public Runner runnerForClass(Class<?> testClass) throws Exception {
         //獲取測(cè)試類中用RunWith注解標(biāo)注的類
         RunWith annotation= testClass.getAnnotation(RunWith.class);
         if (annotation != null)
             return buildRunner(annotation.value(), testClass);
         return null;
      }
    
     public Runner buildRunner(Class<? extends Runner> runnerClass,
         Class<?> testClass) throws Exception {
         try {
             ////創(chuàng)建RunWith注解中聲明類的實(shí)例沙郭,并將測(cè)試類的class傳入
             return runnerClass.getConstructor(Class.class).newInstance(
                 new Object[] { testClass });
         } catch (NoSuchMethodException e) {
             //先忽略異常處理
     }
    
  • 由該段代碼可知佛呻,如果測(cè)試中在@RunWith注解中指定了Runner,則使用該builder病线,并使用反射創(chuàng)建指定的Runner
  • 看到此吓著,相信你知道為什么我們?cè)谟肑unit寫單測(cè)的時(shí)候,單測(cè)類上面注解@RunWith的用途了
  1. SuiteMethodBuilder
    進(jìn)入suiteMethodBuilder()方法

     protected RunnerBuilder suiteMethodBuilder() {
         if (fCanUseSuiteMethod)
             return new SuiteMethodBuilder();
         return new NullBuilder();
     }
    

首先我們看到的是不是直接new SuiteMethodBuilder送挑,而是首先看fCanUseSuiteMethod屬性是否為true绑莺,還記得該屬性是什么時(shí)候賦值的嘛?返回去看下Request.classes方法

public static Request classes(Computer computer, Class<?>... classes) {
    try {
        AllDefaultPossibilitiesBuilder builder = new AllDefaultPossibilitiesBuilder(true);
        Runner suite = computer.getSuite(builder, classes);
        return runner(suite);
    } catch (InitializationError e) {
        throw new RuntimeException(
                "Bug in saff's brain: Suite constructor, called as above, should always complete");
    }
}

正是new AllDefaultPossibilitiesBuilder(true); 中的true
也就是說惕耕,測(cè)試類中如果沒有ignoredannotated纺裁,首先使用的RunnerBuilder實(shí)際是SuiteMethodBuilder,并執(zhí)行該builderrunnerForClass方法,進(jìn)入一探究竟

public Runner runnerForClass(Class<?> each) throws Throwable {
    //判斷測(cè)試的class中是否有suite方法
    if (hasSuiteMethod(each))
        //創(chuàng)建suiteMethod欺缘,該類繼承自JUnit38ClassRunner
        return new SuiteMethod(each);
    return null;
}

public boolean hasSuiteMethod(Class<?> testClass) {
    try {
        testClass.getMethod("suite");
    } catch (NoSuchMethodException e) {
        return false;
    }
    return true;
}
  • 根據(jù)此段代碼可以發(fā)現(xiàn)栋豫,如果測(cè)試類中沒有suite方法的話返回的是null
  • 此時(shí)在 AllDefaultPossibilitiesBuilder.runnerForClass中會(huì)繼續(xù)循環(huán)尋找下一下builder
  1. JUnit3Builder:如果測(cè)試類使用的是Junit3的測(cè)試方式,則使用該builder谚殊,?該builder不再細(xì)看

  2. JUnit4Builder:該builder很簡(jiǎn)單丧鸯,直接new BlockJUnit4ClassRunner

     public Runner runnerForClass(Class<?> testClass) throws Throwable {
         return new BlockJUnit4ClassRunner(testClass);
     }
    
  • 從以上AllDefaultPossibilitiesBuilder.runnerForClass方法的執(zhí)行看來,Junit4默認(rèn)使用的builderBlockJUnit4ClassRunner

讓我們?cè)倩氐轿覀兊闹骶€new Suite中嫩絮,

public Suite(RunnerBuilder builder, Class<?>[] classes) throws InitializationError {
    this(null, builder.runners(null, classes));
}
protected Suite(Class<?> klass, List<Runner> runners) throws InitializationError {
    super(klass);
    //Collections.unmodifiableList將傳入的List變得不可修改
    this.runners = Collections.unmodifiableList(runners);
}
  • 由以上流程可知丛肢,在創(chuàng)建Suite這個(gè)Runner時(shí),首先把所有測(cè)試類對(duì)應(yīng)的具體Runner通過對(duì)應(yīng)的RunnerBuilder構(gòu)建好剿干,放入SuiteList<Runner> runners屬性中蜂怎,至此Suite構(gòu)建完成(構(gòu)造方法中的super(klass)后續(xù)再看)

總之,JunitCore中使用的Runner是直接newSuite置尔,而這個(gè)Suite中屬性List<Runner> runners杠步,默認(rèn)情況下,這些runner都是BlockJUnit4ClassRunner
至此Runner的構(gòu)建完成撰洗,讓我來接下來看下整個(gè)Runner構(gòu)建的時(shí)序圖

4.Runner構(gòu)建時(shí)序圖

Runner構(gòu)建時(shí)序圖
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末篮愉,一起剝皮案震驚了整個(gè)濱河市腐芍,隨后出現(xiàn)的幾起案子差导,更是在濱河造成了極大的恐慌,老刑警劉巖猪勇,帶你破解...
    沈念sama閱讀 206,482評(píng)論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件设褐,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡泣刹,警方通過查閱死者的電腦和手機(jī)助析,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,377評(píng)論 2 382
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來椅您,“玉大人外冀,你說我怎么就攤上這事∠朴荆” “怎么了雪隧?”我有些...
    開封第一講書人閱讀 152,762評(píng)論 0 342
  • 文/不壞的土叔 我叫張陵,是天一觀的道長员舵。 經(jīng)常有香客問我脑沿,道長,這世上最難降的妖魔是什么马僻? 我笑而不...
    開封第一講書人閱讀 55,273評(píng)論 1 279
  • 正文 為了忘掉前任庄拇,我火速辦了婚禮,結(jié)果婚禮上韭邓,老公的妹妹穿的比我還像新娘措近。我一直安慰自己溶弟,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,289評(píng)論 5 373
  • 文/花漫 我一把揭開白布熄诡。 她就那樣靜靜地躺著可很,像睡著了一般。 火紅的嫁衣襯著肌膚如雪凰浮。 梳的紋絲不亂的頭發(fā)上我抠,一...
    開封第一講書人閱讀 49,046評(píng)論 1 285
  • 那天,我揣著相機(jī)與錄音袜茧,去河邊找鬼菜拓。 笑死,一個(gè)胖子當(dāng)著我的面吹牛笛厦,可吹牛的內(nèi)容都是我干的纳鼎。 我是一名探鬼主播,決...
    沈念sama閱讀 38,351評(píng)論 3 400
  • 文/蒼蘭香墨 我猛地睜開眼裳凸,長吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼贱鄙!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起姨谷,我...
    開封第一講書人閱讀 36,988評(píng)論 0 259
  • 序言:老撾萬榮一對(duì)情侶失蹤逗宁,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后梦湘,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體瞎颗,經(jīng)...
    沈念sama閱讀 43,476評(píng)論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 35,948評(píng)論 2 324
  • 正文 我和宋清朗相戀三年捌议,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了哼拔。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 38,064評(píng)論 1 333
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡瓣颅,死狀恐怖倦逐,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情宫补,我是刑警寧澤檬姥,帶...
    沈念sama閱讀 33,712評(píng)論 4 323
  • 正文 年R本政府宣布,位于F島的核電站守谓,受9級(jí)特大地震影響穿铆,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜斋荞,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,261評(píng)論 3 307
  • 文/蒙蒙 一荞雏、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦凤优、人聲如沸悦陋。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,264評(píng)論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽俺驶。三九已至,卻和暖如春棍辕,著一層夾襖步出監(jiān)牢的瞬間暮现,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,486評(píng)論 1 262
  • 我被黑心中介騙來泰國打工楚昭, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留栖袋,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 45,511評(píng)論 2 354
  • 正文 我出身青樓抚太,卻偏偏與公主長得像塘幅,于是被迫代替她去往敵國和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子尿贫,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,802評(píng)論 2 345

推薦閱讀更多精彩內(nèi)容

  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理电媳,服務(wù)發(fā)現(xiàn),斷路器庆亡,智...
    卡卡羅2017閱讀 134,599評(píng)論 18 139
  • JUnit Intro Android基于JUnit Framework來書寫測(cè)試代碼匾乓。JUnit是基于Java語...
    chandarlee閱讀 2,249評(píng)論 0 50
  • 注意事項(xiàng): 測(cè)試方法上必須使用@Test修飾 測(cè)試方法必須使用public void進(jìn)行修飾,不能帶任何參數(shù) 新建...
    魯克巴克詩閱讀 1,753評(píng)論 0 3
  • 前兩篇記錄了Junit入口主流程身冀,以及Runner的構(gòu)建钝尸,接下來看一下用來描述我們測(cè)試類的類-TestClass ...
    春狗閱讀 1,115評(píng)論 0 2
  • 1 場(chǎng)景問題# 1.1 繼續(xù)導(dǎo)出數(shù)據(jù)的應(yīng)用框架## 在討論工廠方法模式的時(shí)候括享,提到了一個(gè)導(dǎo)出數(shù)據(jù)的應(yīng)用框架搂根。 對(duì)于...
    七寸知架構(gòu)閱讀 5,667評(píng)論 1 64