在 Laravel 中建立快速 CSV 導出命令

Laravel 中高效率的 CSV 導出：一種簡化的方法

Laravel 開發人員經常需要將資料匯出到 CSV 檔案以進行報告或分析。本文介紹了一種創建 Laravel CSV 導出命令的高效且簡單的方法，利用 Laravel 的分塊和 PHP 的 fputcsv 函數來實現大型資料集的最佳效能。

為什麼要用這種方法？

這種方法有幾個關鍵優勢：

1. 效率：Laravel 的分塊機制以可管理的批次處理數據，最大限度地減少記憶體消耗。
2. 可擴充性：處理大型資料集而不會出現記憶體耗盡問題。
3. 簡單： fputcsv 提供直接 CSV 格式，無需外部函式庫。

程式碼實作

以下程式碼示範了簡潔的 CSV 匯出：

use Illuminate\Database\Eloquent\Collection;

$chunkSize = 500; // Adjustable chunk size
$outputStream = fopen('php://stdout', 'wb+'); // Output stream to stdout

// Write CSV header row
fputcsv($outputStream, ['email', 'name']);

// Chunk-based data processing and export
User::select(['email', 'name'])
    ->chunk($chunkSize, function (Collection $users) use ($outputStream) {
        $users->each(function ($user) use ($outputStream) {
            fputcsv($outputStream, [$user->email, $user->name]);
        });
    });

程式碼分解

• $chunkSize = 500;：設定每個區塊處理的記錄數。根據您的資料量和伺服器資源按需調整。

• $outputStream = fopen('php://stdout', 'wb ');：開啟寫入二進位流到標準輸出 (stdout)。這允許將輸出直接透過管道傳輸到檔案或其他進程。

• fputcsv($outputStream, ['email', 'name']);：寫入 CSV 標題行。

• User::select(['email', 'name'])->chunk($chunkSize, ...);：Laravel 的 chunk 方法以 User 記錄區塊的形式處理 $chunkSize 模型資料。 chunk 中的匿名函數處理每個區塊。

• $users->each(function ($user) use ($outputStream) { ... });：遍歷區塊中的每個用戶，並使用 fputcsv.

  將電子郵件和姓名寫入 CSV

Artisan 指令整合

要建立可重複使用的 Artisan 指令，請如下建置程式碼：

<?php

namespace App\Console\Commands;

use Illuminate\Console\Command;
use Illuminate\Database\Eloquent\Collection;
use App\Models\User;

class ExportUsersToCsv extends Command
{
    protected $signature = 'export:users';
    protected $description = 'Export users to CSV';

    public function handle()
    {
        // ... (Code from previous example) ...
    }
}

這將會建立一個 Artisan 指令 php artisan export:users 來執行匯出。

結論

此方法為 Laravel 中的 CSV 導出提供了一種高效且可擴展的解決方案，利用內建功能來實現最佳效能和易於實施。 請記得根據您的具體需求調整 $chunkSize 變數。

以上是在 Laravel 中建立快速 CSV 導出命令的詳細內容。更多資訊請關注PHP中文網其他相關文章！