我有一个命令行应用程序,目前为止它使用Symfony依赖项注入组件。现在我发现我想添加命令行选项并改进输出的格式,而Symfony控制台组件似乎是一个很好的选择。
然而,我无法理解如何让我的Symfony控制台命令类接收容器对象。
我发现的文档使用了ContainerWareCommand类,但这是来自FrameworkBundle的,这似乎给纯CLI应用程序增加了大量开销,因为它需要更多的bundle,如路由、http、配置、缓存等,这些都与我无关。
(现有的SO问题是如何向Symfony控制台命令注入依赖项?顺便说一句,还假设使用框架包。)
我在这里用一个基本命令创建了一个测试存储库,说明了这个问题:https://github.com/joachim-n/console-with-di
自2018和Symfony 3.4 DI功能以来,您可以将命令用作服务。
感谢@TravisCarden,您可以在这里找到工作演示
简言之:
<?php
# app/Kernel.php
namespace App;
use Symfony\Component\Config\Loader\LoaderInterface;
use Symfony\Component\Console\Application;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
use Symfony\Component\DependencyInjection\Reference;
use Symfony\Component\HttpKernel\Kernel;
use Symfony\Component\DependencyInjection\ContainerBuilder;
final class AppKernel extends Kernel
{
public function registerBundles(): array
{
return [];
}
public function registerContainerConfiguration(LoaderInterface $loader): void
{
$loader->load(__DIR__.'/../config/services.yml');
}
protected function build(ContainerBuilder $containerBuilder): void
{
$containerBuilder->addCompilerPass($this->createCollectingCompilerPass());
}
private function createCollectingCompilerPass(): CompilerPassInterface
{
return new class implements CompilerPassInterface
{
public function process(ContainerBuilder $containerBuilder)
{
$applicationDefinition = $containerBuilder->findDefinition(Application::class);
foreach ($containerBuilder->getDefinitions() as $definition) {
if (! is_a($definition->getClass(), Command::class, true)) {
continue;
}
$applicationDefinition->addMethodCall('add', [new Reference($definition->getClass())]);
}
}
};
}
}
# config/services.yml
services:
_defaults:
autowire: true
App\:
resource: '../app'
Symfony\Component\Console\Application:
public: true
# index.php
require_once __DIR__ . '/vendor/autoload.php';
use Symfony\Component\Console\Application;
$kernel = new AppKernel;
$kernel->boot();
$container = $kernel->getContainer();
$application = $container->get(Application::class)
$application->run();
php index.php
如果你对更详细的解释感兴趣,我写了一篇文章为什么你应该结合Symfony控制台和依赖注入。
是的,不需要整个框架。在你的例子中,首先你需要创建一种入口脚本。类似的东西:
<?php
require 'just/set/your/own/path/to/vendor/autoload.php';
use Symfony\Component\Console\Application;
use Symfony\Component\DependencyInjection\ContainerBuilder;
$container = new ContainerBuilder();
$container
->register('your_console_command', 'Acme\Command\YourConsoleCommand')
->addMethodCall('setContainer', [new Reference('service_container')]);
$container->compile();
$application = new Application();
$application->add($container->get('your_console_command'));
$application->run();
在本例中,我们创建容器,然后将命令注册为服务,向命令添加依赖项(在本例中是整个容器,但显然可以创建另一个依赖项并将其注入),然后编译容器。然后我们创建应用程序,将命令实例添加到应用程序并运行它。
当然,您可以将容器的所有配置保持在yaml
或xml
中,甚至使用PHP格式。