PHP怎么实现Eloquent Attribute Casting属性转换进阶_Laravel自定义转换器【指南】-php教程-PHP中文网

Eloquent自定义转换器（Laravel 7+）比get/setFooAttribute更推荐，因其统一可控、自动参与全链路序列化；需实现CastsAttributes接口，安全JSON数组转换器应兜底空值与解析失败。

php怎么实现eloquent attribute casting属性转换进阶_laravel自定义转换器【指南】

为什么 `getFooAttribute` 和 `setFooAttribute` 不再推荐用

因为 Eloquent 的 $casts 已支持自定义转换器（Laravel 7+），它比访问器/修改器更统一、更可控，且自动参与序列化、API 响应、模型数组转换等全链路。手动写访问器容易漏掉反向逻辑（比如只处理取值不处理设值），也绕过 toArray() 和 jsonSerialize() 的标准化流程。

常见错误现象：toArray() 返回的仍是原始类型（如字符串），但前端期望是数组；或数据库存的是 JSON 字符串，却没在读取时自动解码。

自定义转换器必须实现 Illuminate\Contracts\Database\Eloquent\CastsAttributes 接口
必须定义 get（从数据库值转 PHP 值）和 set（从 PHP 值转数据库可存值）两个方法
返回值类型需与字段语义一致：比如 get 应返回 array，set 应返回 string 或 null
不要在 get 中抛异常——Eloquent 在序列化时会静默忽略失败，导致字段消失

怎么写一个安全的 JSON 数组转换器

适用于存取 JSON 类型字段（如 MySQL 5.7+ 的 JSON 列，或通用 TEXT 字段），目标是让模型属性始终表现为 PHP array，且空值、null、非 JSON 字符串都能兜底处理。

use Illuminate\Contracts\Database\Eloquent\CastsAttributes;

class JsonArrayCast implements CastsAttributes
{
    public function get($model, string $key, $value, array $attributes)
    {
        if ($value === null || $value === '') {
            return [];
        }

        if (is_array($value)) {
            return $value;
        }

        $decoded = json_decode($value, true);
        return is_array($decoded) ? $decoded : [];
    }

    public function set($model, string $key, $value, array $attributes)
    {
        if ($value === null || $value === []) {
            return null;
        }

        if (!is_array($value)) {
            $value = [];
        }

        return json_encode($value, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES);
    }
}

关键点：

不依赖 json_last_error() ——json_decode 失败直接返回 null，避免后续 is_array(null) 导致意外空数组
set 方法里强制归一化输入，防止传入对象、字符串甚至布尔值导致 json_encode 输出不符合预期
使用 JSON_UNESCAPED_UNICODE 避免中文被编码成 \uXXXX，提升可读性与调试友好度

如何在模型中注册并验证是否生效

在模型类中声明 $casts，键为字段名，值为转换器类完整命名空间路径：

protected $casts = [
    'options' => \App\Casts\JsonArrayCast::class,
];

验证是否生效最直接的方式是：在 Tinker 中测试读写闭环：

btpanel phpsite 宝塔面板PHP网站

宝塔面板 PHP 网站管理：站点创建、删除、启停、PHP 版本切换、域名管理、SSL证书管理、伪静态管理、数据库管理

下载

执行 $model->options = ['theme' => 'dark', 'lang' => 'zh']; $model->save(); → 检查数据库该字段是否存为合法 JSON 字符串
执行 $fresh = Model::find($model->id); dd($fresh->options); → 确认输出是 array 而非 string
执行 $fresh->toArray() → 确认 options 键对应值是数组，不是 JSON 字符串

容易踩的坑：

忘记在 $casts 中写 ::class 后缀，写成字符串路径（如 'App\Casts\JsonArrayCast'）会导致 Laravel 找不到类
转换器类未放在自动加载路径下（如没运行 composer dump-autoload），Tinker 会报 Class not found
字段在数据库中是 NULL，但转换器 get 方法没处理 null 分支，结果返回 null，而前端解析时崩掉