Eloquent: 变换器与类型转换

介绍
访问器和变换器
- 定义访问器
- 定义变换器
属性类型转换
自定义转换

介绍

访问器、变换器和属性类型转换允许您在检索或设置模型实例上的 Eloquent 属性值时进行转换。例如，您可能希望使用 Laravel 加密器在将值存储到数据库时加密它，并在访问 Eloquent 模型上的属性时自动解密。或者，您可能希望将存储在数据库中的 JSON 字符串在通过 Eloquent 模型访问时转换为数组。

访问器和变换器

定义访问器

访问器在访问 Eloquent 属性值时进行转换。要定义访问器，请在模型上创建一个受保护的方法来表示可访问的属性。此方法名称应与基础模型属性/数据库列的“驼峰式”表示相对应（如果适用）。

在此示例中，我们将为 first_name 属性定义一个访问器。访问器将在尝试检索 first_name 属性的值时由 Eloquent 自动调用。所有属性访问器/变换器方法必须声明 Illuminate\Database\Eloquent\Casts\Attribute 的返回类型提示：

php

<?php

namespace App\Models;

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

class User extends Model
{
    /**
     * 获取用户的名字。
     */
    protected function firstName(): Attribute
    {
        return Attribute::make(
            get: fn (string $value) => ucfirst($value),
        );
    }
}

所有访问器方法返回一个 Attribute 实例，该实例定义了属性将如何被访问以及（可选地）如何被变换。在此示例中，我们仅定义了属性将如何被访问。为此，我们向 Attribute 类构造函数提供 get 参数。

如您所见，列的原始值被传递给访问器，允许您操作并返回该值。要访问访问器的值，您只需访问模型实例上的 first_name 属性：

php

use App\Models\User;

$user = User::find(1);

$firstName = $user->first_name;

如果您希望将这些计算值添加到模型的数组/JSON 表示中，您需要将它们附加。

从多个属性构建值对象

有时，您的访问器可能需要将多个模型属性转换为单个“值对象”。为此，您的 get 闭包可以接受第二个参数 $attributes，该参数将自动提供给闭包，并将包含模型的所有当前属性的数组：

php

use App\Support\Address;
use Illuminate\Database\Eloquent\Casts\Attribute;

/**
 * 与用户的地址交互。
 */
protected function address(): Attribute
{
    return Attribute::make(
        get: fn (mixed $value, array $attributes) => new Address(
            $attributes['address_line_one'],
            $attributes['address_line_two'],
        ),
    );
}

访问器缓存

当从访问器返回值对象时，对值对象所做的任何更改将在模型保存之前自动同步回模型。这是可能的，因为 Eloquent 保留了访问器返回的实例，因此每次调用访问器时都可以返回相同的实例：

php

use App\Models\User;

$user = User::find(1);

$user->address->lineOne = 'Updated Address Line 1 Value';
$user->address->lineTwo = 'Updated Address Line 2 Value';

$user->save();

然而，您有时可能希望为字符串和布尔值等原始值启用缓存，特别是如果它们计算密集。为此，您可以在定义访问器时调用 shouldCache 方法：

php

protected function hash(): Attribute
{
    return Attribute::make(
        get: fn (string $value) => bcrypt(gzuncompress($value)),
    )->shouldCache();
}

如果您希望禁用属性的对象缓存行为，可以在定义属性时调用 withoutObjectCaching 方法：

php

/**
 * 与用户的地址交互。
 */
protected function address(): Attribute
{
    return Attribute::make(
        get: fn (mixed $value, array $attributes) => new Address(
            $attributes['address_line_one'],
            $attributes['address_line_two'],
        ),
    )->withoutObjectCaching();
}

定义变换器

变换器在设置 Eloquent 属性值时进行转换。要定义变换器，您可以在定义属性时提供 set 参数。让我们为 first_name 属性定义一个变换器。当我们尝试在模型上设置 first_name 属性的值时，此变换器将自动调用：

php

<?php

namespace App\Models;

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

class User extends Model
{
    /**
     * 与用户的名字交互。
     */
    protected function firstName(): Attribute
    {
        return Attribute::make(
            get: fn (string $value) => ucfirst($value),
            set: fn (string $value) => strtolower($value),
        );
    }
}

变换器闭包将接收正在设置在属性上的值，允许您操作该值并返回操作后的值。要使用我们的变换器，我们只需在 Eloquent 模型上设置 first_name 属性：

php

use App\Models\User;

$user = User::find(1);

$user->first_name = 'Sally';

在此示例中，set 回调将以值 Sally 调用。变换器将对名称应用 strtolower 函数，并在模型的内部 $attributes 数组中设置其结果值。

变换多个属性

有时，您的变换器可能需要在基础模型上设置多个属性。为此，您可以从 set 闭包返回一个数组。数组中的每个键应与模型关联的基础属性/数据库列相对应：

php

use App\Support\Address;
use Illuminate\Database\Eloquent\Casts\Attribute;

/**
 * 与用户的地址交互。
 */
protected function address(): Attribute
{
    return Attribute::make(
        get: fn (mixed $value, array $attributes) => new Address(
            $attributes['address_line_one'],
            $attributes['address_line_two'],
        ),
        set: fn (Address $value) => [
            'address_line_one' => $value->lineOne,
            'address_line_two' => $value->lineTwo,
        ],
    );
}

属性类型转换

属性类型转换提供了类似于访问器和变换器的功能，而无需在模型上定义任何额外的方法。相反，模型的 $casts 属性提供了一种方便的方法来将属性转换为常见数据类型。

$casts 属性应为一个数组，其中键是要转换的属性的名称，值是您希望将列转换为的类型。支持的转换类型有：

array
AsStringable::class
boolean
collection
date
datetime
immutable_date
immutable_datetime
decimal:<precision>
double
encrypted
encrypted:array
encrypted:collection
encrypted:object
float
hashed
integer
object
real
string
timestamp

为了演示属性类型转换，让我们将 is_admin 属性（在数据库中存储为整数 0 或 1）转换为布尔值：

php

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * 应转换的属性。
     *
     * @var array
     */
    protected $casts = [
        'is_admin' => 'boolean',
    ];
}

定义转换后，即使基础值在数据库中存储为整数，is_admin 属性在访问时也将始终转换为布尔值：

php

$user = App\Models\User::find(1);

if ($user->is_admin) {
    // ...
}

如果您需要在运行时添加新的临时转换，可以使用 mergeCasts 方法。这些转换定义将添加到模型上已定义的任何转换中：

php

$user->mergeCasts([
    'is_admin' => 'integer',
    'options' => 'object',
]);

为 null 的属性将不会被转换。此外，您不应定义与关系同名的转换（或属性），也不应将转换分配给模型的主键。

Stringable 转换

您可以使用 Illuminate\Database\Eloquent\Casts\AsStringable 转换类将模型属性转换为流畅的 Illuminate\Support\Stringable 对象：

php

<?php

namespace App\Models;

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

class User extends Model
{
    /**
     * 应转换的属性。
     *
     * @var array
     */
    protected $casts = [
        'directory' => AsStringable::class,
    ];
}

数组和 JSON 转换

array 转换在处理存储为序列化 JSON 的列时特别有用。例如，如果您的数据库有一个 JSON 或 TEXT 字段类型，其中包含序列化的 JSON，向该属性添加 array 转换将在您访问 Eloquent 模型上的属性时自动将其反序列化为 PHP 数组：

php

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * 应转换的属性。
     *
     * @var array
     */
    protected $casts = [
        'options' => 'array',
    ];
}

一旦定义了转换，您可以访问 options 属性，它将自动从 JSON 反序列化为 PHP 数组。当您设置 options 属性的值时，给定的数组将自动序列化回 JSON 以进行存储：

php

use App\Models\User;

$user = User::find(1);

$options = $user->options;

$options['key'] = 'value';

$user->options = $options;

$user->save();

要使用更简洁的语法更新 JSON 属性的单个字段，您可以使属性可批量分配并在调用 update 方法时使用 -> 操作符：

php

$user = User::find(1);

$user->update(['options->key' => 'value']);

数组对象和集合转换

虽然标准的 array 转换对于许多应用程序来说已经足够，但它确实有一些缺点。由于 array 转换返回的是原始类型，因此无法直接修改数组的偏移量。例如，以下代码将触发 PHP 错误：

php

$user = User::find(1);

$user->options['key'] = $value;

为了解决这个问题，Laravel 提供了一个 AsArrayObject 转换，它将您的 JSON 属性转换为 ArrayObject 类。此功能是使用 Laravel 的自定义转换实现的，允许 Laravel 智能地缓存和转换变换后的对象，以便可以修改单个偏移量而不会触发 PHP 错误。要使用 AsArrayObject 转换，只需将其分配给一个属性：

php

use Illuminate\Database\Eloquent\Casts\AsArrayObject;

/**
 * 应转换的属性。
 *
 * @var array
 */
protected $casts = [
    'options' => AsArrayObject::class,
];

类似地，Laravel 提供了一个 AsCollection 转换，它将您的 JSON 属性转换为 Laravel Collection 实例：

php

use Illuminate\Database\Eloquent\Casts\AsCollection;

/**
 * 应转换的属性。
 *
 * @var array
 */
protected $casts = [
    'options' => AsCollection::class,
];

如果您希望 AsCollection 转换实例化自定义集合类而不是 Laravel 的基础集合类，可以将集合类名称作为转换参数提供：

php

use App\Collections\OptionCollection;
use Illuminate\Database\Eloquent\Casts\AsCollection;

/**
 * 应转换的属性。
 *
 * @var array
 */
protected $casts = [
    'options' => AsCollection::class.':'.OptionCollection::class,
];

日期转换

默认情况下，Eloquent 会将 created_at 和 updated_at 列转换为 Carbon 实例，Carbon 扩展了 PHP 的 DateTime 类，并提供了一系列有用的方法。您可以通过在模型的 $casts 属性数组中定义额外的日期转换来转换其他日期属性。通常，日期应使用 datetime 或 immutable_datetime 转换类型进行转换。

在定义 date 或 datetime 转换时，您还可以指定日期的格式。此格式将在模型序列化为数组或 JSON 时使用：

php

/**
 * 应转换的属性。
 *
 * @var array
 */
protected $casts = [
    'created_at' => 'datetime:Y-m-d',
];

当列被转换为日期时，您可以将相应的模型属性值设置为 UNIX 时间戳、日期字符串（Y-m-d）、日期时间字符串或 DateTime / Carbon 实例。日期的值将被正确转换并存储在您的数据库中。

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

php

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

要指定在数据库中实际存储模型日期时应使用的格式，您应在模型上定义 $dateFormat 属性：

php

/**
 * 模型日期列的存储格式。
 *
 * @var string
 */
protected $dateFormat = 'U';

日期转换、序列化和时区

默认情况下，date 和 datetime 转换将在序列化日期时使用 UTC ISO-8601 日期字符串（YYYY-MM-DDTHH:MM:SS.uuuuuuZ），无论您应用程序的 timezone 配置选项中指定的时区如何。强烈建议您始终使用此序列化格式，并通过不更改应用程序的 timezone 配置选项的默认 UTC 值来将应用程序的日期存储在 UTC 时区中。在整个应用程序中一致使用 UTC 时区将提供与其他用 PHP 和 JavaScript 编写的日期操作库的最大互操作性。

如果对 date 或 datetime 转换应用了自定义格式，例如 datetime:Y-m-d H:i:s，则在日期序列化期间将使用 Carbon 实例的内部时区。通常，这将是您应用程序的 timezone 配置选项中指定的时区。

枚举转换

Eloquent 还允许您将属性值转换为 PHP 枚举。为此，您可以在模型的 $casts 属性数组中指定要转换的属性和枚举：

php

use App\Enums\ServerStatus;

/**
 * 应转换的属性。
 *
 * @var array
 */
protected $casts = [
    'status' => ServerStatus::class,
];

一旦在模型上定义了转换，指定的属性将在您与属性交互时自动转换为枚举并从枚举转换：

php

if ($server->status == ServerStatus::Provisioned) {
    $server->status = ServerStatus::Ready;

    $server->save();
}

转换枚举数组

有时，您可能需要模型在单个列中存储枚举值数组。为此，您可以使用 Laravel 提供的 AsEnumArrayObject 或 AsEnumCollection 转换：

php

use App\Enums\ServerStatus;
use Illuminate\Database\Eloquent\Casts\AsEnumCollection;

/**
 * 应转换的属性。
 *
 * @var array
 */
protected $casts = [
    'statuses' => AsEnumCollection::class.':'.ServerStatus::class,
];

加密转换

encrypted 转换将使用 Laravel 的内置加密功能加密模型的属性值。此外，encrypted:array、encrypted:collection、encrypted:object、AsEncryptedArrayObject 和 AsEncryptedCollection 转换的工作方式与其未加密的对应物相同；然而，正如您可能预期的那样，底层值在存储在数据库中时是加密的。

由于加密文本的最终长度不可预测，并且比其明文对应物长，请确保关联的数据库列为 TEXT 类型或更大。此外，由于值在数据库中是加密的，您将无法查询或搜索加密的属性值。

密钥轮换

如您所知，Laravel 使用应用程序的 app 配置文件中指定的 key 配置值加密字符串。通常，此值对应于 APP_KEY 环境变量的值。如果您需要轮换应用程序的加密密钥，您将需要使用新密钥手动重新加密加密的属性。

查询时转换

有时，您可能需要在执行查询时应用转换，例如在从表中选择原始值时。例如，考虑以下查询：

php

use App\Models\Post;
use App\Models\User;

$users = User::select([
    'users.*',
    'last_posted_at' => Post::selectRaw('MAX(created_at)')
            ->whereColumn('user_id', 'users.id')
])->get();

此查询结果中的 last_posted_at 属性将是一个简单的字符串。如果我们可以在执行查询时对该属性应用 datetime 转换，那将是很棒的。幸运的是，我们可以使用 withCasts 方法来实现这一点：

php

$users = User::select([
    'users.*',
    'last_posted_at' => Post::selectRaw('MAX(created_at)')
            ->whereColumn('user_id', 'users.id')
])->withCasts([
    'last_posted_at' => 'datetime'
])->get();

自定义转换

Laravel 有多种内置的、有用的转换类型；然而，您可能偶尔需要定义自己的转换类型。要创建转换，请执行 make:cast Artisan 命令。新转换类将放置在您的 app/Casts 目录中：

shell

php artisan make:cast Json

所有自定义转换类都实现 CastsAttributes 接口。实现此接口的类必须定义 get 和 set 方法。get 方法负责将数据库中的原始值转换为转换值，而 set 方法应将转换值转换为可以存储在数据库中的原始值。作为示例，我们将重新实现内置的 json 转换类型作为自定义转换类型：

php

<?php

namespace App\Casts;

use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
use Illuminate\Database\Eloquent\Model;

class Json implements CastsAttributes
{
    /**
     * 转换给定的值。
     *
     * @param  array<string, mixed>  $attributes
     * @return array<string, mixed>
     */
    public function get(Model $model, string $key, mixed $value, array $attributes): array
    {
        return json_decode($value, true);
    }

    /**
     * 准备给定的值以进行存储。
     *
     * @param  array<string, mixed>  $attributes
     */
    public function set(Model $model, string $key, mixed $value, array $attributes): string
    {
        return json_encode($value);
    }
}

一旦定义了自定义转换类型，您可以使用其类名将其附加到模型属性：

php

<?php

namespace App\Models;

use App\Casts\Json;
use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * 应转换的属性。
     *
     * @var array
     */
    protected $casts = [
        'options' => Json::class,
    ];
}

值对象转换

您不仅限于将值转换为原始类型。您还可以将值转换为对象。定义将值转换为对象的自定义转换与转换为原始类型非常相似；然而，set 方法应返回一个键/值对数组，这些键/值对将用于在模型上设置原始、可存储的值。

作为示例，我们将定义一个自定义转换类，该类将多个模型值转换为单个 Address 值对象。我们将假设 Address 值有两个公共属性：lineOne 和 lineTwo：

php

<?php

namespace App\Casts;

use App\ValueObjects\Address as AddressValueObject;
use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
use Illuminate\Database\Eloquent\Model;
use InvalidArgumentException;

class Address implements CastsAttributes
{
    /**
     * 转换给定的值。
     *
     * @param  array<string, mixed>  $attributes
     */
    public function get(Model $model, string $key, mixed $value, array $attributes): AddressValueObject
    {
        return new AddressValueObject(
            $attributes['address_line_one'],
            $attributes['address_line_two']
        );
    }

    /**
     * 准备给定的值以进行存储。
     *
     * @param  array<string, mixed>  $attributes
     * @return array<string, string>
     */
    public function set(Model $model, string $key, mixed $value, array $attributes): array
    {
        if (! $value instanceof AddressValueObject) {
            throw new InvalidArgumentException('The given value is not an Address instance.');
        }

        return [
            'address_line_one' => $value->lineOne,
            'address_line_two' => $value->lineTwo,
        ];
    }
}

在转换为值对象时，对值对象所做的任何更改将在模型保存之前自动同步回模型：

php

use App\Models\User;

$user = User::find(1);

$user->address->lineOne = 'Updated Address Value';

$user->save();

如果您计划将包含值对象的 Eloquent 模型序列化为 JSON 或数组，您应在值对象上实现 Illuminate\Contracts\Support\Arrayable 和 JsonSerializable 接口。

值对象缓存

当解析为值对象的属性时，它们会被 Eloquent 缓存。因此，如果再次访问该属性，将返回相同的对象实例。

如果您希望禁用自定义转换类的对象缓存行为，可以在自定义转换类上声明一个公共 withoutObjectCaching 属性：

php

class Address implements CastsAttributes
{
    public bool $withoutObjectCaching = true;

    // ...
}

数组/JSON 序列化

当 Eloquent 模型使用 toArray 和 toJson 方法转换为数组或 JSON 时，您的自定义转换值对象通常也会被序列化，只要它们实现 Illuminate\Contracts\Support\Arrayable 和 JsonSerializable 接口。然而，当使用第三方库提供的值对象时，您可能无法将这些接口添加到对象中。

因此，您可以指定自定义转换类将负责序列化值对象。为此，您的自定义转换类应实现 Illuminate\Contracts\Database\Eloquent\SerializesCastableAttributes 接口。此接口声明您的类应包含一个 serialize 方法，该方法应返回值对象的序列化形式：

php

/**
 * 获取值的序列化表示。
 *
 * @param  array<string, mixed>  $attributes
 */
public function serialize(Model $model, string $key, mixed $value, array $attributes): string
{
    return (string) $value;
}

入站转换

有时，您可能需要编写一个仅转换设置在模型上的值的自定义转换类，而不对从模型中检索的属性执行任何操作。

仅入站的自定义转换应实现 CastsInboundAttributes 接口，该接口仅要求定义一个 set 方法。可以使用 --inbound 选项调用 make:cast Artisan 命令以生成仅入站的转换类：

shell

php artisan make:cast Hash --inbound

仅入站转换的经典示例是“哈希”转换。例如，我们可以定义一个通过给定算法对入站值进行哈希的转换：

php

<?php

namespace App\Casts;

use Illuminate\Contracts\Database\Eloquent\CastsInboundAttributes;
use Illuminate\Database\Eloquent\Model;

class Hash implements CastsInboundAttributes
{
    /**
     * 创建一个新的转换类实例。
     */
    public function __construct(
        protected string|null $algorithm = null,
    ) {}

    /**
     * 准备给定的值以进行存储。
     *
     * @param  array<string, mixed>  $attributes
     */
    public function set(Model $model, string $key, mixed $value, array $attributes): string
    {
        return is_null($this->algorithm)
                    ? bcrypt($value)
                    : hash($this->algorithm, $value);
    }
}

转换参数

在将自定义转换附加到模型时，可以通过使用 : 字符分隔类名并用逗号分隔多个参数来指定转换参数。参数将传递给转换类的构造函数：

php

/**
 * 应转换的属性。
 *
 * @var array
 */
protected $casts = [
    'secret' => Hash::class.':sha256',
];

可转换对象

您可能希望允许应用程序的值对象定义自己的自定义转换类。与其将自定义转换类附加到模型，您可以选择附加一个实现 Illuminate\Contracts\Database\Eloquent\Castable 接口的值对象类：

php

use App\ValueObjects\Address;

protected $casts = [
    'address' => Address::class,
];

实现 Castable 接口的对象必须定义一个 castUsing 方法，该方法返回负责从 Castable 类进行转换的自定义转换类的类名：

php

<?php

namespace App\ValueObjects;

use Illuminate\Contracts\Database\Eloquent\Castable;
use App\Casts\Address as AddressCast;

class Address implements Castable
{
    /**
     * 获取从/到此转换目标进行转换时要使用的转换类的名称。
     *
     * @param  array<string, mixed>  $arguments
     */
    public static function castUsing(array $arguments): string
    {
        return AddressCast::class;
    }
}

在使用 Castable 类时，您仍然可以在 $casts 定义中提供参数。参数将传递给 castUsing 方法：

php

use App\ValueObjects\Address;

protected $casts = [
    'address' => Address::class.':argument',
];

可转换对象与匿名转换类

通过将“可转换对象”与 PHP 的匿名类结合使用，您可以将值对象及其转换逻辑定义为单个可转换对象。为此，从值对象的 castUsing 方法返回一个匿名类。匿名类应实现 CastsAttributes 接口：

php

<?php

namespace App\ValueObjects;

use Illuminate\Contracts\Database\Eloquent\Castable;
use Illuminate\Contracts\Database\Eloquent\CastsAttributes;

class Address implements Castable
{
    // ...

    /**
     * 获取从/到此转换目标进行转换时要使用的转换类。
     *
     * @param  array<string, mixed>  $arguments
     */
    public static function castUsing(array $arguments): CastsAttributes
    {
        return new class implements CastsAttributes
        {
            public function get(Model $model, string $key, mixed $value, array $attributes): Address
            {
                return new Address(
                    $attributes['address_line_one'],
                    $attributes['address_line_two']
                );
            }

            public function set(Model $model, string $key, mixed $value, array $attributes): array
            {
                return [
                    'address_line_one' => $value->lineOne,
                    'address_line_two' => $value->lineTwo,
                ];
            }
        };
    }
}

Eloquent: 变换器与类型转换 ​

介绍 ​

访问器和变换器 ​

定义访问器 ​

从多个属性构建值对象 ​

访问器缓存 ​

定义变换器 ​

变换多个属性 ​

属性类型转换 ​

Stringable 转换 ​

数组和 JSON 转换 ​

数组对象和集合转换 ​

日期转换 ​

日期转换、序列化和时区 ​

枚举转换 ​

转换枚举数组 ​

加密转换 ​

密钥轮换 ​

查询时转换 ​

自定义转换 ​

值对象转换 ​

值对象缓存 ​

数组/JSON 序列化 ​

入站转换 ​

转换参数 ​

可转换对象 ​

可转换对象与匿名转换类 ​

Eloquent: 变换器与类型转换

介绍

访问器和变换器

定义访问器

从多个属性构建值对象

访问器缓存

定义变换器

变换多个属性

属性类型转换

Stringable 转换

数组和 JSON 转换

数组对象和集合转换

日期转换

日期转换、序列化和时区

枚举转换

转换枚举数组

加密转换

密钥轮换

查询时转换

自定义转换

值对象转换

值对象缓存

数组/JSON 序列化

入站转换

转换参数

可转换对象

可转换对象与匿名转换类