Laravel 中數據遷移和數據填充

image

本文首發于 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 來進行填充。有一個簡便的方法。在 DatabaseSeederrun 方法中添加一行 $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 函數會針對集合中的每個元素進行操作。這里直接把數據保存到數據庫。

好了,數據遷移和數據填充的基本操作也就這些了。更多復雜的用法。。。。也不一定能用上。

?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 229,117評論 6 537
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,860評論 3 423
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事?!?“怎么了?”我有些...
    開封第一講書人閱讀 177,128評論 0 381
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,291評論 1 315
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,025評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,421評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,477評論 3 444
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,642評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,177評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,970評論 3 356
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,157評論 1 371
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,717評論 5 362
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,410評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,821評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,053評論 1 289
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,896評論 3 395
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,157評論 2 375

推薦閱讀更多精彩內容