Eloquent：序列化
简介
在使用 Laravel 构建 API 时，你经常需要将模型及其关系转换为数组或 JSON。Eloquent 包含了便捷的方法来进行这些转换，并控制模型的序列化表示中包含哪些属性。
NOTE
有关处理 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 支持的任何 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\Attributes\Hidden;
use Illuminate\Database\Eloquent\Model;
#[Hidden(['password'])]
class User extends Model
{
// ...
}NOTE
要隐藏关系，请将关系的方法名添加到 Eloquent 模型的 Hidden 属性中。
或者，你可以使用 Visible 属性来定义一个“允许列表”，列出应包含在模型数组和 JSON 表示中的属性。当模型转换为数组或 JSON 时，所有不在 Visible 属性中的属性都将被隐藏：
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Attributes\Visible;
use Illuminate\Database\Eloquent\Model;
#[Visible(['first_name', 'last_name'])]
class User extends Model
{
// ...
}临时修改属性可见性
如果你希望在给定的模型实例上使一些通常隐藏的属性可见，可以使用 makeVisible 或 mergeVisible 方法。makeVisible 方法返回模型实例：
return $user->makeVisible('attribute')->toArray();
return $user->mergeVisible(['name', 'email'])->toArray();同样，如果你希望隐藏一些通常可见的属性，可以使用 makeHidden 或 mergeHidden 方法：
return $user->makeHidden('attribute')->toArray();
return $user->mergeHidden(['name', 'email'])->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\Attributes\Appends;
use Illuminate\Database\Eloquent\Model;
#[Appends(['is_admin'])]
class User extends Model
{
// ...
}一旦该属性被添加到 appends 列表中，它就会包含在模型的数组和 JSON 表示中。appends 数组中的属性也会遵循模型上配置的 visible 和 hidden 设置。
运行时追加
在运行时，你可以使用 append 或 mergeAppends 方法指示模型实例追加其他属性。或者，你可以使用 setAppends 方法来覆盖给定模型实例的整个追加属性数组：
return $user->append('is_admin')->toArray();
return $user->mergeAppends(['is_admin', 'status'])->toArray();
return $user->setAppends(['is_admin'])->toArray();同样，如果你想从模型中移除所有追加的属性，可以使用 withoutAppends 方法：
return $user->withoutAppends()->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',
];
}