年份参数未正确传入导出类致Excel导出为空的问题解决

问题背景 #

现有一个书籍借阅记录筛选表单，输入出版年份后可展示对应记录；同时需要将筛选后的记录导出为Excel，但导出的文件为空，在导出类的collection()方法中打印$this->year结果为null，说明年份参数未正确传递。

现有代码片段 #

筛选表单

<form action="{{ route('booking.GetBookingsByYear') }}" method="POST">
    @csrf
    <input type="text" name="year" value="{{ old('year') }}" placeholder="Enter Book Year" class="form-control">
    <button type="submit" class="btn btn-primary btn-sm col-12">Filter</button>
</form>

Excel导出类

<?php

namespace App\Exports;

use App\Models\Booking;
use Maatwebsite\Excel\Concerns\FromCollection;
use Illuminate\Support\Facades\DB;
use Illuminate\Http\Request;

class GetBookingsByYearExport implements FromCollection
{
    protected $year;

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

    /**
    * @return \Illuminate\Support\Collection
    */
    public function collection()
    {
        $results = DB::select('CALL GetBookingsByYear(?)', [$this->year]);
        return collect($results);
    }
}

MySQL存储过程

DELIMITER //

CREATE PROCEDURE GetBookingsByYear(IN bookYear INT)
BEGIN
  SELECT b.*
  FROM bookings AS b
  JOIN books AS bk ON b.bookId = bk.id
  WHERE bk.year = bookYear;
END //

DELIMITER ;

控制器导出方法

public function GetBookingsByYearexport(Request $request)
{
    $year = $request->input('year');
    $export = new GetBookingsByYearExport($year);
    return Excel::download($export, 'bookingyear.xlsx');
}

导出路由

Route::post("/booking/GetBookingsByYearexport/", [BookingController::class, 'GetBookingsByYearexport'])->name('booking.GetBookingsByYearexport');

问题分析 #

$this->year为null的核心原因是导出请求未携带有效的year参数，或者参数在传递过程中丢失。

解决步骤 #

1. 确保导出请求携带year参数 #

在筛选结果页面添加导出按钮时，需要将已筛选的年份参数传递给导出接口：

• 若使用POST请求，创建带隐藏字段的表单：

<form action="{{ route('booking.GetBookingsByYearexport') }}" method="POST">
    @csrf
    <!-- 将当前筛选的年份作为隐藏字段传递 -->
    <input type="hidden" name="year" value="{{ $year }}">
    <button type="submit" class="btn btn-success">导出Excel</button>
</form>

• 若改用GET请求（更直观），修改路由和链接：

// 路由改为GET
Route::get("/booking/GetBookingsByYearexport/", [BookingController::class, 'GetBookingsByYearexport'])->name('booking.GetBookingsByYearexport');

<!-- 直接通过URL传递年份参数 -->
<a href="{{ route('booking.GetBookingsByYearexport', ['year' => $year]) }}" class="btn btn-success">导出Excel</a>

2. 验证控制器是否获取到参数 #

在控制器方法开头添加调试代码，确认year参数是否存在：

public function GetBookingsByYearexport(Request $request)
{
    dd($request->all()); // 查看请求中是否包含year参数
    $year = $request->input('year');
    $export = new GetBookingsByYearExport($year);
    return Excel::download($export, 'bookingyear.xlsx');
}

若此处无year参数，说明请求未正确携带，回到步骤1调整。

3. 确认导出类构造函数赋值正常 #

在导出类的构造函数中添加调试，确保参数被正确接收：

public function __construct($year)
{
    $this->year = $year;
    dd($this->year); // 确认是否收到有效年份值
}

若控制器有值但此处为null，检查类的命名空间是否正确引入，或是否存在实例化错误。

4. 可选：添加参数验证 #

在控制器中添加参数校验，避免无效值传递：

public function GetBookingsByYearexport(Request $request)
{
    $request->validate([
        'year' => 'required|integer|min:1900|max:' . date('Y'),
    ]);
    
    $year = $request->input('year');
    $export = new GetBookingsByYearExport($year);
    // 文件名带上年份更清晰
    return Excel::download($export, "booking_{$year}.xlsx");
}

额外检查 #

• 直接在数据库中调用存储过程验证数据：CALL GetBookingsByYear(2020)（替换为测试年份），确认是否返回有效记录；
• 确认Maatwebsite Excel包已正确安装并配置，基础导出功能可正常运行。

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