原文参考链接:https://scotch.io/tutorials/generate-dummy-laravel-data-with-model-factories
开发中,假如我需要一些演示的数据,那么,我可能得连接数据库,创建一大堆的演示数据,这是一件非常蛋疼的事情。还好,Laravel是优雅高效的,Laravel绝对不会干很蠢的事情。
按照大多数人的做法,按照令人繁琐的方式创建数据,比如我需要创建1000个用户,普通的做法就得按照下面的方式一个个追加,或者聪明点弄个循环,但假如我用户下面还有文章,岂不是更麻烦:
// manually make a list of users $users = [ [ 'username' => 'firstuser', 'name' => 'first user', 'email' => 'firstuser@email.com' ], [ 'username' => 'seconduser', 'name' => 'second user', 'email' => 'seconduser@email.com' ] ... ];
这都是非常愚蠢的做法,浪费时间!多亏了 fzaninotto/faker 这个库,我们可以非常简单的创建一大堆模拟数据。
这个库可以在packagist下载,所以,我们可以通过composer下载下来。不过,从Laravel 5之后,就不需要自己下载安装了,因为Laravel直接内置了这个库。
composer require fzaninotto/faker --dev
安装好fzaninotto/faker 库,我们可以通过Laravel的DB seeder class进行操作,几行代码就创建我们需要的模拟数据。具体如何使用 Laravel 的 DB seeder class 操作,参考这篇文章https://laravel.com/docs/5.2/seeding:
public function run() { $faker = Faker\Factory::create(); for($i = 0; $i < 1000; $i++) { App\User::create([ 'username' => $faker->userName, 'name' => $faker->name, 'email' => $faker->email ]); } }
通过上面代码段,我们就可以创建1000个用户。
虽然上面的办法非常凑效,可以把你从最初的愚蠢做法解围出来,但是这并不是最佳的解决方案,我们总不可能每次都把上面的代码写一遍运行一次创建用户。
Laravel的开发原则是,永远保持你的代码优雅。那么我们可以按照下面的方式操作。
#Model Factories
模型工厂给我们提供了非常牛逼的方式去生成数据。自从Laravel 5版本之后,模型工厂已经成为Laravel的标配。
如何使用呢?打开Laravel项目下文件:database/factories/ModelFactory.php
我们可以创建一个所谓的工厂。Laravel提供了一个全局的对象 $factory 用来定义我们的工厂,比如:
$factory->define(App\User::class, function (Faker\Generator $faker) { return [ 'username' => $faker->userName, 'email' => $faker->email, 'name' => $faker->name ]; });
从上面代码可以看到,define方法有两个参数,一个是对象模型类,另一个是一个带了Faker\Generator类的闭包,返回用户对象数组。
定义好工厂,那么如何使用呢?
#Using the Factory
上一步我们定义好了我们的工厂,那么我们便可以随时使用,不过我们往往会在 测试脚本里 或者 seed 类里进行使用。我通过 factory 函数便可以使用工厂了,如下:
// create a user and save them to the database $user = factory(App\User::class)->create();
上面代码创建了一个用户,直接在数据库里生效的哦,假如我们需要创建大量的用户,直接给 factory 函数传递第二个参数即可。
// create 1000 users with just one line $users = factory(App\User::class, 1000)->create();
#Overriding Attributes
如果你想覆盖在工厂里定义的对象属性值,那么可以在create()方法里传递一个数组参数,定义你需要改变的属性值,这不会影响其他默认属性值,依然保持工厂里定义的属性值。
$user = factory(App\User::class)->create([ 'username' => 'pizzamuncher' ]);
#Factory Make
有时候我们并不需要把数据存到数据库里,只是想通过工厂制造点数据查看下,那么,我们可以使用make 方法,而不是 create 方法。
$user = factory(App\User::class)->make();
就像create方法一样,我们依然可以自定义一些属性值:
$user = factory(App\User::class)->make([ 'username' => 'pitzanotpizza' ]);
#Multiple Factory Types
一个对象模型可能有不同的类型,我们可以定义对象工厂使用不同的类型。比如:我们希望一些用户成为管理员,我们可以使用 $factory->defineAs()方法,它具有3个参数,第一个是对象模型,第二个是类型,第三个是闭包(定义了属性值)。
$factory->defineAs(App\User::class, 'admin', function (Faker\Generator $faker) { return [ 'username' => $faker->userName, 'email' => $faker->email, 'name' => $faker->name, 'admin' => true ]; });
或者假如你希望拓展下模型,可以这么做:
$factory->defineAs(App\User::class, 'admin', function ($faker) use ($factory) { $post = $factory->raw('App\User'); return array_merge($post, ['admin' => true]); });
定义好了上面的代码,我们便可以通过 factory 方法,直接生成 管理员 类的用户了,比如:
factory(App\User::class, 'admin')->create();
factory(App\User::class, 'admin', 10)->create();
#Create a Model with Relation
下面我们再来看另外一种需求,每个用户可能发布有不同(hasMany)的文章,那么这种带有对象关系的模型,如何在魔星工厂里使用呢?假如我们需要每个用户下面包含文章。那么,没问题的,我们可以这么做:创建用户,遍历用户,插入post保存即可。
factory(App\User::class, 50)->create()->each(function($u) { $u->posts()->save(factory(App\Post::class)->make()); });
#Using Model Factories While Testing
在测试的时候,我们便可以随心所欲的使用模型工厂生成数据了。假如你修改了你的属性字段,那么你需要做的仅仅是更新下工厂属性定义就可以了。
下面是两段使用模型工厂的测试脚本,可以参考学习下。
<?php use Illuminate\Foundation\Testing\WithoutMiddleware; use Illuminate\Foundation\Testing\DatabaseMigrations; use Illuminate\Foundation\Testing\DatabaseTransactions; class ExampleTest extends TestCase { public function setUp() { parent::setUp(); Artisan::call('migrate'); //run migrations Eloquent::unguard(); // disable eloquent guard } public function it_creates_at_least_hundred_fake_users() { $users = factory(App\Users::class, mt_rand(100, 1000))->create(); $user_count = count($users) >= 100; $this->assertTrue($user_count); } }
public function it_creates_at_least_hundred_fake_users() { $users = []; $faker = Faker\Factory::create(); for ($i = 0; $i < mt_rand(100, 1000); $i++) { $users[] = App\User::create([ 'username' => $faker->userName, 'email' => $faker->email, 'name' => $faker->name ]); } $this->assertTrue(count($users) >= 100); }
文章的脚注信息由WordPress的wp-posturl插件自动生成