命令行模式（Command）

目的

为了封装调用和解耦。

我们有一个调用程序和一个接收器。 这种模式使用「命令行」将方法调用委托给接收器并且呈现相同的「执行」方法。 因此，调用程序只知道调用「执行」去处理客户端的命令。接收器会从调用程序中分离出来。

这个模式的另一面是取消方法的 execute()，也就是 undo() 。命令行也可以通过最小量的复制粘贴和依赖组合（不是继承）被聚合，从而组合成更复杂的命令集。

例子

  • 文本编辑器：所有事件都是可以被解除、堆放，保存的命令。
  • Symfony2：SF2 命令可以从 CLI 运行，它的建立只需考虑到命令行模式。
  • 大型 CLI 工具使用子程序来分发不同的任务并将它们封装在「模型」中，每个模块都可以通过命令行模式实现（例如：vagrant）。

UML 图

file

代码

你也可以在GitHub上查看 源码

CommandInterface.php

  2. <?php
  4. namespace DesignPatterns\Behavioral\Command;
  6. interface CommandInterface
  7. {
  8.     /**
  9.      * 这是在命令行模式中很重要的方法，
  10.      * 这个接收者会被载入构造器
  11.      */
  12.     public function execute();
  13. }

HelloCommand.php

  2. <?php
  4. namespace DesignPatterns\Behavioral\Command;
  6. /**
  7.  * 这个具体命令，在接收器上调用 "print" ，
  8.  *  但是外部调用者只知道，这个是否可以执行。
  9.  */
  10. class HelloCommand implements CommandInterface
  11. {
  12.     /**
  13.      * @var Receiver
  14.      */
  15.     private $output;
  17.     /**
  18.      * 每个具体的命令都来自于不同的接收者。
  19.      * 这个可以是一个或者多个接收者，但是参数里必须是可以被执行的命令。
  20.      *
  21.      * @param Receiver $console
  22.      */
  23.     public function __construct(Receiver $console)
  24.     {
  25.         $this->output = $console;
  26.     }
  28.     /**
  29.      * 执行和输出 "Hello World".
  30.      */
  31.     public function execute()
  32.     {
  33.         // 有时候，这里没有接收者，并且这个命令执行所有工作。
  34.         $this->output->write('Hello World');
  35.     }
  36. }

Receiver.php

  2. <?php
  4. namespace DesignPatterns\Behavioral\Command;
  6. /**
  7.  * 接收方是特定的服务，有自己的 contract ，只能是具体的实例。
  8.  */
  9. class Receiver
  10. {
  11.     /**
  12.      * @var bool
  13.      */
  14.     private $enableDate = false;
  16.     /**
  17.      * @var string[]
  18.      */
  19.     private $output = [];
  21.     /**
  22.      * @param string $str
  23.      */
  24.     public function write(string $str)
  25.     {
  26.         if ($this->enableDate) {
  27.             $str .= ' ['.date('Y-m-d').']';
  28.         }
  30.         $this->output[] = $str;
  31.     }
  33.     public function getOutput(): string
  34.     {
  35.         return join("\n", $this->output);
  36.     }
  38.     /**
  39.      * 可以显示消息的时间
  40.      */
  41.     public function enableDate()
  42.     {
  43.         $this->enableDate = true;
  44.     }
  46.     /**
  47.      * 禁止显示消息的时间
  48.      */
  49.     public function disableDate()
  50.     {
  51.         $this->enableDate = false;
  52.     }
  53. }

Invoker.php

  2. <?php
  4. namespace DesignPatterns\Behavioral\Command;
  6. /**
  7.  *调用者使用这种命令。
  8.  * 比例 : 一个在 SF2 中的应用
  9.  */
  10. class Invoker
  11. {
  12.     /**
  13.      * @var CommandInterface
  14.      */
  15.     private $command;
  17.     /**
  18.      * 在这种调用者中，我们发现，订阅命令也是这种方法
  19.      * 还包括：堆栈、列表、集合等等
  20.      *
  21.      * @param CommandInterface $cmd
  22.      */
  23.     public function setCommand(CommandInterface $cmd)
  24.     {
  25.         $this->command = $cmd;
  26.     }
  28.     /**
  29.      * 执行这个命令；
  30.      * 调用者也是用这个命令。
  31.      */
  32.     public function run()
  33.     {
  34.         $this->command->execute();
  35.     }
  36. }

测试

Tests/CommandTest.php

  2. <?php
  4. namespace DesignPatterns\Behavioral\Command\Tests;
  6. use DesignPatterns\Behavioral\Command\HelloCommand;
  7. use DesignPatterns\Behavioral\Command\Invoker;
  8. use DesignPatterns\Behavioral\Command\Receiver;
  9. use PHPUnit\Framework\TestCase;
  11. class CommandTest extends TestCase
  12. {
  13.     public function testInvocation()
  14.     {
  15.         $invoker = new Invoker();
  16.         $receiver = new Receiver();
  18.         $invoker->setCommand(new HelloCommand($receiver));
  19.         $invoker->run();
  20.         $this->assertEquals('Hello World', $receiver->getOutput());
  21.     }
  22. }