创建命令
最后更新于：2022-04-02 07:05:32
## 创建命令
命令就是一个命令行程序，`Command` 类似于 HTTP 应用的 `Controller` 控制器，负责业务逻辑，不同的是命令行程序通常是处理复杂的数据处理逻辑，相比简单的 `CRUD` 操作要复杂很多。
## 一个简单的命令
首先在配置文件 `manifest.php` 的 `commands` 或者 `commandPath` 中增加命令。
- commands
~~~
// 命令
'commands' => [
'he' => [
\App\Console\Commands\HelloCommand::class,
'description' => "\tEcho demo",
'options' => [
[['n', 'name'], 'description' => 'Your name'],
['say', 'description' => "\tSay ..."],
],
],
],
~~~
- commandPath
在 `commandPath` 指定的目录中任意创建一个文件，内容如下：
~~~
// 命令
return [
'he' => [
\App\Console\Commands\HelloCommand::class,
'description' => "\tEcho demo",
'options' => [
[['n', 'name'], 'description' => 'Your name'],
['say', 'description' => "\tSay ..."],
],
],
];
~~~
详解命令规则：
- 命令名称： `he`
- 命令类的类名：`\App\Console\Commands\HelloCommand::class`
- `description` 命令的描述，命令 `-h` 时显示，(可不定义)
- `options` 命令的参数，参数 `-h` 时显示，(可不定义)
- `['n', 'name']`、`'say'` 命令参数的名称，可为字符或数组，**所有参数都必须在这里注册方可使用**。
- `options.description` 参数的描述，参数 `COMMAND -h` 时显示，(可不定义)
当在 [mix-phar](https://github.com/mix-php/mix-phar) 中开发时还可以进行单命令配置，使整个 phar 文件为一个命令，配置方式如下：
~~~
// 命令
'commands' => [
\App\Console\Commands\HelloCommand::class,
'description' => "\tEcho demo",
'options' => [
[['n', 'name'], 'description' => 'Your name'],
['say', 'description' => "\tSay ..."],
],
],
~~~
创建命令类，代码如下：
~~~
*/
class HelloCommand
{
/**
* 主函数
*/
public function main()
{
$name = Flag::string(['n', 'name'], 'Xiao Ming');
$say = Flag::string('say', 'Hello, World!');
println("{$name}: {$say}");
}
}
~~~
## 命名空间与文件位置的关系
控制器定义的命名空间为：
~~~
namespace App\Console\Commands;
~~~
因为根命名空间 `App` 在 `composer.json` 内定义的路径为 ：
~~~
"psr-4": {
"App\\": "app/"
},
~~~
所以控制器的完整路径为：
~~~
app/Console/Commands/HelloCommand.php
~~~
## 命令行执行
执行上面写的命令。
~~~shell
// 不带参数
php bin/mix.php he
// 带参数
php bin/mix.php he -n "Xiao Hua" --say=Hi
~~~
';