PHP项目Symfony service与别名

wen PHP项目 2026-07-23 181

Symfony Service 与别名详解

基础概念

Service 是 Symfony 中可复用的 PHP 对象，通过服务容器统一管理。

别名是为服务创建的替代名称，指向相同的服务实例。

定义方式

1 YAML 配置

# config/services.yaml
services:
    # 定义服务
    App\Service\MailService:
        arguments:
            $mailer: '@mailer.mailer'
            $logger: '@logger'
    # 创建别名
    app.mail_service: '@App\Service\MailService'
    # 别名（带参数）
    app.mail_service_alias:
        alias: App\Service\MailService
        public: true

2 PHP 配置

// config/services.php
use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
use Symfony\Component\DependencyInjection\Reference;
return function(ContainerConfigurator $configurator) {
    $services = $configurator->services();
    // 定义服务
    $services->set('App\Service\MailService')
        ->arg('$mailer', new Reference('mailer.mailer'))
        ->arg('$logger', new Reference('logger'));
    // 创建别名
    $services->alias('app.mail_service', 'App\Service\MailService');
};

3 属性注解

// src/Service/MailService.php
namespace App\Service;
use Symfony\Component\DependencyInjection\Attribute\Autoconfigure;
#[Autoconfigure()]
class MailService
{
    // ...
}
// 别名使用
use Symfony\Component\DependencyInjection\Attribute\AsAlias;
#[AsAlias('app.mail_service')]
class MailService
{
    // ...
}

别名的使用场景

1 依赖注入

// Controller 中使用别名
class UserController extends AbstractController
{
    public function __construct(
        #[Autowire(service: 'app.mail_service')]
        private MailService $mailService
    ) {}
    public function sendEmail(): Response
    {
        $this->mailService->send('user@example.com', 'Subject', 'Body');
        return new Response('Email sent');
    }
}

2 接口多实现

// 接口定义
interface PaymentGatewayInterface
{
    public function processPayment(float $amount): bool;
}
// 多个实现
class StripePayment implements PaymentGatewayInterface
{
    public function processPayment(float $amount): bool
    {
        // Stripe 实现
        return true;
    }
}
class PayPalPayment implements PaymentGatewayInterface
{
    public function processPayment(float $amount): bool
    {
        // PayPal 实现
        return true;
    }
}
// services.yaml 配置
services:
    App\Payment\StripePayment:
        tags: ['app.payment_gateway']
    App\Payment\PayPalPayment:
        tags: ['app.payment_gateway']
    # 创建别名指定默认实现
    App\Payment\PaymentGatewayInterface: '@App\Payment\StripePayment'

3 服务装饰器

// 装饰器模式示例
class LoggingMailService
{
    private MailService $innerService;
    private LoggerInterface $logger;
    public function __construct(MailService $innerService, LoggerInterface $logger)
    {
        $this->innerService = $innerService;
        $this->logger = $logger;
    }
    public function send(string $to, string $subject, string $body): void
    {
        $this->logger->info("Sending email to: $to");
        $this->innerService->send($to, $subject, $body);
    }
}
// services.yaml
services:
    App\Service\MailService: ~
    App\Service\LoggingMailService:
        decorates: App\Service\MailService
        arguments:
            $innerService: '@.inner'
            $logger: '@logger'
    # 创建别名指向装饰后的服务
    app.mail_service: '@App\Service\LoggingMailService'

别名的高级特性

1 公共与私有别名

services:
    # 公共别名（可直接从容器获取）
    app.public_service:
        alias: App\Service\SomeService
        public: true
    # 私有别名（仅用于 DI）
    app.private_service:
        alias: App\Service\SomeService
        public: false

2 别名标签

services:
    app.mail_service:
        alias: App\Service\MailService
        tags:
            - { name: 'app.service_alias', type: 'mail' }

3 条件别名

services:
    # 根据环境条件创建别名
    app.current_payment:
        alias: App\Payment\StripePayment
        # 仅在生产环境有效
        condition: 'kernel.environment == "prod"'
    app.dev_payment:
        alias: App\Payment\PayPalPayment
        condition: 'kernel.environment == "dev"'

获取服务及别名

// Controller 或 Service 中
use Psr\Container\ContainerInterface;
class SomeController extends AbstractController
{
    public function testAction(ContainerInterface $container)
    {
        // 通过别名获取服务
        $mailService = $container->get('app.mail_service');
        // 检查别名是否存在
        if ($container->has('app.mail_service')) {
            // 使用服务
        }
        // 获取服务的服务ID
        $serviceId = $container->getServiceId('app.mail_service');
    }
}

最佳实践

# 最佳实践配置示例
services:
    # 1. 使用 FQCN 作为服务 ID
    App\Service\UserService:
        arguments:
            - '@App\Repository\UserRepository'
    # 2. 为接口创建别名
    App\Repository\UserRepositoryInterface: '@App\Repository\UserRepository'
    # 3. 使用清晰的别名命名
    app.user_manager: '@App\Service\UserService'
    # 4. 避免过度使用别名
    # 仅在需要解耦或兼容旧代码时使用
    # 5. 标记公共服务
    app.public_service:
        alias: App\Service\PublicService
        public: true
    # 6. 使用依赖注入而非容器获取
    App\Controller\UserController:
        arguments:
            $userService: '@app.user_manager'

调试别名

# 查看所有服务别名
php bin/console debug:container --aliases
# 查看特定服务信息
php bin/console debug:container app.mail_service
# 查看服务的别名列表
php bin/console debug:container --show-aliases App\\Service\\MailService