Symfony命令行怎么用_Symfony Console组件命令行工具

Symfony Console组件是Symfony框架中用于快速构建命令行工具的核心组件，它提供了完整的命令行参数解析、选项处理、输入输出交互等能力，不仅可以用于Symfony项目，也可以独立安装到普通PHP项目中使用。下面我们就从安装到实际开发，一步步了解如何使用Symfony Console组件构建命令行工具。

一、安装Symfony Console组件

如果是独立的PHP项目，我们可以通过Composer来安装Symfony Console组件，在终端中执行以下命令：

composer require symfony/console

如果是Symfony框架项目，Console组件通常已经默认安装，无需额外操作。安装完成后，我们就可以开始编写第一个命令行工具了。

二、创建第一个命令行命令

使用Symfony Console组件开发命令，首先需要创建一个继承Symfony\Component\Console\Command\Command的类，然后定义命令的名称、描述、参数、选项以及执行逻辑。

下面是一个最简单的命令行命令示例，实现输出一句问候语的功能：

<?php

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

use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

// 定义命令类，继承Command基类
class HelloCommand extends Command
{
    // 命令配置方法，用于设置命令的名称、描述等信息
    protected function configure()
    {
        // 设置命令名称为 hello
        $this->setName('hello')
            // 设置命令的简短描述，会在命令列表的帮助信息中显示
            ->setDescription('输出一句问候语')
            // 设置命令的详细描述，会在执行 php cli.php hello --help 时显示
            ->setHelp('这个命令用于输出自定义的问候语，默认输出Hello World');
    }

    // 命令执行逻辑方法，输入参数由InputInterface提供，输出操作由OutputInterface完成
    protected function execute(InputInterface $input, OutputInterface $output)
    {
        // 向终端输出内容
        $output->writeln('Hello World');
        // 命令执行成功返回Command::SUCCESS，失败返回Command::FAILURE
        return Command::SUCCESS;
    }
}

接下来我们需要创建一个入口文件来注册并运行这个命令，入口文件通常命名为cli.php或者console：

<?php

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

use Symfony\Component\Console\Application;

// 创建Application实例，参数是应用名称和版本号
$application = new Application('My CLI Tool', '1.0.0');

// 注册我们之前定义的HelloCommand命令
$application->add(new HelloCommand());

// 运行应用，处理命令行输入
$application->run();

现在我们在终端中执行以下命令，就可以看到命令的输出效果：

php cli.php hello
# 输出结果：Hello World

三、添加命令参数和选项

实际开发中，命令行工具往往需要接收用户输入的参数和选项，Symfony Console组件提供了非常便捷的方式来定义这些输入项。

1. 添加命令参数

参数是命令后面跟着的必填或可选的值，比如我们想要让问候语可以自定义称呼，就可以添加一个name参数：

<?php

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

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

class GreetCommand extends Command
{
    protected function configure()
    {
        $this->setName('greet')
            ->setDescription('向指定的人输出问候语')
            ->setHelp('用法：php cli.php greet [姓名]，如果不填写姓名默认问候World')
            // 添加参数，第一个参数是参数名，第二个参数是参数模式，第三个是参数描述，第四个是默认值
            // InputArgument::REQUIRED 表示必填参数，InputArgument::OPTIONAL 表示可选参数
            ->addArgument('name', InputArgument::OPTIONAL, '要问候的人名', 'World');
    }

    protected function execute(InputInterface $input, OutputInterface $output)
    {
        // 获取输入的参数值
        $name = $input->getArgument('name');
        $output->writeln(sprintf('Hello %s', $name));
        return Command::SUCCESS;
    }
}

修改入口文件注册这个新命令后，我们就可以测试参数的效果：

php cli.php greet
# 输出：Hello World

php cli.php greet 张三
# 输出：Hello 张三

2. 添加命令选项

选项是命令中以--开头的键值对，通常用于设置一些可选的配置项，比如我们想要添加一个--yell选项，开启后输出大写形式的问候语：

<?php

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

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

class GreetCommand extends Command
{
    protected function configure()
    {
        $this->setName('greet')
            ->setDescription('向指定的人输出问候语')
            ->setHelp('用法：php cli.php greet [姓名] [--yell]，--yell选项会让问候语变成大写')
            ->addArgument('name', InputArgument::OPTIONAL, '要问候的人名', 'World')
            // 添加选项，第一个是选项名，第二个是选项简写，第三个是选项模式，第四个是描述，第五个是默认值
            // InputOption::VALUE_NONE 表示这个选项不需要值，只要出现就代表开启
            ->addOption('yell', 'y', InputOption::VALUE_NONE, '是否将问候语转为大写');
    }

    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $name = $input->getArgument('name');
        $message = sprintf('Hello %s', $name);
        
        // 判断--yell选项是否被设置
        if ($input->getOption('yell')) {
            $message = strtoupper($message);
        }
        
        $output->writeln($message);
        return Command::SUCCESS;
    }
}

测试选项的效果：

php cli.php greet 张三
# 输出：Hello 张三

php cli.php greet 张三 --yell
# 输出：HELLO 张三

php cli.php greet 张三 -y
# 输出：HELLO 张三（使用简写选项效果相同）

四、常用的输入输出操作

Symfony Console组件还提供了丰富的输入输出交互能力，让命令行工具更加灵活好用。

1. 输出不同样式的文本

我们可以通过OutputInterface设置输出文本的颜色、背景色等样式，方便区分不同信息：

protected function execute(InputInterface $input, OutputInterface $output)
{
    // 输出普通信息
    $output->writeln('这是普通信息');
    // 输出绿色的成功信息
    $output->writeln('<info>这是成功提示信息</info>');
    // 输出红色的报错信息
    $output->writeln('<error>这是错误提示信息</error>');
    // 输出黄色的警告信息
    $output->writeln('<comment>这是警告提示信息</comment>');
    // 输出带背景的提示信息
    $output->writeln('<bg=blue;fg=white>这是蓝底白字的提示信息</bg=blue;fg=white>');
    return Command::SUCCESS;
}

2. 询问用户输入

如果需要在命令执行过程中询问用户输入，可以使用Symfony\Component\Console\Style\SymfonyStyle类，它封装了很多便捷的交互方法：

<?php

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

use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Style\SymfonyStyle;

class AskCommand extends Command
{
    protected function configure()
    {
        $this->setName('ask')
            ->setDescription('询问用户输入信息并输出');
    }

    protected function execute(InputInterface $input, OutputInterface $output)
    {
        // 创建SymfonyStyle实例，封装输入输出操作
        $io = new SymfonyStyle($input, $output);
        
        // 询问用户输入姓名，第二个参数是默认值
        $name = $io->ask('请输入你的姓名', '匿名用户');
        // 询问用户输入年龄，第三个参数是验证回调，返回验证后的结果
        $age = $io->ask('请输入你的年龄', null, function ($value) {
            if (!is_numeric($value) || $value <= 0) {
                throw new \RuntimeException('年龄必须是大于0的数字');
            }
            return (int)$value;
        });
        
        // 输出用户输入的信息
        $io->success(sprintf('你输入的信息是：姓名%s，年龄%d', $name, $age));
        return Command::SUCCESS;
    }
}

执行这个命令后，终端会依次等待用户输入，输入不符合要求还会提示重新输入。

3. 进度条展示

如果命令需要执行耗时操作，比如批量处理数据，可以使用进度条来展示执行进度：

protected function execute(InputInterface $input, OutputInterface $output)
{
    $io = new SymfonyStyle($input, $output);
    $io->title('开始执行批量处理任务');
    
    // 模拟需要处理的100条数据
    $total = 100;
    // 创建进度条，设置总步数
    $progressBar = $io->createProgressBar($total);
    // 设置进度条格式
    $progressBar->setFormat(' %current%/%max% [%bar%] %percent:3s%% %elapsed:6s%/%estimated:-6s%');
    
    for ($i = 0; $i < $total; $i++) {
        // 模拟耗时操作
        usleep(50000);
        // 进度条前进一步
        $progressBar->advance();
    }
    
    // 进度条完成
    $progressBar->finish();
    $io->newLine(2);
    $io->success('批量处理任务完成');
    return Command::SUCCESS;
}

五、查看命令帮助信息

Symfony Console组件自动为每个命令生成帮助信息，我们只需要执行以下命令就可以查看所有可用命令：

php cli.php list

如果要查看某个具体命令的帮助信息，可以使用--help选项：

php cli.php greet --help

帮助信息会展示命令的名称、描述、参数、选项的详细说明，方便其他用户使用我们开发的命令行工具。

六、在Symfony框架中使用命令行

如果是Symfony框架项目，我们不需要手动创建入口文件，只需要将命令类放在src/Command目录下，框架会自动发现并注册这些命令。命令类的命名空间需要符合Symfony的规范，比如App\Command\GreetCommand，配置方式和独立使用类似，只是不需要手动注册到Application中。

在Symfony项目中，我们可以通过bin/console入口文件来执行命令，比如执行我们定义的greet命令：

php bin/console greet 张三 --yell

以上就是Symfony Console组件的基本使用方法，通过这些能力，我们可以快速开发出功能完善的PHP命令行工具，满足日常开发、运维等各类场景的需求。

Symfony_Console命令行开发PHP命令行工具参数解析进度条实现