Laravel 多工作表 Excel 导出常见错误排查与正确实现

本文详解 laravel 使用 `maatwebsite/excel` 实现多工作表导出时的典型报错原因(如未实现抽象方法、`query()` 错误调用 `get()`、缺少必需接口方法),并提供完整、可运行的修复方案。

在 Laravel 中通过 maatwebsite/excel(v3.1+)实现多工作表 Excel 导出是一个高频需求,但若未严格遵循接口契约,极易触发 FatalError 或类型错误。你遇到的两个核心报错——

  • Class ... contains 1 abstract method and must therefore be declared abstract...
  • Argument #2 ($format) must be of type string, array given...

——均源于 ReportGeneralExport 类实现了某些接口(如 WithTitle、WithColumnFormatting),却未提供对应必需方法;同时 query() 方法错误地调用了 ->get(),违反了 Laravel Excel 的数据流约定。

✅ 正确实现关键点

1. 严格实现所有声明的接口方法

ReportGeneralExport 声明了 WithTitle 和 WithColumnFormatting,就必须补全:

use Maatwebsite\Excel\Concerns\WithTitle;
use Maatwebsite\Excel\Concerns\WithColumnFormatting;
use PhpOffice\PhpSpreadsheet\Style\NumberFormat;

class ReportGeneralExport implements FromQuery, WithHeadings, WithTitle, ShouldAutoSize, WithColumnFormatting, WithMapping
{
    use Exportable;

    public function __construct(int $providerid)
    {
        $this->providerid = $providerid;
    }

    // ✅ 必须实现:返回工作表标题(字符串)
    public function title(): string
    {
        return 'General Info';
    }

    // ✅ 必须实现:定义列格式(键为列字母,值为格式常量或自定义字符串)
    public function columnFormats(): array
    {
        return [
            'A' => NumberFormat::FORMAT_TEXT,      // First Name
            'D' => NumberFormat::FORMAT_GENERAL,  // Email Id
            'F' => NumberFormat::FORMAT_TEXT,      // Home Address
        ];
    }

    // ✅ query() 必须返回 QueryBuilder 实例,**禁止调用 ->get()**
    public function query()
    {
        return Providerinfo::query()->where('id', $this->providerid);
        // ❌ 错误:return Providerinfo::where('id',$this->providerid)->get();
    }

    public function map($row): array
    {
        return [
            $row->providername,
            $row->middlename,
            $row->lastname,
            $row->email,
            $row->official_email,
            $row->home_address,
            $row->home_city,
            $row->home_state,
            $row->home_country,
            $row->home_zipcode,
            $row->mail_address,
        ];
    }

    public function headings(): array
    {
        return [
            'First Name',
            'Middle Name',
            'Last Name',
            'Email Id',
            'Other Email Id',
            'Home Address',
            'Home City',
            'Home State',
            'Home Country',
            'Home Zipcode',
            'Mail Address',
        ];
    }
}
? 注意:map() 中应使用对象属性访问($row->xxx)而非数组下标($row['xxx']),因 FromQuery 默认传递的是 Eloquent 模型实例。

2. 确保子导出类结构一致

其他工作表类(如 ReportPracticeExport 等)若也实现了 WithTitle 或 WithColumnFormatting,必须同步补全 title() 和 columnFormats() 方法。建议统一基类或严格校验。

3. 主导出类保持简洁可靠

ReportExport 类本身无需改动,但需确保其引用的所有子类均通过上述验证:

class ReportExport implements WithMultipleSheets
{
    use Exportable;

    public function __construct(int $providerid)
    {
        $this->providerid = $providerid;
    }

    public function sheets(): array
    {
        return [
            new ReportGeneralExport($this->providerid),
            new ReportPracticeExport($this->providerid),
            // ... 其他子导出类(务必均已正确实现接口)
        ];
    }
}

4. 控制器调用无须修改

你的控制器代码完全正确,保持原样即可:

public function exportproviders($id)
{
    return Excel::download(new ReportExport($id), 'provider_report.xlsx');
}

⚠️ 常见陷阱总结

问题 原因 修复方式
abstract method not implemented 声明了接口但未实现其抽象方法(如 title()、columnFormats()) 补全方法,或移除对应 implements 声明
Argument #2 ($format) must be of type string columnFormats() 返回了非字符串值(如 null、数组) 确保每个格式值均为 string(推荐使用 NumberFormat::XXX 常量)
query() must return Builder 在 query() 中调用了 ->get() / ->first() 等执行方法 仅返回 QueryBuilder,如 Model::query()->where(...)
数据为空或格式错乱 map() 中使用 $row['field'] 访问模型属性 改用 $row->field(Eloquent 模型)或显式 ->toArray() 后再取键

遵循以上规范后,多工作表导出将稳定运行,并支持自动列宽、自定义标题、数字格式化等高级特性。建议在开发中启用 IDE 的接口实现提示(如 PHPStorm),避免遗漏必需方法。