Symfony：如何将依赖注入到服务中

Bug编译狮

在 Symfony 中，依赖注入（Dependency Injection, DI）是一种设计模式，用于将类之间的关系和控制权分离。通过使用 DI，你可以更灵活地配置和管理应用程序的组件。下面是如何在 Symfony 项目中将依赖注入到服务中的步骤。

1. 定义服务

首先，你需要定义一个服务，并将其注册为容器的一部分。你可以通过 services.yaml 文件来实现这一点。

# config/services.yaml
services:
    AppServiceMyService:
        arguments: ['@logger']

在这个例子中，MyService 类需要接受一个参数 logger，这个参数是由 logger 服务提供的。

2. 注册服务

在 AppKernel.php 或 bootstrap.php 文件中注册服务。

// src/App/AppKernel.php
use SymfonyComponentDependencyInjectionContainerBuilder;
use SymfonyComponentHttpKernelBundleBundle;

class AppBundle extends Bundle
{
    public function registerContainerConfiguration(LoaderInterface $loader)
    {
        $loader->load(__DIR__.'/config/config.yml');
    }
}

或者在 bootstrap.php：

// app/bootstrap.php
$container = new ContainerBuilder();
$container->register('app.service.myservice', 'AppServiceMyService')
    ->addArgument(new Reference('logger'));
$container->compile();

3. 使用服务

现在，你可以从容器中获取并使用 MyService。

// src/Controller/HomeController.php
namespace AppController;

use AppServiceMyService;
use SymfonyBundleFrameworkBundleControllerAbstractController;
use SymfonyComponentHttpFoundationResponse;

class HomeController extends AbstractController
{
    private $myService;

    public function __construct(MyService $myService)
    {
        $this->myService = $myService;
    }

    public function index(): Response
    {
        return $this->render('home/index.html.twig', [
            'message' => $this->myService->getMessage(),
        ]);
    }
}

示例代码

以下是一个完整的示例，展示了如何定义、注册和服务，并在控制器中使用它。

1. `services.yaml`

# config/services.yaml
services:
    AppServiceMyService:
        arguments: ['@logger']

    AppControllerHomeController:
        arguments: [ '@app.service.myservice' ]

2. `AppKernel.php`

// src/App/AppKernel.php
use SymfonyComponentDependencyInjectionContainerBuilder;
use SymfonyComponentHttpKernelBundleBundle;

class AppBundle extends Bundle
{
    public function registerContainerConfiguration(LoaderInterface $loader)
    {
        $loader->load(__DIR__.'/config/config.yml');
    }
}

3. `HomeController.php`

// src/Controller/HomeController.php
namespace AppController;

use AppServiceMyService;
use SymfonyBundleFrameworkBundleControllerAbstractController;
use SymfonyComponentHttpFoundationResponse;

class HomeController extends AbstractController
{
    private $myService;

    public function __construct(MyService $myService)
    {
        $this->myService = $myService;
    }

    public function index(): Response
    {
        return $this->render('home/index.html.twig', [
            'message' => $this->myService->getMessage(),
        ]);
    }
}

4. `index.html.twig`

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Home Page</title>
</head>
<body>
    <h1>{{ message }}</h1>
</body>
</html>

通过这些步骤，你可以在 Symfony 项目中成功地将依赖注入到服务中，并在控制器中使用它。

黑板Bug讲师

介绍

依赖注入（DI）是一种设计模式，允许一个类从外部来源接收其依赖项，而不是内部创建它们。在Symfony中，服务依赖注入对于维护干净的代码和关注点分离至关重要。本教程将引导您通过过程，在Symfony中为服务注入依赖，从最基础的例子到更高级的应用场景。附带代码示例，您将了解如何有效地利用Symfony的服务容器来管理依赖关系。

理解基本概念

首先，让我们澄清一下Symfony中的服务是什么样的。一个服务是一个执行特定任务的PHP对象，例如发送电子邮件、处理数据库连接或处理支付等。服务端点架构的核心就是服务，通常它们是在服务容器内配置和管理的。

首先，你需要定义你的服务。这里有一个简单的示例服务来记录消息：

namespace AppService;

class LoggerService {
  public function log(string $message) {
    // Log the message to some storage
  }
}

在许多情况下，像这样的服务是存在的。LoggerService需要外部资源，比如日志库或配置文件。这就是依赖注入发挥作用的地方。

构造器注入

最常见的将依赖注入到服务的方法是通过构造函数。使用构造函数注入可以明确显示地声明依赖项，并确保在使用之前，服务已经拥有所有需要的资源。

假设我们想要在我们的代码中注入一个日志接口。LoggerService我们将通过定义日志记录依赖项的接口来实现这一点：

namespace AppLogger;

interface LoggerInterface {
  public function log(string $message): void;
}

然后，修改了它。LoggerService接受一个LoggerInterface通过其构造函数：

// src/Service/LoggerService.php
namespace AppService;

use AppLoggerLoggerInterface;

class LoggerService {
  private $logger;

  public function __construct(LoggerInterface $logger) {
    $this->logger = $logger;
  }

  public function log(string $message) {
    $this->logger->log($message);
  }
}

接下来，您将在配置文件中定义此服务及其依赖项，这样Symfony就能实例化它了：

# config/services.yaml
services:
  AppLoggerLoggerInterface: '@monolog.logger'
  AppServiceLoggerService:
    arguments: ['@AppLoggerLoggerInterface']

使用这种方法，当服务容器创建实例时，就会调用这个方法。LoggerService它会自动通过定义的记录器实例传递，满足依赖。

setter注入

如果依赖项不是服务运行所必需的，或者需要在稍后设置，则可以使用setter注入。以下是如何进行的：

namespace AppService;

use AppLoggerLoggerInterface;

class SomeService {
  private $logger;

  public function setLogger(LoggerInterface $logger) {
    $this->logger = $logger;
  }
}

对不起，我不明白你在说什么。services.yaml您可以指定调用设置方法的调用：

# config/services.yaml
services:
  AppServiceSomeService:
    calls:
      - method: 'setLogger'
        arguments: ['@AppLoggerLoggerInterface']

这指示服务容器调用setLogger在服务实例化后，通过注入日志记录器依赖项来实现方法。

属性注入

尽管这种情况较为罕见，且不被视为最佳实践，因为可能会破坏封装性，但你可以直接将依赖注入到属性中。以下是一个实现示例：

namespace AppService;

use AppLoggerLoggerInterface;

class AnotherService {@Inject}
  public $logger;
}

使用属性注入配置，请参阅以下步骤：services.yaml好的，请提供需要翻译的内容。

# config/services.yaml
services:
  AppServiceAnotherService:
    properties:
      $logger: '@AppLoggerLoggerInterface'

请注意，属性注入仅在特殊情况下使用，因为它暴露了服务的内部细节，并可能复杂化单元测试。

接口注入

依赖注入的形式要求接收类实现一个接口，该接口有一个方法会接收依赖项。在Symfony中，由于构造函数和setter注入已经足够覆盖大多数用例，因此这种模式使用得较少。

高级方法

随着你在Symfony中的进展，你可能会遇到其他类型的依赖注入需求，如方法注入和工厂注入。这些是更复杂的方法，将在特定主题的教程中进行详细说明。

最佳实践：依赖注入（Dependency Injection）

在注入依赖项时，务必牢记以下最佳实践：

保持依赖层次结构浅，以避免复杂性叠加并确保最佳性能。

在必要时才避免属性注入。

使用接口代替具体的类来定义依赖关系，这可以促进松耦合和更容易的测试。

推荐使用构造函数注入，以确保服务始终处于有效状态。

结论。

总结一下，Symfony的依赖注入技术使得开发者能够保持代码整洁且解耦。正确使用注入方法有助于使服务灵活且易于测试。遵循所展示的原则和实践，可以让你的Symfony应用程序变得更加健壮和可扩展。

长工码奴1523

在使用Symfony框架时，依赖注入是一种常见的设计模式，它允许您将对象的实例作为参数传递给函数，并通过这些参数来创建新的对象。以下是将依赖注入到服务中的基本步骤：

定义服务接口：首先，你需要定义一个服务接口，该接口定义了你希望服务实现的所有功能和行为。

use SymfonyComponentHttpKernelBundleBundle;

interface MyServiceInterface {
    public function myMethod();
}

创建服务类：然后，你可以创建一个服务类，继承自MyServiceInterface并实现这个接口。在这个类中，你可以添加任何你想提供的方法或者属性。

class MyService implements MyServiceInterface {
    public function myMethod() {
        // 这里是你的业务逻辑
    }
}

注入依赖：最后，你需要向你的服务提供者或其他组件（如控制器）注入这个服务类。这通常是在配置文件中完成的，但在实际项目中，你可能会使用容器管理器（如yiisoft/yii2-Yii或symfony/dependency-injection)。

例如，在一个简单的composer.json文件中：

{
    "require": {
        "yiisoft/yii2-Yii": "^2.0",
        "symfony/dependency-injection": "^5.4"
    },
    "config": {
        "bin-dir": ".",
        "cache-base-path": "/tmp/.cache/yiisoft/yii2-Yii/"
    }
}

现在，当你运行yii run命令时，Symfony容器会自动从composer.json加载所需的依赖，并为你提供一个包含所有已注册服务的服务容器。

例如：

$ yii run
Starting development server...
[  OK  ] /var/www/html/symfony-project/app/web/index.php

这就是将依赖注入到服务中的基本步骤。在实践中，你可能需要根据具体需求调整这些步骤，但总体上保持一致即可。

Symfony：如何将依赖注入到服务中

Bug编译狮

1. 定义服务

2. 注册服务

3. 使用服务

示例代码

1. services.yaml

2. AppKernel.php

3. HomeController.php

4. index.html.twig

黑板Bug讲师

介绍

理解基本概念

构造器注入

setter注入

属性注入

接口注入

高级方法

最佳实践：依赖注入（Dependency Injection）

结论。

长工码奴1523

最新更新

Symfony：如何将依赖注入到服务中

1. `services.yaml`

2. `AppKernel.php`

3. `HomeController.php`

4. `index.html.twig`