在 Laravel 8 中优雅地定义和复用全局验证规则

在 laravel 8 中，开发者常常希望能够集中管理和复用应用程序中的验证规则，以避免重复代码并提高可维护性。然而，直接尝试将包含复杂表达式（例如 `rule::in` 或其他动态生成规则）的验证规则数组定义为类的静态属性时，会遇到 php 的一个限制：静态属性只能使用字面量或常量进行初始化，不能包含在编译时无法求值的表达式。这导致诸如 `symfony\component\errorhandler\error\fatalerror: constant expression contains invalid operations` 这样的错误。为了解决这一问题，laravel 推荐采用 php trait 的方式来优雅地实现验证规则的全局化和复用。

理解 PHP 静态属性的限制

PHP 在 5.6 版本之前，静态属性和类常量只能用字面量或常量表达式初始化。即使在 PHP 5.6 及更高版本中，虽然允许有限的表达式，但这些表达式也必须能在编译时求值。像 Rule::in(['on', 'off']) 这样的表达式，其结果是在运行时通过对象实例化或方法调用产生的，因此不能直接用于静态属性的初始化。

// 错误的示例：尝试在静态属性中定义动态规则
class GlobalRules
{
    public static $VALIDATION_RULES = [
        'signatures' => [
            'enabled' => ['required', \Illuminate\Validation\Rule::in(['on', 'off'])], // 错误：Rule::in 是运行时表达式
            // ... 其他规则
        ],
    ];
}

登录后复制

上述代码会因为 Rule::in 的动态性质而抛出编译时错误。

使用 Trait 实现验证规则的复用

Laravel 框架鼓励使用 Form Request 来处理复杂的验证逻辑。结合 PHP Trait，我们可以将常用的验证规则封装起来，并在多个 Form Request 类中复用。这种方法既符合面向对象的设计原则，又能规避静态属性的限制，因为 Trait 中的方法是在运行时被调用的。

1. 创建一个验证 Trait

首先，创建一个 Trait 文件，例如 app/Http/Traits/UserValidationTrait.php。在这个 Trait 中，定义一个私有方法，该方法负责返回一组与特定业务逻辑相关的验证规则。

<?php

namespace App\Http\Traits;

use Illuminate\Validation\Rule; // 如果规则中使用了Rule::in等，需要引入

trait UserValidationTrait
{
    /**
     * 返回用户信息的验证规则。
     *
     * @param string $prefix 规则字段前缀，用于处理嵌套对象。
     * @return array
     */
    private function getUserInfoRules(string $prefix = ''): array
    {
        return [
            $prefix . 'first_name' => ['required', 'string', 'max:100'],
            $prefix . 'last_name' => ['required', 'string', 'max:100'],
            $prefix . 'status' => ['required', Rule::in(['active', 'inactive'])], // 可以在这里使用Rule::in
        ];
    }

    /**
     * 返回签名信息的验证规则。
     *
     * @param string $prefix 规则字段前缀。
     * @return array
     */
    private function getSignatureRules(string $prefix = ''): array
    {
        return [
            $prefix . 'signature_file' => ['required', 'mimes:png,jpeg,jpg', 'max:1024'],
            $prefix . 'operator_id' => ['required', 'numeric'],
            // ... 其他签名相关规则
        ];
    }
}

登录后复制

在 getUserInfoRules 方法中，我们定义了 first_name 和 last_name 的验证规则。值得注意的是，我们还引入了 $prefix 参数。这个参数非常有用，当我们需要验证一个嵌套对象（例如一个包含多个用户对象的数组）时，可以通过添加前缀来指定具体的字段路径，例如 users.*.first_name。

2. 在 FormRequest 中使用 Trait

接下来，在你的 Form Request 类中引入并使用这个 Trait。在 Form Request 的 rules() 方法中，你可以调用 Trait 中定义的私有方法来获取验证规则，并将其与当前 Form Request 特有的规则合并。

标签： php laravel app ai 代码复用 red