【译】如何使用PHP快速构建命令行应用程序

原文地址： How to build a Command Line Application using PHP?

如果你是一名Web开发工程师，那么你一定使用PHP开发过很多Web应用程序。但是你知道如何使用PHP快速构建一个命令行应用程序(工具)吗?下面我将向您展示如何使用PHP和一个著名的的Composer扩展包--Symphony/Console构建一个命令行应用。

Symphony/Console是一个使用Composer管理的PHP扩展包，它简化了创建一个漂亮的、可测试的PHP命令行应用的过程，它提供了开箱即用的诸如(可选/必选的)参数规范和选项规范(使用-符号)等功能。那么，我们来一起开始构建我们的应用。

按照惯例，我们将构建一个“Hello World”的控制台应用程序，但是要稍微修改一下它，让它支持自定义问候语（代替Hello）,并且可以随意的去问候一个人（代替world)。

这个Hello World应用程序将会有如下功能：

1. 为我们提供一个单独的greet(问候)命令，我们将使用它来与应用程序交互。
2. greet可以接受一个可选的参数(name)来打印出一个被问候的人(默认是World)。
3. greet可以接受一个选项(--say)来更改问候语(默认是Hello)。
4. 如果我们么样给定参数或者选项，程序将默认输出一个Hello World消息。

如何使用PHP构建命令行应用程序

• 为我们的项目创建新的目录并cd进入它：

  mkdir hello-world-app && cd hello-world-app

• 使用Composer将控制台组件引入我们项目

  composer require symfony/console

• 然后为你的应用程序创建一个入口点，PHP扩展不是必需的，因为我们要使这个文件成为可执行文件，并在文件本身中指定环境。

  touch HelloWorld
  chmod +X HelloWorld 

• 将下面的代码添加到HelloWorld文件中（后面我将为每一行做注解），并在你的终端中执行HelloWorld这个应用程序.

  #!/usr/bin/env php
  register('greet')
        ->addArgument('name', InputArgument::OPTIONAL, 'Name of the person')
        ->addOption('say', null, InputOption::VALUE_REQUIRED, 'Custom greeting')
        ->setCode(function (InputInterface $input, OutputInterface $output) {
                
          $name = $input->getArgument('name');
          $greeting = $input->getOption('say');
  
          if (!empty($name) && !empty($greeting)) {
              return $output->writeln("$greeting $name!");
          } else if (!empty($name)) {
              return $output->writeln("Hello $name!");
          } else if (!empty($greeting)) {
              return $output->writeln("$greeting World!");
          } else {
              return $output->writeln("Hello World!");
          }
        })
        ->getApplication()
        ->run();

看，就这样，你拥有了自己的HelloWorld控制台程序

当没有指定命令时，HelloWorld默认输出一屏信息提示

Symfony Console组件给我们提供的应用程序有几个开箱可用的选项的和命令，比如help，list和--version

解释这个神奇的文件内容

OK，让我们来看看我们的HelloWorld文件中的代码。

1. 我们引入autoload.php以使用由composer提供的自动加载以及控制台组件提供的各功能。

InputInterface和OutputInterface将使应用程序的输入和输出功能变得简单，InputArgument和InputOption将帮助我们处理传递给我们HelloWorld应用程序的选项和参数。

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

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

1. symphony/console通过名称实例化一个新的应用程序HelloWorld (v1.0.0) ,并注册我们的greet命令。

   (new Application('Hello World', '1.0.0'))
       ->register('greet')
   

2. 我们添加一个可选的name参数（addArgument()），并提供参数的简短描述。然后,我们使用这个addOption()方法添加一个say选项。请注意，选项始终是可选的，但您可以指定要传递的值，也可以仅仅将其用作指boolean标识。

   ->addArgument('name', InputArgument::OPTIONAL, 'Name of the person') 
   ->addOption('say', null, InputOption::VALUE_REQUIRED, 'Custom greeting')

3. setCode()方法中的代码会包含我们应用程序的主逻辑，它会根据传递的参数和选项打印一个问候语到终端。我们监听$input对象，使用getArgument()和getOption()辅助方法获取传递给greet的选项和参数，然后，我们只需要检查传递了哪些参数或者选项，并相应的（使用$output对象)向控制台输出打印问候语。这个writeln()方法可以根据标签格式化文本，比如输出不同颜色的info,error和warning。

   ->setCode(function (InputInterface $input, OutputInterface $output) {
       $name = $input->getArgument('name');
       $greeting = $input->getOption('say');
   
       if (!empty($name) && !empty($greeting)) {
           return $output->writeln("$greeting $name!");
       } else if (!empty($name)) {
           return $output->writeln("Hello $name!");
       } else if (!empty($greeting)) {
           return $output->writeln("$greeting World!");
       } else {
           return $output->writeln("Hello World!");
       }
     })

4. 最后我们引导应用程序并调用他的方法，以便他做好随时接收和处理greet命令。

   ->getApplication()
   ->run();

现在让我们在实例中看看我们HelloWorld程序

1. greet不传递任何参数和选项

1. greet有一个可选的name参数

1. greet使用say选项自定义问候语

1. 最后，greet自定义问候语和问候人

---

关于作者

程序开发人员，不拘泥于语言与技术，目前主要从事PHP和前端开发，使用Laravel和VueJs。合适和够用是永不停息的追求。

个人网站：https://www.linganmin.cn

译者注：本文中的部分链接和图片地址已更换为国内地址，如有翻译错误请多指正。
Happy Coding！