【Laravel】CSVインポートの実装紹介

php artisan make:controller CsvImportController

// app/Http/Controllers/CsvImportController.php

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use App\Services\CsvImportService;

class CsvImportController extends Controller
{
    protected $csvImportService;

    /**
     * CsvImportControllerのコンストラクタ
     *
     * @param CsvImportService $csvImportService サービスクラスのインスタンス
     */
    public function __construct(CsvImportService $csvImportService)
    {
        $this->csvImportService = $csvImportService;
    }

    /**
     * CSVアップロードフォームを表示する。
     *
     * @return \Illuminate\View\View
     */
    public function showUploadForm()
    {
        return view('upload');
    }

    /**
     * アップロードされたCSVファイルを検証する。
     *
     * @param \Illuminate\Http\Request $request リクエストオブジェクト
     * @return string アップロードされたファイルのパス
     */
   protected function validateAndUploadFile(Request $request)
    {
        // アップロードされたファイルの検証
        // リクエストで受け取ったファイルが必須であり、かつCSVまたはTXT形式であることを確認します。
        // これにより、不正なファイル形式がアップロードされるのを防ぎます。
        $request->validate([
            'csv_file' => 'required|file', // ファイルが必須であることを指定
        ]);

        // アップロードされたファイルを取得
        $file = $request->file('csv_file'); // リクエストオブジェクトから 'csv_file' フィールドのファイルを取得

        // MIMEタイプと拡張子を取得
        $mimeType = $file->getMimeType(); // ファイルのMIMEタイプを取得
        $extension = $file->getClientOriginalExtension(); // ファイルの元の拡張子を取得
        
        // 許可されているMIMEタイプの配列を定義。
        $allowedMimeTypes = [
             'text/csv',                // 標準的なCSVファイルのMIMEタイプ
             'application/csv',         // 一部のシステムで使用されるCSVファイルのMIMEタイプ
             'application/vnd.ms-excel',// Excelや一部のCSVファイルで使用されるMIMEタイプ
             'text/plain'               // 一部のテキストファイル形式のCSVファイル
         ];

        // 許可されている拡張子のリストを定義
        $allowedExtensions = [
             'csv', // CSVファイルの拡張子
             'txt'  // テキストファイルの拡張子 (CSVファイルがテキストファイルとして保存されている場合)
        ];

        // MIMEタイプと拡張子が許可されているかどうかを確認
        if (!in_array($mimeType, $allowedMimeTypes) || !in_array($extension, $allowedExtensions)) {
            return redirect()->back()->withErrors(['csv_file' => '無効なファイル形式です。CSVまたはTXT形式のファイルをアップロードしてください。']);
        }

        // ファイルを一時ディレクトリに保存し、そのパスを返す
        return $file->getRealPath();
    }

    /**
     * CSVファイルをインポートする。
     *
     * @param \Illuminate\Http\Request $request リクエストオブジェクト
     * @return \Illuminate\Http\RedirectResponse
     */
    public function import(Request $request)
    {
        // ファイルを検証してアップロード
        $path = $this->validateAndUploadFile($request);

        // サービスクラスを使用してCSVファイルをインポート
        $this->csvImportService->import($path);

        // 成功メッセージと共にリダイレクト
        return redirect()->back()->with('success', 'CSVデータが正常にインポートされました。');
    }
}

$request->validate([
      'csv_file' => 'required|file'
]);

<form action="/upload" method="POST" enctype="multipart/form-data">
    @csrf
    <input type="file" name="csv_file">
    <button type="submit">Upload</button>
</form>

$file = $request->file('csv_file');

// MIMEタイプを取得
$mimeType = $file->getMimeType(); // ファイルのMIMEタイプを取得

// 拡張子を取得
$extension = $file->getClientOriginalExtension(); // ファイルの元の拡張子を取得

// 許可されているMIMEタイプの配列を定義します。
// これらのMIMEタイプのみが有効なファイルとして受け入れられます。
$allowedMimeTypes = [
    'text/csv',                // 標準的なCSVファイルのMIMEタイプ
    'application/csv',         // 一部のシステムで使用されるCSVファイルのMIMEタイプ
    'application/vnd.ms-excel',// Excelや一部のCSVファイルで使用されるMIMEタイプ
    'text/plain'               // 一部のテキストファイル形式のCSVファイル
];

// 許可されているファイル拡張子の配列を定義します。
// これらの拡張子のみが有効なファイルとして受け入れられます。
$allowedExtensions = [
    'csv', // CSVファイルの拡張子
    'txt'  // テキストファイルの拡張子 (CSVファイルがテキストファイルとして保存されている場合)
];

// MIMEタイプと拡張子が許可されているかどうかを確認
if (!in_array($mimeType, $allowedMimeTypes) || !in_array($extension, $allowedExtensions)) {
      return redirect()->back()->withErrors(['csv_file' => '無効なファイル形式です。ファイル形式を確認して、アップロードしてください。']);
}

// app/Services/CsvImportService.php

namespace App\Services;

use App\Models\User;

class CsvImportService
{
    /**
     * CSVファイルからユーザーデータをインポートする。
     *
     * @param string $path CSVファイルのパス
     * @return void
     */
    public function import($path)
    {
        // CSVファイルを配列として読み込む
        $data = array_map('str_getcsv', file($path));

        // 最初の行がヘッダー行であると仮定し、ヘッダーを取得
        $header = array_shift($data);

        // 各データ行を処理
        foreach ($data as $row) {
            // ヘッダーとデータ行を結合して連想配列を作成
            $row = array_combine($header, $row);

            // データ行を検証 (例: 必須フィールドの確認)
            // ここでは、ユーザーの名前、メールアドレス、パスワードを取得し、パスワードはハッシュ化しています。
            $userData = [
                'id' => $row['id'],                     // ユーザーID
                'name' => $row['name'],                 // ユーザー名
                'email' => $row['email'],               // ユーザーのメールアドレス
                'password' => bcrypt($row['password']), // ユーザーのパスワード (ハッシュ化)
                'first_name' => $row['first_name'],     // ユーザーのファーストネーム
                'last_name' => $row['last_name'],       // ユーザーのラストネーム
                'gender' => $row['gender'],             // ユーザーの性別
                'account_role' => $row['account_role'], // ユーザーのアカウントロール
            ];

            // ユーザーを作成または更新
            User::updateOrCreate(['email' => $row['email']], $userData);
        }
    }
}

$data = array_map('str_getcsv', file($path));

$header = array_shift($data);

$row = array_combine($header, $row);

User::updateOrCreate(['id' => $row['id']], $userData);