如何在 Laravel Excel 中导出关联数据(如用户姓名)

云静酱_4498

云静酱_4498

2026-06-28

957人浏览

原创

如何在 Laravel Excel 中导出关联数据(如用户姓名)

本文详解如何使用 Laravel Excel(Maatwebsite/Excel)导出含关联模型(如 Attendance 关联 User)的 Excel 表格,通过 with() 预加载 + map() 方法优雅拼接关系字段,避免 N+1 查询,实现类似 SQL JOIN 的效果。

本文详解如何使用 laravel excel(maatwebsite/excel)导出含关联模型(如 attendance 关联 user)的 excel 表格,通过 `with()` 预加载 + `map()` 方法优雅拼接关系字段,避免 n+1 查询,实现类似 sql join 的效果。

在 Laravel 中使用 Maatwebsite/Laravel-Excel 导出数据时,若仅调用 Attendance::all(),默认只会导出 attendances 表的原始字段,无法显示关联的用户姓名(users.name)或状态中文描述(如 'Check In'/'Check Out')。要实现类似原生 SQL JOIN 的效果(如 SELECT ... FROM attendances INNER JOIN users ON ...),关键在于预加载关联关系并在导出映射阶段手动组装字段,而非依赖原始查询。

✅ 正确做法:预加载 + 映射转换

首先,确保 Attendance 模型正确定义了与 User 的关联关系:

// app/Models/Attendance.php
public function user()
{
    return $this->belongsTo(User::class, 'user_id'); // 显式指定外键(可选,默认为 user_id)
}

接着,在 Excel 导出类(如 AttendanceExport)中,必须使用 with('user') 预加载,否则 $row->user 会触发延迟加载(N+1 问题),极大降低性能:

excel-clean
excel-clean

Excel 数据清洗——去重、填补缺失值、格式转换。

下载
// app/Exports/AttendanceExport.php
<?php namespace App\Exports;

use App\Models\Attendance;
use Maatwebsite\Excel\Concerns\FromCollection;
use Maatwebsite\Excel\Concerns\WithHeadings;
use Maatwebsite\Excel\Concerns\WithMapping;

class AttendanceExport implements FromCollection, WithHeadings, WithMapping
{
    public function collection()
    {
        // ✅ 关键:预加载 user 关系,避免循环中多次查询
        return Attendance::with('user')->get();
    }

    public function map($attendance): array
    {
        // ✅ 将 status 数字转为可读文本,并安全访问关联模型(防止空用户)
        $statusText = $attendance->status == 0 ? 'Check In' : 'Check Out';
        $userName = $attendance->user?->name ?? 'Unknown';

        return [
            $attendance->id,
            $userName,
            $statusText,
            $attendance->created_at,
            $attendance->updated_at,
        ];
    }

    public function headings(): array
    {
        return [
            'ID',
            'User Name',
            'Status',
            'Created At',
            'Updated At',
        ];
    }
}

? 为什么不用 Attendance::all()?
Attendance::all() 不支持关联预加载;而 Attendance::with('user')->get() 会在单次查询中获取所有 attendance 记录,并额外执行 1 次 JOIN 查询 获取全部关联用户,效率远高于在 map() 中逐条访问 $attendance->user(那将触发 N 次独立查询)。

? 常见错误规避

  • ❌ 错误:在 collection() 中直接写 Attendance::all(),再于 map() 中访问 $row->user->name → 触发 N+1 查询,导出慢且易超时。
  • ❌ 错误:未处理关联模型为空(如 user_id 为 null 或用户被删除)→ $row->user->name 报 Trying to get property 'name' of non-object。应使用空合并操作符:$row->user?->name ?? 'N/A'。
  • ❌ 错误:忽略时区或格式化 → created_at 默认导出为 Carbon 实例,Excel 可能显示为时间戳。如需标准格式,可在 map() 中处理:$attendance->created_at->format('Y-m-d H:i:s')。

✅ 进阶:自定义列标题与样式(可选)

可通过 registerEvents() 添加样式,例如自动调整列宽、设置表头背景色:

use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet;
use Maatwebsite\Excel\Concerns\ShouldAutoSize;
use Maatwebsite\Excel\Concerns\WithEvents;
use Maatwebsite\Excel\Events\AfterSheet;

class AttendanceExport implements FromCollection, WithHeadings, WithMapping, WithEvents, ShouldAutoSize
{
    // ... 其他方法保持不变

    public function registerEvents(): array
    {
        return [
            AfterSheet::class => function(AfterSheet $event) {
                $sheet = $event->sheet->getDelegate();

                // 设置第一行(表头)加粗 & 背景色
                $sheet->getStyle('A1:E1')->applyFromArray([
                    'font' => ['bold' => true],
                    'fill' => [
                        'fillType' => \PhpOffice\PhpSpreadsheet\Style\Fill::FILL_SOLID,
                        'startColor' => ['argb' => 'FF4CAF50'],
                    ],
                ]);

                // 自动列宽(由 ShouldAutoSize 支持)
            },
        ];
    }
}

? 总结

Laravel Excel 导出关联数据的核心逻辑是:
1️⃣ 在 collection() 中用 with('relation') 预加载关联模型;
2️⃣ 在 map() 中安全访问关联属性(配合空值判断),并完成字段转换(如状态映射);
3️⃣ 在 headings() 中对齐列名,确保语义清晰;
4️⃣ 必要时通过 WithEvents 增强导出体验。

这种方式完全替代了手写原生 SQL JOIN,既符合 Laravel 的 Eloquent 风格,又保障性能与可维护性。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

excel laravel

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2023.09.01

10324

6

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

6081

5

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

2095

5

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

2023.10.23

3828

4

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

2023.10.23

4534

6

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.03

3551

9

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.09

5057

8

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.13

3962

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

11922

4

热门下载

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

精品课程

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

共162课时 | 44万人学习

成为PHP架构师-自制PHP框架
成为PHP架构师-自制PHP框架

共28课时 | 3.5万人学习