adaptit / fast-excel
Laravel 的快速 Excel 导入/导出
Requires
- php: ^7.3 || ^8.0
- illuminate/support: 5.3.* || 5.4.* || 5.5.* || 5.6.* || 5.7.* || 5.8.* || ^6.0 || ^7.0 || ^8.0 || ^9.0
- openspout/openspout: ^3
Requires (Dev)
- illuminate/database: ^6.20.12 || ^7.30.4 || ^8.24.0 || ^9.0
- phpunit/phpunit: ^9.5
- squizlabs/php_codesniffer: 3.*
This package is not auto-updated.
Last update: 2024-09-19 19:24:27 UTC
README
为 Laravel 提供快速 Excel 导入/导出,感谢 Spout。下面是基准测试。
快速开始
通过 composer 安装
composer require adaptit/fast-excel
将模型导出到 .xlsx
文件
use AdaptIT\FastExcel\FastExcel; use App\User; // Load users $users = User::all(); // Export all users (new FastExcel($users))->export('file.xlsx');
导出
导出模型或 集合
$list = collect([ [ 'id' => 1, 'name' => 'Jane' ], [ 'id' => 2, 'name' => 'John' ], ]); (new FastExcel($list))->export('file.xlsx');
导出 xlsx
、ods
和 csv
$invoices = App\Invoice::orderBy('created_at', 'DESC')->get(); (new FastExcel($invoices))->export('invoices.csv');
指定列名仅导出一些属性
(new FastExcel(User::all()))->export('users.csv', function ($user) { return [ 'Email' => $user->email, 'First Name' => $user->firstname, 'Last Name' => strtoupper($user->lastname), ]; });
下载(从控制器方法)
return (new FastExcel(User::all()))->download('file.xlsx');
导入
import
返回一个集合
$collection = (new FastExcel)->import('file.xlsx');
导入具有特定分隔符、封装字符和 "gbk" 编码的 csv
$collection = (new FastExcel)->configureCsv(';', '#', 'gbk')->import('file.csv');
导入并插入到数据库
$users = (new FastExcel)->import('file.xlsx', function ($line) { return User::create([ 'name' => $line['Name'], 'email' => $line['Email'] ]); });
门面
您可以使用可选的 Facade 使用 FastExcel。将以下行添加到 config/app.php
下的 aliases
键。
'FastExcel' => AdaptIT\FastExcel\Facades\FastExcel::class,
使用门面,您将无法访问构造函数。您可以使用 data
方法设置您的导出数据。
$list = collect([ [ 'id' => 1, 'name' => 'Jane' ], [ 'id' => 2, 'name' => 'John' ], ]); FastExcel::data($list)->export('file.xlsx');
全局助手
FastExcel 提供了一个方便的全局助手,可以在 Laravel 应用程序的任何位置快速实例化 FastExcel 类。
$collection = fastexcel()->import('file.xlsx'); fastexcel($collection)->export('file.xlsx');
高级使用
导出多个工作表
通过创建 SheetCollection
来导出多个工作表
$sheets = new SheetCollection([ User::all(), Project::all() ]); (new FastExcel($sheets))->export('file.xlsx');
使用索引指定工作表名称
$sheets = new SheetCollection([ 'Users' => User::all(), 'Second sheet' => Project::all() ]);
导入多个工作表
使用 importSheets
导入多个工作表
$sheets = (new FastExcel)->importSheets('file.xlsx');
您还可以通过其编号导入特定的工作表
$users = (new FastExcel)->sheet(3)->import('file.xlsx');
使用工作表名称导入多个工作表
$sheets = (new FastExcel)->withSheetsNames()->importSheets('file.xlsx');
使用分块导出大型集合
逐行导出以避免 memory_limit
问题 使用 yield
function usersGenerator() { foreach (User::cursor() as $user) { yield $user; } } // Export consumes only a few MB, even with 10M+ rows. (new FastExcel(usersGenerator()))->export('test.xlsx');
添加标题和行样式
使用 headerStyle
和 rowsStyle
方法添加标题和行样式。
$header_style = (new StyleBuilder())->setFontBold()->build(); $rows_style = (new StyleBuilder()) ->setFontSize(15) ->setShouldWrapText() ->setBackgroundColor("EDEDED") ->build(); return (new FastExcel($list)) ->headerStyle($header_style) ->rowsStyle($rows_style) ->download('file.xlsx');
为什么?
FastExcel 旨在成为 Laravel 风格的 Spout:一个简单但优雅的包装器,旨在简化 导入和导出。它可以被认为是 Laravel Excel 的一个更快(且内存友好)的替代品,功能较少。仅用于简单任务。
基准测试
在 2015 款 MacBook Pro 2.7 GHz Intel Core i5、16 Go 1867 MHz DDR3 上测试。测试 10000 行、20 列的 XLSX 导出,随机数据,10 次迭代,2018-04-05。 不要相信基准测试。
然而,请记住 Laravel Excel 具有许多更多功能。