php單元測試進階（9）- 核心技術 - 樁件(stub) - 工廠類注入樁件
本系列文章主要代碼與文字來源于《單元測試的藝術》，原作者：Roy Osherove。譯者：金迎。
本系列文章根據php的語法與使用習慣做了改編。所有代碼在本機測試通過。如轉載請注明出處。
這一節討論的場景是：你在對一個對象進行操作之前才能得到其實例，而不是通過構造方法或者屬性注入得到。換句話說，樁件（通過工廠類）和調用樁件的方法聯系更加緊密。
這種情況的不同之處在于發起樁件請求的對象是被測試代碼。而之前幾節中，那些偽對象是在測試開始之前，由被測代碼之外的代碼設置的。
工廠模式是一種設計模式，允許另一個類負責創建對象。
為了增強控制，方便測試，本示例中的工廠有一個set方法可以注入樁件。
使用這種技術實現的測試代碼可讀性好，不同的類之間界限清晰，每個類各自負責不同的行為。
在上上文中，有一個全部代碼的清單。上文沒有，為了便于觀看，本文給出全部代碼。
注意，又多了一個工廠類，在源代碼中，現在源代碼4個文件，測試2個文件（這么多工作只是為了測試一句調用文件管理器的代碼，但值得，后面會有用單元測試專門的mock類庫來寫樁件）。
注意到接口，和接口的兩個實現代碼完全不變。
源代碼
（1）t2\application\index\controller下根據測試需要（實際是解耦，讓程序更加結構清晰）提取的接口
IExtensionManager.php（未改動）
<?php
namespace app\index\controller;
/**
* 文件名是否有效接口
* 源代碼中的文件管理器類會實現，一個樁件也會實現
* 接口的存在，讓所有代碼的含義更加清晰，穩定。
*/
interface IExtensionManager
{
/**
* 判斷文件名是否有效
* @param string $filename
* @return boolean
*/
public function isValid($filename);
}
（2）t2\application\index\controller下文件管理器類，實現了上面的接口，但是實際被排除在單元測試之外，不測它。應該使用集成測試來測試此類。
FileExtensionManager.php（未改動）
<?php
namespace app\index\controller;
/**
* 文件管理器類
*
*/
class FileExtensionManager implements IExtensionManager
{
/**
* 根據某個配置文件的內容判斷文件名是否有效
* @param string $filename
*/
public function isValid($filename)
{
// 會使用file_get_contents函數讀取某個文件的內容
// 這里為了簡略不寫，因為不是重點。
return true;
}
}
（3）t2\application\index\controller下，工廠類，返回一個實現了上面的接口的對象，為了方便測試，可以被注入。
ExtensionManagerFactory.php
<?php
namespace app\index\controller;
/**
* 靜態工廠類，返回實現IExtensionManager接口的對象，
* 分離代碼的功能。
*/
class ExtensionManagerFactory
{
/**
* @var IExtensionManager
*/
private static $manager = null;
/**
* 通過此方法，可以注入樁件或正常的對象
* @param unknown $mgr
*/
public static function setManager($mgr)
{
self::$manager = $mgr;
}
/**
* 工廠方法，能看到有一個默認的實現
* @return \app\index\controller\IExtensionManager
*/
public static function create()
{
if (self::$manager) {
return self::$manager;
}
return new FileExtensionManager();
}
}
（4）t2\application\index\controller下被測類，日志分析器。使用了構造方法注入的方式來寫代碼，便于測試
LogAnalyzer.php
<?php
namespace app\index\controller;
/**
* 日志分析器類，也是被測類
*
* 注意，這是用靜態工廠注入樁件的例子。
*/
class LogAnalyzer
{
/**
* @var IExtensionManager
*/
private $manager;
public function __construct()
{
// 在源代碼中使用工廠類
$this->manager = ExtensionManagerFactory::create();
}
/**
* 判斷文件名是否有效，調用另一個類來實現
* @param string $filename
*/
public function isValidLogFileName($filename)
{
return $this->manager->isValid($filename);
}
}
測試代碼
（5）t2\tests\index\controller\下，樁件類，用于替換文件管理器，便于測試
FakeExtensionManager.php（未改動）
<?php
namespace tests\index\controller;
/**
* 一個樁件類，用于測試日志分析器，因為日志分析會讀取文件，妨礙單元測試。
*/
class FakeExtensionManager implements \app\index\controller\IExtensionManager
{
public $willBeValid = false;
/**
* 根據某個配置文件的內容判斷文件名是否有效
* @param string $filename
*/
public function isValid($filename)
{
return $this->willBeValid;
}
}
（6）t2\tests\index\controller\下，最后是測試類，用構造方法注入樁件
LogAnalyzerTest.php
<?php
namespace tests\index\controller;
/**
* 測試用的類
*/
class LogAnalyzerTest extends \think\testing\TestCase
{
/**
* @test
* 使用靜態工廠注入樁件的方法 進行測試
* 注意，盡量使得測試的方法名稱有意義，這非常重要，便于維護測試代碼。有規律
*/
public function isValidFileName_NameSupportedExtension_ReturnTrue()
{
//準備好一個返回true的樁件，注入到靜態工廠中去。
$myFakeManager = new FakeExtensionManager();
$myFakeManager->willBeValid = true;
\app\index\controller\ExtensionManagerFactory::setManager($myFakeManager);
//開始創建被測類的對象，準備測試
$analyzer = new \app\index\controller\LogAnalyzer();
$result = $analyzer->isValidLogFileName("short.ext");
$this->assertTrue($result);
}
}
cmd下測試通過。
上一篇：php單元測試進階（8）- 核心技術 - 樁件(stub) - 屬性注入樁件
下一篇：php單元測試進階（10）- 核心技術 - 樁件(stub) - 調用方法注入樁件
