使用spatie/laravel-data将请求数据转换为数据对象-CSDN博客

使用spatie/laravel-data将请求数据转换为数据对象

在Laravel开发中，处理请求数据并将其转换为结构化对象是一个常见需求。spatie/laravel-data包提供了一种优雅的方式来实现这一过程，本文将详细介绍如何利用该包将HTTP请求数据自动转换为数据对象。

基本用法

首先，我们需要定义一个继承自Data类的数据对象。例如，我们创建一个表示歌曲信息的SongData类：

class SongData extends Data
{
    public function __construct(
        public string $title,
        public string $artist,
    ) {
    }
}

当客户端发送一个包含title和artist字段的POST请求时，我们可以直接在控制器方法中注入这个SongData类：

class UpdateSongController
{
    public function __invoke(
        Song $model,
        SongData $data
    ){
        $model->update($data->all());
        
        return redirect()->back();
    }
}

这种方式的优势在于：

自动将请求数据映射到数据对象
内置数据验证功能
代码更加清晰和类型安全

验证机制

spatie/laravel-data会自动为数据对象生成验证规则。如果请求数据不符合要求，会抛出ValidationException异常，就像你手动定义了验证规则一样。

你也可以显式地从请求对象创建数据对象：

class UpdateSongController
{
    public function __invoke(
        Song $model,
        SongRequest $request
    ){
        $model->update(SongData::from($request)->all());
        
        return redirect()->back();
    }
}

全局解析数据对象

在任何地方，你都可以通过Laravel的服务容器来解析一个已经填充了请求数据的数据对象：

app(SongData::class);

这种方式同样会触发验证机制，确保数据的完整性。

处理数据对象集合

spatie/laravel-data还支持处理嵌套的数据对象集合。例如，我们可以定义一个专辑数据对象，其中包含多首歌曲：

class AlbumData extends Data
{
    public function __construct(
        public string $title,
        #[DataCollectionOf(SongData::class)]
        public DataCollection $songs,
    ) {
    }
}

对于这样的结构，包会自动为集合中的每个元素应用相应的验证规则。上述AlbumData类生成的验证规则会包含：

[
    'title' => ['required', 'string'],
    'songs' => ['required', 'array'],
    'songs.*.title' => ['required', 'string'],
    'songs.*.artist' => ['required', 'string'],
]