Симфони Commands Like You Write Controllers - Эцэст нь

Symfony Console компонентын хөгжил нь тогтвортой тэсвэрлэх аялал юм. жилийн турш, хөгжүүлэгчид Command class-ийг нэмэгдүүлэх ритуалтай, үйл ажиллагаа явуулж байна аргаар, сонголт тодорхойлох, тэдний логик дотор байрлуулах арга хэрэгсэл . Энэ нь хүчтэй, deterministic болон verbose байсан. configure() execute() Симфони 5 болон 6-ийн идэвхжүүлэхийн тулд бид Invokable Commands-ийн идэвхжүүлэлтийг үзсэн бөгөөд энэ нь орлого нь контроллеруудтай харьцуулахад боломжийг олгодог. метод нь шинэ эх үүсвэр, боодлын хавтан болж байна Fade эхэлсэн, PHP-ийн атрибутууд гэх мэт хэсэгт өөрчлөгдсөн Гэсэн хэдий ч, нэг зөөлөн тоноглогдсон байна: команданы бүртгэл, үр дүнтэй эх сурвалж хооронд холбох. Бид одоо ч байтугай гарын авлага нь аргументийг олж байна эсвэл харьцуулагдсан янз бүрийн харьцуулахад комплексны конфигурацтай. or relying on complex configurations to map inputs to type variables. __invoke() configure() #[AsCommand] $input->getArgument(‘…’) Symfony 7.4 Бүгдийг өөрчилж байна Арванхоёрдугаар сарын 2025, Symfony 7.4 нь Console компонентын амьдралын чанарын сайжруулах багц танилцуулдаг. Энэ нь Console Commands болон Http Controllers хоорондын хоорондоо үр дүнтэй шилжих болно. Нөхцөл гарын авлага болон deklarative интерактив нь Нөхцөл , CLI хэрэгсэл бичлэхийн тулд энэ хэлбэрийн аюулгүй, expressive байсангүй. Backed Enums Input DTOs #[MapInput] #[Interact] #[Ask] Энэ өргөн хүрээтэй гарын авлагад бид энэ шинэ шинж чанарыг нарийвчлалтай судлах болно. Бид одоогоор буцаж, имплементацийг, баталгаажуулалт, туршилтын талаарх орчин үеийн Symfony 7.4-ийн гайхамшигтай үйл ажиллагаа явуулж болно. Барааны шаардлага, суулгах Код руу суулгах өмнө, таны байгаль орчинд тохиромжтой байх ёстой. Та хэрэгтэй болно: PHP 8.2 буюу түүнээс дээш (PHP 8.4 илүү сайн синтаксийн дэмжлэг хийхэд зөвлөж байна). Composer дэлхий даяар суулгасан. Жишээ нь, шинэ Symfony 7.4 төсөл үүсгэхийн тулд, эсвэл одоогийн нэг нь шинэчлэх хэрэгтэй. Хэрэв та шинэ эхэлж байгаа бол: composer create-project symfony/skeleton:^7.4 my_cli_app cd my_cli_app composer require symfony/console:^7.4 Хэрэв та одоогийн төслийг шинэчлэх байгаа бол, таны Консолын бүрэлдэхүүн хэсэг нь 7.4 хуваалцсан: composer.json { "require": { "php": ">=8.2", "symfony/console": "^7.4", "symfony/framework-bundle": "^7.4", "symfony/runtime": "^7.4" } } Бүртгүүлэх үйл явц: composer update symfony/* Таны хувилбар шалгана уу: php bin/console --version # Output should look like: Symfony 7.4.x (env: dev, debug: true) Native Enum дэмжлэг Эдүүлбэр / The Old Way (Pre-7.4) Previously, handling enumerated values in commands was a manual process. You would accept a string argument, valid it against a list of allowed values manually and then perhaps map it to a PHP Enum usage. // src/Command/LegacyServerCommand.php namespace App\Command; use Symfony\Component\Console\Attribute\AsCommand; use Symfony\Component\Console\Command\Command; use Symfony\Component\Console\Input\InputArgument; use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; #[AsCommand(name: 'app:legacy-server')] class LegacyServerCommand extends Command { protected function configure(): void { $this->addArgument('region', InputArgument::REQUIRED, 'The server region (us, eu)'); } protected function execute(InputInterface $input, OutputInterface $output): int { $region = $input->getArgument('region'); if (!in_array($region, ['us', 'eu'])) { $output->writeln(' Invalid region. '); return Command::FAILURE; } // Logic here... return Command::SUCCESS; } } Энэ нь ажилладаг, гэхдээ энэ нь гүйцэтгэлийн үйл явц руу валидацны логик илрүүлэх бөгөөд төрөл аюулгүй байдалтай байдаг. Симфони 7.4 Way Symfony 7.4 нь Console компонент логик орлогдсон байна. Та одоо орлогдсон орлогдсон болно . Symfony нь автоматаар: ArgumentResolver Backed Enums Input string унших. Энэ нь Enum-ийн дэмжлэг үзүүлэлттэй үнэтэй харьцуулахыг туршиж байна. Үнэгүй сонголт жагсаалтыг жагсаалтын хэзээ ч үнэ цэнэтэй бол тайлбарлагч алдааг явах.Throw a descriptive error if the value is invalid, listing available options. Бидний Enum эхлээд тодорхойлох болно. // src/Enum/ServerRegion.php namespace App\Enum; enum ServerRegion: string { case US = 'us-east-1'; case EU = 'eu-central-1'; case ASIA = 'ap-northeast-1'; } Одоо, орлог нь гайхамшигтай хялбар байна: // src/Command/CreateServerCommand.php namespace App\Command; use App\Enum\ServerRegion; use Symfony\Component\Console\Attribute\AsCommand; use Symfony\Component\Console\Attribute\Argument; // Note: In 7.4 attributes are often simplified use Symfony\Component\Console\Command\Command; use Symfony\Component\Console\Output\OutputInterface; #[AsCommand(name: 'app:create-server', description: 'Creates a server in a specific region.')] class CreateServerCommand extends Command { // The magic happens here: Type-hinting the Enum public function __invoke( OutputInterface $output, #[Argument] ServerRegion $region ): int { $output->writeln(sprintf('Creating server in region: %s', $region->value)); return Command::SUCCESS; } } Үнэлгээгүй үнэтэй орлогдсон орлогдсон орлогдсон: php bin/console app:create-server mars Бүтээгдэхүүн : [ERROR] The value "mars" is not allowed for argument "region". Allowed values are: "us-east-1", "eu-central-1", "ap-northeast-1". Эдгээр баталгаажуулалт нь "нэгүй" байдаг, таны код нь тэр ч байтугай гүйцэтгэхийн өмнө framework-ийн баталгаажуулалттай. Input DTOs нь #[MapInput] Таны орд нэмэгдэж, таны арга хэрэгсэл нь арваннэгдсэн аргументийн болон сонголттай байх болно. Энэ нь "Long Parameter List" код ухаалаг юм. Controllers энэ нь шийдсэн Одоо Console дараах дараах . __invoke #[MapRequestPayload] #[MapInput] Энэ нь тавтай морилно уу, тавтай морилно уу.This allows you to extract your command's input definition into a dedicated Data Transfer Object (DTO). DTO ангилал Хэрэв та Validator компонент суулгасан байгаа бол стандарт баталгаажуулалтын хязгаарлалт ашиглах! // src/Dto/ServerInput.php namespace App\Dto; use App\Enum\ServerRegion; use Symfony\Component\Console\Attribute\Argument; use Symfony\Component\Console\Attribute\Option; use Symfony\Component\Validator\Constraints as Assert; class ServerInput { #[Argument(description: 'The region to deploy to')] public ServerRegion $region; #[Option(description: 'The size of the instance')] #[Assert\Choice(['small', 'medium', 'large'])] public string $size = 'small'; #[AsOption(name: 'dry-run', description: 'Simulate the creation')] public bool $dryRun = false; } Refactored Команд Одоо бид энэ DTO-ийг DTO-ийг ашигладаг. Үйлчилгээ #[MapInput] // src/Command/DeployServerCommand.php namespace App\Command; use App\Dto\ServerInput; use Symfony\Component\Console\Attribute\AsCommand; use Symfony\Component\Console\Attribute\MapInput; use Symfony\Component\Console\Command\Command; use Symfony\Component\Console\Output\OutputInterface; #[AsCommand(name: 'app:deploy-server')] class DeployServerCommand extends Command { public function __invoke( OutputInterface $output, #[MapInput] ServerInput $input ): int { if ($input->dryRun) { $output->writeln(' Dry run enabled. No changes made. '); } $output->writeln(sprintf( 'Deploying %s instance to %s...', $input->size, $input->region->value )); return Command::SUCCESS; } } Хэрэв энэ нь чухал Хязгаарлагдмал: Та ServerInput DTO-ийг зөв хувилбарлагдсан бол бусад үйлчилгээ, эсвэл ч бас хянагчд өөрчилж болно. Үзүүлэлт: Команданы логик аргумент, сонголт тохиргоог тусгаарлагддаг. Validation: Хэрэв та symfony / validator ашиглаж байгаа бол __invocate зовох өмнө DTO-ийг автоматаар validate болно. #[Interact] болон #[Ask] нь Declarative Interaction Интерактив үйл ажиллагаа нь сайн DX-ийн хувьд чухал юм, гэхдээ Метод нь ихэвчлэн хоёр дахь орлогдсон гэж мэдэгддэг бөгөөд энэ нь анхны орлогдсон орлогдсон орлогдсон юм. Symfony 7.4 нь энэ нь deklaratively ажиллуулахын тулд атрибутуудыг танилцуулдаг. interact() Ажлын #[Ask] атрибут Хязгаарлагдмал аргумент хэрэглэгчдэд зориулж байх ёстой хялбар тохиолдолд . #[Ask] // src/Command/HelloCommand.php namespace App\Command; use Symfony\Component\Console\Attribute\AsCommand; use Symfony\Component\Console\Attribute\Argument; use Symfony\Component\Console\Attribute\Ask; // New in 7.4 use Symfony\Component\Console\Command\Command; use Symfony\Component\Console\Output\OutputInterface; #[AsCommand(name: 'app:hello')] class HelloCommand extends Command { public function __invoke( OutputInterface $output, #[Argument, Ask(question: "What is your name?")] string $name ): int { $output->writeln("Hello, $name!"); return Command::SUCCESS; } } Хэрэв хэрэглэгчийн , Командууд нь хязгаарлагддаг, хайж болно • Хэрэв та Энэ нь хурдасгаж байна. php bin/console app:hello Өөрийн нэр юу вэ? » php bin/console app:hello World Энэ #[Interact] онцлог Комплекс интеракци (жишээ нь, өмнөх хариу дээр суурилсан динамик асуултууд), Та одоо ямар ч арга нь интеракцийн менежер гэж тэмдэглэх болно. Нөхцөл Автомат InputInterface StyleInterface // src/Command/WizardCommand.php namespace App\Command; use Symfony\Component\Console\Attribute\AsCommand; use Symfony\Component\Console\Attribute\Interact; use Symfony\Component\Console\Command\Command; use Symfony\Component\Console\Input\InputArgument; use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; use Symfony\Component\Console\Style\SymfonyStyle; #[AsCommand(name: 'app:wizard')] class WizardCommand extends Command { protected function configure(): void { $this->addArgument('password', InputArgument::REQUIRED); } // This method is called automatically before __invoke if arguments are missing #[Interact] public function promptForPassword(InputInterface $input, SymfonyStyle $io): void { if (null === $input->getArgument('password')) { $password = $io->askHidden('Please enter your API password'); $input->setArgument('password', $password); } } public function __invoke(OutputInterface $output, string $password): int { $output->writeln('Password received (hashed): ' . md5($password)); return Command::SUCCESS; } } Тавтай морилно уу Symfony 7.4 нь Эдгээр шинэ ач холбогдол нь зөөлөн ажилладаг. DTOs эсвэл Enums ашиглан туршилтын орд нь тусгай тохиргоог шаарддаггүй. CommandTester Судалгааны Case Бид туршиж болно Үүнээс өмнө бид үүсгэдэг. DeployServerCommand // tests/Command/DeployServerCommandTest.php namespace App\Tests\Command; use Symfony\Bundle\FrameworkBundle\Console\Application; use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase; use Symfony\Component\Console\Tester\CommandTester; class DeployServerCommandTest extends KernelTestCase { public function testExecuteWithDto(): void { $kernel = self::bootKernel(); $application = new Application($kernel); $command = $application->find('app:deploy-server'); $commandTester = new CommandTester($command); $commandTester->execute([ 'region' => 'us-east-1', // Passing string, automatically converted to Enum '--size' => 'large', '--dry-run' => true, ]); $commandTester->assertCommandIsSuccessful(); $output = $commandTester->getDisplay(); $this->assertStringContainsString('Dry run enabled', $output); $this->assertStringContainsString('Deploying large instance to us-east-1', $output); } public function testInvalidEnumThrowsError(): void { $kernel = self::bootKernel(); $application = new Application($kernel); $command = $application->find('app:deploy-server'); $commandTester = new CommandTester($command); // We expect a runtime exception or validation error depending on configuration // In Console context, this usually results in a status code 1 and error output $this->expectException(\Throwable::class); // Or inspect status code: // $exitCode = $commandTester->execute(['region' => 'mars']); // $this->assertNotSame(0, $exitCode); $commandTester->execute([ 'region' => 'mars', ]); } } Таны тест хийх: php bin/phpunit tests/Command/DeployServerCommandTest.php Real-World Сценарий: Complex Report Generator Бид бүх шинж чанарыг нэгтгэхийн тулд - Нөхцөл Нөхцөл — зөөлөн, мэргэжлийн түвшний орлогдсон. Финансийн өгөгдлийг үүсгэхийн тулд орлогдсон. Enums DTOs Attributes Эмэгтэйчүүд namespace App\Enum; enum ReportFormat: string { case PDF = 'pdf'; case CSV = 'csv'; case JSON = 'json'; } enum ReportPeriod: string { case DAILY = 'daily'; case WEEKLY = 'weekly'; case MONTHLY = 'monthly'; } Ажлын DTO namespace App\Dto; use App\Enum\ReportFormat; use App\Enum\ReportPeriod; use Symfony\Component\Console\Attribute\Argument; use Symfony\Component\Console\Attribute\Option; use Symfony\Component\Console\Attribute\Ask; class ReportInput { #[Argument(description: 'Type of report')] #[Ask('What type of report would you like to generate?')] public string $reportType; #[Option] public ReportPeriod $period = ReportPeriod::WEEKLY; #[Option] public ReportFormat $format = ReportFormat::PDF; #[AsOption(name: 'email', description: 'Email to send report to')] public ?string $recipientEmail = null; } Үйлчилгээ Үнэндээ, таны логик нь үйл ажиллагаа, үйл ажиллагаа биш юм. namespace App\Service; use App\Dto\ReportInput; class ReportGenerator { public function generate(ReportInput $input): void { // ... generation logic } } Эдүүлбэр namespace App\Command; use App\Dto\ReportInput; use App\Service\ReportGenerator; use Symfony\Component\Console\Attribute\AsCommand; use Symfony\Component\Console\Attribute\Interact; use Symfony\Component\Console\Attribute\MapInput; use Symfony\Component\Console\Command\Command; use Symfony\Component\Console\Output\OutputInterface; use Symfony\Component\Console\Style\SymfonyStyle; #[AsCommand(name: 'app:report:generate')] class GenerateReportCommand extends Command { public function __construct( private ReportGenerator $generator ) { parent::__construct(); } #[Interact] public function interactRecipient(InputInterface $input, SymfonyStyle $io): void { // Only ask for email if not provided and format is PDF (business rule) // Accessing raw input here since mapping happens later if (null === $input->getOption('email') && 'pdf' === $input->getOption('format')) { $email = $io->ask('Enter recipient email for the PDF'); $input->setOption('email', $email); } } public function __invoke( OutputInterface $output, #[MapInput] ReportInput $input ): int { $output->writeln("Starting {$input->period->value} report generation..."); $this->generator->generate($input); $output->writeln("Report generated in {$input->format->value} format."); if ($input->recipientEmail) { $output->writeln("Sent to: {$input->recipientEmail}"); } return Command::SUCCESS; } } Эдгээр жишээ нь Symfony 7.4-ийн хүч чадал харуулдаг: Асуулт тусгаарлагч: ReportInput DTO нь өгөгдлийн бүтэцтэй ажиллуулдаг. Service нь логиктэй ажиллуулдаг. Command нь CLI интерфэйстэй ажиллуулдаг. Контекст мэддэг интерактив: #[Интерактив] арга нь динамик асуултууд (PDF-ийг сонгож байгаа бол зөвхөн цахим илгээх) боломжийг олгодог. Тип аюулгүй байдал: Бид $форматын pdf эсвэл csv юм бол бид гарын авлагагүй. Enum casting энэ баталгаажуулдаг. Баримтлал Symfony 7.4 нь консолын бүрэлдэхүүн хэсэг нь чухал ач холбогдолтой ач холбогдолтой юм. Ажлын ач холбогдол, DTO-ийг хүлээн зөвшөөрч, консолын орлого нь орчин үеийн хэрэглээнд анхны ангилалтай, HTTP Controllers-ийн адил хөгжүүлэгч туршлага (DX) хүлээн зөвшөөрч байна. Key Takeaways: Ангиллахын тулд #[MapInput] болон Enums-ийг ашиглахын тулд Symfony-ийн өгөгдлийн гидравлик, баталгаажуулалт хийх боломжийг олгодог. Зөвлөгөөг цэвэршүүлэх: Аргументийн урт жагсаалт DTOs руу дамжуулах. Декларатив интеракцийг хамарна уу: #[Ask] нь хялбар санал болгож, #[Interact] нь барааны ангиллын логик хамарна. Эдгээр хувилбарууд боодлын хавтан багасгах, туршилтын чадварыг нэмэгдүүлэх, кодг унших илүү хялбар болгох. Хэрэв та Symfony 7.4-ийг шинэчлэгдсэнгүй бол Console-ийн сайжруулсан бүрэлдэхүүн хэсэг нь энэ нь маш их үр дүнтэй шалтгаан юм. Бид тав тухтай Та өөрийн CLI хэрэгслүүд нь шинэчлэхэд зориулсан байна уу? Таны хамгийн сүүлийн үеийн үйл явцыг ашиглан шинэчлэхэд эхэлнэ үү Таны туршлагатай хуваалцах. #[MapInput] Хэрэв та энэ гарын авлага нь тусалдаг уу, эсвэл зарим нэг асуултуудтай бол бидэнтэй холбоо барина уу! [LinkedIn] ). Symfony-ийн байгаль орчинд дэлгэрэнгүй гүнзгий зайлсхийхын тулд бюллетень дээр бүртгүүлэх. https://www.linkedin.com/in/matthew-mochalkin/ https://www.linkedin.com/in/matthew-mochalkin/ Happy Кодекс