php單元測試進(jìn)階（9）- 核心技術(shù) - 樁件(stub) - 工廠類注入樁件

本系列文章主要代碼與文字來源于《單元測試的藝術(shù)》晃琳，原作者：Roy Osherove括袒。譯者：金迎禾怠。

本系列文章根據(jù)php的語法與使用習(xí)慣做了改編。所有代碼在本機(jī)測試通過。如轉(zhuǎn)載請注明出處刻撒。
這一節(jié)討論的場景是：你在對一個(gè)對象進(jìn)行操作之前才能得到其實(shí)例啸盏，而不是通過構(gòu)造方法或者屬性注入得到重贺。換句話說，樁件（通過工廠類）和調(diào)用樁件的方法聯(lián)系更加緊密回懦。

這種情況的不同之處在于發(fā)起樁件請求的對象是被測試代碼气笙。而之前幾節(jié)中，那些偽對象是在測試開始之前怯晕，由被測代碼之外的代碼設(shè)置的潜圃。

工廠模式是一種設(shè)計(jì)模式，允許另一個(gè)類負(fù)責(zé)創(chuàng)建對象舟茶。
為了增強(qiáng)控制谭期，方便測試，本示例中的工廠有一個(gè)set方法可以注入樁件吧凉。
使用這種技術(shù)實(shí)現(xiàn)的測試代碼可讀性好隧出，不同的類之間界限清晰，每個(gè)類各自負(fù)責(zé)不同的行為阀捅。
在上上文中胀瞪，有一個(gè)全部代碼的清單。上文沒有饲鄙，為了便于觀看凄诞，本文給出全部代碼。
注意忍级，又多了一個(gè)工廠類帆谍，在源代碼中，現(xiàn)在源代碼4個(gè)文件颤练，測試2個(gè)文件（這么多工作只是為了測試一句調(diào)用文件管理器的代碼既忆，但值得驱负，后面會有用單元測試專門的mock類庫來寫樁件）。
注意到接口患雇，和接口的兩個(gè)實(shí)現(xiàn)代碼完全不變跃脊。

源代碼

（1）t2\application\index\controller下根據(jù)測試需要（實(shí)際是解耦，讓程序更加結(jié)構(gòu)清晰）提取的接口
IExtensionManager.php（未改動(dòng)）

<?php
namespace app\index\controller;

/**
 * 文件名是否有效接口
 * 源代碼中的文件管理器類會實(shí)現(xiàn)苛吱，一個(gè)樁件也會實(shí)現(xiàn)
 * 接口的存在酪术，讓所有代碼的含義更加清晰，穩(wěn)定翠储。
 */
interface  IExtensionManager
{
    /**
     * 判斷文件名是否有效
     * @param string $filename
     * @return boolean
     */
    public function isValid($filename);
}

（2）t2\application\index\controller下文件管理器類绘雁，實(shí)現(xiàn)了上面的接口，但是實(shí)際被排除在單元測試之外援所，不測它庐舟。應(yīng)該使用集成測試來測試此類。
FileExtensionManager.php（未改動(dòng)）

<?php
namespace app\index\controller;

/**
 * 文件管理器類
 *
 */
class FileExtensionManager implements IExtensionManager
{
    /**
     * 根據(jù)某個(gè)配置文件的內(nèi)容判斷文件名是否有效
     * @param string $filename
     */
    public function isValid($filename)
    {
        // 會使用file_get_contents函數(shù)讀取某個(gè)文件的內(nèi)容
        // 這里為了簡略不寫住拭，因?yàn)椴皇侵攸c(diǎn)挪略。
        return true;
    }
}

（3）t2\application\index\controller下，工廠類滔岳，返回一個(gè)實(shí)現(xiàn)了上面的接口的對象杠娱，為了方便測試，可以被注入谱煤。
ExtensionManagerFactory.php

<?php
namespace app\index\controller;

/**
 * 靜態(tài)工廠類摊求，返回實(shí)現(xiàn)IExtensionManager接口的對象，
 * 分離代碼的功能刘离。
 */
class ExtensionManagerFactory
{
    /**
     * @var IExtensionManager
     */
    private static $manager = null;
    
    /**
     * 通過此方法室叉，可以注入樁件或正常的對象
     * @param unknown $mgr
     */
    public static function setManager($mgr)
    {
        self::$manager = $mgr;
    }
    
    /**
     * 工廠方法，能看到有一個(gè)默認(rèn)的實(shí)現(xiàn)
     * @return \app\index\controller\IExtensionManager
     */
    public static function create()
    {
        if (self::$manager) {
            return self::$manager;
        }
        return new FileExtensionManager();
    }
}

（4）t2\application\index\controller下被測類寥闪，日志分析器太惠。使用了構(gòu)造方法注入的方式來寫代碼磨淌，便于測試
LogAnalyzer.php

<?php
namespace app\index\controller;

/**
 * 日志分析器類疲憋，也是被測類
 * 
 * 注意，這是用靜態(tài)工廠注入樁件的例子梁只。
 */
class LogAnalyzer
{
    /**
     * @var IExtensionManager
     */
    private $manager;
    
    public function __construct()
    {
        // 在源代碼中使用工廠類
        $this->manager = ExtensionManagerFactory::create();
    }
    
    /**
     * 判斷文件名是否有效缚柳，調(diào)用另一個(gè)類來實(shí)現(xiàn)
     * @param string $filename
     */
    public function isValidLogFileName($filename)
    {
        return $this->manager->isValid($filename);
    }
}

測試代碼

（5）t2\tests\index\controller\下，樁件類搪锣，用于替換文件管理器秋忙，便于測試
FakeExtensionManager.php（未改動(dòng)）

<?php
namespace tests\index\controller;
/**
 * 一個(gè)樁件類，用于測試日志分析器构舟，因?yàn)槿罩痉治鰰x取文件灰追，妨礙單元測試。
 */
class FakeExtensionManager implements \app\index\controller\IExtensionManager
{
    public $willBeValid = false;
    
    /**
     * 根據(jù)某個(gè)配置文件的內(nèi)容判斷文件名是否有效
     * @param string $filename
     */
    public function isValid($filename)
    {
        return $this->willBeValid;
    }
}

（6）t2\tests\index\controller\下，最后是測試類弹澎，用構(gòu)造方法注入樁件
LogAnalyzerTest.php

<?php
namespace tests\index\controller;

/**
 * 測試用的類
 */
class LogAnalyzerTest extends \think\testing\TestCase
{

    /**
     * @test
     * 使用靜態(tài)工廠注入樁件的方法 進(jìn)行測試
     * 注意朴下，盡量使得測試的方法名稱有意義，這非常重要苦蒿，便于維護(hù)測試代碼殴胧。有規(guī)律
     */
    public function isValidFileName_NameSupportedExtension_ReturnTrue()
    {
        //準(zhǔn)備好一個(gè)返回true的樁件，注入到靜態(tài)工廠中去佩迟。
        $myFakeManager = new FakeExtensionManager();
        $myFakeManager->willBeValid = true; 
        \app\index\controller\ExtensionManagerFactory::setManager($myFakeManager);
        
        //開始創(chuàng)建被測類的對象团滥，準(zhǔn)備測試
        $analyzer = new \app\index\controller\LogAnalyzer();
        $result = $analyzer->isValidLogFileName("short.ext");
        $this->assertTrue($result);
    }
}

cmd下測試通過。

上一篇：php單元測試進(jìn)階（8）- 核心技術(shù) - 樁件(stub) - 屬性注入樁件
下一篇：php單元測試進(jìn)階（10）- 核心技術(shù) - 樁件(stub) - 調(diào)用方法注入樁件