核心要點(diǎn)

• 將 JavaScript 風(fēng)格的測(cè)試觀察者集成到 PHP 項(xiàng)目中，自動(dòng)化預(yù)處理文件的轉(zhuǎn)換，并在文件更改時(shí)重新運(yùn)行單元測(cè)試，從而提高開(kāi)發(fā)效率。
• 使用 PHPUnit 等工具設(shè)置自動(dòng)化測(cè)試，并使用 PHPUnit-Watcher 觀察文件修改，確保在開(kāi)發(fā)過(guò)程中立即獲得反饋并檢測(cè)錯(cuò)誤。
• 在 PHP 項(xiàng)目中實(shí)現(xiàn)預(yù)處理腳本，允許進(jìn)行類(lèi)似于 JavaScript Babel 的語(yǔ)法轉(zhuǎn)換，從而提高兼容性并減少手動(dòng)編碼工作。
• 配置 PHP 測(cè)試環(huán)境，以便在測(cè)試之前自動(dòng)重建預(yù)處理文件，從而保持準(zhǔn)確的代碼覆蓋率并簡(jiǎn)化測(cè)試過(guò)程。
• 探索使用文件觀察者的高級(jí)配置，以便有選擇地僅重建已修改的文件，從而顯著加快大型項(xiàng)目中大量文件的測(cè)試周期。

本文由 Younes Rafie 審核。感謝所有 SitePoint 的同行評(píng)審人員，使 SitePoint 內(nèi)容達(dá)到最佳狀態(tài)！

我一開(kāi)始并沒(méi)有為我的代碼編寫(xiě)測(cè)試。像許多人一樣，我的“測(cè)試”就是編寫(xiě)代碼并刷新頁(yè)面。“看起來(lái)對(duì)嗎？”，我會(huì)問(wèn)自己。如果我認(rèn)為是對(duì)的，我就繼續(xù)進(jìn)行。

事實(shí)上，我做過(guò)的大部分工作都是在不太關(guān)心其他形式測(cè)試的公司。經(jīng)過(guò)多年時(shí)間，以及像 Chris Hartjes 這樣的人的明智建議，我才看到了測(cè)試的價(jià)值。而且我仍在學(xué)習(xí)好的測(cè)試是什么樣的。

我最近開(kāi)始從事一些包含捆綁測(cè)試觀察者的 JavaScript 項(xiàng)目。

這是一個(gè)關(guān)于測(cè)試驅(qū)動(dòng) NodeJS 開(kāi)發(fā)的精彩高級(jí)視頻教程！

在 JavaScript 的世界里，預(yù)處理源代碼并不少見(jiàn)。在 JavaScript 的世界里，開(kāi)發(fā)人員使用不被廣泛支持的語(yǔ)法編寫(xiě)代碼，然后將代碼轉(zhuǎn)換為被廣泛支持的語(yǔ)法，通常使用名為 Babel 的工具。

為了減少調(diào)用轉(zhuǎn)換腳本的負(fù)擔(dān)，樣板項(xiàng)目已開(kāi)始包含自動(dòng)監(jiān)視文件更改的腳本；然后調(diào)用這些腳本。

我參與的這些項(xiàng)目采用了類(lèi)似的方法來(lái)重新運(yùn)行單元測(cè)試。當(dāng)我更改 JavaScript 文件時(shí)，這些文件會(huì)被轉(zhuǎn)換，并且單元測(cè)試會(huì)被重新運(yùn)行。這樣，我可以立即看到是否破壞了任何東西。

本教程的代碼可以在 Github 上找到。我已經(jīng)用 PHP 7.1 測(cè)試過(guò)它。

項(xiàng)目設(shè)置

自從開(kāi)始從事這些項(xiàng)目以來(lái)，我開(kāi)始為 PHPUnit 設(shè)置類(lèi)似的東西。事實(shí)上，我設(shè)置 PHPUnit 觀察者腳本的第一個(gè)項(xiàng)目是一個(gè)也預(yù)處理文件的 PHP 項(xiàng)目。

在我向我的項(xiàng)目添加預(yù)處理腳本后，這一切就開(kāi)始了：

composer require pre/short-closures

這些特定的預(yù)處理腳本允許我重命名 PSR-4 自動(dòng)加載的類(lèi)（從 path/to/file.php ? path/to/file.pre），以選擇加入它們提供的功能。所以我向我的 composer.json 文件添加了以下內(nèi)容：

"autoload": {
    "psr-4": {
        "App\": "src"
    }
},
"autoload-dev": {
    "psr-4": {
        "App\Tests\": "tests"
    }
}

這來(lái)自 composer.json

然后我添加了一個(gè)類(lèi)來(lái)生成包含當(dāng)前用戶會(huì)話詳細(xì)信息的函數(shù)：

namespace App;

use Closure;

class Session
{
    private $user;

    public function __construct(array $user)
    {
        $this->user = $user;
    }

    public function closureWithUser(Closure $closure)
    {
        return () => {
            $closure($this->user);
        };
    }
}

這來(lái)自 src/Session.pre

為了檢查這是否有效，我設(shè)置了一個(gè)小的示例腳本：

require_once __DIR__ . "/vendor/autoload.php";

$session = new App\Session(["id" => 1]);

$closure = ($user) => {
    print "user: " . $user["id"] . PHP_EOL;
};

$closureWithUser = $session->closureWithUser($closure);
$closureWithUser();

這來(lái)自 example.pre

……而且因?yàn)槲蚁朐诜?PSR-4 類(lèi)中使用短閉包，我還需要設(shè)置一個(gè)加載器：

require_once __DIR__ . "/vendor/autoload.php";

Pre\Plugin\process(__DIR__ . "/example.pre");

這來(lái)自 loader.php

這段代碼很多，是為了說(shuō)明一個(gè)小點(diǎn)。Session 類(lèi)有一個(gè) closureWithUser 方法，它接受一個(gè)閉包并返回另一個(gè)。調(diào)用時(shí)，這個(gè)新的閉包將調(diào)用原始閉包，提供用戶會(huì)話數(shù)組作為參數(shù)。

要運(yùn)行所有這些，請(qǐng)?jiān)诮K端中鍵入：

php loader.php

作為旁注，這些預(yù)處理器生成的有效 PHP 語(yǔ)法非常漂亮。它看起來(lái)像這樣：

$closure = function ($user) {
   print "user: " . $user["id"] . PHP_EOL;
};

……和

public function closureWithUser(Closure $closure)
{
   return [$closure = $closure ?? null, "fn" => function () use (&$closure) {
       $closure($this->user);
   }]["fn"];
}

你可能不想將 php 和 pre 文件都提交到倉(cāng)庫(kù)。為此，我已經(jīng)將 app/**/*.php 和 examples.php 添加到 .gitignore 中。

設(shè)置測(cè)試

那么我們?nèi)绾螠y(cè)試這個(gè)呢？讓我們從安裝 PHPUnit 開(kāi)始：

composer require --dev phpunit/phpunit

然后，我們應(yīng)該創(chuàng)建一個(gè)配置文件：

<?xml version="1.0" encoding="UTF-8"?>
<phpunit
    backupGlobals="false"
    backupStaticAttributes="false"
    bootstrap="vendor/autoload.php"
    colors="true"
    convertErrorsToExceptions="true"
    convertNoticesToExceptions="true"
    convertWarningsToExceptions="false"
    processIsolation="false"
    stopOnFailure="false"
    syntaxCheck="false"
>
    <testsuites>
        <testsuite>
            <directory suffix="Test.php">tests</directory>
        </testsuite>
    </testsuites>
    <filter>
        <whitelist addUncoveredFilesFromWhitelist="true">
            <directory suffix=".php">src</directory>
        </whitelist>
    </filter>
</phpunit>

這來(lái)自 phpunit.xml

如果我們運(yùn)行 vendor/bin/phpunit，它將有效。但是我們還沒(méi)有任何測(cè)試。讓我們做一個(gè)：

namespace App\Tests;

use App\Session;
use PHPUnit\Framework\TestCase;

class SessionTest extends TestCase
{
    public function testClosureIsDecorated()
    {
        $user = ["id" => 1];
        $session = new Session($user);

        $expected = null;

        $closure = function($user) use (&$expected) {
            $expected = "user: " . $user["id"];
        };

        $closureWithUser = $session
            ->closureWithUser($closure);

        $closureWithUser();

        $this->assertEquals("user: 1", $expected);
    }
}

這來(lái)自 tests/SessionTest.php

當(dāng)我們運(yùn)行 vendor/bin/phpunit 時(shí)，單個(gè)測(cè)試通過(guò)了。耶！

在測(cè)試之前構(gòu)建所有文件

讓我們創(chuàng)建一個(gè)新腳本，在嘗試運(yùn)行測(cè)試之前構(gòu)建所有 Pre 文件：

composer require pre/short-closures

這來(lái)自 tests/bootstrap.php

在這里，我們創(chuàng)建了 3 個(gè)函數(shù)；一個(gè)用于獲取遞歸文件迭代器（來(lái)自路徑），一個(gè)用于刪除此迭代器的文件，一個(gè)用于重新編譯 Pre 文件。

我們需要替換 phpunit.xml 中當(dāng)前的 bootstrap 文件：

"autoload": {
    "psr-4": {
        "App\": "src"
    }
},
"autoload-dev": {
    "psr-4": {
        "App\Tests\": "tests"
    }
}

這來(lái)自 phpunit.xml

現(xiàn)在，每當(dāng)我們運(yùn)行測(cè)試時(shí)，此腳本將首先清理并重建所有 Pre 文件到 PHP 文件。覆蓋率被正確報(bào)告，我們可以繼續(xù)我們的快樂(lè)旅程……

除了這件事……

我們的代碼庫(kù)很小，但它不需要很小。我們可以在真實(shí)的應(yīng)用程序中嘗試這個(gè)，并立即后悔每次想要測(cè)試時(shí)都必須重建文件。

在這個(gè)我提到的項(xiàng)目中，我有 101 個(gè) Pre 文件。僅僅為了運(yùn)行我的（希望很快的）單元測(cè)試套件，這就需要大量的預(yù)處理。我們需要一種方法來(lái)監(jiān)視更改，并且只重建重要的部分。首先，讓我們安裝一個(gè)文件觀察者：

namespace App;

use Closure;

class Session
{
    private $user;

    public function __construct(array $user)
    {
        $this->user = $user;
    }

    public function closureWithUser(Closure $closure)
    {
        return () => {
            $closure($this->user);
        };
    }
}

然后，讓我們創(chuàng)建一個(gè)測(cè)試腳本：

require_once __DIR__ . "/vendor/autoload.php";

$session = new App\Session(["id" => 1]);

$closure = ($user) => {
    print "user: " . $user["id"] . PHP_EOL;
};

$closureWithUser = $session->closureWithUser($closure);
$closureWithUser();

這來(lái)自 scripts/watch-test

該腳本創(chuàng)建一個(gè) Symfony 查找器（用于掃描我們的 src 和 tests 文件夾）。我們定義了一個(gè)臨時(shí)更改文件，但這對(duì)于我們正在做的事情來(lái)說(shuō)并不是嚴(yán)格要求的。我們接下來(lái)使用一個(gè)無(wú)限循環(huán)。ResourceWatcher 有一個(gè)我們可以用來(lái)查看是否創(chuàng)建、修改或刪除了任何文件的方法。

新的，讓我們找到哪些文件已更改，并重建它們：

require_once __DIR__ . "/vendor/autoload.php";

Pre\Plugin\process(__DIR__ . "/example.pre");

這來(lái)自 scripts/watch-test

這段代碼類(lèi)似于我們?cè)?bootstrap 文件中所做的操作，但它只應(yīng)用于已更改的文件。當(dāng)文件更改時(shí)，我們還應(yīng)該重新運(yùn)行測(cè)試：

php loader.php

這來(lái)自 scripts/watch-test

我們正在引入幾個(gè)環(huán)境變量。您可以根據(jù)自己的喜好管理這些變量，但我更喜歡將它們添加到 composer 腳本中：

$closure = function ($user) {
   print "user: " . $user["id"] . PHP_EOL;
};

這來(lái)自 composer.json

APP_COVER 并不是那么重要。它只是告訴觀察者腳本是否包含代碼覆蓋率。APP_REBUILD 扮演著更重要的角色：它控制在加載 tests/bootstrap.php 文件時(shí)是否重建 Pre 文件。我們需要修改該文件，以便僅在請(qǐng)求時(shí)重建文件：

public function closureWithUser(Closure $closure)
{
   return [$closure = $closure ?? null, "fn" => function () use (&$closure) {
       $closure($this->user);
   }]["fn"];
}

這來(lái)自 tests/bootstrap.php

我們還需要修改觀察者腳本，以便在包含 bootstrap 代碼之前設(shè)置此環(huán)境變量。整個(gè)觀察者腳本如下所示：

composer require --dev phpunit/phpunit

這來(lái)自 scripts/watch-test

現(xiàn)在我們應(yīng)該能夠啟動(dòng)它，并在每次可預(yù)處理文件更改時(shí)運(yùn)行我們的測(cè)試……

需要記住幾件事（rawr）。首先，您需要 chmod x scripts/* 才能運(yùn)行觀察者腳本。其次，您需要設(shè)置 config: {process-timeout: 0}（在 composer.json 中），否則觀察者將在 300 秒后死亡。

獎(jiǎng)勵(lì)回合！

這個(gè)測(cè)試觀察者還啟用了一個(gè)很酷的副作用：能夠在我們的 PHPUnit 測(cè)試中使用預(yù)處理器/轉(zhuǎn)換。如果我們向 tests/bootstrap.php 添加一些代碼：

composer require pre/short-closures

這來(lái)自 tests/bootstrap.php

……并且我們?cè)跍y(cè)試文件中啟用預(yù)處理（對(duì)于 Pre，這意味著將其重命名為 .pre）。然后我們可以開(kāi)始在我們的測(cè)試文件中使用相同的預(yù)處理器：

"autoload": {
    "psr-4": {
        "App\": "src"
    }
},
"autoload-dev": {
    "psr-4": {
        "App\Tests\": "tests"
    }
}

這來(lái)自 tests/SessionTest.pre

結(jié)論

我不敢相信在嘗試創(chuàng)建這種測(cè)試觀察者之前，我已經(jīng)做了這么多的預(yù)處理器工作。這證明了我們可以從其他語(yǔ)言和框架中學(xué)到什么。如果我沒(méi)有參與那些 JavaScript 項(xiàng)目，我可能會(huì)繼續(xù)在每次測(cè)試運(yùn)行之前重建我的文件。惡心！

這種方法對(duì)您有效嗎？它可以適應(yīng)異步 HTTP 服務(wù)器或其他長(zhǎng)期運(yùn)行的進(jìn)程。請(qǐng)?jiān)谠u(píng)論中告訴我們您的想法。

關(guān)于 PHP 中 JavaScript 風(fēng)格測(cè)試觀察者的常見(jiàn)問(wèn)題解答 (FAQ)

如何在 PHP 中設(shè)置 JavaScript 風(fēng)格的測(cè)試觀察者？

在 PHP 中設(shè)置 JavaScript 風(fēng)格的測(cè)試觀察者涉及多個(gè)步驟。首先，您需要安裝 PHPUnit 和 PHPUnit-Watcher。PHPUnit 是一個(gè)用于 PHP 的測(cè)試框架，它提供了一種為代碼編寫(xiě)測(cè)試的方法。PHPUnit-Watcher 是一個(gè)監(jiān)視您的代碼并在保存文件時(shí)運(yùn)行 PHPUnit 測(cè)試的工具。安裝這些工具后，您可以配置 PHPUnit-Watcher 來(lái)監(jiān)視您的代碼并自動(dòng)運(yùn)行您的測(cè)試。此設(shè)置允許您立即獲得代碼更改的反饋，這可以幫助您更快地發(fā)現(xiàn)和修復(fù)錯(cuò)誤。

使用 PHP 中的測(cè)試觀察者的好處是什么？

在 PHP 中使用測(cè)試觀察者有很多好處。它提供代碼更改的即時(shí)反饋，這可以幫助您更快地發(fā)現(xiàn)和修復(fù)錯(cuò)誤。它還可以節(jié)省您的時(shí)間，因?yàn)槟槐卦诿看未a更改后手動(dòng)運(yùn)行測(cè)試。此外，它鼓勵(lì)您為代碼編寫(xiě)測(cè)試，這可以提高代碼質(zhì)量并使其更易于維護(hù)。

我可以在 JavaScript 函數(shù)內(nèi)使用 PHP 代碼嗎？

是的，您可以在 JavaScript 函數(shù)內(nèi)使用 PHP 代碼，但不建議這樣做。PHP 是一種服務(wù)器端語(yǔ)言，而 JavaScript 是一種客戶端語(yǔ)言。這意味著 PHP 代碼在頁(yè)面發(fā)送到客戶端之前在服務(wù)器上執(zhí)行，而 JavaScript 代碼在頁(yè)面接收后在客戶端執(zhí)行。因此，如果您嘗試在 JavaScript 函數(shù)內(nèi)使用 PHP 代碼，PHP 代碼將在 JavaScript 函數(shù)之前執(zhí)行，這可能會(huì)導(dǎo)致意外結(jié)果。

如何使用 Codeception 測(cè)試我的 PHP 代碼？

Codeception 是一個(gè)用于 PHP 的測(cè)試框架，它支持單元測(cè)試、功能測(cè)試和驗(yàn)收測(cè)試。要使用 Codeception 測(cè)試您的 PHP 代碼，您首先需要安裝 Codeception 并為您的項(xiàng)目配置它。然后，您可以使用 Codeception 的語(yǔ)法為您的代碼編寫(xiě)測(cè)試，并使用 Codeception 的命令行工具運(yùn)行您的測(cè)試。

如何在 JavaScript 中編寫(xiě) PHP 代碼？

雖然從技術(shù)上講可以在 JavaScript 中編寫(xiě) PHP 代碼，但不建議這樣做。PHP 是一種服務(wù)器端語(yǔ)言，而 JavaScript 是一種客戶端語(yǔ)言。這意味著 PHP 代碼在頁(yè)面發(fā)送到客戶端之前在服務(wù)器上執(zhí)行，而 JavaScript 代碼在頁(yè)面接收后在客戶端執(zhí)行。因此，如果您嘗試在 JavaScript 中編寫(xiě) PHP 代碼，PHP 代碼將在 JavaScript 代碼之前執(zhí)行，這可能會(huì)導(dǎo)致意外結(jié)果。相反，最好使用 AJAX 將數(shù)據(jù)從客戶端發(fā)送到服務(wù)器，反之亦然。

以上是如何在PHP中寫(xiě)JavaScript風(fēng)格的測(cè)試觀察者的詳細(xì)內(nèi)容。更多信息請(qǐng)關(guān)注PHP中文網(wǎng)其他相關(guān)文章！