drupal-services

Drupal のサービスと依存性注入

基本原則

クラス内で \Drupal::service() を使用せず、コンストラクター経由で注入してください。

依存性注入のパターン

コントローラーとフォーム（ContainerInjectionInterface）

use Drupal\Core\DependencyInjection\ContainerInjectionInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

final class MyController implements ContainerInjectionInterface {
  public function __construct(
    private readonly AccountProxyInterface $currentUser,
    private readonly EntityTypeManagerInterface $entityTypeManager,
  ) {}

  public static function create(ContainerInterface $container): static {
    return new static(
      $container->get('current_user'),
      $container->get('entity_type.manager'),
    );
  }
}

プラグイン（ContainerFactoryPluginInterface）

use Drupal\Core\Plugin\ContainerFactoryPluginInterface;

final class MyBlock extends BlockBase implements ContainerFactoryPluginInterface {
  public function __construct(
    array $configuration,
    string $plugin_id,
    mixed $plugin_definition,
    private readonly EntityTypeManagerInterface $entityTypeManager,
  ) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
  }

  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition): static {
    return new static(
      $configuration,
      $plugin_id,
      $plugin_definition,
      $container->get('entity_type.manager'),
    );
  }
}

サービス定義（services.yml）

services:
  my_module.my_service:
    class: Drupal\my_module\Service\MyService
    arguments:
      - '@entity_type.manager'
      - '@current_user'
      - '@logger.factory'

  # With autowiring (Drupal 10.3+)
  Drupal\my_module\Hook\MyModuleHooks:
    autowire: true

よく使われるサービス ID

サービス ID	インターフェース
entity_type.manager	EntityTypeManagerInterface
current_user	AccountProxyInterface
logger.factory	LoggerChannelFactoryInterface
database	Connection
config.factory	ConfigFactoryInterface
renderer	RendererInterface
messenger	MessengerInterface
date.formatter	DateFormatterInterface
language_manager	LanguageManagerInterface
path_alias.manager	AliasManagerInterface
module_handler	ModuleHandlerInterface
cache.default	CacheBackendInterface

StringTranslationTrait

翻訳サービスを完全に依存性注入しなくても $this->t() を使えるようにするには、必要なクラスに use StringTranslationTrait; を追加します。

Drush でのサービス生成

drush generate service --answers='{
  "module": "my_module",
  "service_name": "my_module.helper",
  "class": "HelperService",
  "services": ["entity_type.manager", "logger.factory"]
}'