Laravel Castable Data Transfer Object 使用教程-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00718/article/details/142009054

Laravel Castable Data Transfer Object 使用教程

laravel-castable-data-transfer-objectAutomatically cast JSON columns to rich PHP objects in Laravel using Spatie's data-transfer-object class项目地址:https://gitcode.com/gh_mirrors/la/laravel-castable-data-transfer-object

1、项目介绍

Laravel Castable Data Transfer Object 是一个用于 Laravel 框架的开源包，它允许你将数据库中的 JSON 列自动转换为丰富的 PHP 对象。这个包扩展了 Spatie 的 Data Transfer Object (DTO) 类，并实现了 Laravel 的 Castable 接口。通过这个包，你可以轻松地将 JSON 数据转换为 PHP 对象，并在数据库和应用程序之间进行序列化和反序列化。

2、项目快速启动

安装

首先，你需要通过 Composer 安装这个包：

composer require jessarcher/laravel-castable-data-transfer-object

使用

1. 创建 CastableDataTransferObject

你可以创建一个继承自 CastableDataTransferObject 的类，并定义你的属性。例如：

namespace App\Values;

use JessArcher\CastableDataTransferObject\CastableDataTransferObject;

class Address extends CastableDataTransferObject
{
    public string $street;
    public string $suburb;
    public string $state;
}

2. 配置 Eloquent 模型

在你的 Eloquent 模型中，配置相应的属性以使用这个 CastableDataTransferObject：

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use App\Values\Address;

class User extends Model
{
    protected $casts = [
        'address' => Address::class,
    ];
}

确保你的数据库列是 json 或 jsonb 类型。

3、应用案例和最佳实践

应用案例

假设你有一个用户模型，其中包含一个 address 字段，该字段存储用户的地址信息。你可以使用 CastableDataTransferObject 将这个 JSON 字段转换为一个 Address 对象，从而在代码中更方便地操作地址信息。

$user = User::find(1);
echo $user->address->street; // 输出街道信息
echo $user->address->suburb; // 输出郊区信息
echo $user->address->state;  // 输出州信息

最佳实践

命名空间：建议将 CastableDataTransferObject 类放在 App\Values 命名空间下，以便于管理和区分。
默认值：可以在 CastableDataTransferObject 类中为属性设置默认值，以避免未定义的属性错误。
序列化控制：通过 CastUsingJsonFlags 属性，你可以控制 JSON 序列化的行为，例如保留小数点后的零。

4、典型生态项目

Spatie Data Transfer Object

Spatie Data Transfer Object 是 Laravel Castable Data Transfer Object 的基础包。它提供了一个简单的方式来创建和使用数据传输对象，而 Laravel Castable Data Transfer Object 在此基础上增加了与 Laravel 的集成，使得在 Eloquent 模型中使用 DTO 变得更加方便。