0

0

Laravel Eloquent:优雅地将关联模型字段扁平化到主模型中

聖光之護

聖光之護

发布时间:2025-12-31 21:34:31

|

357人浏览过

|

来源于php中文网

原创

Laravel Eloquent:优雅地将关联模型字段扁平化到主模型中

本文介绍如何在 laravel 中不使用循环的前提下,将 `with()` 预加载的关联模型(如 `role`)的字段(如 `role_name`、`role_category`)直接“展开”到主模型(如 `user`)的数组/json 输出中,实现字段扁平化。

在 Laravel 开发中,我们常通过 ->with('relation') 预加载关联数据以避免 N+1 查询。但默认情况下,关联模型会以嵌套对象(如 "role": { ... })形式存在,而实际 API 或前端渲染往往需要扁平化结构——即把 role.role_name 直接提升为 role_name 字段,与用户自身字段同级。手动 foreach 拼接不仅冗余,还违背 Eloquent 的声明式设计哲学。

幸运的是,Laravel 提供了更优雅、可复用且符合框架约定的解决方案:访问器(Accessors) + 序列化追加(Appends)

✅ 推荐方案:使用 Eloquent 访问器 + $appends

在 App\Models\User 模型中,定义访问器来动态暴露关联字段,并通过 $appends 声明其为“可序列化属性”:

// app/Models/User.php
namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    // 声明需自动包含在 toArray() / toJson() 中的访问器
    protected $appends = [
        'role_name',
        'role_category',
    ];

    // 定义访问器:返回预加载的 role 关联中的字段
    public function getRoleNameAttribute()
    {
        return $this->relationLoaded('role') 
            ? $this->role->role_name 
            : null;
    }

    public function getRoleCategoryAttribute()
    {
        return $this->relationLoaded('role') 
            ? $this->role->role_category 
            : null;
    }
}
⚠️ 注意:$this->relationLoaded('role') 是关键防护——它确保仅在 ->with('role') 已执行时才读取关联属性,避免未加载时触发懒加载或报错。

随后,你的原始查询无需任何改动,只需确保调用了 ->with('role'):

$users = User::where('active', 1)
    ->whereHas('role', function ($query) use ($column, $role) {
        $query->where("role_{$column}", $role);
    })
    ->with('role:id,role_name,role_category') // 只加载必要字段,提升性能
    ->orderBy('users.id')
    ->get([
        'id',
        'email',
        'phone_number',
        'id_role',
        'firstname',
        'lastname',
        'verified',
        'active',
        'id_configuration',
        'external_service_id',
    ]);

// 直接转数组,role_name 和 role_category 已自动扁平化
return response()->json($users);

输出即为你期望的格式:

红墨
红墨

一站式小红书图文生成器

下载
[{
  "id": 968,
  "email": "user@example.com",
  "phone_number": "123",
  "id_role": 4,
  "firstname": "Name",
  "lastname": "TEST User",
  "verified": 0,
  "active": 1,
  "id_configuration": 1,
  "external_service_id": 123,
  "role_name": "Admin",
  "role_category": "Company"
}]

? 替代方案:运行时动态追加(按需使用)

若该扁平化行为并非全局需求(例如仅在某个 API 接口需要),可避免污染模型 $appends,改用 append() 方法动态添加:

return $users->map(function ($user) {
    return $user->append(['role_name', 'role_category'])->toArray();
});

或在单个模型上:

$user->append(['role_name', 'role_category'])->toArray();

? 注意事项与最佳实践

  • 性能意识:始终搭配 ->with('relation:col1,col2') 指定字段,避免加载整张关联表。
  • 空值安全:访问器中务必检查 relationLoaded(),防止未预加载时意外触发查询或抛出 Trying to get property on null。
  • 命名规范:访问器名(如 getRoleNameAttribute)对应属性名 role_name(驼峰转蛇形),Laravel 自动识别。
  • 不推荐 flatten() 或 map() 处理:Collection 的 flatten() 用于降维嵌套数组,不适用于对象属性提取;map() 虽可行但丧失模型层语义,且无法复用。

通过访问器与 $appends 的组合,你既保持了代码的可维护性与复用性,又实现了零循环、高性能、符合 Laravel 约定的扁平化输出——这才是真正的“Laravel 方式”。

相关专题

更多
laravel组件介绍
laravel组件介绍

laravel 提供了丰富的组件,包括身份验证、模板引擎、缓存、命令行工具、数据库交互、对象关系映射器、事件处理、文件操作、电子邮件发送、队列管理和数据验证。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

313

2024.04.09

laravel中间件介绍
laravel中间件介绍

laravel 中间件分为五种类型:全局、路由、组、终止和自定。想了解更多laravel中间件的相关内容,可以阅读本专题下面的文章。

270

2024.04.09

laravel使用的设计模式有哪些
laravel使用的设计模式有哪些

laravel使用的设计模式有:1、单例模式;2、工厂方法模式;3、建造者模式;4、适配器模式;5、装饰器模式;6、策略模式;7、观察者模式。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

363

2024.04.09

thinkphp和laravel哪个简单
thinkphp和laravel哪个简单

对于初学者来说,laravel 的入门门槛较低,更易上手,原因包括:1. 更简单的安装和配置;2. 丰富的文档和社区支持;3. 简洁易懂的语法和 api;4. 平缓的学习曲线。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

363

2024.04.10

laravel入门教程
laravel入门教程

本专题整合了laravel入门教程,想了解更多详细内容,请阅读专题下面的文章。

80

2025.08.05

laravel实战教程
laravel实战教程

本专题整合了laravel实战教程,阅读专题下面的文章了解更多详细内容。

63

2025.08.05

laravel面试题
laravel面试题

本专题整合了laravel面试题相关内容,阅读专题下面的文章了解更多详细内容。

62

2025.08.05

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

403

2023.08.07

php源码安装教程大全
php源码安装教程大全

本专题整合了php源码安装教程,阅读专题下面的文章了解更多详细内容。

7

2025.12.31

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PHP课程
PHP课程

共137课时 | 8.1万人学习

JavaScript ES5基础线上课程教学
JavaScript ES5基础线上课程教学

共6课时 | 6.9万人学习

PHP新手语法线上课程教学
PHP新手语法线上课程教学

共13课时 | 0.8万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号