文档首页> 常见问题> 详解PHP用xlswriter优化Excel导出性能（附代码示例）

详解PHP用xlswriter优化Excel导出性能（附代码示例）

发布时间：2023-03-21 02:29       

本篇文章给大家带来了关于php的相关知识，其中主要跟大家聊一聊xlswriter扩展是什么？怎么使用xlswriter扩展优化Excel导出性能，感兴趣的朋友下面一起来看一下吧，希望对大家有帮助。

关于xlswriter

xlswriter 是一个 PHP C 扩展，旨在提升php在导出大数据量时的性能问题，支持 windows / Linux 。可用于在 Excel 2007+ XLSX 文件中读取数据，插入多个工作表，写入文本、数字、公式、日期、图表、图片和超链接。

它具备以下特性：

一、写入

  • 100％兼容的 Excel XLSX 文件
  • 完整的 Excel 格式
  • 合并单元格
  • 定义工作表名称
  • 过滤器
  • 图表
  • 数据验证和下拉列表
  • 工作表 PNG/JPEG 图像
  • 用于写入大文件的内存优化模式
  • 适用于 Linux，FreeBSD，OpenBSD，OS X，Windows
  • 编译为 32 位和 64 位
  • FreeBSD 许可证
  • 唯一的依赖是 zlib

二、读取

  • 完整读取数据
  • 光标读取数据
  • 按数据类型读取
  • xlsx 转 CSV
  • 性能对比
  • 先感谢网友提供数据

下载安装

github源码

https://github.com/viest/php-ext-xlswriter

xlswriter 文档

https://xlswriter-docs.viest.me/zh-cn/an-zhuang/huan-jing-yao-qiu

下载 ide helper

composer require viest/php-ext-xlswriter-ide-helper:dev-master

但是我一直下载失败，于是去github仓库直接下载 https://github.com/viest/php-ext-xlswriter-ide-helper
然后将里面的几个类复制到一个 xlswriter_ide_helper.php 文件里面，将这个文件放到你的项目中就有代码提示了。

安装 xlswriter 扩展

此处在docker中安装

docker exec -it php72-fpm bashcd /usr/local/bin
pecl install xlswriter
docker-php-ext-enable xlswriter
php -m

php --ri xlswriter
Version => 1.3.6

docker restart php72-fpm

性能测试：

测试数据：20 列，每列长度为 19 英文字母

Xlswriter

c88e27d2dcfbb6772a494276bb3a342.jpg

PHPSpreadSheet

d943758d996c696c3cc6d48603ba640.jpg

PHP_XLSXWriter

80a430d822b78989ac01640e7c21ee0.jpg

使用示例：

private function rankPersonExport($activityInfo, $list){
    $date = date('Y-m-d');
    $filename = "{$activityInfo['orgname']}-{$activityInfo['name']}-个人排行榜-{$date}";
    $header = ['名次', '用户ID', '对接账号', '姓名', '电话', '部门ID', '一级部门', '二级部门', '三级部门', '总积分', '最后积分时间', "毫秒"];
    if (!empty($activityInfo['ext'])) {
        $extArr = json_decode($activityInfo['ext'], true);
        foreach ($extArr as $errItem) {
            array_push($header, $errItem['name']);
        }
    }
    // list
    $listVal = [];
    foreach($list as $v){
        $temp = [
            $v['rank'],
            $v['userid'],
            $v['userName'],
            $v['nickName'],
            $v['phone'],
            $v['departid'],
            $v['topDepartName'],
            $v['secDepartName'],
            $v['thirdDepartName'],
            $v['score'],
            $v['updatetime'],
            $v['micro'],
        ];

        if (!empty($v['ext'])) {
            $extArr = explode('|', $v['ext']);
            foreach ($extArr as $k2 => $v2) {
                $errItemArr = explode('^', $v2);
                array_push($temp, $errItemArr[1]);
            }
        }
        array_push($listVal, $temp);
    }

    $re = downloadXLSX($filename, $header, $listVal);
    if($re){
        return $this->output(0, $re);
    }else{
        return $this->output(1, 'success');
    }}
function getTmpDir(): string{
    $tmp = ini_get('upload_tmp_dir');

    if ($tmp !== False && file_exists($tmp)) {
        return realpath($tmp);
    }

    return realpath(sys_get_temp_dir());}/**
 * download xlsx file
 *
 * @param string $filename
 * @param array $header
 * @param array $list
 * @return string errmsg
 */function downloadXLSX(string $filename, array $header, array $list): string{
    try {
        $config = ['path' => getTmpDir() . '/'];
        $excel  = (new \Vtiful\Kernel\Excel($config))->fileName($filename.'.xlsx', 'Sheet1');
        $fileHandle = $excel->getHandle();
        $format1    = new \Vtiful\Kernel\Format($fileHandle);
        $format2    = new \Vtiful\Kernel\Format($fileHandle);

        // title style
        $titleStyle = $format1->fontSize(16)
            ->bold()
            ->font("Calibri")
            ->align(\Vtiful\Kernel\Format::FORMAT_ALIGN_CENTER, \Vtiful\Kernel\Format::FORMAT_ALIGN_VERTICAL_CENTER)
            ->toResource();

        // global style
        $globalStyle = $format2->fontSize(10)
            ->font("Calibri")
            ->align(\Vtiful\Kernel\Format::FORMAT_ALIGN_CENTER, \Vtiful\Kernel\Format::FORMAT_ALIGN_VERTICAL_CENTER)
            ->border(\Vtiful\Kernel\Format::BORDER_THIN)
            ->toResource();

        $headerLen = count($header);

        // header
        array_unshift($list, $header);

        // title
        $title = array_fill(1, $headerLen - 1, '');
        $title[0] = $filename;
        array_unshift($list, $title);

        $end = strtoupper(chr(65 + $headerLen - 1));
        // column style
        $excel->setColumn("A:{$end}", 15, $globalStyle);
        // title
        $excel->MergeCells("A1:{$end}1", $filename)->setRow("A1", 25, $titleStyle);
        // 冻结前两行，列不冻结
        $excel->freezePanes(2, 0);
        // 数据
        $filePath = $excel->data($list)->output();

        header("Content-Disposition:attachment;filename={$filename}.xlsx");

        $re = copy($filePath, 'php://output');
        if ($re === false) {
            $err = 'failed to write output';
        } else {
            $err = '';
        }
        @unlink($filePath);

        return $err;
    } catch (\Vtiful\Kernel\Exception $e) {
        return $e->getMessage();
    }}

如果发现下载的文件有时候打不开，那应该是你使用了官方的DEMO，问题出在 filesize()，这个函数是有缓存的，所以你会发现下载下来的文件和原始的文件大小不一样。要么像我一样不去设置 Content-Length，要么使用 clearstatcache()手动清除缓存。

实测5w条记录导出耗时1.5s，效果还是很强劲的。

导出效果
97762f1e30787a3829807ea8c9c09b1.jpg