掌握 PHP 單元測試：工具、框架與最佳實踐

如何在 PHP 中執行單元測試：工具和最佳實踐

單元測試是軟體開發生命週期的關鍵部分，可確保應用程式的各個元件或功能如預期運作。在 PHP 中，單元測試有助於驗證程式碼的正確性，使開發人員能夠及早發現 bug，提高程式碼的可靠性和可維護性。

在 PHP 中執行單元測試涉及為小型、獨立的功能（單元）編寫測試，通常使用專門的測試框架和工具。以下深入說明如何在 PHP 中進行單元測試、常用的工具和框架以及要遵循的最佳實務。

---

1. PHP 中的單元測試是什麼？

單元測試涉及單獨測試各個程式碼單元（稱為函數或方法），以確保它們按預期執行。單元測試的首要目標是驗證每個單元的正確性，幫助及早發現 bug，讓開發人員放心重構或修改程式碼。

單元測試檢查特定輸入的函數或方法的行為，並將實際輸出與預期輸出進行比較。單元測試通常是自動化的，並且可以連續運行以保持高程式碼品質。

---

2.單元測試的主要好處

• 早期錯誤偵測：單元測試有助於及早發現錯誤和錯誤，從而更容易在它們影響應用程式的較大部分之前修復它們。
• 重建信心：透過適當的單元測試，開發人員可以自信地進行更改或重構程式碼，因為知道測試會捕獲任何回歸。
• 提高程式碼品質：編寫單元測試迫使開發人員編寫模組化、可維護且結構良好的程式碼，從而促進更好的設計實踐。
• 文件：單元測試充當函數和方法的預期行為的活文檔。

---

3. PHP 單元測試工具與框架

PHP 中的一些工具和框架可以幫助您編寫和執行單元測試。最受歡迎的是 PHPUnit、Mockery 和 PHPSpec。以下是這些工具的概述：

a. PHPUnit

PHPUnit 是最廣泛使用的 PHP 測試框架。它是一個開源工具，提供了一種編寫和運行單元測試的簡單方法。 PHPUnit 的靈感來自 xUnit 系列框架（例如用於 Java 的 JUnit 和用於 .NET 的 NUnit）。

• 安裝：PHPUnit 可以透過 PHP 依賴管理器 Composer 安裝。

composer require --dev phpunit/phpunit

• 基本範例：

// Example: A simple Calculator class
class Calculator {
    public function add($a, $b) {
        return $a + $b;
    }
}

// PHPUnit test for Calculator class
use PHPUnit\Framework\TestCase;

class CalculatorTest extends TestCase {
    public function testAdd() {
        $calculator = new Calculator();
        $result = $calculator->add(2, 3);
        $this->assertEquals(5, $result);
    }
}

• 運行 PHPUnit:

要使用 PHPUnit 執行測試，請使用下列指令：

./vendor/bin/phpunit tests/CalculatorTest.php

PHPUnit 功能：

• Assertions：提供多種斷言方法，如assertEquals、assertTrue、assertFalse、assertContains等，用於驗證測試結果。
• 測試套件：將多個測試組合在一起並將它們作為一個套件運行。
• 模擬：建立模擬物件來模擬測試過程中的依賴關係。
• 程式碼覆蓋率：PHPUnit 可以產生程式碼覆蓋率報告來衡量測試涵蓋了多少程式碼。

b.嘲諷

Mockery 是一個與 PHPUnit 一起使用的模擬框架，用於模擬物件並模擬依賴項的行為。在測試具有外部相依性的元件（例如資料庫連線、API 或服務）時，它允許進行更細粒度的控制。

• 安裝：Mockery 可以透過 Composer 安裝。

composer require --dev mockery/mockery

• 範例：

use Mockery;
use PHPUnit\Framework\TestCase;

class UserServiceTest extends TestCase {
    public function testGetUserName() {
        // Create a mock UserRepository
        $userRepository = Mockery::mock(UserRepository::class);
        $userRepository->shouldReceive('find')->with(1)->andReturn(new User('John Doe'));

        $userService = new UserService($userRepository);
        $userName = $userService->getUserName(1);

        $this->assertEquals('John Doe', $userName);
    }

    public function tearDown(): void {
        Mockery::close();  // Clean up mock objects
    }
}

c. PHP 規格

PHPSpec 是 PHP 的行為驅動開發 (BDD) 框架。 PHPUnit 專注於為程式碼單元編寫測試，而 PHPSpec 則專注於指定類別和物件的行為。它允許用更自然的語言編寫測試，並且通常用於從外到內驅動開發。

• 安裝：

composer require --dev phpspec/phpspec

• 基本範例：

// Spec for Calculator class
class CalculatorSpec extends \PhpSpec\ObjectBehavior {
    function it_adds_two_numbers() {
        $this->add(2, 3)->shouldReturn(5);
    }
}

---

4. PHP 單元測試的最佳實務

以下是在 PHP 中編寫單元測試時應遵循的一些最佳實踐：

a.一次測試一件事

每個測試應該只驗證一種特定的行為或功能。這使得測試更容易理解、維護和調試。

b.保持測試隔離

單元測試應該相互獨立。每個測試應獨立於其他測試運行，以確保其可靠且可重複。

c.使用模擬依賴

如果您的程式碼依賴外部服務、資料庫或 API，請使用模擬來模擬它們的行為。這可以防止您的測試依賴真實的外部系統，確保它們運作得更快、更可靠。

d.在編碼之前編寫測試（測試驅動開發）

遵循 TDD（測試驅動開發）有助於確保編寫程式碼時考慮到可測試性。首先編寫測試，然後編寫使它們通過的程式碼。

e.使用描述性檢定名稱

使用描述性測試名稱來解釋正在測試的行為。這可以幫助其他人（以及未來的你）了解每次測試的目的。

composer require --dev phpunit/phpunit

f.定期執行測試

將您的測試整合到持續整合 (CI) 管道中，以便它們在每次提交時自動執行。這可確保新的變更不會破壞現有功能。

---

5.使用 PHPUnit 進行完整單元測試的範例

讓我們來看看使用 PHPUnit 對類別進行單元測試的完整範例。

要測試的類別（Calculator.php）：

// Example: A simple Calculator class
class Calculator {
    public function add($a, $b) {
        return $a + $b;
    }
}

// PHPUnit test for Calculator class
use PHPUnit\Framework\TestCase;

class CalculatorTest extends TestCase {
    public function testAdd() {
        $calculator = new Calculator();
        $result = $calculator->add(2, 3);
        $this->assertEquals(5, $result);
    }
}

單元測試類別（CalculatorTest.php）：

./vendor/bin/phpunit tests/CalculatorTest.php

執行測試：

composer require --dev mockery/mockery

---

6.結論

單元測試是確保軟體品質的重要組成部分，尤其是在 PHP 應用程式中。透過使用 PHPUnit、Mockery 和 PHPSpec 等測試框架，您可以編寫自動化測試來幫助驗證程式碼的正確性。單元測試提供了多種好處，例如早期錯誤檢測、重構期間的程式碼信心以及更好的整體軟體品質。

透過遵循最佳實踐，例如編寫獨立的描述性測試以及使用模擬來模擬依賴關係，您可以編寫有效且可維護的單元測試，從而有助於專案的長期成功。

以上是掌握 PHP 單元測試：工具、框架與最佳實踐的詳細內容。更多資訊請關注PHP中文網其他相關文章！