Improve Command (#5878)

Author: huangdijia

src/Command.php

@@ -11,20 +11,13 @@
  */
 namespace Hyperf\Command;
 
-use Hyperf\Contract\Arrayable;
 use Hyperf\Coroutine\Coroutine;
-use Hyperf\Stringable\Str;
 use Psr\EventDispatcher\EventDispatcherInterface;
 use Swoole\ExitException;
 use Symfony\Component\Console\Command\Command as SymfonyCommand;
-use Symfony\Component\Console\Formatter\OutputFormatterStyle;
-use Symfony\Component\Console\Helper\Table;
-use Symfony\Component\Console\Helper\TableStyle;
 use Symfony\Component\Console\Input\ArrayInput;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
-use Symfony\Component\Console\Question\ChoiceQuestion;
-use Symfony\Component\Console\Question\Question;
 use Symfony\Component\Console\Style\SymfonyStyle;
 use Throwable;
 
@@ -36,52 +29,39 @@
 abstract class Command extends SymfonyCommand
 {
     use DisableEventDispatcher;
+    use Concerns\InteractsWithIO;
+    use Concerns\HasParameters;
 
     /**
      * The name of the command.
      */
     protected ?string $name = null;
 
-    protected string $description = '';
-
-    protected ?InputInterface $input = null;
-
     /**
-     * @var null|SymfonyStyle
+     * The description of the command.
      */
-    protected ?OutputInterface $output = null;
-
-    /**
-     * The default verbosity of output commands.
-     */
-    protected int $verbosity = OutputInterface::VERBOSITY_NORMAL;
+    protected string $description = '';
 
     /**
      * Execution in a coroutine environment.
      */
     protected bool $coroutine = true;
 
+    /**
+     * The eventDispatcher.
+     */
     protected ?EventDispatcherInterface $eventDispatcher = null;
 
+    /**
+     * The hookFlags of the command.
+     */
     protected int $hookFlags = -1;
 
     /**
      * The name and signature of the command.
      */
     protected ?string $signature = null;
 
-    /**
-     * The mapping between human-readable verbosity levels and Symfony's OutputInterface.
-     */
-    protected array $verbosityMap
-        = [
-            'v' => OutputInterface::VERBOSITY_VERBOSE,
-            'vv' => OutputInterface::VERBOSITY_VERY_VERBOSE,
-            'vvv' => OutputInterface::VERBOSITY_DEBUG,
-            'quiet' => OutputInterface::VERBOSITY_QUIET,
-            'normal' => OutputInterface::VERBOSITY_NORMAL,
-        ];
-
     /**
      * The exit code of the command.
      */
@@ -101,208 +81,25 @@ public function __construct(string $name = null)
             parent::__construct($this->name);
         }
 
-        ! empty($this->description) && $this->setDescription($this->description);
-
         $this->addDisableDispatcherOption();
-    }
-
-    /**
-     * Run the console command.
-     */
-    public function run(InputInterface $input, OutputInterface $output): int
-    {
-        $this->output = new SymfonyStyle($input, $output);
-
-        return parent::run($this->input = $input, $this->output);
-    }
-
-    /**
-     * Confirm a question with the user.
-     */
-    public function confirm(string $question, bool $default = false): bool
-    {
-        return $this->output->confirm($question, $default);
-    }
-
-    /**
-     * Prompt the user for input.
-     */
-    public function ask(string $question, string $default = null)
-    {
-        return $this->output->ask($question, $default);
-    }
-
-    /**
-     * Prompt the user for input with auto-completion.
-     *
-     * @param null|bool|float|int|string $default
-     */
-    public function anticipate(string $question, array $choices, $default = null)
-    {
-        return $this->askWithCompletion($question, $choices, $default);
-    }
-
-    /**
-     * Prompt the user for input with auto-completion.
-     *
-     * @param null|bool|float|int|string $default
-     */
-    public function askWithCompletion(string $question, array $choices, $default = null)
-    {
-        $question = new Question($question, $default);
-
-        $question->setAutocompleterValues($choices);
-
-        return $this->output->askQuestion($question);
-    }
-
-    /**
-     * Prompt the user for input but hide the answer from the console.
-     */
-    public function secret(string $question, bool $fallback = true)
-    {
-        $question = new Question($question);
-
-        $question->setHidden(true)->setHiddenFallback($fallback);
-
-        return $this->output->askQuestion($question);
-    }
-
-    /**
-     * Give the user a multiple choice from an array of answers.
-     * @param mixed $default
-     */
-    public function choiceMultiple(
-        string $question,
-        array $choices,
-        $default = null,
-        ?int $attempts = null
-    ): array {
-        $question = new ChoiceQuestion($question, $choices, $default);
-
-        $question->setMaxAttempts($attempts)->setMultiselect(true);
-
-        return $this->output->askQuestion($question);
-    }
-
-    /**
-     * Give the user a single choice from an array of answers.
-     *
-     * @param mixed $default
-     */
-    public function choice(
-        string $question,
-        array $choices,
-        $default = null,
-        ?int $attempts = null
-    ): mixed {
-        return $this->choiceMultiple($question, $choices, $default, $attempts)[0];
-    }
-
-    /**
-     * Format input to textual table.
-     */
-    public function table(array $headers, array|Arrayable $rows, TableStyle|string $tableStyle = 'default', array $columnStyles = []): void
-    {
-        $table = new Table($this->output);
 
-        if ($rows instanceof Arrayable) {
-            $rows = $rows->toArray();
+        if (! empty($this->description)) {
+            $this->setDescription($this->description);
         }
 
-        $table->setHeaders($headers)->setRows($rows)->setStyle($tableStyle);
-
-        foreach ($columnStyles as $columnIndex => $columnStyle) {
-            $table->setColumnStyle($columnIndex, $columnStyle);
+        if (! isset($this->signature)) {
+            $this->specifyParameters();
         }
-
-        $table->render();
-    }
-
-    /**
-     * Write a string as standard output.
-     *
-     * @param mixed $string
-     * @param null|mixed $style
-     * @param null|mixed $verbosity
-     */
-    public function line($string, $style = null, $verbosity = null)
-    {
-        $styled = $style ? "<{$style}>{$string}</{$style}>" : $string;
-        $this->output->writeln($styled, $this->parseVerbosity($verbosity));
-    }
-
-    /**
-     * Write a string as information output.
-     *
-     * @param mixed $string
-     * @param null|mixed $verbosity
-     */
-    public function info($string, $verbosity = null)
-    {
-        $this->line($string, 'info', $verbosity);
-    }
-
-    /**
-     * Write a string as comment output.
-     *
-     * @param mixed $string
-     * @param null|mixed $verbosity
-     */
-    public function comment($string, $verbosity = null)
-    {
-        $this->line($string, 'comment', $verbosity);
-    }
-
-    /**
-     * Write a string as question output.
-     *
-     * @param mixed $string
-     * @param null|mixed $verbosity
-     */
-    public function question($string, $verbosity = null)
-    {
-        $this->line($string, 'question', $verbosity);
     }
 
     /**
-     * Write a string as error output.
-     *
-     * @param mixed $string
-     * @param null|mixed $verbosity
-     */
-    public function error($string, $verbosity = null)
-    {
-        $this->line($string, 'error', $verbosity);
-    }
-
-    /**
-     * Write a string as warning output.
-     *
-     * @param mixed $string
-     * @param null|mixed $verbosity
+     * Run the console command.
      */
-    public function warn($string, $verbosity = null)
+    public function run(InputInterface $input, OutputInterface $output): int
     {
-        if (! $this->output->getFormatter()->hasStyle('warning')) {
-            $style = new OutputFormatterStyle('yellow');
-            $this->output->getFormatter()->setStyle('warning', $style);
-        }
-        $this->line($string, 'warning', $verbosity);
-    }
+        $this->output = new SymfonyStyle($input, $output);
 
-    /**
-     * Write a string in an alert box.
-     *
-     * @param mixed $string
-     */
-    public function alert($string)
-    {
-        $length = Str::length(strip_tags($string)) + 12;
-        $this->comment(str_repeat('*', $length));
-        $this->comment('*     ' . $string . '     *');
-        $this->comment(str_repeat('*', $length));
-        $this->output->newLine();
+        return parent::run($this->input = $input, $this->output);
     }
 
     /**
@@ -315,36 +112,6 @@ public function call(string $command, array $arguments = []): int
         return $this->getApplication()->find($command)->run($this->createInputFromArguments($arguments), $this->output);
     }
 
-    /**
-     * Handle the current command.
-     */
-    abstract public function handle();
-
-    /**
-     * Set the verbosity level.
-     *
-     * @param mixed $level
-     */
-    protected function setVerbosity($level)
-    {
-        $this->verbosity = $this->parseVerbosity($level);
-    }
-
-    /**
-     * Get the verbosity level in terms of Symfony's OutputInterface level.
-     *
-     * @param null|mixed $level
-     */
-    protected function parseVerbosity($level = null): int
-    {
-        if (isset($this->verbosityMap[$level])) {
-            $level = $this->verbosityMap[$level];
-        } elseif (! is_int($level)) {
-            $level = $this->verbosity;
-        }
-        return $level;
-    }
-
     /**
      * Create an input instance from the given arguments.
      */
@@ -373,27 +140,6 @@ protected function context(): array
         })->all();
     }
 
-    /**
-     * Specify the arguments and options on the command.
-     */
-    protected function specifyParameters(): void
-    {
-        // We will loop through all the arguments and options for the command and
-        // set them all on the base command instance. This specifies what can get
-        // past into these commands as "parameters" to control the execution.
-        if (method_exists($this, 'getArguments')) {
-            foreach ($this->getArguments() ?? [] as $arguments) {
-                call_user_func_array([$this, 'addArgument'], $arguments);
-            }
-        }
-
-        if (method_exists($this, 'getOptions')) {
-            foreach ($this->getOptions() ?? [] as $options) {
-                call_user_func_array([$this, 'addOption'], $options);
-            }
-        }
-    }
-
     /**
      * Configure the console command using a fluent definition.
      */
@@ -413,19 +159,17 @@ protected function configureUsingFluentDefinition()
     protected function configure()
     {
         parent::configure();
-        if (! isset($this->signature)) {
-            $this->specifyParameters();
-        }
     }
 
     protected function execute(InputInterface $input, OutputInterface $output)
     {
         $this->disableDispatcher($input);
+        $method = method_exists($this, 'handle') ? 'handle' : '__invoke';
 
-        $callback = function () {
+        $callback = function () use ($method) {
             try {
                 $this->eventDispatcher?->dispatch(new Event\BeforeHandle($this));
-                $this->handle();
+                $this->{$method}();
                 $this->eventDispatcher?->dispatch(new Event\AfterHandle($this));
             } catch (Throwable $exception) {
                 if (class_exists(ExitException::class) && $exception instanceof ExitException) {