vartruexuan / yii-excel
excel导入导出组件
v1.1.1
2024-07-27 02:19 UTC
Requires
- php: >=8.2
- creocoder/yii2-flysystem: ^1.1
- overtrue/http: ^1.2
- ramsey/uuid: *
Requires (Dev)
- brainmaestro/composer-git-hooks: ^2.8
- friendsofphp/php-cs-fixer: ^3.0
- jetbrains/phpstorm-attributes: ^1.0
- mockery/mockery: ^1.2
- phpunit/phpunit: ^9.0
- vimeo/psalm: ^4.10
This package is auto-updated.
Last update: 2024-08-27 10:00:15 UTC
README
概述
excel 导入导出,支持异步、进度构建。
组件能力
- 导入、导出excel
- 支持异步操作,进度构建,进度消息输出
- 格式
xlsx
- ...
安装
- 安装依赖拓展 xlswriter
pecl install xlswriter
- 安装组件
composer require vartruexuan/yii-excel
使用
配置
- 配置组件
components
[ 'components' => [ // excel组件 'excel' => [ 'class' => \vartruexuan\excel\drivers\xlswriter\Excel::class, 'fileSystem' => 'filesystem', // 文件管理组件(默认:filesystem) 'redis' => 'redis',// redis组件(默认:redis) 'queue' => 'queue', // 队列组件(默认:queue) // 进度组件 'progress'=>[ 'class' => \vartruexuan\excel\ExcelProgress::class, 'expireTime' => 3600, // 进度信息失效时长(秒) 'prefix' => 'excel',// key前缀 'redis' => 'redis',// redis组件(默认:redis) 'queue' => 'queue', // 队列组件(默认:queue) ], // 进度行为 'as progress' => \vartruexuan\excel\behaviors\ExcelProgressBehavior::class, // 日志行为 'as log' => \vartruexuan\excel\behaviors\ExcelLogBehavior::class ] ] ]
- api
// 导出 \Yii::$app->excel->export(\vartruexuan\excel\data\export\ExportConfig $config); // 导入 \Yii::$app->excel->import(\vartruexuan\excel\data\export\ImportConfig $config); // 进度查询 \Yii::$app->excel->progress->getProgressRecord($token,true); // 进度消息输出查询 \Yii::$app->excel->progress->getProgressMessage($token);
导出
/** * 导出配置 * * @var \vartruexuan\excel\data\export\ExportConfig $config */ $config = new DemoExportConfig([ // 额外参数,比如导出需要筛选时 'param' => [ 'name' => '先生', ] ]); /** * 导出数据 * * @var \vartruexuan\excel\data\export\ExportData $exportData */ $exportData = \Yii::$app->excel->export($config); $token = $exportData->token; // 导出唯一标识
- 配置
<?php namespace common\excel\export; use vartruexuan\excel\data\export\Column; use vartruexuan\excel\data\export\ExportCallbackParam; use vartruexuan\excel\data\export\ExportConfig; use vartruexuan\excel\data\export\Sheet; /** * 用户分组导出 */ class DemoExportConfig extends ExportConfig { /** * 是否异步导出 * true 推入队列中异步消费 * false 同步导出 * * @var bool */ public bool $isAsync = true; /** * 输出类型 * OUT_PUT_TYPE_UPLOAD 上传 filesystem * OUT_PUT_TYPE_LOCAL 保存到本地 * OUT_PUT_TYPE_OUT 直接输出 * @var string */ public string $outPutType = self::OUT_PUT_TYPE_LOCAL; /** * 页配置 * * @return array|Sheet[] * @throws \Exception */ public function getSheets() { $this->setSheets([ // 可配置多页 new Sheet([ 'name' => 'sheet1', 'columns' => [ new Column([ 'title' => '姓名', 'field' => 'name', ]), new Column([ 'title' => '年龄', 'field' => 'age', ]), new Column([ 'title' => '身高', 'field' => 'height', ]), new Column([ 'title' => '职业', 'field' => 'post', ]), ], 'count' => $this->dataCount(), // 1.直接数组数据 2.支持回调分批导出 'data' => [$this, 'dataCallback'], // 每页导出数量 'pageSize' => 500, ]) ]); return $this->sheets; } /** * 数据回调 * * @param ExportCallbackParam $exportCallbackParam * @return array|array[] * @throws RandomException */ public function dataCallback(ExportCallbackParam $exportCallbackParam) { // $exportCallbackParam->page 当前页 // $exportCallbackParam->pageSize 限制每页数量 // $exportCallbackParam->totalCount 数据总数 // 额外参数 $exportCallbackParam->exportConfig->getParam(); $list = []; for ($i = 0; $i < $exportCallbackParam->pageSize; $i++) { $list[] = [ 'name' => '先生' . random_int(1, 100000), 'age' => random_int(10, 100), 'height' => random_int(100, 180), 'post' => '无业', ]; } return $list; } /** * 数据数量 * * @return array|array[]|int * @throws \Exception */ public function dataCount() { return 1000; } /** * 设置保存地址 * * @return string */ public function getPath() { // 上传 excel/demo.xlsx // 本地 /www/project/upload/demo.xlsx // 直接输出 demo.xlsx return '/excels/demo_'. date('Y_m_d_H_i_s_u') . '.xlsx'; } }
导入
/** * 导入配置 * * @var \vartruexuan\excel\data\import\ImportConfig $config */ $config = new DemoImportConfig([ // 导入文件地址 'path' => '/www/files/ceshi.xlsx', // 本地地址 // 'path' => 'https://xxx.com/ceshi.xlsx', // 远程地址 ]); /** * 导入 * * @var \vartruexuan\excel\data\import\ImportData $importData */ $importData = \Yii::$app->excel->import($config); $token = $exportData->token; // 导入唯一标识
- 配置
<?php namespace common\excel\import; use vartruexuan\excel\data\import\ImportConfig; use vartruexuan\excel\data\import\ImportRowCallbackParam; use vartruexuan\excel\data\import\Sheet; use vartruexuan\excel\ExcelAbstract; use vartruexuan\excel\exceptions\ExcelException; /** * 用户组导入 */ class DemoImportConfig extends ImportConfig { /** * 是否异步导入 * true 推入队列中异步消费 * false 同步导入 * * @var bool */ public bool $isAsync = true; /** * 页配置 * * @return array */ public function getSheets(): array { $this->setSheets([ new Sheet([ 'name' => 'sheet1', 'isReturnSheetData' => true, 'isSetHeader' => true, // 列名映射 'headerMap' => [ '姓名' => 'name', '年龄' => 'age', ], // 行数据回调 'callback' => [$this, 'rowCallback'] ]) ]); return $this->sheets; } /** * 行处理 * * @param ImportRowCallbackParam $importRowCallbackParam 行数据 * @return void * @throws ExcelException * @throws \Throwable */ public function rowCallback(ImportRowCallbackParam $importRowCallbackParam) { try { // 当前行数据 $importRowCallbackParam->row //todo 执行业务代码 } catch (ExcelException $excelException) { // 设置进度消息 $importRowCallbackParam->excel->progress->pushProgressMessage($importRowCallbackParam->importConfig->getToken(), $excelException->getMessage()); throw $e; } catch (\Throwable $exception) { $importRowCallbackParam->excel->progress->pushProgressMessage($importRowCallbackParam->importConfig->getToken(), "导出异常"); \Yii::error('导出demo异常:'.$exception->getMessage()); throw $exception; } } }
进度
- 进度查询
/** * 进度信息 * token 导入/导出时返回的token * @var \vartruexuan\excel\data\progress\ProgressRecord $progressRecord */ $progressRecord = \Yii::$app->excel->progress->getProgressRecord($token,true); // $progressRecord->progress 总进度信息 // $progressRecord->progress->status 进度状态 1.待处理 2.处理中 3.完成 4.失败 // $progressRecord->sheetListProgress 页码进度信息
- 消息输出查询
/** * token 导入/导出时返回的token * * @var array|null $messages */ $messages = Yii::$app->excel->progress->getProgressMessage($token,30);
License
MIT