Laravel/Symfony如何利用PHP 8 Attributes实现声明式配置与依赖注入 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

Laravel/Symfony 利用 PHP 8 Attributes 实现声明式配置与依赖注入

各位同学，今天我们来深入探讨一下如何在 Laravel 和 Symfony 框架中利用 PHP 8 的 Attributes（属性）来实现声明式配置和依赖注入。Attributes 的引入为 PHP 代码添加元数据提供了标准且强大的机制，使我们能够以更简洁、更具表达力的方式来配置和组织应用程序。

一、理解 PHP 8 Attributes

Attributes 是一种将元数据添加到类、方法、属性、参数等代码结构中的方式。它们可以被看作是代码的“注解”，但与传统的注解（例如 Java 的注解）不同，Attributes 是 PHP 语言本身的特性，并且可以通过反射 API 在运行时访问。

Attributes 通过 #[AttributeName] 的语法形式来声明，可以带参数，也可以不带参数。

基本语法：

#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)] // 定义 Attribute 作用域
class MyAttribute
{
    public function __construct(public string $value) {}
}

#[MyAttribute("Example Value")] // 使用 Attribute
class MyClass
{
    #[MyAttribute("Another Value")]
    public function myMethod() {}
}

解释：

#[Attribute]：PHP 8 内置的 Attribute，用于声明一个类为 Attribute 类。
Attribute::TARGET_CLASS | Attribute::TARGET_METHOD：指定该 Attribute 可以应用到哪些代码结构上，这里是类和方法。
MyAttribute("Example Value")：将 MyAttribute 应用到 MyClass 和 myMethod 上，并传递参数 "Example Value"。

二、Laravel 中的声明式配置

在 Laravel 中，我们可以利用 Attributes 来实现声明式配置，从而避免在配置文件或服务提供者中编写大量的样板代码。

示例：配置路由

假设我们需要根据类名自动注册路由。我们可以创建一个 Route Attribute，用于指定路由的 URI 和 HTTP 方法。

#[Attribute(Attribute::TARGET_CLASS)]
class Route
{
    public function __construct(public string $uri, public string $method = 'GET') {}
}

#[Route('/users', 'GET')]
class UserController
{
    #[Route('/{id}', 'GET')]
    public function show(int $id)
    {
        // ...
    }
}

现在，我们可以编写一个路由注册器，利用反射 API 读取类的 Attributes，并自动注册路由。

use IlluminateSupportFacadesRoute as RouteFacade;
use ReflectionClass;

class RouteRegistrar
{
    public function registerRoutes(string $controllerNamespace)
    {
        $controllers = $this->getControllers($controllerNamespace);

        foreach ($controllers as $controller) {
            $reflection = new ReflectionClass($controller);

            // 获取类上的 Route Attribute
            $routeAttribute = $reflection->getAttributes(Route::class)[0] ?? null;

            if ($routeAttribute) {
                $routeInstance = $routeAttribute->newInstance();
                $uri = $routeInstance->uri;
                $method = $routeInstance->method;

                RouteFacade::match([$method], $uri, [$controller, 'index']); // 假设index方法是默认方法

                // 遍历方法，寻找方法上的 Route Attribute
                foreach ($reflection->getMethods() as $method) {
                    $methodRouteAttribute = $method->getAttributes(Route::class)[0] ?? null;

                    if ($methodRouteAttribute) {
                        $methodRouteInstance = $methodRouteAttribute->newInstance();
                        $methodUri = $uri . $methodRouteInstance->uri; // 将类上的 URI 作为前缀
                        $methodType = $methodRouteInstance->method;
                        RouteFacade::match([$methodType], $methodUri, [$controller, $method->getName()]);
                    }
                }
            }
        }
    }

    private function getControllers(string $controllerNamespace): array
    {
        $files = glob(app_path('Http/Controllers/' . str_replace('\', '/', $controllerNamespace) . '/*.php'));

        $controllers = [];
        foreach ($files as $file) {
            $className = $controllerNamespace . '\' . pathinfo($file, PATHINFO_FILENAME);
            if (class_exists($className)) {
                $controllers[] = $className;
            }
        }

        return $controllers;
    }
}

// 在 RouteServiceProvider 中注册路由
public function boot(): void
{
    (new RouteRegistrar())->registerRoutes('App\Http\Controllers');

    require base_path('routes/web.php');
}

解释：

Route Attribute: 定义了路由的 URI 和 HTTP 方法。
RouteRegistrar 类:
- registerRoutes() 方法：接收控制器命名空间作为参数，遍历该命名空间下的所有控制器。
- ReflectionClass: 使用反射 API 获取类的元数据。
- getAttributes(Route::class): 获取类和方法上的 Route Attribute 实例。
- newInstance(): 创建 Attribute 实例。
- RouteFacade::match(): 使用 Laravel 的路由 Facade 注册路由。

三、Symfony 中的依赖注入

Symfony 的服务容器是其核心组件之一，负责管理应用程序中的对象及其依赖关系。我们可以利用 Attributes 来简化服务配置和依赖注入。

示例：自动注册服务

假设我们有一个接口 LoggerInterface 和一个实现类 DatabaseLogger。我们可以创建一个 Service Attribute，用于标记服务类并指定其接口。

#[Attribute(Attribute::TARGET_CLASS)]
class Service
{
    public function __construct(public ?string $interface = null) {}
}

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

#[Service(LoggerInterface::class)]
class DatabaseLogger implements LoggerInterface
{
    public function __construct(private DatabaseConnection $connection) {}

    public function log(string $message): void
    {
        // ...
    }
}

class DatabaseConnection
{
    public function __construct(private string $dsn) {}
}

在 Symfony 的配置中，我们可以启用自动注册服务，并创建一个服务注册器来处理带有 Service Attribute 的类。

config/services.yaml:

services:
    # 自动注册 services.php 文件中的服务
    _defaults:
        autowire: true      # 自动注入依赖
        autoconfigure: true # 自动配置服务

    # 自动注册指定命名空间下的服务
    App:
        resource: '../src/*'
        exclude: '../src/{DependencyInjection,Entity,Migrations,Tests,Kernel.php}'

    # 自定义服务注册器
    AppServiceRegistrar:
        tags: ['kernel.event_listener']
        arguments: ['%container.namespaces%']

src/ServiceRegistrar.php:

namespace App;

use SymfonyComponentDependencyInjectionContainerBuilder;
use SymfonyComponentDependencyInjectionDefinition;
use SymfonyComponentEventDispatcherEventSubscriberInterface;
use SymfonyComponentHttpKernelEventKernelEvents;
use SymfonyComponentHttpKernelKernelEvents as BaseKernelEvents;
use SymfonyComponentDependencyInjectionReference;
use ReflectionClass;

class ServiceRegistrar implements EventSubscriberInterface
{
    private array $namespaces;

    public function __construct(array $namespaces)
    {
        $this->namespaces = $namespaces;
    }

    public static function getSubscribedEvents(): array
    {
        return [
            KernelEvents::CONFIGURE => 'onKernelConfigure',
        ];
    }

    public function onKernelConfigure(SymfonyComponentHttpKernelEventConfigureEvent $event): void
    {
        $container = $event->getContainer();
        $this->registerServices($container);
    }

    private function registerServices(ContainerBuilder $container): void
    {
        foreach ($this->namespaces as $namespace) {
            $files = glob($container->getParameter('kernel.project_dir').'/src/' . str_replace('\', '/', $namespace) . '/*.php');

            foreach ($files as $file) {
                $className = $namespace . '\' . pathinfo($file, PATHINFO_FILENAME);

                if (class_exists($className)) {
                    $reflection = new ReflectionClass($className);

                    // 获取类上的 Service Attribute
                    $serviceAttribute = $reflection->getAttributes(Service::class)[0] ?? null;

                    if ($serviceAttribute) {
                        $serviceInstance = $serviceAttribute->newInstance();
                        $interface = $serviceInstance->interface;

                        $definition = new Definition($className);
                        $definition->setAutowired(true);

                        if ($interface) {
                            $container->setDefinition($interface, $definition);
                            $container->setAlias($className, $interface); // 允许通过类名和接口名获取服务
                        } else {
                            $container->setDefinition($className, $definition);
                        }
                    }
                }
            }
        }
    }
}

解释：

Service Attribute: 定义了服务类及其接口。
ServiceRegistrar 类:
- onKernelConfigure() 方法：在 Symfony 内核配置时触发，获取服务容器。
- registerServices() 方法：遍历指定命名空间下的所有类。
- ReflectionClass: 使用反射 API 获取类的元数据。
- getAttributes(Service::class): 获取类上的 Service Attribute 实例。
- newInstance(): 创建 Attribute 实例。
- Definition: 创建 Symfony 服务定义。
- setAutowired(true): 启用自动注入依赖。
- setDefinition(): 将服务定义添加到服务容器。

四、Attributes 的优势与局限性

优势：

声明式配置: 将配置信息直接嵌入到代码中，提高了代码的可读性和可维护性。
类型安全: Attributes 是 PHP 语言本身的特性，可以进行类型检查，避免运行时错误。
可扩展性: 可以自定义 Attributes 来满足不同的需求。
减少样板代码: 避免在配置文件或服务提供者中编写大量的重复代码。

局限性：

运行时开销: 使用反射 API 读取 Attributes 会带来一定的运行时开销，尤其是在大量使用时。
复杂性: 过度使用 Attributes 可能会导致代码难以理解和调试。

五、最佳实践

合理使用 Attributes: 不要过度使用 Attributes，只在确实能够简化配置和提高代码可读性的情况下使用。
保持 Attributes 的简洁性: Attributes 应该只包含必要的配置信息，避免过于复杂。
编写单元测试: 确保 Attributes 的行为符合预期。
考虑性能影响: 在大量使用 Attributes 时，需要考虑性能影响，并进行优化。

六、进阶应用

除了上述示例，Attributes 还可以用于以下场景：

验证规则: 可以使用 Attributes 来定义数据验证规则，例如 #[Required], #[Email], #[MinLength(8)]。
序列化/反序列化: 可以使用 Attributes 来控制对象的序列化和反序列化过程，例如 #[SerializedName('user_id')]。
访问控制: 可以使用 Attributes 来定义访问控制规则，例如 #[Role('admin')]。
ORM 映射: 可以使用 Attributes 来定义 ORM 实体和字段的映射关系，例如 #[Entity], #[Column(type: 'string')]。

七、代码对比

为了更直观地展示 Attributes 的优势，我们来看一个使用传统方式和使用 Attributes 方式的代码对比。

传统方式 (Laravel – 配置文件):

// config/routes.php
Route::get('/users', [UserController::class, 'index']);
Route::get('/users/{id}', [UserController::class, 'show']);

使用 Attributes 方式 (Laravel):

#[Route('/users', 'GET')]
class UserController
{
    #[Route('/{id}', 'GET')]
    public function show(int $id)
    {
        // ...
    }
}

传统方式 (Symfony – services.yaml):

services:
    AppDatabaseLogger:
        arguments:
            $connection: '@AppDatabaseConnection'

    AppDatabaseConnection:
        arguments:
            $dsn: '%database_dsn%'

    AppUserController:
        arguments:
            $logger: '@AppDatabaseLogger'

使用 Attributes 方式 (Symfony):

#[Service(LoggerInterface::class)]
class DatabaseLogger implements LoggerInterface
{
    public function __construct(private DatabaseConnection $connection) {}

    public function log(string $message): void
    {
        // ...
    }
}

class DatabaseConnection
{
    public function __construct(private string $dsn) {}
}

class UserController {
    public function __construct(private LoggerInterface $logger) {}
}

通过对比，我们可以看到使用 Attributes 方式的代码更加简洁、易读，并且更贴近业务逻辑。

Attributes 简化配置，提升代码可读性

总而言之，PHP 8 的 Attributes 为 Laravel 和 Symfony 框架提供了强大的声明式配置和依赖注入能力。通过合理地使用 Attributes，我们可以编写出更加简洁、易读、可维护的代码。希望今天的讲解能够帮助大家更好地理解和应用 Attributes。

Laravel/Symfony 利用 PHP 8 Attributes 实现声明式配置与依赖注入

发表回复 取消回复

发表回复取消回复