使用樁件 (Stub) 解決 Laravel 單元測試中的依賴

Miyang 發(fā)布于2019-06-28 13:23 / 1309人閱讀

摘要：可是我們在做單元測試的時候，希望盡可能少的產(chǎn)生依賴。后記任何一個可靠的系統(tǒng)，單元測試都是必不可少的。慶幸的是，幫我們提供了好用的單元測試。

本文是我在實踐后的一點總結(jié)，難免有不妥之處。如有幸得大神路過，還望不吝賜教，小弟在此謝過了！

很早就知道有單元測試的概念，也曾嘗試過，但是一直對單元測試的概念和方法，比較模糊。在聽了 @vimac 大神的講堂 PHP單元測試與測試驅(qū)動開發(fā) 后，慢慢地對單元測試和 PHPUnit 的認(rèn)識清晰了起來，也開始慢慢地去實踐單元測試。

Laravel 中的依賴

我們都知道，Laravel 使用了 IoC，各個模塊之間也因此解耦了。而正是因為這一點，我們在 Laravel 中編寫單元測試的時候，變得更加輕松了。

舉個栗子

考慮以下場景。我們在開發(fā)中，可能會在控制器和模型之間加一個 Repository 來處理數(shù)據(jù)。那么我們的 Controller 就會依賴 Respository。利用 Laravel 的 IoC，我們可以定義一個 Service Provider 來集中將 Respository 注入到容器中。

假設(shè)我們現(xiàn)在有這樣一個 Repository，里面記錄了商品的信息，我們想要在 Controller 中獲取某件商品信息，然后執(zhí)行一些業(yè)務(wù)邏輯。

Class GoodRepository
{
    public function getGoodById($goodId)
    {
        // TODO: Get good by its id.
    }
}

class GoodController extends Controller
{
    public function show($id, GoodRepository $goodRepository)
    {
        // TODO: Do something with good info from that repository.
    }
}

// In route/api.php
Route::get("/api/good/{id}", "GoodController@show");

// Create a RepositoriesServiceProvider in Provider/RepositoriesServiceProvider.php。
// And inject the GoodRepository into Container.
class RepositoriesServiceProvider extends ServiceProvider
{
    public function boot()
    {
    
    }
    
    public function register()
    {
        $this->app->singleton(GoodRepository::class);
    }
}

好了，我們可以發(fā)現(xiàn)，GoodController 是依賴 GoodRepository 的，而 GoodRepository 是依賴數(shù)據(jù)庫中的數(shù)據(jù)的。可是我們在做單元測試的時候，希望盡可能少的產(chǎn)生依賴。所以，我們應(yīng)該希望能夠掌控 GoodRepository 所返回的數(shù)據(jù)。

在 Laravel，提供了 $this->get("/path/to/route"); 的方法來對 HTTP 請求進(jìn)行測試。這個測試必然會涉及到剛才所提到的那些依賴，如何解決這個依賴的問題，我們可以請出我們的主角————樁件。

樁件

將對象替換為（可選地）返回配置好的返回值的測試替身的實踐方法稱為上樁(stubbing)。

這是 PHPUnit 文檔上的解釋。那我的理解呢，所謂的樁件，就是模擬一個依賴的類的行為，使得這個行為所做的事情在我們自己的掌控之中。比如上面的這種情況，我們希望模擬 GoodRepository 的 getGoodById 方法返回與真正的返回結(jié)構(gòu)相同的值，而不需要依賴外部數(shù)據(jù)源。

在 Laravel 中使用樁件

我們通過 Service Provider 注冊了 GoodRepository 單例，那么按照這個思路，我們在寫單元測試的時候，就可以將我們定義的樁件，注冊為 GoodRepository 單例。

class GoodControllerTest extends TestCase
{
    public function testShow()
    {
        $data = []; // The data returns from GoodRepository::getGoodById.
        
        $stub = $this->createMock(GoodRepository::class);
        
        $stub->method("getGoodById")->will($this->returnValue($data));
        
        $this->app->singleton(GoodRepository::class, function () use ($stub) {
            return $stub;
        });
        
        $response = $this->get("/api/good/1");
        
        // Some assertions.
    }
}

我們通過在這里將樁件 $stub 用單例模式注冊給了 Container，在調(diào)用 $this->get("/api/good/1"); 時原本在 Controller 中的 GoodRepository 依賴就變成了我們自定義的樁件 $stub。我們將 $data 定義為和返回值相同的結(jié)構(gòu)，注冊到樁件中。這樣，所有的數(shù)據(jù)都在我們可控的范圍了。

如果我們在這里不使用樁件，而是直接依賴外部（數(shù)據(jù)庫）中的數(shù)據(jù)，那么如果 id 為 1 的數(shù)據(jù)被刪除了，我們是不是就要改成 2 了呢？我們是不是就要重新計算數(shù)據(jù)了匹配斷言了呢？這樣的測試，可靠性便大大降低。

后記

任何一個可靠的系統(tǒng)，單元測試都是必不可少的。慶幸的是，PHPUnit 幫我們提供了好用的單元測試。本文所講的，也只是 PHPUnit 的九牛一毛。而我自己也在慢慢摸索慢慢實踐中。與君共勉。

最后還是推薦去聽一下 @vimac 的講堂 PHP單元測試與測試驅(qū)動開發(fā)，受益匪淺。