核心要點(diǎn)

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

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

"控制臺(tái)組件簡(jiǎn)化了創(chuàng)建美觀且可測(cè)試的命令行界面的過(guò)程。"

這是我們?cè)L問(wèn)Symfony Console組件工具頁(yè)面時(shí)看到的歡迎語(yǔ)。

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

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

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

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

安裝

composer require symfony/console

此處包含Composer的重要信息。

創(chuàng)建新命令

要?jiǎng)?chuàng)建新命令，我們需要確保我們的文件可執(zhí)行。為此，讓我們?cè)陧?xiàng)目根目錄中創(chuàng)建一個(gè)控制臺(tái)文件。此文件將作為我們的命令管理器。

touch console

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

chmod 755 console

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

之後，讓我們定義我們的控制臺(tái)應(yīng)用程序。我們的命令管理器的第一個(gè)迭代將如下所示：

#!/usr/bin/env php

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

use Symfony\Component\Console\Application;

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

讓我們仔細(xì)看看。首先，我們自動(dòng)加載所有依賴項(xiàng)，然後從Console組件導(dǎo)入Application包。之後，我們創(chuàng)建一個(gè)Application的新實(shí)例並運(yùn)行它。

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

這是因?yàn)槲覀冞€沒(méi)有註冊(cè)任何命令，我們只是構(gòu)建了它們的的基本框架。

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

對(duì)於這個(gè)具體的例子，我們將實(shí)現(xiàn)兩個(gè)簡(jiǎn)單的命令：一個(gè)用於哈希字符串，另一個(gè)用於確認(rèn)哈希屬於給定的字符串。

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

composer require symfony/console

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

這個(gè)類將擴(kuò)展Symfony的Command類並實(shí)現(xiàn)configure和execute方法。這些方法對(duì)於我們的命令至關(guān)重要，因?yàn)樗鼈兏嬖V命令如何外觀和行為。

完成的命令如下所示：

touch console

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

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

如果我們像這樣運(yùn)行我們的命令，我們將看到什麼也沒(méi)有發(fā)生。這是因?yàn)槲覀內(nèi)匀蝗鄙僖粋€(gè)非常重要的步驟。我們?nèi)匀恍枰诳刂婆_(tái)中註冊(cè)我們的命令。

chmod 755 console

在控制臺(tái)中註冊(cè)了命令後，讓我們運(yùn)行它。

如果我們?cè)俅芜\(yùn)行./console命令，我們可以看到我們現(xiàn)在註冊(cè)了一個(gè)新命令。

讓我們運(yùn)行它：

#!/usr/bin/env php

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

use Symfony\Component\Console\Application;

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

我們看到最終結(jié)果：

哈希值是將PHP hash()方法應(yīng)用於Sitepoint字符串的結(jié)果。

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

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

<?php
namespace Hash;

class Hash {

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

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

}

然後，在控制臺(tái)中註冊(cè)該命令。

<?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對(duì)給定字符串進(jìn)行哈希處理。")
                ->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);

    }

}

測(cè)試

在測(cè)試方面，Symfony為我們提供了一些方便的工具。其中最有用的是CommandTester類，因?yàn)樗峁┨厥獾妮斎牒洼敵鲱悂?lái)測(cè)試我們的命令，而無(wú)需命令行。

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

首先，讓我們?cè)谂c我們的/src文件夾相同的級(jí)別創(chuàng)建一個(gè)/tests文件夾。

然後，讓我們?cè)谄渲袆?chuàng)建我們的測(cè)試類，並將其命名為HashCommandTest.php：

composer require symfony/console

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

getDisplay()方法保存我們命令執(zhí)行的結(jié)果，就像我們?cè)诿钚兄锌吹降哪菢印?

結(jié)論

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

您想在SitePoint上看到更多關(guān)於Symfony Console的高級(jí)教程嗎？請(qǐng)告訴我們！

我們?cè)诒疚闹芯帉?xiě)的全部代碼都可以在Github上找到。

Symfony Console常見(jiàn)問(wèn)題解答

如何安裝Symfony Console？

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

Symfony Console的主要功能是什麼？

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

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

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

如何運(yùn)行Symfony Console中的命令？

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

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

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

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

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

如何在Symfony Console中顯示輸出？

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

如何處理Symfony Console中的錯(cuò)誤？

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

如何測(cè)試Symfony Console中的命令？

Symfony Console提供了一個(gè)CommandTester類，可用於測(cè)試命令。您可以使用此類來(lái)使用特定參數(shù)和選項(xiàng)執(zhí)行命令，並斷言輸出和退出代碼。

如何在Symfony項(xiàng)目中使用Symfony Console？

在Symfony項(xiàng)目中，您可以使用bin/console腳本運(yùn)行命令。您還可以通過(guò)在src/Command目錄中創(chuàng)建一個(gè)擴(kuò)展SymfonyComponentConsoleCommandCommand類的新類來(lái)創(chuàng)建您自己的命令。

以上是重新引入Symfony Console -CLI PHP，用於初學(xué)者！的詳細(xì)內(nèi)容。更多資訊請(qǐng)關(guān)注PHP中文網(wǎng)其他相關(guān)文章！