Laravel、シーディングの設定方法(基礎)


皆さんこんにちは
今回はLaravelのシーディングについて解説していきます。
それでは早速いきましょう

開発環境

・Mac
・php 7.4.6
・Laravel 7.15.0
・MySQL

シーディングとは

今回はシーディングの説明に重きを置きたいので、ModelやMigrationについての詳しい説明は割愛させて頂きますなので、シーディングの前にModelとMigrationを終わらせといてください。

シーディングとは、データーベースに始めから用意されているサンプルを作成する機能のことです。
シーディングにより作成されたレコードのことを、シードと呼びます。
掲示板などのアプリケーションをデプロイした時に、初期状態でサンプルが全く無いと寂しいですよね(笑)

シーディングの手順

データベースにpostsテーブルがあるとします。このテーブル内にシーディングによってサンプルを作れるようにしていきます。まずは、terminalで以下のコマンドを実行します。

1. $ php artisan make:seeder PostsTableSeeder

これによりdatabase/seeds内に、PostsTableSeeder.phpというファイルが作成されます。

PostsTableSeeder.phpのファイルは以下のような記述があります。

PostsTableSeeder.php
<?php
 use Illuminate\Database\Seeder;

class PostsTableSeeder extends Seeder
{
   public function run()
   {

   }
}

2. PostsTableSeeder.phpにコードを書いていく

postsテーブルにtitle,bodyのサンプルを作成していきます。

PostsTableSeeder.php
<?php
 use Illuminate\Database\Seeder;

class PostsTableSeeder extends Seeder
{
   public function run()
   {
      DB::table('posts')->insert([
        'title' =>  'タイトル。',
        'body' => 'テキスト。テキスト。テキスト。テキスト。テキスト。',
      ]);

      DB::table('posts')->insert([
        'title' =>  'タイトル。',
        'body' => 'テキスト。テキスト。テキスト。テキスト。テキスト。',
      ]);
   }
}

3. DatabaseSeeder.phpに登録

PostsTableSeeder.phpと同じ階層に、DatabaseSeeder.phpというファイルがあります。
DatabaseSeeder.phpは以下のように記述します。

DatabaseSeeder.php
<?php
use Illuminate\Database\Seeder;

   class DatabaseSeeder extends Seeder
   {
       public function run()
       {
           $this->call([
               PostsTableSeeder::class;   //追加した記述
           ]);
       }
   }
}

追加でコメントのシーダーを作成したい場合は、DBにcommentsテーブルを作成してpostsテーブルと同様にファイルを作成します。そして、DatabaseSeeder.phpのcallメソッド内に記述すればいいですね。以下のようになります。

DatabaseSeeder.php
<?php
use Illuminate\Database\Seeder;

   class DatabaseSeeder extends Seeder
   {
       public function run()
       {
           $this->call([
               PostsTableSeeder::class;   
               CommentsTableSeeder::class;  //追加した記述
           ]);
       }
   }
}

4. $php artisan db:seed

最後にこのコマンドを実行すれば、DBにサンプルのデータが作成されます。

気づいた人もいるかと思いますが、このやり方だとたくさんのデータを挿入するのは面倒ですよね。
そういう場合は、factoryを使います。今回は説明しませんので興味があるひとは是非調べて見てください