Jak na progress bar v konzolové aplikaci se Symfony

Console v PHP frameworku Symfony je něco jako například Drush pro Drupal nebo WP-CLI pro WordPress. Tedy nástroj pro ovládání webu z příkazového řádku. Hodí se pro spouštění jednorázových operací jako jsou vstupní importy dat, nebo pro periodické spouštění operací v aplikaci pomocí plánovače procesů v systému.

S konzolí samozřejmě pracujete i během vývoje. Pokud se vám líbí všechny ty generátory kódu, vytváření a migrace databází, tak vězte, že velmi snadno si napíšete i vlastní příkaz pro Symfony Console.

V tomto článku si ukážeme vytvoření jednoduché konzolové aplikace v Symfony, která zobrazí průběh práce pomocí progress baru. V další iteraci si ukážeme, jak výstup konzolové aplikace obarvit, a nakonec vyzkoušíme zapojení grafiky místo textového znázornění progress baru. 

Vytvořte si tedy nový projekt na hraní a pustíme se do toho:
symfony new progress

Základní konzolová aplikace v Symfony

Naše vzorová aplikace bude spouštěna příkazem bin/console import. Řekněme, že třeba poslouží pro jednorázový import dat do webu z nějaké jiné databáze. Samotnou operaci zde jenom nasimulujeme, cílem je ukázat si kostru a práci s progress barem.

1. Začněte tím, že do projektu přidáte generátor kódu:
   composer require symfony/maker-bundle –dev
2. Vygenerujte základ konzolové aplikace příkazem
   bin/console make:command
3. Na výzvu, jak se bude příkaz konzolové aplikace jmenovat, zadejte import a potvrďte klávesou Enter.
4. Připravený kód najdete v souboru src/Command/ImportCommand.php. V popisku na začátku si upravte vygenerovaný text.
5. Náš příkaz nebude mít žádné vstupní parametry, takže odeberte obsah metody configure() z vygenerovaného kódu.
6. Místo toho přidejte popisek aplikace. Jádrem příkazu je pak metoda execute(). Do proměnné uložte aktuální čas, definujte si pomyslný počet řádků nutných ke zpracování.
7. Vytvořte nový ProgressBar, určete mu výstupní informace a celkový počet řádků. Nastartujte jej, začněte počítat a v nějaké smyčce spusťte pomyslné zpracování dat. Já jen pro příklad uvádím uspání o několik mikrosekund. V každém průchodu smyčkou aktualizujte posun progress baru. 
8. Po skončení operace ukončete progress bar, spočítejte uplynulý čas a zobrazte výsledné hlášení pod ukazatelem průběhu.

Výsledný kód:

<?php

namespace App\Command;

use Symfony\Component\Console\Attribute\AsCommand;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Helper\ProgressBar;

#[AsCommand(
    name: 'import',
    description: 'Ukázka déle trvající operace s progress barem',
)]

class ImportCommand extends Command

{
    public function __construct()
    {
        parent::__construct();
    }

    protected function configure(): void
    {
        $this
            ->setDescription('Ukázka déle trvající operace s progress barem');
    }

    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        $startTime = microtime(true);
        $totalRows = 123;
        $progressBar = new ProgressBar($output, $totalRows);
        $progressBar->start();
        $processedCount = 0;
        for ($i = 0; $i < $totalRows; $i++) {
           usleep(10000);
           $processedCount++;
           $progressBar->advance();
        }
        $progressBar->finish();
        $endTime = microtime(true);
        $executionTime = $endTime - $startTime;
        $output->writeln("\nImport hotov. Zpracováno záznamů: $processedCount");
        $output->writeln("Délka zpracování: " . round($executionTime, 2) . " sekund.");
        return Command::SUCCESS;
    }
}

Image

Jak na barevný výstup do terminálu

Základní výstup máme, ale Symfony se neomezuje pouze na něj, dovede pracovat s barvami tak, aby zobrazované informace byly přehlednější.

1. Do klauzule use přidejte SymfonyStyle, které řídí právě lepší formátování výstupů ze Symfony do terminálu.
2. Na začátek metody execute() doplňte input/output operace a vypište informační hlášení.
3. Za definici ProgressBaru přidejte nastavení formátu ukazatele spolu se šablonou pro obsah ukazatele v průběhu operace a při zobrazení případných chyb.
4. Původní výstup po skončení operace změňte na přiřazení textů do hlášky o úspěšném průběhu operace a do běžného textového řádku.

<?php

namespace App\Command;

use Symfony\Component\Console\Attribute\AsCommand;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Helper\ProgressBar;
use Symfony\Component\Console\Style\SymfonyStyle;

#[AsCommand(
    name: 'import',
    description: 'Ukázka déle trvající operace s progress barem',
)]

class ImportCommand extends Command
{

    public function __construct()
    {
        parent::__construct();
    }

    protected function configure(): void
    {
        $this
            ->setDescription('Ukázka déle trvající operace s progress barem');
    }

    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        $io = new SymfonyStyle($input, $output);
        $io->title('Zahajuji import studijních programů');
        $startTime = microtime(true);
        $totalRows = 123;
        
        $progressBar = $io->createProgressBar($totalRows);
        $progressBar->setFormat(' [%bar%] %current%/%max% | %percent:3s%% | %elapsed:6s%');
        $progressBar->setBarCharacter('<info>=</info>');
        $progressBar->setEmptyBarCharacter('<error>-</error>');
        $progressBar->setProgressCharacter('<comment>></comment>');
        
        $progressBar->start();
        $processedCount = 0;
        
        for ($i = 0; $i < $totalRows; $i++) {
            usleep(100000);
            $processedCount++;
            $progressBar->advance();
        }
        
        $progressBar->finish();
        $endTime = microtime(true);
        $executionTime = $endTime - $startTime;
        
        $io->newLine(2);
        $io->success("Import hotov. Celkem záznamů: $processedCount");
        $io->text("Čas zpracování: " . round($executionTime, 2) . " sekund.");
        
        return Command::SUCCESS;
    }
}

Image

Grafický ukazatel průběhu práce

Předchozí úprava už je celkem přehledná, barvy nám oddělují zobrazení důležitých informací. Na záběr si ještě ukážeme zobrazení progress baru, který pracuje s grafickým výstupem místo se znakem rovnítka.

Nová úprava zahrnuje pouze změnu v nastavování vlastností po vytvoření progress baru:

$progressBar->setBarWidth(50);
$progressBar->setFormat('<bg=green;fg=white> %current%/%max% [%bar%] %percent:3s%% %elapsed:6s% </>');
$progressBar->setEmptyBarCharacter(' ');
$progressBar->setProgressCharacter('>');
$progressBar->setBarCharacter('<bg=blue> </>');

Image

S výstupy z konzolové aplikace v Symfony si můžeme docela vyhrát a když jsem progress bar použil kdysi poprvé, překvapilo mě, jak snadné je díky Symfony zobrazovat na příkazovém řádku průběh zpracování dat nebo jakékoli jiné déle trvající operace.

Další materiály najdete samozřejmě na stránkách dokumentace. Kromě tohoto klasického průběhového ukazatele má Symfony též Progress Indicator, který využijete ve chvíli, kdy nelze určit délku operace, ale potřebujete ukázat uplynulý čas a dát uživateli najevo, že aplikace stále pracuje.