October CMS使用ImportExport行为实现CSV与XLSX双格式导出问题

实现步骤 #

1. 安装XLSX处理依赖

首先通过composer安装PhpSpreadsheet库用于生成XLSX文件：

composer require phpoffice/phpspreadsheet

2. 新增导出格式选择项

修改你的控制器对应的config_export.yaml配置文件，在导出表单中添加格式选择字段：

# config_export.yaml
form:
    fields:
        export_type:
            label: 导出格式
            type: dropdown
            options:
                csv: CSV 文件
                xlsx: XLSX 表格文件
            default: csv
        # 保留原有其他导出配置字段

3. 正确重写导出方法

October CMS中控制器的同名方法优先级高于挂载的行为方法，你之前重写不生效的核心原因是没有将用户选择的导出格式参数传入方法逻辑，同时不需要全局扩展ImportExportController行为，直接在当前控制器重写exportFromList方法即可：

<?php namespace Your\Plugin\Controllers;

use Backend\Classes\Controller;
use PhpOffice\PhpSpreadsheet\Spreadsheet;
use PhpOffice\PhpSpreadsheet\Writer\Xlsx;

class DataImportExport extends Controller
{
    public $implement = [
        'Backend.Behaviors.ImportExportController',
    ];

    // 保留原有配置属性，比如$exportConfig等
    public $exportConfig = 'config_export.yaml';

    public function __construct()
    {
        parent::__construct();
        BackendMenu::setContext('RainLab.User', 'user', $this->action);
        // 删掉之前的全局extend代码，不需要全局扩展行为
    }

    // 重写导出方法
    public function exportFromList($definition = null, $options = [])
    {
        // 合并用户提交的导出格式参数
        $options = array_merge($options, [
            'export_type' => post('export_type', 'csv'),
        ]);

        // CSV格式直接调用原有行为逻辑，无需重复开发
        if ($options['export_type'] === 'csv') {
            return $this->asExtension('ImportExportController')->exportFromList($definition, $options);
        }

        // 以下为XLSX导出逻辑
        $exportColumns = $this->getExportColumns($definition);
        $exportData = $this->getExportData($definition, $options);
        $filename = $this->getExportFileName($definition, $options) . '.xlsx';

        $spreadsheet = new Spreadsheet();
        $sheet = $spreadsheet->getActiveSheet();

        // 写入表头
        $colIndex = 1;
        foreach ($exportColumns as $columnLabel) {
            $sheet->setCellValueByColumnAndRow($colIndex, 1, $columnLabel);
            $colIndex++;
        }

        // 写入数据行
        $rowIndex = 2;
        foreach ($exportData as $item) {
            $colIndex = 1;
            foreach ($exportColumns as $columnKey => $columnLabel) {
                $sheet->setCellValueByColumnAndRow($colIndex, $rowIndex, $item->{$columnKey} ?? '');
                $colIndex++;
            }
            $rowIndex++;
        }

        // 生成下载响应
        ob_start();
        $writer = new Xlsx($spreadsheet);
        $writer->save('php://output');
        $content = ob_get_clean();

        return response($content, 200, [
            'Content-Type' => 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
            'Content-Disposition' => 'attachment;filename="' . $filename . '"',
            'Cache-Control' => 'max-age=0',
        ]);
    }
}

注意事项 #

• 如果需要导出万级以上的数据，建议添加分批查询逻辑，避免内存溢出
• 原有CSV导出的权限校验、字段过滤等逻辑完全复用，不需要额外调整

内容的提问来源于stack exchange，提问作者Igor Savinkin