Laravel Excel 导出空白文件问题排查与解决方案

laravel excel 导出空白文件问题排查与解决方案

本文档旨在解决 Laravel 项目中使用 maatwebsite/excel 导出 Excel 文件时出现空白文件的问题。我们将深入分析可能导致此问题的常见原因,并提供详细的解决方案,包括路由配置、视图表单提交、控制器数据处理以及 Excel 导出类的正确实现。通过本文,你将能够有效地诊断和修复 Laravel Excel 导出空白文件的问题,确保数据导出的顺利进行。

问题分析

在 Laravel 中使用 maatwebsite/excel 库导出 Excel 文件时,出现空白文件通常是由于以下几个原因造成的:

  1. 路由配置错误: 使用 GET 请求传递大量数据可能导致 URL 超长,数据丢失
  2. 表单提交方式不正确: GET 请求不适合传递复杂参数,应使用 POST 请求。
  3. 控制器参数接收错误: 控制器没有正确接收到前端传递的参数。
  4. Excel 导出类数据查询错误: 查询条件不正确或查询结果为空。

解决方案

下面我们将针对以上问题,提供详细的解决方案。

1. 修改路由配置

将 GET 路由修改为 POST 路由,以便通过表单提交数据。

// routes/web.php
Route::post('users/export/', 'App/Http/Controllers/Admin/ReportController@exportvehicles')->name('exportVehiclesToExcel');
登录后复制

注意: 确保路由名称 exportVehiclesToExcel 在后续的表单中使用。

2. 修改视图文件

将导出链接 修改为表单

,并使用 POST 方法提交数据。

<form action="{{route('exportVehiclesToExcel')}}" method="POST">
    @csrf
    <label>选择员工</label>
    <select name="smsstaff_key" id="smsstaff_key">
        <option>----------------选择-----------------</option>
        @foreach ($staff as $staffMember)
        <option value="{{$staffMember->smsstaff_key}}" {{request()->input('smsstaff_key') === $staffMember->smsstaff_key ? 'selected="selected"' : ''}}>{{$staffMember->name}}</option>
        @endforeach
    </select>
    <button class="btn btn-primary">根据选择的员工筛选</button>

    </div>
    <div style="margin-left: 100px;">
        <label>从:</label>
        <input type="date" class="form-control" name="startDate" value="{{ $startDate }}">
    </div>
    <div style="margin-left: 150px;">
        <label>至:</label>
        <input style="width: 14em" type="date" class="form-control" name="endDate" value="{{ $endDate }}">
    </div>
    <button type="submit">导出到 Excel</button>
</form>
登录后复制

注意:

  • 添加了 @csrf 指令,用于防止 CSRF 攻击。
  • 使用了 route() 函数生成路由 URL,确保 URL 的正确性。
  • 将导出按钮 修改为

3. 修改控制器

修改控制器方法,正确接收表单提交的参数,并传递给 Excel 导出类。

public function exportvehicles(Request $request)
{
    $startDate = $request->startDate;
    $endDate = $request->endDate;
    $smsStaffKey = $request->smsstaff_key;

    return Excel::download(new ExportV($startDate, $endDate, $smsStaffKey), 'excelname.xlsx');
}
登录后复制

4. 修改 Excel 导出类

修改 Excel 导出类,使其能够接收控制器传递的参数,并正确地应用到查询条件中。

use Maatwebsite/Excel/Concerns/FromQuery;
use Maatwebsite/Excel/Concerns/Exportable;

class ExportV implements FromQuery
{
    use Exportable;

    public $startDate;
    public $endDate;
    public $smsStaffKey;

    function __construct($startDate, $endDate, $smsStaffKey = null)
    {
        $this->startDate = $startDate;
        $this->endDate = $endDate;
        $this->smsStaffKey = $smsStaffKey;
    }

    public function query()
    {
        $startDate = $this->startDate;
        $endDate = $this->endDate;

        return VehicleLog::join('vehicle', 'vehicleslog.vehicle_id', '=', 'vehicle.id')
            ->join('smsstaff', 'vehicleslog.smsstaff_key', '=', 'smsstaff.smsstaff_key')
            ->when($this->smsStaffKey, function ($query) {
                $query->where('smsstaff.smsstaff_key', $this->smsStaffKey);
            })
            ->whereDate('log_dt', '>=', $startDate)
            ->whereDate('log_dt', '<=', $endDate);
    }
}
登录后复制

注意:

  • 构造函数接收 $startDate, $endDate, 和 $smsStaffKey 参数。
  • query() 方法中使用 $this->startDate、$this->endDate 和 $this->smsStaffKey 来构建查询条件。
  • 使用 when() 方法,只有当 $this->smsStaffKey 存在时,才添加 where 条件。
  • 确保返回的是一个查询构建器对象,而不是查询结果集合。

总结

解决 Laravel Excel 导出空白文件的问题,需要从路由配置、表单提交方式、控制器参数接收以及 Excel 导出类的实现等多个方面进行排查和修改。 通过将 GET 请求改为 POST 请求,正确地传递参数,并确保 Excel 导出类能够正确地应用查询条件,可以有效地解决这个问题。

注意事项:

  • 确保 maatwebsite/excel 库已正确安装。
  • 检查数据库连接是否正常。
  • 检查数据表中是否存在符合查询条件的数据。
  • 如果导出的数据量很大,可以考虑使用队列来处理导出任务,以避免请求超时。
  • 根据实际需求,可以自定义 Excel 导出类的更多功能,例如设置表头、格式化数据等。

通过遵循以上步骤,你应该能够成功解决 Laravel Excel 导出空白文件的问题,并实现数据的正确导出。如果仍然遇到问题,请仔细检查代码和配置,并参考 maatwebsite/excel 官方文档。

以上就是Laravel Excel 导出空白文件问题排查与解决方案的详细内容,更多请关注php中文网其它相关文章!

https://www.php.cn/faq/1453149.html

发表回复

Your email address will not be published. Required fields are marked *