Laravel Excelインポート時に重複をスキップする方法 firstOrCreate

Laravelでエクセルファイルをインポートしたいときには、Maatwebsiteが便利です。

Maatwebsiteを使う際、firstOrCreateを活用すれば、重複部分を除外したインポートが可能。

fistOrCreateと似たような関数にfirstOrNew、セットで使うと便利な関数にwasRecentlyCreatedがあります。

重複部分の除外方法と共に、firstOrCreate, firstOrNew, wasRecentlyCreated の３つの関数の使い方も紹介します。

Laravel Excelインポート時に重複をスキップする方法 firstOrCreate
Laravel Excelインポート時に重複をスキップする方法 firstOrNew
さいごに

Laravel Excelインポート時に重複をスキップする方法 firstOrCreate

今回は、次のお団子情報が入ったエクセルファイルをデータベースにインポートします。

なおMaatwebsiteのインストール方法、ルート設定やコントローラー処理については、下記の記事を参考にしてください。

LaravelにExcelを簡単にインポートする方法【maatwebsite】

Laravelでエクセル機能を使うには、maatwebsiteが超おすすめ。エクセルのインポート・エクスポートがとても手軽にできます。今回はインストール方法とインストール方法、そしてバリデーションの付け方を解説していきますね...

本記事ではインポートファイルの処理のみ解説していきます。

① ToModelではなくOnEachRowに変更

インポートファイルにはデフォルトでToModelメソッドが使われますが、これですと、一括でインポート処理が行われます。

もしエラーがあると、ファイル丸ごと「エラーあり」ということではじかれてしまいます。

今回の重複チェックのように「一行ずつ」処理を行うためには、ToModelではなく、OnEachRowメソッドを使いましょう。

インポートファイル先頭のUse宣言、クラスの記述を下記のように変更します。

namespace App\Imports;

use App\Models\Dango;
// To Modelを削除
// use Maatwebsite\Excel\Concerns\ToModel;
use Maatwebsite\Excel\Row;
// On Each Rowを追加
use Maatwebsite\Excel\Concerns\OnEachRow;
use Maatwebsite\Excel\Concerns\WithHeadingRow;
use Maatwebsite\Excel\Concerns\WithValidation;

// クラスの宣言もToModel削除して、On Each Rowを入れる
class DangoImport implements OnEachRow, WithHeadingRow

namespace App\Imports;

use App\Models\Dango;

// To Modelを削除

// use Maatwebsite\Excel\Concerns\ToModel;

use Maatwebsite\Excel\Row;

// On Each Rowを追加

use Maatwebsite\Excel\Concerns\OnEachRow;

use Maatwebsite\Excel\Concerns\WithHeadingRow;

use Maatwebsite\Excel\Concerns\WithValidation;

// クラスの宣言もToModel削除して、On Each Rowを入れる

class DangoImport implements OnEachRow, WithHeadingRow

② firstOrCreateを使う

インポート処理部分では、firstOrCreate関数を使います。

これは、重複した値がなければ新規作成・保存する関数。

重複かどうかを判断するキーを最初に設定します。

「お団子の種類」について重複していれば登録したくない場合には、次のように記述します。

    public function OnRow(Row $row)
    {  
       $row=$row->toArray();
       $dango=Dango::firstOrCreate(
            // 重複除外カラムを指定
            [   'dango'=>$row['お団子の種類']],
            // データベースのカラムとエクセルのカラムを紐づけ
            [
                'dango'=>$row['お団子の種類'],
                'number'=>$row['数'],
            ]
        );
    }

public function OnRow(Row $row)

{

$row=$row->toArray();

$dango=Dango::firstOrCreate(

// 重複除外カラムを指定

[ 'dango'=>$row['お団子の種類']],

// データベースのカラムとエクセルのカラムを紐づけ

[

'dango'=>$row['お団子の種類'],

'number'=>$row['数'],

]

);

}

これでOKです。

③ 追加処理はwasRecentlyCreatedを使う

もし「今新規作成したばかりの値に処理を加えたい！」という場合には、wasRecentlyCreatedを使います。

wasRecentlyCreatedによって、今作成したばかりのデータを簡単に選択できます。

たとえば、作成したデータのnumber部分を「5」にする場合は、次のように処理を加えます。

    public function OnRow(Row $row)
    {  
       $row=$row->toArray();
       $dango=Dango::firstOrCreate(
            [   'dango'=>$row['お団子の種類']],
            [
                'dango'=>$row['お団子の種類'],
                'number'=>$row['数'],
            ]
        );
        
        // 今作成したデータに処理を追加
        if($dango->wasRecentlyCreated){
            $dango->number='5';
        }
    }

public function OnRow(Row $row)

{

$row=$row->toArray();

$dango=Dango::firstOrCreate(

[ 'dango'=>$row['お団子の種類']],

[

'dango'=>$row['お団子の種類'],

'number'=>$row['数'],

]

);

// 今作成したデータに処理を追加

if($dango->wasRecentlyCreated){

$dango->number='5';

}

Laravel Excelインポート時に重複をスキップする方法 firstOrNew

以上がfirstOrCreateとwasRecentlyCreatedを使った処理の例です。

次にfirstOrNewの使った方法を解説します。

firstOrNewは、重複した値がなければ新規作成のための値をセットします。

但し、保存まではしてくれません。

次のように、保存の処理は、別途入れる必要があります。

    public function OnRow(Row $row)
    {  
       $row=$row->toArray();
       $dango=Dango::FirstOrNew(
            // 重複除外カラムを指定
            ['dango'=>$row['お団子の種類']],
            // データベースのカラムとエクセルのカラムを紐づけ
            [
                'dango'=>$row['お団子の種類'],
                'number'=>$row['数'],
            ]);

       $dango->save();
    }