Laravel多态关联如何序列化

Laravel的多态关联允许一个模型在单个关联中属于多个其他模型，在实际开发中，我们常需要将包含多态关联的数据序列化为数组或JSON格式返回给前端，不同场景下需要不同的序列化策略。

多态关联的基础定义

首先我们定义一个典型的多态关联场景：评论（Comment）可以属于文章（Post）或者视频（Video），评论模型通过多态关联和这两个模型建立联系。

评论模型的关联定义如下：

<?php

namespace AppModels;

use IlluminateDatabaseEloquentModel;
use IlluminateDatabaseEloquentRelationsMorphTo;

class Comment extends Model
{
    // 定义多态关联，commentable是关联方法名
    public function commentable(): MorphTo
    {
        return $this->morphTo();
    }
}

文章模型的定义如下：

<?php

namespace AppModels;

use IlluminateDatabaseEloquentModel;
use IlluminateDatabaseEloquentRelationsMorphMany;

class Post extends Model
{
    // 文章有多个评论
    public function comments(): MorphMany
    {
        return $this->morphMany(Comment::class, 'commentable');
    }
}

视频模型的定义和文章类似：

<?php

namespace AppModels;

use IlluminateDatabaseEloquentModel;
use IlluminateDatabaseEloquentRelationsMorphMany;

class Video extends Model
{
    // 视频有多个评论
    public function comments(): MorphMany
    {
        return $this->morphMany(Comment::class, 'commentable');
    }
}

默认序列化行为

当我们直接调用模型的toArray()或者toJson()方法时，Laravel会自动序列化已加载的多态关联数据。首先我们需要先加载关联数据：

<?php

// 获取id为1的评论，并加载其关联的多态模型
$comment = Comment::with('commentable')->find(1);

// 序列化为数组
$arrayData = $comment->toArray();

// 序列化为JSON
$jsonData = $comment->toJson();

默认序列化后的数组结构会包含commentable字段，字段内容就是关联的Post或者Video模型的数据，同时会自动带上模型的id、created_at等默认字段。

自定义序列化字段

如果默认的序列化字段不符合需求，我们可以通过在模型中定义$visible属性或者serializeDate方法等方式控制输出字段，也可以为多态关联定义专门的序列化逻辑。

比如在Comment模型中，我们只想输出评论内容和关联模型的名称和类型，可以重写toArray方法：

<?php

namespace AppModels;

use IlluminateDatabaseEloquentModel;
use IlluminateDatabaseEloquentRelationsMorphTo;

class Comment extends Model
{
    public function commentable(): MorphTo
    {
        return $this->morphTo();
    }

    // 自定义toArray方法控制序列化输出
    public function toArray()
    {
        $data = parent::toArray();
        // 只保留需要的字段
        $filteredData = [
            'id' => $data['id'],
            'content' => $data['content'],
            'created_at' => $this->created_at->format('Y-m-d H:i:s'),
        ];
        // 如果存在关联的多态模型，处理关联数据
        if ($this->relationLoaded('commentable')) {
            $commentable = $this->commentable;
            $filteredData['commentable_type'] = get_class($commentable);
            $filteredData['commentable_name'] = $commentable->name ?? '未知';
        }
        return $filteredData;
    }
}

处理嵌套多态关联序列化

如果多态关联本身还有其他的关联需要序列化，比如评论的关联模型（Post）还有作者（User）关联，我们可以通过with方法嵌套加载关联，再自定义序列化逻辑处理嵌套数据。

<?php

// 嵌套加载关联：评论->关联模型（Post/Video）->作者
$comment = Comment::with('commentable.author')->find(1);

// 自定义序列化逻辑处理嵌套
$result = [
    'comment_id' => $comment->id,
    'comment_content' => $comment->content,
    'related_info' => function () use ($comment) {
        if ($comment->relationLoaded('commentable')) {
            $related = $comment->commentable;
            $info = [
                'type' => get_class($related),
                'id' => $related->id,
                'title' => $related->title ?? $related->name,
            ];
            // 如果关联模型加载了作者关联
            if ($related->relationLoaded('author')) {
                $info['author_name'] = $related->author->name ?? '未知作者';
            }
            return $info;
        }
        return null;
    }
];

// 执行闭包获取最终数据
$result['related_info'] = $result['related_info']();

使用资源类序列化多态关联

Laravel提供的资源类（Resource）是更规范的序列化方式，我们可以为Comment创建对应的资源类，专门处理多态关联的序列化逻辑。

首先创建Comment资源类：

<?php

namespace AppHttpResources;

use IlluminateHttpRequest;
use IlluminateHttpResourcesJsonJsonResource;

class CommentResource extends JsonResource
{
    public function toArray(Request $request): array
    {
        return [
            'id' => $this->id,
            'content' => $this->content,
            'created_at' => $this->created_at->format('Y-m-d H:i:s'),
            // 处理多态关联数据
            'commentable' => $this->whenLoaded('commentable', function () {
                $commentable = $this->commentable;
                // 根据关联模型类型返回不同结构
                if ($commentable instanceof AppModelsPost) {
                    return [
                        'type' => 'post',
                        'id' => $commentable->id,
                        'title' => $commentable->title,
                        'author' => $commentable->author->name ?? null,
                    ];
                } elseif ($commentable instanceof AppModelsVideo) {
                    return [
                        'type' => 'video',
                        'id' => $commentable->id,
                        'name' => $commentable->name,
                        'duration' => $commentable->duration,
                    ];
                }
                return null;
            }),
        ];
    }
}

在控制器中使用资源类返回数据：

<?php

namespace AppHttpControllers;

use AppHttpResourcesCommentResource;
use AppModelsComment;

class CommentController extends Controller
{
    public function show($id)
    {
        $comment = Comment::with('commentable.author')->findOrFail($id);
        // 使用资源类序列化返回
        return new CommentResource($comment);
    }
}

序列化时的注意事项

• 序列化前需要确保多态关联已经通过with或者load方法加载，否则关联数据不会被序列化输出。
• 如果多态关联的模型存在循环引用，需要在资源类中做好判断，避免序列化时出现无限递归。
• 当关联模型类型较多时，可以在资源类中使用映射数组统一管理不同模型类型的序列化规则，减少重复代码。
• 如果需要对序列化后的数据进行额外处理，可以在资源类的with方法中添加额外的响应数据，或者在控制器中对资源类的输出做二次处理。

Laravel多态关联序列化eloquent_relationship修改时间：2026-06-22 02:15:48