Eloquent：序列化 – 乌鸦嘴文档中心

介绍

在使用 Laravel 构建 API 时，您经常需要将模型及其关系转换为数组或 JSON。Eloquent 包含了方便的方法来进行这些转换，以及控制在模型的序列化表示中包含哪些属性。

[!注意]
对于处理 Eloquent 模型和集合 JSON 序列化的更强大的方法，请查看关于Eloquent API 资源的文档。

模型和集合的序列化

序列化为数组

要将模型及其加载的关系转换为数组，您应该使用toArray方法。此方法是递归的，因此所有属性和所有关系（包括关系的关系）都将转换为数组：

use App\Models\User;

$user = User::with('roles')->first();

return $user->toArray();

attributesToArray方法可用于将模型的属性转换为数组，但不包括其关系：

$user = User::first();

return $user->attributesToArray();

您还可以通过在集合实例上调用toArray方法将整个模型集合转换为数组：

$users = User::all();

return $users->toArray();

序列化为 JSON

要将模型转换为 JSON，您应该使用toJson方法。与toArray一样，toJson方法是递归的，因此所有属性和关系都将转换为 JSON。您还可以指定PHP 支持的 (opens in a new tab)任何 JSON 编码选项：

use App\Models\User;

$user = User::find(1);

return $user->toJson();

return $user->toJson(JSON_PRETTY_PRINT);

或者，您可以将模型或集合转换为字符串，这将自动在模型或集合上调用toJson方法：

return (string) User::find(1);

由于模型和集合在转换为字符串时会被转换为 JSON，因此您可以直接从应用程序的路由或控制器中返回 Eloquent 对象。当从路由或控制器中返回时，Laravel 会自动将您的 Eloquent 模型和集合序列化为 JSON：

Route::get('/users', function () {
    return User::all();
});

关系

当一个 Eloquent 模型被转换为 JSON 时，其加载的关系将自动作为 JSON 对象的属性包含在内。此外，虽然 Eloquent 关系方法是使用“驼峰式”方法名称定义的，但关系的 JSON 属性将是“蛇形命名法”。

从 JSON 中隐藏属性

有时您可能希望限制模型的数组或 JSON 表示中包含的属性，例如密码。为此，向您的模型添加一个 $hidden 属性。在 $hidden 属性的数组中列出的属性将不会包含在您的模型的序列化表示中：

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * 应在数组中隐藏的属性。
     *
     * @var array
     */
    protected $hidden = ['password'];
}

[!注意]
要隐藏关系，将关系的方法名称添加到 Eloquent 模型的 $hidden 属性中。

或者，您可以使用 visible 属性来定义一个“允许列表”，其中包含应在模型的数组和 JSON 表示中包含的属性。当模型转换为数组或 JSON 时，不在 $visible 数组中的所有属性都将被隐藏：

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * 应在数组中可见的属性。
     *
     * @var array
     */
    protected $visible = ['first_name', 'last_name'];
}

临时修改属性可见性

如果您希望在给定的模型实例上使一些通常隐藏的属性可见，可以使用 makeVisible 方法。makeVisible 方法会返回模型实例：

return $user->makeVisible('attribute')->toArray();

同样，如果您希望隐藏一些通常可见的属性，可以使用 makeHidden 方法。

return $user->makeHidden('attribute')->toArray();

如果您希望临时覆盖所有可见或隐藏的属性，可以分别使用 setVisible 和 setHidden 方法：

return $user->setVisible(['id', 'name'])->toArray();

return $user->setHidden(['email', 'password', 'remember_token'])->toArray();

向 JSON 追加值

有时，在将模型转换为数组或 JSON 时，您可能希望添加在数据库中没有对应列的属性。为此，首先为该值定义一个访问器：

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Casts\Attribute;
use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * 确定用户是否为管理员。
     */
    protected function isAdmin(): Attribute
    {
        return new Attribute(
            get: fn () => 'yes',
        );
    }
}

如果您希望访问器始终附加到模型的数组和 JSON 表示中，可以将属性名称添加到模型的appends属性中。请注意，属性名称通常使用其“蛇形命名法”的序列化表示形式进行引用，即使访问器的 PHP 方法是使用“驼峰命名法”定义的：

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * 要附加到模型数组形式的访问器。
     *
     * @var array
     */
    protected $appends = ['is_admin'];
}

一旦将属性添加到appends列表中，它将包含在模型的数组和 JSON 表示中。appends数组中的属性也将尊重在模型上配置的visible和hidden设置。

运行时追加

在运行时，您可以使用append方法指示模型实例追加其他属性。或者，您可以使用setAppends方法为给定的模型实例覆盖整个附加属性的数组：

return $user->append('is_admin')->toArray();

return $user->setAppends(['is_admin'])->toArray();

日期序列化

自定义默认日期格式

您可以通过重写serializeDate方法来自定义默认的序列化格式。此方法不会影响您的日期在数据库中存储的格式：

/**
 * 为数组/JSON 序列化准备日期。
 */
protected function serializeDate(DateTimeInterface $date): string
{
    return $date->format('Y-m-d');
}

按属性自定义日期格式

您可以通过在模型的类型声明中指定日期格式来自定义各个 Eloquent 日期属性的序列化格式：

protected function casts(): array
{
    return [
        'birthday' => 'date:Y-m-d',
        'joined_at' => 'datetime:Y-m-d H:00',
    ];
}

Eloquent：API 资源 Eloquent：工厂