JUnit原始碼分析 （三）——Template Method模式

dennis_zane發表於2007-04-06
原始碼模式
    在JUnit執行測試時，我們經常需要初始化一些環境供測試程式碼使用，比如資料庫連線、mock物件等等，這些初始化程式碼應當在每一個測試之前執行並在測試方法執行後清理。在JUnit裡面就是相應的setUp和tearDown方法。如果沒有這兩個方法，那麼我們要在每個測試方法的程式碼內寫上一大堆重複的初始化和清理程式碼，這是多麼愚蠢的做法。那麼JUnit是怎麼讓setUp和tearDown在測試執行前後被呼叫的呢？
    如果你檢視下TestCase方法，你會發現TestCase和TestSuite的run()方法都是將執行測試的任務委託給了TestResult，由TestResult去執行測試程式碼並收集測試過程中的資訊（這裡用到了Collecting Parameter模式）。
   
    public TestResult run() {
        TestResult result= createResult();
        run(result);
        return result;
    }
    /**
     * Runs the test case and collects the results in TestResult.
     * This is the template method that defines the control flow
     * for running a test case.
     */
    public void run(TestResult result) {
        result.run(this);
    }
   
    我們直接找到TestResult，看看它的run方法：
/**
     * Runs a TestCase.
     */
    protected void run(final TestCase test) {
        startTest(test);
        Protectable p = new Protectable() {
            public void protect() throws Throwable {
                test.runBare();
            }
        };
        runProtected(test, p);
        endTest(test);
    }

    這裡例項化了一個內部類，內部類實現了Protectable介面的 protect()方法，並執行傳入的TestCase的runBare()方法，顯然，真正的測試程式碼在TestCase的runBare()方法中，讓我們來看下：


        //將被子類實現
    protected void setUp() throws Throwable {
    }
    //同上，將被具體的TestCase實現
    protected void tearDown() throws Throwable {
    }
     /**
     * 模板方法
     * Runs the bare test sequence.
     * @exception Throwable if any exception is thrown
     */
    public void runBare() throws Throwable {
        setUp();
        try {
            runTest();
        }
        finally {
            tearDown();
        }
    }

真相水落石出，對於每一個測試方法，都遵循這樣的模板：setUp->執行測試 runTest()->tearDown。這正是模板方式模式的一個應用例子。什麼是template method模式呢？

Template Method模式

類行為模式的一種
1.意圖：定義一個操作中的演算法的骨架，而將一些延遲步驟到子類中。Template Method使得子類可以不改變一個演算法的結構即可重定義該演算法的某些步驟。
2.適用場景：
1）一次性實現演算法的不變部分（基本骨架），將可變的行為留給子類來完成
2）子類中的公共部分（比如JUnit中的初始化和清理）被抽取到一個公共父類中以避免程式碼重複。
3）控制了子類的擴充套件，這裡其實也有類似回撥函式的性質，具體步驟先在骨架中註冊，在具體執行時被回撥。

3.UML圖和結構
   
  抽象父類定義了演算法的基本骨架（模板方法），而不同的子類實現具體的演算法步驟，客戶端由此可以與演算法的更改隔離。

4.效果：
1）模板方法是程式碼複用的基本技術，在類庫中經常使用，可以減少大量的程式碼重複
2）通過隔離演算法的不變和可變部分，增加了系統的靈活性，擴充套件演算法的某些步驟將變的很容易。

    瞭解了Template Method模式之後，讓我們回到JUnit的原始碼，看看runTest()方法，這裡主要應用的是java的反射技術，對於學習反射技術的有參考價值：
protected void runTest() throws Throwable {
        Method runMethod= null;
        try {
            runMethod= getClass().getDeclaredMethod(fName, new Class[0]);
        } catch (NoSuchMethodException e) {
            fail("Method \""+fName+"\" not found");
        }
        if (runMethod != null && !Modifier.isPublic(runMethod.getModifiers())) {
            fail("Method \""+fName+"\" should be public");
        }

        try {
            runMethod.invoke(this, new Class[0]);
        }
        catch (InvocationTargetException e) {
            e.fillInStackTrace();
            throw e.getTargetException();
        }
        catch (IllegalAccessException e) {
            e.fillInStackTrace();
            throw e;
        }
    }

   

相關文章