如何在Laravel框架中基于MySQL表字段生成对应Excel模板

1. 依赖安装 #

使用社区主流的Laravel Excel扩展处理Excel生成，执行以下命令安装：
composer require maatwebsite/excel
默认配置即可覆盖绝大多数使用场景，如有自定义需求可执行php artisan vendor:publish --provider="Maatwebsite\Excel\ExcelServiceProvider"发布配置文件自行修改。

2. 创建导出类 #

执行Artisan命令生成导出类文件：
php artisan make:export TableTemplateExport
修改生成的app/Exports/TableTemplateExport.php文件内容：

<?php
namespace App\Exports;
use Maatwebsite\Excel\Concerns\FromCollection;
use Maatwebsite\Excel\Concerns\WithHeadings;
use Illuminate\Support\Facades\Schema;
class TableTemplateExport implements FromCollection, WithHeadings
{
    protected $tableName;
    // 构造方法传入要生成模板的表名
    public function __construct(string $tableName)
    {
        $this->tableName = $tableName;
    }
    // 表头直接使用数据库表字段
    public function headings(): array
    {
        // 获取指定表的全量字段列表
        $columns = Schema::getColumnListing($this->tableName);
        // 不需要的字段可以在这里过滤，比如排除主键、系统时间戳字段
        // return array_filter($columns, fn($col) => !in_array($col, ['id', 'created_at', 'updated_at', 'deleted_at']));
        return $columns;
    }
    // 模板仅需表头的话返回空集合即可，需要示例行可在这里返回对应格式的数组
    public function collection()
    {
        return collect([]);
    }
}

3. 新增下载逻辑 #

在控制器中添加模板下载方法：

<?php
namespace App\Http\Controllers;
use App\Exports\TableTemplateExport;
use Maatwebsite\Excel\Facades\Excel;
class ExcelTemplateController extends Controller
{
    public function download()
    {
        // 替换为实际需要生成模板的表名，也可以通过请求参数动态传入
        $targetTable = 'users';
        return Excel::download(new TableTemplateExport($targetTable), $targetTable . '_导入模板.xlsx');
    }
}

在路由文件中添加访问入口：
Route::get('/excel-template/download', [ExcelTemplateController::class, 'download']);

可选扩展配置 #

• 要使用字段注释作为表头时，可以替换headings方法的逻辑，执行DB::select("SHOW FULL COLUMNS FROM {$this->tableName}")即可获取每个字段的注释信息，自行组装返回即可
• 可在collection方法中返回一行示例数据，提示用户各字段的填写规范
• 多表动态生成的场景可以把表名作为请求参数传入，注意做好权限校验，避免泄露敏感表结构

内容的提问来源于stack exchange，提问作者neliza