Laravelには、「シーダクラス（初期値設定クラス）」というものがあり、データベースへ初期データを簡単に投入できます。例えば、マイグレーションでデータベースを構築し、シーディングで初期データを投入するようにしておけば、いつでもデータベースの再構築と初期データの投入までを行えます。

LaravelのSeeding（シーディング）でデータベースへ任意の初期データを自動投入する

Laravel には、「シーダクラス（初期値設定クラス）」というものがあり、データベースへ初期データを簡単に投入できます。
例えば、マイグレーションでデータベースを構築し、シーディングで初期データを投入するようにしておけば、いつでもデータベースの再構築と初期データの投入までを行えます。
一人で開発している場合でも十分に役に立つのですが、チームで開発する場合にはさらに力を発揮するのもこのシーディングです。マイグレーションとシーディングを設定しておけば、チームに新しいメンバーがアサインした場合でも、artisan コマンドを叩くだけで一撃で必要なデータベースと初期データが提供できます。
マイグレーションに関しては以下の解説を参照してください。 
<a href="/posts/25">Laravel のマイグレーション＆スキーマビルダで DB のテーブルやカラムを作成する</a> 
今回は、シーディングについて解説していきます。
今回の環境は以下の通りです。
<ul>
<li>linux CentOS 7</li>
<li>Apache 2.4</li>
<li>MySQL 5.8</li>
<li>PHP 7.3/7.2/7.1</li>
<li>Laravel</li>
</ul>
Laravel のバージョンに関しては 5.8/5.7/5.6/5.5/5.4/5.3 にて動作確認済みです。
Laravel のルートディレクトリを「laravel/」とします。
linux 環境ではなく XAMPP でも、artisan コマンドが使えれば同様の手順で進めていけます。
<h2 id="contents">Contents</h2>
<ol>
<li><a href="#seed-%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%E3%81%AE%E7%94%9F%E6%88%90">Seed ファイルの生成</a></li>
<li><a href="#%E3%82%B7%E3%83%BC%E3%83%80%E3%83%BC%E3%82%AF%E3%83%A9%E3%82%B9%E3%81%AE%E5%AE%9A%E7%BE%A9">シーダークラスの定義</a></li>
<li><a href="#%E3%82%B7%E3%83%BC%E3%83%80%E3%82%AF%E3%83%A9%E3%82%B9%E3%82%92%E3%82%B3%E3%83%BC%E3%83%AB%E3%81%99%E3%82%8B%E7%82%BA%E3%81%AE%E8%A8%AD%E5%AE%9A">シーダクラスをコールする為の設定</a></li>
<li><a href="#%E3%82%AA%E3%83%BC%E3%83%88%E3%83%AD%E3%83%BC%E3%83%80%E5%86%8D%E7%94%9F%E6%88%90">オートローダ再生成</a></li>
<li><a href="#%E3%82%B7%E3%83%BC%E3%83%87%E3%82%A3%E3%83%B3%E3%82%B0%E5%AE%9F%E8%A1%8C">シーディング実行</a></li>
<li><a href="#%E3%83%9E%E3%82%A4%E3%82%B0%E3%83%AC%E3%83%BC%E3%82%B7%E3%83%A7%E3%83%B3%E3%81%A8%E3%82%B7%E3%83%BC%E3%83%87%E3%82%A3%E3%83%B3%E3%82%B0%E3%81%A7%E3%83%87%E3%83%BC%E3%82%BF%E3%83%99%E3%83%BC%E3%82%B9%E3%82%92%E6%A7%8B%E7%AF%89%E3%81%99%E3%82%8B">マイグレーションとシーディングでデータベースを構築する</a></li>
</ol>
<h2 id="seed-ファイルの生成">Seed ファイルの生成</h2>
まずは、投入するデータを記述するための Seed ファイルを生成します。その為にまずは、にシーダクラス名を決めます。
公式に倣うのであれば、「"TABLEBNAME"TableSeeder 」のような名前が良いです。ここでは、本の管理テーブルである「books 」へのシーダーを生成するので、「BooksTableSeeder 」という名前にします。
クラス名が決まったら、Laravel ルートディレクトリに移動し、シーダー生成の為の以下の artisan コマンドを叩きます。
<pre><code class="hljs language-shell"># laravel ルートディレクトリへ移動
cd /path/to/laravel

# シーダー生成のための artisan コマンドを叩く
php artisan make:seeder BooksTableSeeder

# 実行結果
[demo@localhost laravel]$ php artisan make:seeder BooksTableSeeder
Seeder created successfully.
</code></pre>
laravel/database/seeds 配下に BooksTableSeeder.php が生成されます。
<pre><code class="hljs language-shell">laravel
├─ database
│ ├─ seeds
│ │ ├─ BooksTableSeeder.php
</code></pre>
シーダーの生成が完了したら、ファイルを確認します。
<h2 id="シーダークラスの定義">シーダークラスの定義</h2>
それでは生成したシーダークラスを定義（データを流し込む記述）していきます。先ほど生成したシーダファイルを開きます。
<dl class="description_setting">
<dt>laravel/database/seeds/BooksTableSeeder.php</dt>
<dd>
<pre><code class="hljs language-php">&#x3C;?php

use Illuminate\Database\Seeder;

class BooksTableSeeder extends Seeder
{
 /**
 * Run the database seeds.
 *
 * @return void
 */
 public function run()
 {
 //
 }
}
</code></pre>
</dd>
</dl>
この run() メソッドにデータを投入する記述を行います。
<dl class="description_setting">
<dt>laravel/database/seeds/BooksTableSeeder.php</dt>
<dd>
<pre><code class="hljs language-php">&#x3C;?php

use Illuminate\Database\Seeder;

class BooksTableSeeder extends Seeder
{
 /**
 * Run the database seeds.
 *
 * @return void
 */
 public function run()
 {
 DB::table('books')->insert([
 [
 'book_name' => 'ブック１',
 'author' => '著者１',
 'price' => 1000,
 'stocks' => 20,
 'release_dt' => date('Y-m-d H:i:s'),
 ],
 [
 'book_name' => 'ブック２',
 'author' => '著者２',
 'price' => 2000,
 'stocks' => 30,
 'release_dt' => date('Y-m-d H:i:s'),
 ],
 [
 'book_name' => 'ブック３',
 'author' => '著者３',
 'price' => 1200,
 'stocks' => 150,
 'release_dt' => date('Y-m-d H:i:s'),
 ],
 ]);
 }
}
</code></pre>
</dd>
</dl>
シンプルに、DB ファサードを使ってクエリビルダでインサートを実装している。という事になります。
<h2 id="シーダクラスをコールする為の設定">シーダクラスをコールする為の設定</h2>
シーダクラスの定義が完了したら、このシーダクラスをシーディング実行時にコール（呼び出す）できるようにします。 seeds ディレクトリにあるもう一つのファイル DatabaseSeeder.php に以下を記述します。
<dl class="description_setting">
<dt>laravel/database/seeds/DatabaseSeeder.php</dt>
<dd>
<pre><code class="hljs language-php">&#x3C;?php

use Illuminate\Database\Seeder;

class DatabaseSeeder extends Seeder
{
 /**
 * Run the database seeds.
 *
 * @return void
 */
 public function run()
 {
 $this->call([
 BooksTableSeeder::class,
 ]);
 }
}
</code></pre>
</dd>
</dl>
ここにクラスを登録することにより、シーディング実行時にクラスがコールされ、実行されます。また、登録したいシーダクラスが複数ある場合には、この配列に追加していけば OK です。
<h2 id="オートローダ再生成">オートローダ再生成</h2>
最後に Composer のオートローダを再生成します。以下の Composer コマンドを叩きます。
<pre><code class="hljs language-shell"># autoloader 再生成
composer dump-autoload
</code></pre>
<h2 id="シーディング実行">シーディング実行</h2>
それでは実際にシーディングを実行してみます。 Laravel ルートディレクトリに移動し、以下を叩きます。
<pre><code class="hljs language-shell"># laravel ルートディレクトリへ移動
cd /path/to/laravel

# シーダー実行の artisan コマンドを叩く
php artisan db:seed

# 実行結果
[demo@localhost laravel]$ php artisan db:seed
Seeding: BooksTableSeeder
</code></pre>
実行が完了したら、実際に MySQL へログインしてデータを確認してみます。
<pre><code class="hljs language-shell">mysql> select * from books;
+----+--------------+-----------+-------+--------+---------------------+------------+------------+
| id | book_name | author | price | stocks | release_dt | created_at | updated_at |
+----+--------------+-----------+-------+--------+---------------------+------------+------------+
| 1 | ブック１ | 著者１ | 1000 | 20 | 2017-10-28 10:11:01 | NULL | NULL |
| 2 | ブック２ | 著者２ | 2000 | 30 | 2017-10-28 10:11:01 | NULL | NULL |
| 3 | ブック３ | 著者３ | 1200 | 150 | 2017-10-28 10:11:01 | NULL | NULL |
+----+--------------+-----------+-------+--------+---------------------+------------+------------+
</code></pre>
問題なく初期データが投入されている事を確認できました。
<h2 id="マイグレーションとシーディングでデータベースを構築する">マイグレーションとシーディングでデータベースを構築する</h2>
マイグレーションをロールバックした場合に、もちろんデータも一緒に失われてしまうわけですが、ロールバック＆再構築の際には、以下のコマンドを叩く事でロールバック（定義したテーブル全削除）→テーブル再構築→シーディング実行（初期データ投入）までを１つのコマンドで行えます。
<pre><code class="hljs language-shell"># マイグレーションにて全ロールバックを行い、テーブル再構築の後、シーディングを実行（初期データ投入）する
php artisan migrate:refresh --seed

# 実行結果
[demo@localhost laravel]$ php artisan migrate:refresh --seed
Rolling back: 2018_05_21_223549_create_books_table
Rolled back: 2018_05_21_223549_create_books_table
Migrating: 2018_05_21_223549_create_books_table
Migrated: 2018_05_21_223549_create_books_table
Seeding: BooksTableSeeder
</code></pre>
実行結果を見ると、まずロールバック（削除）が行われ、そしてマイグレート（再構築）し、最後にシーディング（初期データ投入）が行われているのがわかります。
ちなみに初回実行の場合は単純に、マイグレーション実行時にシーダー実行のオプションをつけた artisan コマンドを叩けば OK です
<pre><code class="hljs language-shell"># laravel ルートディレクトリへ移動
cd /path/to/laravel

# マイグレーション実行時にシーダー実行のオプションをつけた artisan コマンドを叩く
php artisan migrate --seed

# 実行結果
[demo@localhost laravel]$ php artisan migrate --seed
Migrating: 2018_05_21_223549_create_books_table
Migrated: 2018_05_21_223549_create_books_table
Seeding: BooksTableSeeder
</code></pre>
<h2 id="まとめ">まとめ</h2>
以上で作業は完了です。シーディングとマイグレーションの組み合わせは最強ですが、もちろんシーディングだけでも使う事が出来ますので、是非試してみてください。
また、今回はシンプルにシーダクラスに手動でインサートするデータを記述しましたが、自動でランダムにデータを生成して投入する方法もあります。次回はその手順について解説します。
next：<a href="/posts/28">Laravel の Faker と Seeding（シーディング）を使い、テスト（フェイク）データを自動生成しデータベースへ投入する</a>

Author