[Laravel]初期データを登録する方法（Seederを使う）

アプリケーションを開発している時に、ほぼ必ずといっていいほどデータベースに初期データを登録する方法について解説します。
確認はLaravel10で行っておりますが、Laravel8や9でも同様に行って開発をしていましたので、手順やコマンドは変わらないと思います。

LaravelのSeeder（シーダー）とは
Seederを作成して登録データを作成する
1. Seederを作成する
2. Seederに登録データを記述する
  1. Model作成済みの場合
  2. テスト用などでランダムな値を入れたい
DatabaseSeederを編集する
Seederを実行する
1. Seederを指定して実行する
2. Migrateと同時にSeederも実行する
まとめ

LaravelのSeeder（シーダー）とは

LaravelのSeederとは、データベースに初期データを登録する際に利用します。
最初から用意しておきたいマスターデータやテスト用のデータを作成するときに使えます。

SQLのINSERT文を記載したものを用意して実行するのも一つのやり方ですが、プログラムを利用した方がforループを利用したり、csvから読み込んだりできるし、パスワードのハッシュ化もできるので、積極的に利用した方が良さそうです。

Seederを作成して登録データを作成する

Seederを作成した後に、登録するデータを記載していきます。
Seederの作成にはartisanを利用して行います。

Seederを作成する

今回は例としてユーザーテーブルを作成します。

php artisan make:seeder UserSeeder

Bash

Seederのファイルはdatabase/seeders配下に配置されます。
作成されたファイルは以下のようになっています。

database/seeders/UserSeeder.php

<?php

namespace Database\Seeders;

use Illuminate\Database\Console\Seeds\WithoutModelEvents;
use Illuminate\Database\Seeder;

class UserSeeder extends Seeder
{
    /**
     * Run the database seeds.
     */
    public function run(): void
    {
        //
    }
}

PHP

runメソッドがSeederを実行したときに処理されるメソッドです。
ここに登録処理を書いていきます。

Seederに登録データを記述する

Modelはまだ作成していないものとして記載しています。

database/seeders/UserSeeder.php

<?php
 
namespace Database\Seeders;
 
use Illuminate\Database\Seeder;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Hash;
use Illuminate\Support\Str;
 
class DatabaseSeeder extends Seeder
{
    /**
     * Run the database seeders.
     */
    public function run(): void
    {
        DB::table('users')->insert([
            'name' => Str::random(10),
            'email' => Str::random(10).'@example.com',
            'password' => Hash::make('password'),
        ]);
    }
}

PHP

Model作成済みの場合

あまり変わらないですが、Modelがあるならばこちらの方が良いかもしれません。

database/seeders/UserSeeder.php

<?php
 
namespace Database\Seeders;
 
use Illuminate\Database\Seeder;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Hash;
use Illuminate\Support\Str;
use App\Models\User;
 
class DatabaseSeeder extends Seeder
{
    /**
     * Run the database seeders.
     */
    public function run(): void
    {
        User::create([
            'name' => Str::random(10),
            'email' => Str::random(10).'@example.com',
            'password' => Hash::make('password'),
        ]);
    }
}

PHP

テスト用などでランダムな値を入れたい

上記の例のように、ランダムな名前やメールアドレスを入れたい場合は、FactoryとFakerを利用すると楽に登録ができるようになります。

これに関しては別の記事で紹介したいと思います。

DatabaseSeederを編集する

作成したSeederファイルは、database/seeders/DatabaseSeeder.phpから呼び出すようにして使用します。
今回は1ファイルだけですが、複数ファイルの場合はcallメソッドの引数の配列に追加していきます。

database/seeders/DatabaseSeeder.php

<?php

namespace Database\Seeders;

use Illuminate\Database\Seeder;

class DatabaseSeeder extends Seeder
{
    /**
     * Seed the application's database.
     */
    public function run(): void
    {
        $this->call([
            UserSeeder::class,
        ]);
    }
}