README

当前支持

• CSV
• XLSX
• XML

安装

步骤 1: 使用 Composer 安装

composer require audunru/export-response

根据您想导出的格式，您可能需要安装额外的包

步骤 2: 向您的路由添加中间件

为了允许所有 API 端点进行导出，请向 Kernel.php 添加中间件

'api' => [
    'throttle:api',
    \Illuminate\Routing\Middleware\SubstituteBindings::class,
    \audunru\ExportResponse\Middleware\ExportCsv::class,
    \audunru\ExportResponse\Middleware\ExportXlsx::class,
    \audunru\ExportResponse\Middleware\ExportXml::class,
],

要将中间件添加到特定的 API 资源中，您可以在 api.php 中使用此方法

Route::apiResource('documents', DocumentController::class)
    ->middleware([
        ExportCsv::class,
        ExportXlsx::class,
        ExportXml::class
    ])
    ->name('documents');

您可以指定一个数组键，该键将用于检索数据。支持点符号表示法。

Route::apiResource('documents', DocumentController::class)
    ->middleware([
        ExportCsv::with([
            'key' => 'data',
        ]),
        ExportXlsx::with([
            'key' => 'data',
        ]),
        ExportXml::class::with([
            'key' => 'data',
        ]),
    ])
    ->name('documents');

您还可以在 app/Http/Kernel.php 中的 $middlewareGroups 和 $routeMiddleware 数组中添加中间件

protected $middlewareGroups = [
    'web' => [
        \App\Http\Middleware\EncryptCookies::class,
        \Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse::class,
        \Illuminate\Session\Middleware\StartSession::class,
        \Illuminate\View\Middleware\ShareErrorsFromSession::class,
        \App\Http\Middleware\VerifyCsrfToken::class,
        \Illuminate\Routing\Middleware\SubstituteBindings::class,
    ],

    'api' => [
        'throttle:api',
        \Illuminate\Routing\Middleware\SubstituteBindings::class,
        // Add ExportCsv middleware to all requests. "data" is the name of
        // the key to retrieve using "dot" notation.
        'csv:data',
    ],
];

protected $routeMiddleware = [
    'auth' => \App\Http\Middleware\Authenticate::class,
    'auth.basic' => \Illuminate\Auth\Middleware\AuthenticateWithBasicAuth::class,
    'cache.headers' => \Illuminate\Http\Middleware\SetCacheHeaders::class,
    'can' => \Illuminate\Auth\Middleware\Authorize::class,
    'guest' => \App\Http\Middleware\RedirectIfAuthenticated::class,
    'password.confirm' => \Illuminate\Auth\Middleware\RequirePassword::class,
    'signed' => \Illuminate\Routing\Middleware\ValidateSignature::class,
    'throttle' => \Illuminate\Routing\Middleware\ThrottleRequests::class,
    'verified' => \Illuminate\Auth\Middleware\EnsureEmailIsVerified::class,
    'csv' => \audunru\ExportResponse\Middleware\ExportCsv::class,
];

从控制器导出

除了使用中间件外，您还可以在控制器中执行导出操作

class ProductController extends Controller
{
    public function csv()
    {
        $products = Product::all();

        return $products->toCsv('filename.csv');
    }

也支持延迟集合

class ProductController extends Controller
{
    public function csv()
    {
        $products = Product::lazy();

        return $products->toCsv('filename.csv');
    }

当可能时请使用延迟集合。在测试过程中，使用 Product::lazy() 导出 10,000 个产品大约需要 2MB 的内存，而使用 Product::all() 则需要 44 MB 的内存。两种导出方式所需时间相同（约 45 秒）。

步骤 3: 导出响应

为了将 API 响应作为 CSV 而不是 JSON 获取，请向您的 API 发送请求，并将 Accept 标头设置为 text/csv。

对于 XML，请将标头设置为 application/xml。

对于 XLSX，请将标头设置为 application/vnd.openxmlformats-officedocument.spreadsheetml.sheet。

配置

运行以下命令发布配置文件

php artisan vendor:publish --tag=export-response-config

开发

测试

运行测试

composer test