aoding9/dcat-xlswriter-export

xlswriter导出Excel(dcat-admin扩展)

1.2.3 2023-10-19 10:50 UTC

This package is auto-updated.

Last update: 2024-09-17 10:02:00 UTC


README

dcat扩展:xlswriter导出

之前使用laravel-excel进行数据导出,内存消耗大,速度慢,数据量大时内存占用容易达到PHP上限,或者响应超时,因此改为使用xlswriter扩展进行导出。

由于直接导出的表格不太美观,经常需要进行合并单元格和自定义表格样式等操作,我对此进行了一些封装,使得使用更加方便直观。

本扩展是laravel-xlswriter-export 的dcat版本,可以直接查看laravel-xlswriter-export的readme文档,此处只介绍不同点。

安装

首先按照文档安装xlswriter扩展

https://xlswriter-docs.viest.me/

在phpinfo中确认安装成功后,进行下一步

composer require aoding9/dcat-xlswriter-export

如果国内composer镜像安装失败,请设置官方源

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

由于官方源下载速度慢,国内镜像偶尔出问题可能导致安装失败,也可以将以下代码添加到composer.json中,直接从github安装

如果无法访问github,可以将url改为gitee:https://gitee.com/aoding9/dcat-xlswriter-export

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

使用

1.定义导出类

与laravel-xlswriter-export相同,不同点在于,不传参数将使用dcat中grid的查询构造器作为数据源,另外由于make方法与dcat不兼容,只能使用new的方式。

2、在控制器中使用

在grid方法中使用$grid->export(new UserExport());即可

由于构造函数传参为空,数据源为other类型,走buildDataFromOther获取grid数据,如有特殊需要,可以重写该方法修改获取到的数据

//use xxx

protected function grid() {
    return Grid::make(new User(), function(Grid $grid) {
         $grid->export(new UserExport());
        //$grid->export(new UserMergeExport());
    });
}

3、通过swoole使用

由于swoole中不能调用exit()方法,需要在控制器中直接return下载响应

为此,需要在导出类中将$useSwoole属性设为true,然后在dcat控制器中引入HandleExportIfUseSwoole,这个trait将重写index方法,以正确地触发下载

// UserExport中添加
public $useSwoole = true;

// UserController中添加
use Aoding9\Dcat\Xlswriter\Export\HandleExportIfUseSwoole;

版本更新

  • v1.2.2 (2023-9-16)
    • download时调用$this->useSwoole()判断是否使用了swoole,如果使用了,将返回下载响应,代替默认的exit()
    • 新增HandleExportIfUseSwoole,用于swoole访问dcat时,重写控制器的index以返回下载响应