Yii Framework Offizieller Leitfaden Serie 50 – Spezialthema: Konsolenanwendungen

Die Konsolenanwendung wird hauptsächlich zum Implementieren von Offline-Vorgängen verwendet, die für Online-Webanwendungen erforderlich sind, z. B. Codegenerierung, Suchindexkompilierung, E-Mail-Versand usw . Das Yii-Framework bietet ein Framework zum objektorientierten Schreiben von Konsolenanwendungen. Es ermöglicht Konsolenanwendungen, auf Ressourcen zuzugreifen, die von Online-Webanwendungen verwendet werden (z. B. Datenbankverbindungsinformationen).

Übersicht

Yii kann jede Konsolenaufgabe in der Befehlszeile ausführen. Der Konsolenbefehl ist eine von CConsoleCommand geerbte Klasse.

Wenn wir das yiic-Webapp-Tool verwenden, um ein initialisiertes Yii-Anwendungsskelett zu erstellen, können wir die folgenden zwei Dateien im geschützten Ordner sehen:

• yiic: Dies ist eine ausführbares Skript, das unter Linux/Unix ausgeführt wird;

• yiic.bat: Dies ist ein ausführbares Batch-Skript, das unter Windows ausgeführt wird.

Im Konsolenfenster , können wir den folgenden Befehl eingeben:

cd protected
yiic help

Dadurch wird eine Reihe von Konsolenbefehlen angezeigt. Zu diesen gültigen Befehlen gehören standardmäßig diejenigen, die vom Yii-Framework bereitgestellt werden (Systembefehle) und diejenigen, die von Entwicklern selbst für eigenständige Anwendungen geschrieben wurden (Benutzerbefehle).

Wenn Sie sehen möchten, wie ein Befehl verwendet wird, können Sie Folgendes verwenden:

yiic help <command-name></command-name>

Um einen Befehl auszuführen, können Sie den folgenden Befehl verwenden Format:

yiic <command-name> [parameters...]</command-name>

2. Befehl erstellen

Der Konsolenbefehl wird in Form einer Klassendatei in einem Pfad wie CConsoleApplication::command gespeichert Ordner protected/commands.

Eine Konsolenbefehlsklasse muss von CConsoleCommand erben. Der Klassenname muss das Format XyzCommand haben, wobei Xyz den Befehlsnamen mit einem Großbuchstaben darstellt Verwenden Sie den Klassennamen SitemapCommand. Bei Konsolenbefehlsnamen wird die Groß-/Kleinschreibung beachtet.

Tipp: Durch die Konfiguration des CConsoleApplication::command-Abgleichs können Sie Befehle erhalten, die in verschiedenen Formen benannt und in verschiedenen Ordnern der Klasse gespeichert werden.

Um einen neuen Befehl zu erstellen, müssen Sie häufig CConsoleCommand::run() überschreiben oder eine oder mehrere Befehlsaktionen entwickeln.

Beim Ausführen eines Konsolenbefehls wird die Methode CConsoleCommand::run() von der Konsolenanwendung aufgerufen. Alle Konsolenparameter werden auch in Form des folgenden Methodenfragments an diese Methode übergeben:

public function run($args) { ... }

wo $args Stellt zusätzliche Parameter dar, die in der Befehlszeile angegeben werden.

Im Konsolenbefehl können wir Yii::app() verwenden, um auf die Konsolenanwendungsinstanz zuzugreifen. Darüber hinaus können wir auch auf Ressourcen wie Datenbankverbindungen zugreifen (z. B. Yii::app()-> ;db ). Sie können sehen, dass diese Verwendung der Verwendung in Webanwendungen sehr ähnlich ist.

Info: Ab Version 1.1.1 können wir auch globale Befehle erstellen, die von allen Yii-Anwendungen auf demselben Computer gemeinsam genutzt werden: Definieren Sie eine Umgebungsvariable mit dem Namen YII_CONSOLE_COMMANDS. Zeigen Sie auf eine vorhandene Ordner und platzieren Sie dann unsere globale Befehlsklasse in diesem Ordner.

3. Konsolenbefehlsaktion (Aktion)

Hinweis: Diese Konsolenbefehlsaktionsfunktion ist ab Version 1.1.5 gültig.

Ein Konsolenbefehl muss häufig verschiedene Befehlszeilenparameter verarbeiten, einige sind erforderlich und andere optional. Der Konsolenbefehl muss auch einige Unterbefehle bereitstellen, um verschiedene Unteraufgaben zu verarbeiten. Diese Aufgaben können mithilfe von Konsolenbefehlsaktionen vereinfacht werden.

Eine Konsolenbefehlsaktion ist eine Methode in der Konsolenbefehlsklasse. Der Methodenname muss das Format actionXyz haben, wobei Xyz den Aktionsnamen mit großgeschriebenem Anfangsbuchstaben darstellt. Eine actionIndex-Methode definiert beispielsweise eine Aktion benannte Indexaktion.

Um eine bestimmte Aktion auszuführen, können wir das folgende Befehlszeilenformat verwenden:

yiic <command-name> <action-name> --option1=value1 --option2=value2 ...</action-name></command-name>

Zusätzliche Option-Wert-Paare werden als benannte Parameter in der Aktionsmethode übergeben . Der Wert einer xyz-Operation wird in Form des Parameters $xyz an die Aktionsmethode übergeben. Wenn wir beispielsweise die folgende Befehlsklasse definieren:

class SitemapCommand extends CConsoleCommand
{
    public function actionIndex($type, $limit=5) { ... }
    public function actionInit() { ... }
}

Dann heißt der folgende Konsolenbefehl actionIndex ('News', 5) wird Ergebnisse liefern:

yiic sitemap index --type=News --limit=5

// $limit takes default value
yiic sitemap index --type=News

// $limit takes default value
// because 'index' is a default action, we can omit the action name
yiic sitemap --type=News

// the order of options does not matter
yiic sitemap index --limit=5 --type=News

Wenn eine Operation keinen Wert angibt (z. B. --type statt --type=News), wird der entsprechende Aktionsparameterwert angenommen um wahr zu sein.

Hinweis: unterstützt nicht das optionale Parameterformat --type News, -t News.

Ein Parameterwert kann ein Array sein ( erforderlich Hinweis zum Array-Typ erforderlich):

public function actionIndex(array $types) { ... }

Wenn Sie Array-Werte in Befehlszeilenparametern verwenden möchten , einfach die gleiche Option wiederholen:

yiic sitemap index --types=News --types=Article

Der obige Befehl ruft schließlich actionIndex(array('News', 'Article')) auf.

Ab Version 1.1.6, Yii Die Verwendung anonymer Aktionsparameter und globaler Optionen wird ebenfalls unterstützt

匿名参数表示这些命令行参数不是以选项的形式呈现. 例如, 在命令 yiic sitemap index --limit=5 News中, 我们有一个值为News的匿名参数和命名参数 limit，其值为5。

为了使用匿名参数, 一个命令动作必须声明参数为 $args的形式. 例如,

public function actionIndex($limit=10, $args=array()) {...}

$args数组将会装入所有的匿名参数值.

全局选项代表那些命令行选项可以被一个命令中所有动作共享的选项. 例如, 在一个命令中提供了多个选项, 我们可能想要每一个动作识别一个名为verbose的动作. 当然我们可以在每一个动作方法中声明 $verbose 参数, 一个更好的方式是将其声明为这个命令类的公有成员变量, 将 verbose 转换为全局参数:

class SitemapCommand extends CConsoleCommand
{
    public $verbose=false;
    public function actionIndex($type) {...}
}

上面的代码允许我们执行一个带 verbose 选项的命令:

yiic sitemap index --verbose=1 --type=News

4. 退出代码

Note: 在控制台命令中退出代码的特性从版本 1.1.11起有效.

通过cronjob或者使用一个持续集成的服务器自动运行控制台命令的时候, 要么命令运行运行成功，要么命令运行失败. 这可以通过检查进程返回的退出代码来查看。

这些退出码是从0-254的整型值(this is the range in php world), 其中 0 表示退出成功其他的所有非0值表示出现了错误.

在一个动作方法或者控制台命令的 run() 方法中你可以在退出时返回整型值退出码 ，例如:

if (/* error */) {
    return 1; // exit with error code 1
}
// ... do something ...
return 0; // exit successfully

如果没有返回值, 应用将会退出返回 0.

5. 自定义控制台应用

默认情况下, 如果一个应用是使用yiic webapp工具创建的, 命令行应用的配置将会放在 protected/config/console.php文件中. 和一个Web应用配置文件一样, 这个文件是一个返回控制台应用实例的初始化配置值的数组的PHP脚本。所以CConsoleApplication的任何公有属性都可以在该文件中配置.

因为控制台命令经常被创建来服务于Web应用, 所以需要访问资源（如数据库连接）。我们可以在控制台配置文件中以如下方式来实现 ：

return array(
    ......
    'components'=>array(
        'db'=>array(
            ......
        ),
    ),
);

正如我们所看到的那样, 配置的格式和我们在Web应用中的配置类似.这是因为CConsoleApplication和 CWebApplication 的基类相同。

 以上就是Yii框架官方指南系列50——专题：控制台应用的内容，更多相关内容请关注PHP中文网（www.php.cn）！