Laravel 中資料遷移和資料填充

jaychen發表於2017-12-02
Laravel

Laravel 中資料遷移和資料填充

本文首發於 https://jaychen.cc

作者 JayChen

這是一篇基礎教程，對標 Laravel 文件中的資料遷移和資料填充。

migration

Laravel 中提供了資料庫遷移的方式來管理資料庫，想象一個場景：在一個多人開發的專案中，你的同事修改了某個資料庫結構並修改了程式碼，通過 git 你可以即時的同步同事修改的程式碼，但是資料庫結構，你只能通過手工的方式來複制同事修改的 SQL 語句，執行以保證資料庫的結構一致。那麼，Laravel 中的資料庫遷移概念，就是用於解決團隊中保證資料庫結構一致的方案。

migration 使用非常簡單，編寫一定的 php 程式碼並執行，那麼 Laravel 就會自動的更新資料庫。假設你的同事要修改資料庫某個欄位，那麼只要編寫 php 程式碼，接著你通過 git 更新了程式碼，執行 migrate 操作之後，你的資料庫結構就和他的同步了。下面我們就來看具體的使用方法。

migrate

Laravel 把編寫資料庫改動的 php 程式碼稱為遷移，可以通過 php artisan make:migration filename 的方式來建立遷移檔案。假設你需要建立一張新的 user 表，那麼你可以通過執行 php artisan make:migration create_user_table --create=user 來建立一個遷移檔案，執行命令會在 database/migrations/ 目錄下建立一個 檔案建立時間_filename 的 php 檔案，那麼這個檔案就是我們接下來用來編寫資料庫結構變化的檔案了。這裡要提一點，雖然說建立遷移檔案的名稱可以隨意，但是為了管理方便，最好檔名可以體現要執行的資料庫操作，比如這裡我們要建立一張 user 表，所以檔名稱為 create_user_table。

php artisan make:migration filename 有兩個可選引數

  • --create=tablename 表明該遷移是用來建立表。
  • --table=tablename 表明該遷移是用來對 tablename 這張表進行操作。

我們建立出來的遷移檔案 create_user_table 會包含兩個方法。


public function up()
{
    Schema::create('user', function (Blueprint $table) {
        $table->increments('id');
        $table->timestamps();
    });
}


public function down()
{
    Schema::dropIfExists('user');
}
複製程式碼

這兩個方法是互逆的操作，比如我們可以再 up 方法中編寫我們要建立的 user 表的相關資訊，而 down 方法中則是刪除 user 表的操作。這樣，我們就可以做到回滾操作，當我們建立 user 表之後發現某個欄位名寫錯了，就可以通過 down 來刪除 user 表，進而重新建立 user 表。

假設 user 表有 id,username,email 三個欄位，那麼可以再 up 方法中寫

public function up()
{
    Schema::create('user', function (Blueprint $table) {
        $table->increments('id')->index()->comment('使用者id');
        $table->string('name')->default('')->comment('使用者名稱');
        $table->string('email')->nullable()->comment('使用者郵箱');
        $table->timestamps();
    });
}
複製程式碼

一般，我們的邏輯會在閉包函式中寫。上面的程式碼，即時不能完全明白，也可以大概猜出以下幾點：

  • 我們操作的表是 user 表。
  • user 表中定義了 id 欄位，因為呼叫了 increments 方法，所以 id 為 auto_increment，呼叫了 index 方法說明給 id 新增了索引，最後 comment 等同於註釋。
  • 有了 id 的經驗，那麼 name 欄位也很好理解了，string 方法說明 name 是 varchar/char 型別的，default 定義了 name 欄位的預設值。
  • email 欄位 呼叫了 nullable 方法說明執行 email 欄位為空。
  • 定義欄位結構的時候可以使用鏈式呼叫的方式。

Laravel 中的方法是滿足你對 sql 語句的所有操作，如果你需要定義一個型別為 text 的欄位，那麼可以呼叫 text() 方法，更多的方法說明可以參見文件 Laravel 資料庫結構構造器。

我們已經編寫好了 user 表的結構，接下來執行 php artisan migrate，Laravel 會根據 create 方法自動為我們建立 user 表。至此，我們已經成功的通過 Larvel 的遷移功能來實現建立表。

Rollback

使用 Laravel 的遷移功能可以有後悔藥吃。

執行 php artisan migrate 建立 user 表之後，覺得不行，不要 user 這張表，於是你打算刪除這張表。那麼這時候我們就要使用剛剛說到的 down 方法了。

public function down()
{
    Schema::dropIfExists('user');
}
複製程式碼

這裡 Laarvel 已經為我們寫好邏輯了，dropIfExists 函式就是用來刪除表，我們只需要執行 php artisan migrate :rollback 就可以回滾到執行 php artisan migrate 之前的狀態。

重新命名錶

除了建立表，也可以用遷移記錄表的其他任何操作，包括修改表屬性，修改欄位等等操作。這裡再舉個例子說明如何用遷移來對錶進行重新命名。

  • 假設有表 user，我們需要對它重新命名為 users。首先要執行 php artisan make:migration rename_user_to_users --table user 來建立遷移檔案。
  • 在 up 方法中寫我們要重新命名錶的邏輯。

public function up()
{
    Schema::table('user', function (Blueprint $table) {
        Schema::rename('user','users');
    });
}
複製程式碼
  • 為了可以 rollback 可以順利執行，我們還需要在 down 方法中編寫撤銷重新命名操作的邏輯。
public function up()
{
    Schema::table('user', function (Blueprint $table) {
        //
        Schema::rename('users','user');
    });
}
複製程式碼
  • 最後執行 php artisan migrate 就就可以完成對 user 表的重新命名操作。如果需要回滾，只要執行 php artisan migrate:rollback。

你會發現，如果執行一次遷移之後，如果執行第二次遷移是不會重複執行的，這是因為 Laravel 會在資料庫中建立一張 migrations 的表來記錄哪些已經進行過遷移。

基本的 migration 介紹就到這裡，以上的內容可以應對大部分的需求，如果需要更詳細的介紹，可能需要閱讀 Laravel 那不知所云的文件了。:)

Seeder

Laravel 中除了 migration 之外，還有一個 seeder 的東西，這個東西用於做資料填充。假設專案開發中需要有一些測試資料，那麼同樣可以通過編寫 php 程式碼來填充測試資料，那麼通過 git 同步程式碼，所有的人都可以擁有一份同樣的測試資料。

同樣，資料填充在 Laravel 中被稱為 Seeder，如果需要對某張表填充資料，需要先建立一個 seeder。通過執行 php artisan make:seeder UserTableSeeder 來生成一個 seeder 類。這裡我們希望填充資料的表示 test 表，所以名字為 UserTableSeeder。當然這個名字不是強制性的，只是為了做到見名知意。

建立 UserTableSeeder 之後會在 database/seeders 目錄下生成一個 UserTableSeeder 類，這個類只有一個 run 方法。你可以在 run 方法中寫插入資料庫的程式碼。假設我們使用 DB facade 來向 test 表插入資料。

class UserTableSeeder extends Seeder
{

    public function run()
    {
        DB::table('users')->insert($insertData);
    }
}
複製程式碼

編寫完程式碼之後，執行 php artsian db:seeder --class= UserTableSeeder 來進行資料填充。執行完畢之後檢視資料庫已經有資料了。

如果我們有多個表要進行資料填充，那麼不可能在編寫完 php 程式碼之後，逐個的執行 php artisan db:seeder --class=xxxx 來進行填充。有一個簡便的方法。在 DatabaseSeeder 的 run 方法中新增一行 $this->call(UserTableSeeder::class);，然後執行 php artisan db:seeder，那麼 Laravel 就會執行 DatabaseSeeder 中的 run 方法，然後逐個執行遷移。

和 migration 不同，如果多次執行 php artisan db:seeder 就會進行多次資料填充。

加入你想一次性插入大量的測試資料 ，那麼在 run 方法中使用 DB facade 來逐個插入顯然不是一個好的方法。Laravel 中提供了一種模型工廠的方式來建立建立大量的資料。

模型工廠

模型工廠，意味著本質其實是一個工廠模式。那麼，在使用模型工廠建立資料需要做兩件事情

  1. 建立工廠，定義好工廠要返回的資料。
  2. 呼叫工廠獲取資料。

Laravel 中通過執行 php artisan make:factory UserFactory --model=User 來為 User Model 建立一個工廠類，該檔案會放在 database/factory 目錄下。開啟該檔案可以看到如下程式碼：

$factory->define(App\User::class, function (Faker $faker) {
    return [
        //
    ];
});
複製程式碼

這裡， return 的值就是我們第 2 步呼叫工廠獲取到的資料。生成資料的邏輯也只需要寫在閉包函式中就可以。這裡需要提一下 Faker 這個類。這是一個第三方庫，Laravel 整合了這個第三方庫。這個庫的作用很好玩：**用於生成假資料。**假設 User 表需要插入 100 個使用者，那麼就需要 100 個 username，那麼你就不必自己寫邏輯生成大量的 test01，test02 這樣子幼稚的假資料，直接使用 Faker 類，會替你生成大量逼真的 username。(我也不知道這個算不算無聊了 :)。。。)。

現在假設 User 表有 id, email, username 三個欄位，那麼我要生成 100 個使用者，首先在工廠類中實現邏輯。

$factory->define(App\Models\User::class, function (Faker $faker) {
    return [
    	// 直接呼叫 faker API 生成假資料，更多 faker 相關檢視 文件。
        'username' => $faker->name,
        'email' => $faker->unique()->safeEmail,
    ];
});
複製程式碼

現在，我們已經定義好了工廠，現在我們就要在 UserSeeder@run 函式中使用模型工廠來生成測試資料。


class UserTableSeeder extends Seeder
{

    public function run()
    {
        factory(App\User::class)->times(10)->make()->each(function($user,$index){
        	$user->save();
        });
    }
}
複製程式碼

run 函式中這一波行雲流水的鏈式呼叫在我剛剛開始接觸 Laravel 的時候也是一臉黑線，不過習慣之後感覺這程式碼可讀性確實很強

  • factory(App\User::class) 指明返回哪個工廠，引數 App\User::class 就是工廠的唯一標識。這裡我們在定義工廠的時候 define 的第一個引數已經指明瞭。
  • ->times(10) 指明需要工廠模式生成 10 個 User 資料。即會呼叫 10 次 define 函式的第二個引數。
  • ->make() 把生成的 10 個 User 資料封裝成 Laravel 中的集合物件。
  • ->each() 是 Laravel 集合中的函式，each 函式會針對集合中的每個元素進行操作。這裡直接把資料儲存到資料庫。

好了，資料遷移和資料填充的基本操作也就這些了。更多複雜的用法。。。。也不一定能用上。

相關文章