使用dcat-xlswriter扩展实现表格文件自定义列宽导出流程步骤

Laravel  /  管理员 发布于 1年前   504

使用dcat-xlswriter扩展实现表格文件自定义列宽导出

安装

composer require aoding9/dcat-xlswriter-export

因为官方源下载太慢了，国内镜像又有各种问题可能导致安装失败，可以把以下代码添加到 composer.json，直接从 github 安装

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/aoding9/dcat-xlswriter-export"
    }
  ]
}

官方源（速度慢）

composer config -g repo.packagist composer https://packagist.org

阿里云镜像（可能安装失败）

composer config -g repo.packagist composer https://mirrors.aliyun.com/composer/

使用

以用户导出为例，首先创建一个 UserExport 导出类，继承 Aoding9\Dcat\Xlswriter\Export\BaseExport 基类，

一般放在 app\Admin\Exports 目录下

<?php
namespace App\Admin\Exports;
use Aoding9\Dcat\Xlswriter\Export\BaseExport;
use Illuminate\Database\Eloquent\Model;
use Aoding9\Dcat\Xlswriter\Export\Demo\User; // 要导出的模型，用于代码提示
class UserExport extends BaseExport {
    // 定义表头
    public $header = [
        ['column' => 'a', 'width' => 8, 'name' => '序号'],
        ['column' => 'b', 'width' => 8, 'name' => 'id'],
        ['column' => 'c', 'width' => 20, 'name' => '姓名'],
        ['column' => 'd', 'width' => 20, 'name' => '手机号'],
        ['column' => 'e', 'width' => 20, 'name' => '注册时间'],
    ];
    public $fileName = '用户导出表'; // 导出的文件名
    public $tableTitle = '用户导出表'; // 第一行标题
    //public $rowHeight = 30; // 行高 可选配置项
    //public $headerRowHeight = 50; // 表头行高 可选配置项
    // 将模型字段映射为数组
    public function map($row) {
        // 跳过空行
        if (!$row instanceof Model) {
            return $row;
        }
        // dd($row); // $row就是dcat表格每一行对应的模型实例
        try {
            /** @var User $row 用于代码提示 */
            $rowData = [
                $this->index,      // 自增序号，用于无id时，排查导出失败的行
                $row->id,
                $row->name,
                $row->phone,
                $row->created_at->toDateTimeString(),
            ];
            // dd($rowData);
            return $rowData;
        } catch (\Exception $e) {
            dd('id为' . $row->id . '的记录导出失败，原因：' . $e->getMessage());
        }
    }
}

在 dcat 的 UserController 的 grid 方法中，添加如下代码：

namespace App\Admin\Controllers;
use Dcat\Admin\Grid;
use Aoding9\Dcat\Xlswriter\Export\Demo\User;
use Aoding9\Dcat\Xlswriter\Export\Demo\UserExport;
class UserController {
    protected function grid()
    {
        return Grid::make(new User(), function (Grid $grid) {
            //添加这行即可
             $grid->export(new UserExport());
        });
    }
}

如果 map 中需要调用关联关系，可以在 grid 中使用 with 来预加载关联，从而优化查询。

看看效果：