rap2hpoutre/fast-excel

Laravel 的快速 Excel 导入/导出

资助包维护!
rap2hpoutre

安装次数: 12,316,060

依赖项: 49

建议者: 2

安全性: 0

星星: 2,084

关注者: 30

分支: 246

开放问题: 84

v5.5.0 2024-06-03 08:00 UTC

README

Version License StyleCI Tests Total Downloads

Laravel 的快速 Excel 导入/导出,得益于 Spout。下面是基准测试

快速入门

通过 composer 安装

composer require rap2hpoutre/fast-excel

导出模型到 .xlsx 文件

use Rap2hpoutre\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');

导出 xlsxodscsv

$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']
    ]);
});

门面

您可以使用可选的门面来使用 FastExcel。将以下行添加到 config/app.php 中的 aliases 键下。

'FastExcel' => Rap2hpoutre\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');

添加标题和行样式

使用 headerStylerowsStyle 方法添加标题和行样式。

use OpenSpout\Common\Entity\Style\Style;

$header_style = (new Style())->setFontBold();

$rows_style = (new Style())
    ->setFontSize(15)
    ->setShouldWrapText()
    ->setBackgroundColor("EDEDED");

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 有更多功能。