核心要點

• Symfony Console是一個獨立的包，提供了一個簡單的框架來創(chuàng)建命令行工具，這對于重復性任務（如數(shù)據(jù)遷移、導入或創(chuàng)建cron作業(yè)）非常有用。
• 要創(chuàng)建新的命令，需要使文件可執(zhí)行。這可以通過在項目根目錄中創(chuàng)建控制臺文件、確保文件可執(zhí)行以及定義控制臺應用程序來完成。
• 可以使用Symfony的CommandTester類測試命令，該類提供特殊的輸入和輸出類來測試命令，而無需命令行。
• Symfony Console是使用Composer（PHP中的依賴項管理工具）安裝的。它提供了一個簡單的API來創(chuàng)建命令行命令，并支持輸出的彩色顯示、進度條、表格和其他交互式功能。

這篇文章于2017年5月24日更新，提供了對這個重要現(xiàn)代工具的更全面的介紹。

"控制臺組件簡化了創(chuàng)建美觀且可測試的命令行界面的過程。"

這是我們訪問Symfony Console組件工具頁面時看到的歡迎語。

作為軟件開發(fā)人員，我們經(jīng)常需要使用命令行工具。當我們需要執(zhí)行某種重復性任務（如遷移數(shù)據(jù)、執(zhí)行導入或創(chuàng)建cron作業(yè)）時，這些工具非常有用。

Symfony Console組件工具為我們提供了一個簡單的框架來創(chuàng)建我們自己的命令行工具。

與Symfony中的許多組件不同，這是一個獨立的包，被Laravel的Artisan以及許多其他著名的PHP包使用。

要了解Symfony Console的替代方案，請參閱我們的比較文章：PHP控制臺之戰(zhàn)!

安裝

composer require symfony/console

此處包含Composer的重要信息。

創(chuàng)建新命令

要創(chuàng)建新命令，我們需要確保我們的文件可執(zhí)行。為此，讓我們在項目根目錄中創(chuàng)建一個控制臺文件。此文件將作為我們的命令管理器。

touch console

現(xiàn)在，讓我們確保該文件可執(zhí)行。

chmod 755 console

然后，讓我們確保我們的文件開頭有shebang。shebang是一個字符序列（井號后跟感嘆號），出現(xiàn)在腳本的開頭。當存在shebang時，exec()將改為運行shebang后指定的可執(zhí)行文件。在我們的例子中，它將作為PHP腳本運行。

之后，讓我們定義我們的控制臺應用程序。我們的命令管理器的第一個迭代將如下所示：

#!/usr/bin/env php

<?php require_once __DIR__ . '/vendor/autoload.php';

use Symfony\Component\Console\Application;

$app = new Application();
$app->run();

讓我們仔細看看。首先，我們自動加載所有依賴項，然后從Console組件導入Application包。之后，我們創(chuàng)建一個Application的新實例并運行它。

如果我們使用./console執(zhí)行腳本，我們應該得到以下幫助消息：

這是因為我們還沒有注冊任何命令，我們只是構建了它們的的基本框架。

讓我們創(chuàng)建我們的腳本并在我們新創(chuàng)建的命令管理器中注冊它。

對于這個具體的例子，我們將實現(xiàn)兩個簡單的命令：一個用于哈希字符串，另一個用于確認哈希屬于給定的字符串。

我們將在其中放置我們的Hash.php類的/src文件夾中，內(nèi)容如下：

composer require symfony/console

現(xiàn)在是創(chuàng)建我們的命令的時候了。讓我們創(chuàng)建一個名為HashCommand.php的新PHP文件。

這個類將擴展Symfony的Command類并實現(xiàn)configure和execute方法。這些方法對于我們的命令至關重要，因為它們告訴命令如何外觀和行為。

完成的命令如下所示：

touch console

在configure部分，setName方法是我們調(diào)用命令的方式，setDescription是命令的描述，addArgument是我們聲明命令將接受一個名為Password的參數(shù)，并且它是必需的。

在execute部分，我們通過getArgument函數(shù)訪問參數(shù)，然后使用我們的Hash類對其進行哈希處理。最后，我們使用OutputInterface的writeln方法將結果打印到屏幕上。

如果我們像這樣運行我們的命令，我們將看到什么也沒有發(fā)生。這是因為我們?nèi)匀蝗鄙僖粋€非常重要的步驟。我們?nèi)匀恍枰诳刂婆_中注冊我們的命令。

chmod 755 console

在控制臺中注冊了命令后，讓我們運行它。

如果我們再次運行./console命令，我們可以看到我們現(xiàn)在注冊了一個新命令。

讓我們運行它：

#!/usr/bin/env php

<?php require_once __DIR__ . '/vendor/autoload.php';

use Symfony\Component\Console\Application;

$app = new Application();
$app->run();

我們看到最終結果：

哈希值是將PHP hash()方法應用于Sitepoint字符串的結果。

對于哈希確認功能，我們將使用相同的方法，但我們將有兩個參數(shù)，而不是一個。一個將是需要確認的字符串，另一個是我們想要驗證的哈希值。

我們將創(chuàng)建一個新的命令文件，就在HashCommand文件的旁邊。讓我們稱之為ConfirmCommand。

<?php
namespace Hash;

class Hash {

    /**
     * 接收一個字符串密碼并對其進行哈希處理。
     *
     * @param string $password
     * @return string $hash
     */
    public static function hash($password) {
        return password_hash($password, PASSWORD_DEFAULT);
    }

    /**
     * 驗證哈希是否與給定的密碼相對應
     *
     * @param string $password
     * @param string $hash
     * @return boolean 如果哈希是從密碼生成的
     */
    public static function checkHash($string, $hash) {
        if (password_verify($string, $hash)) {
            return true;
        }
        return false;
    }

}

然后，在控制臺中注冊該命令。

<?php
namespace Hash;

use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Formatter\OutputFormatterStyle;

use Hash\Hash;

class HashCommand extends Command {

    protected function configure() {
        $this->setName("Hash:Hash")
                ->setDescription("使用Bcrypt對給定字符串進行哈希處理。")
                ->addArgument('Password', InputArgument::REQUIRED, '你想要哈希什么？');
    }

    protected function execute(InputInterface $input, OutputInterface $output) {

        $hash = new Hash();
        $input = $input->getArgument('Password');

        $result = $hash->hash($input);

        $output->writeln('你的密碼哈希值：' . $result);

    }

}

測試

在測試方面，Symfony為我們提供了一些方便的工具。其中最有用的是CommandTester類，因為它提供特殊的輸入和輸出類來測試我們的命令，而無需命令行。

讓我們使用CommandTester類為我們的Hash:Hash命令實現(xiàn)一個測試。

首先，讓我們在與我們的/src文件夾相同的級別創(chuàng)建一個/tests文件夾。

然后，讓我們在其中創(chuàng)建我們的測試類，并將其命名為HashCommandTest.php：

composer require symfony/console

我們首先使用Application類加載我們的命令。然后，我們實例化一個新的CommandTester。使用CommandTester，我們可以配置我們想要如何調(diào)用我們的命令。最后一步只是使用getDisplay()方法將執(zhí)行結果與我們期望的結果進行比較。

getDisplay()方法保存我們命令執(zhí)行的結果，就像我們在命令行中看到的那樣。

結論

我們剛剛使用Symfony Console組件創(chuàng)建了兩個不同的命令。我們還看到了測試這些命令的好方法。我建議您查看組件的各種選項和功能，并在下面的評論部分給我們一些關于您實驗的反饋。

您想在SitePoint上看到更多關于Symfony Console的高級教程嗎？請告訴我們！

我們在本文中編寫的全部代碼都可以在Github上找到。

Symfony Console常見問題解答

如何安裝Symfony Console？

Symfony Console是Symfony框架的一個組件，可以使用Composer（PHP中的依賴項管理工具）安裝。要安裝Symfony Console，您需要在終端中運行以下命令：composer require symfony/console。此命令將下載并將Symfony Console組件安裝到您的項目中。

Symfony Console的主要功能是什么？

Symfony Console提供了一個簡單的API來創(chuàng)建命令行命令。這些命令可用于cron作業(yè)、遷移、導入或任何其他可以通過命令行運行的任務類型。它還支持輸出的彩色顯示、進度條、表格和其他交互式功能。

如何在Symfony Console中創(chuàng)建新命令？

要創(chuàng)建新命令，您需要創(chuàng)建一個新類，該類擴展SymfonyComponentConsoleCommandCommand類。在此類中，您在configure方法中定義命令的名稱、描述、參數(shù)和選項。execute方法包含命令的邏輯。

如何運行Symfony Console中的命令？

要運行命令，您需要使用bin/console腳本，后跟命令的名稱。例如，如果您有一個名為app:my-command的命令，您可以使用以下命令運行它：bin/console app:my-command。

如何將Symfony Console用于數(shù)據(jù)庫遷移？

Symfony Console可以與Doctrine（Symfony中的數(shù)據(jù)庫抽象層）結合使用來管理數(shù)據(jù)庫遷移。您可以創(chuàng)建一個新命令，該命令執(zhí)行必要的SQL查詢來遷移您的數(shù)據(jù)庫。

如何在Symfony Console中處理命令參數(shù)和選項？

可以在命令類的configure方法中定義命令參數(shù)和選項。您可以使用getArgument和getOption方法在execute方法中檢索這些參數(shù)和選項的值。

如何在Symfony Console中顯示輸出？

Symfony Console提供了幾種顯示輸出的方法。您可以使用writeln方法顯示一行文本，使用write方法顯示文本（末尾沒有換行符），以及使用table方法顯示表格。

如何處理Symfony Console中的錯誤？

可以通過拋出異常來處理錯誤。Symfony Console將捕獲這些異常并顯示錯誤消息。您還可以使用exit方法停止命令的執(zhí)行并返回退出代碼。

如何測試Symfony Console中的命令？

Symfony Console提供了一個CommandTester類，可用于測試命令。您可以使用此類來使用特定參數(shù)和選項執(zhí)行命令，并斷言輸出和退出代碼。

如何在Symfony項目中使用Symfony Console？

在Symfony項目中，您可以使用bin/console腳本運行命令。您還可以通過在src/Command目錄中創(chuàng)建一個擴展SymfonyComponentConsoleCommandCommand類的新類來創(chuàng)建您自己的命令。

以上是重新引入Symfony Console -CLI PHP，用于初學者！的詳細內(nèi)容。更多信息請關注PHP中文網(wǎng)其他相關文章！