如何全局取消命令触发事件分发

[huangdijia]

有留意的小伙伴，不难发现 Hyperf 的命令默认会有一个 option

Hyperf Version	Command Option
2.x	--enable-event-dispatcher
3.x	--disable-event-dispatcher

2.x 文档上有说明

注意：在运行命令时，默认不会触发事件分发，可通过添加 --enable-event-dispatcher 参数来开启。

3.x 之后默认开启，但可通过 --disable-event-dispatcher 来禁用，没错，跟 2.x 刚好相反。

默认开启肯定是有它的道理，这里不讨论。但是，不得不说因为这个调整，踩了一些坑，于是我就想怎么可以取消（不想每次都敲 --disable-event-dispatcher）。

@limingxinleo 很快就给出了方案（增加一个 Hyperf\Command\NullDisableEventDispatcher），在需要的 Command 里面 use 一下就可以了，例如：

class FooCommand
{
    use \Hyperf\Command\NullDisableEventDispatcher;

    public function handle() {}
}

但是问题又来了，Hyperf 自带的命令呢？查看路由、生成模型等等，我改不了源码怎么办？

最后想到了 class_map，改写 Hyperf\Command\DisableEventDispatcher 就好了。

// app/Kernel/ClassMap/DisableEventDispatcher.php

namespace Hyperf\Command;

use Hyperf\Utils\ApplicationContext;
use Psr\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;

trait DisableEventDispatcher
{
    public function addDisableDispatcherOption(): void
    {
        $this->addOption('enable-event-dispatcher', null, InputOption::VALUE_NONE, 'Whether enable event dispatcher.');
    }

    public function disableDispatcher(InputInterface $input)
    {
        if ($input->getOption('enable-event-dispatcher')) {
            if (! ApplicationContext::hasContainer()) {
                return;
            }

            $container = ApplicationContext::getContainer();
            if (! $container->has(EventDispatcherInterface::class)) {
                return;
            }

            $dispatcher = $container->get(EventDispatcherInterface::class);

            $this->eventDispatcher = $dispatcher instanceof EventDispatcherInterface ? $dispatcher : null;
        }
    }
}

然后配字 class_map

// config/autoload/annotations.php

return [
    'scan' => [
        'class_map' => [
            Hyperf\Command\DisableEventDispatcher::class => BASE_PATH . '/app/Kernel/ClassMap/DisableEventDispatcher.php',
        ]
    ]
];

看效果：

$ hyperf describe:routes -h

Description:
  Describe the routes information.

Usage:
  describe:routes [options]

Options:
  -p, --path[=PATH]              Get the detail of the specified route information by path
  -S, --server[=SERVER]          Which server you want to describe routes. [default: "http"]
      --enable-event-dispatcher  Whether enable event dispatcher.
  -h, --help                     Display help for the given command. When no command is given display help for the list command
  -q, --quiet                    Do not output any message
  -V, --version                  Display this application version
      --ansi|--no-ansi           Force (or disable --no-ansi) ANSI output
  -n, --no-interaction           Do not ask any interactive question
  -v|vv|vvv, --verbose           Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug