說明：本文主要說明Laravel Eloquent的延遲預先載入( Eager Loading)，使用延遲預先載入來減少MySQL查詢次數。同時，作者會將開發過程中的一些截圖和程式碼黏上去，提高閱讀效率。
備註：現在有4張表：商家表merchants、商家電話表phones、商家擁有的店舖shops表和店舖裡的商品表products。而關係是：
[ 'merchants_phones' => 'one-to-one', 'merchants_shops' => 'one-to-many', 'shops_products' => 'one-to-many', ]
現在要求做出一個頁面以列表形式顯示每個店鋪，每個店鋪區塊包含店鋪資訊如標題、包含店舖商家資訊如姓名和電話、包含擁有的商品資訊如介紹和價格。看看有沒有預載會有什麼不同。
開發環境：Laravel5.1 MAMP PHP7 MySQL5.5
#先寫個商店清單頁
1.先裝上開發外掛三件組(具體可參考：Laravel學習筆記之Seeder填充資料小技巧)
不管咋樣，先裝上開發外掛三件套：
composer require barryvdh/laravel-debugbar --dev composer require barryvdh/laravel-ide-helper --dev composer require mpociot/laravel-test-factory-helper --dev //config/app.php /** *Develop Plugin */ Barryvdh\Debugbar\ServiceProvider::class, Mpociot\LaravelTestFactoryHelper\TestFactoryHelperServiceProvider::class, Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class,
2.寫上表格欄位、表格關聯和測試資料填充器Seeder
依序輸入指令：
php artisan make:model Merchant -m php artisan make:model Phone -m php artisan make:model Shop -m php artisan make:model Product -m
寫上表格欄位和表格關聯：
class CreateMerchantsTable extends Migration
{
/**
* Run the migrations.
*
* @return void
*/
public function up()
{
Schema::create('merchants', function (Blueprint $table) {
$table->increments('id');
$table->string('username')->unique();
$table->string('email')->unique();
$table->string('first_name');
$table->string('last_name');
$table->timestamps();
});
}
/**
* Reverse the migrations.
*
* @return void
*/
public function down()
{
Schema::drop('merchants');
}
}
class CreatePhonesTable extends Migration
{
/**
* Run the migrations.
*
* @return void
*/
public function up()
{
Schema::create('phones', function (Blueprint $table) {
$table->increments('id');
$table->integer('number')->unsigned();
$table->integer('merchant_id')->unsigned();
$table->timestamps();
$table->foreign('merchant_id')
->references('id')
->on('merchants')
->onUpdate('cascade')
->onDelete('cascade');
});
}
/**
* Reverse the migrations.
*
* @return void
*/
public function down()
{
Schema::table('phones', function($table){
$table->dropForeign('merchant_id'); // Drop foreign key 'user_id' from 'posts' table
});
Schema::drop('phones');
}
}
class CreateShopsTable extends Migration
{
/**
* Run the migrations.
*
* @return void
*/
public function up()
{
Schema::create('shops', function (Blueprint $table) {
$table->increments('id');
$table->string('name');
$table->string('slug')->unique();
$table->string('site');
$table->integer('merchant_id')->unsigned();
$table->timestamps();
$table->foreign('merchant_id')
->references('id')
->on('merchants')
->onUpdate('cascade')
->onDelete('cascade');
});
}
/**
* Reverse the migrations.
*
* @return void
*/
public function down()
{
Schema::table('shops', function($table){
$table->dropForeign('merchant_id'); // Drop foreign key 'user_id' from 'posts' table
});
Schema::drop('shops');
}
}
class CreateProductsTable extends Migration
{
/**
* Run the migrations.
*
* @return void
*/
public function up()
{
Schema::create('products', function (Blueprint $table) {
$table->increments('id');
$table->string('name');
$table->text('short_desc');
$table->text('long_desc');
$table->double('price');
$table->integer('shop_id')->unsigned();
$table->timestamps();
$table->foreign('shop_id')
->references('id')
->on('shops')
->onUpdate('cascade')
->onDelete('cascade');
});
}
/**
* Reverse the migrations.
*
* @return void
*/
public function down()
{
Schema::table('products', function($table){
$table->dropForeign('shop_id'); // Drop foreign key 'user_id' from 'posts' table
});
Schema::drop('products');
}
}
/**
* App\Merchant
*
* @property integer $id
* @property string $username
* @property string $email
* @property string $first_name
* @property string $last_name
* @property \Carbon\Carbon $created_at
* @property \Carbon\Carbon $updated_at
* @property-read \App\Phone $phone
* @property-read \Illuminate\Database\Eloquent\Collection|\App\Shop[] $shops
* @method static \Illuminate\Database\Query\Builder|\App\Merchant whereId($value)
* @method static \Illuminate\Database\Query\Builder|\App\Merchant whereUsername($value)
* @method static \Illuminate\Database\Query\Builder|\App\Merchant whereEmail($value)
* @method static \Illuminate\Database\Query\Builder|\App\Merchant whereFirstName($value)
* @method static \Illuminate\Database\Query\Builder|\App\Merchant whereLastName($value)
* @method static \Illuminate\Database\Query\Builder|\App\Merchant whereCreatedAt($value)
* @method static \Illuminate\Database\Query\Builder|\App\Merchant whereUpdatedAt($value)
* @mixin \Eloquent
*/
class Merchant extends Model
{
/**
* @return \Illuminate\Database\Eloquent\Relations\HasOne
*/
public function phone()
{
return $this->hasOne(Phone::class, 'merchant_id');
}
/**
* @return \Illuminate\Database\Eloquent\Relations\HasMany
*/
public function shops()
{
return $this->hasMany(Shop::class, 'merchant_id');
}
}
/**
* App\Phone
*
* @property integer $id
* @property integer $number
* @property integer $merchant_id
* @property \Carbon\Carbon $created_at
* @property \Carbon\Carbon $updated_at
* @property-read \App\Merchant $merchant
* @method static \Illuminate\Database\Query\Builder|\App\Phone whereId($value)
* @method static \Illuminate\Database\Query\Builder|\App\Phone whereNumber($value)
* @method static \Illuminate\Database\Query\Builder|\App\Phone whereMerchantId($value)
* @method static \Illuminate\Database\Query\Builder|\App\Phone whereCreatedAt($value)
* @method static \Illuminate\Database\Query\Builder|\App\Phone whereUpdatedAt($value)
* @mixin \Eloquent
*/
class Phone extends Model
{
/**
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
*/
public function merchant()
{
return $this->belongsTo(Merchant::class, 'merchant_id');
}
}
/**
* App\Product
*
* @property integer $id
* @property string $name
* @property string $short_desc
* @property string $long_desc
* @property float $price
* @property integer $shop_id
* @property \Carbon\Carbon $created_at
* @property \Carbon\Carbon $updated_at
* @property-read \Illuminate\Database\Eloquent\Collection|\App\Shop[] $shop
* @method static \Illuminate\Database\Query\Builder|\App\Product whereId($value)
* @method static \Illuminate\Database\Query\Builder|\App\Product whereName($value)
* @method static \Illuminate\Database\Query\Builder|\App\Product whereShortDesc($value)
* @method static \Illuminate\Database\Query\Builder|\App\Product whereLongDesc($value)
* @method static \Illuminate\Database\Query\Builder|\App\Product wherePrice($value)
* @method static \Illuminate\Database\Query\Builder|\App\Product whereShopId($value)
* @method static \Illuminate\Database\Query\Builder|\App\Product whereCreatedAt($value)
* @method static \Illuminate\Database\Query\Builder|\App\Product whereUpdatedAt($value)
* @mixin \Eloquent
*/
class Product extends Model
{
/**
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
*/
public function shop()
{
return $this->belongsTo(Shop::class, 'shop_id');
}
}
/**
* App\Shop
*
* @property integer $id
* @property string $name
* @property string $slug
* @property string $site
* @property integer $merchant_id
* @property \Carbon\Carbon $created_at
* @property \Carbon\Carbon $updated_at
* @property-read \Illuminate\Database\Eloquent\Collection|\App\Merchant[] $merchant
* @property-read \Illuminate\Database\Eloquent\Collection|\App\Product[] $products
* @method static \Illuminate\Database\Query\Builder|\App\Shop whereId($value)
* @method static \Illuminate\Database\Query\Builder|\App\Shop whereName($value)
* @method static \Illuminate\Database\Query\Builder|\App\Shop whereSlug($value)
* @method static \Illuminate\Database\Query\Builder|\App\Shop whereSite($value)
* @method static \Illuminate\Database\Query\Builder|\App\Shop whereMerchantId($value)
* @method static \Illuminate\Database\Query\Builder|\App\Shop whereCreatedAt($value)
* @method static \Illuminate\Database\Query\Builder|\App\Shop whereUpdatedAt($value)
* @mixin \Eloquent
*/
class Shop extends Model
{
/**
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
*/
public function merchant()
{
return $this->belongsTo(Merchant::class, 'merchant_id');
}
/**
* @return \Illuminate\Database\Eloquent\Relations\HasMany
*/
public function products()
{
return $this->hasMany(Product::class, 'shop_id');
}
}
別忘了利用下開發三件套輸入指令：
php artisan ide-helper:generate php artisan ide-helper:models php artisan test-factory-helper:generate
表的關係如圖：
然後寫Seeder，可以參考Laravel學習筆記之Seeder填充資料小技巧:
php artisan make:seeder MerchantTableSeeder
php artisan make:seeder PhoneTableSeeder
php artisan make:seeder ShopTableSeeder
php artisan make:seeder ProductTableSeeder
class MerchantTableSeeder extends Seeder
{
/**
* Run the database seeds.
*
* @return void
*/
public function run()
{
$faker = Faker\Factory::create();
$datas = [];
foreach (range(1, 20) as $key => $value) {
$datas[] = [
'username' => $faker->userName ,
'email' => $faker->safeEmail ,
'first_name' => $faker->firstName ,
'last_name' => $faker->lastName ,
'created_at' => \Carbon\Carbon::now()->toDateTimeString(),
'updated_at' => \Carbon\Carbon::now()->toDateTimeString()
];
}
DB::table('merchants')->insert($datas);
}
}
class PhoneTableSeeder extends Seeder
{
/**
* Run the database seeds.
*
* @return void
*/
public function run()
{
$faker = Faker\Factory::create();
$merchant_ids = \App\Merchant::lists('id')->toArray();
$datas = [];
foreach (range(1, 20) as $key => $value) {
$datas[] = [
'number' => $faker->randomNumber() ,
'merchant_id' => $faker->randomElement($merchant_ids) ,
'created_at' => \Carbon\Carbon::now()->toDateTimeString(),
'updated_at' => \Carbon\Carbon::now()->toDateTimeString()
];
}
DB::table('phones')->insert($datas);
}
}
class ShopTableSeeder extends Seeder
{
/**
* Run the database seeds.
*
* @return void
*/
public function run()
{
$faker = Faker\Factory::create();
$merchant_ids = \App\Merchant::lists('id')->toArray();
$datas = [];
foreach (range(1, 40) as $key => $value) {
$datas[] = [
'name' => $faker->name ,
'slug' => $faker->slug ,
'site' => $faker->word ,
'merchant_id' => $faker->randomElement($merchant_ids) ,
'created_at' => \Carbon\Carbon::now()->toDateTimeString(),
'updated_at' => \Carbon\Carbon::now()->toDateTimeString()
];
}
DB::table('shops')->insert($datas);
}
}
class ProductTableSeeder extends Seeder
{
/**
* Run the database seeds.
*
* @return void
*/
public function run()
{
$faker = Faker\Factory::create();
$shop_ids = \App\Shop::lists('id')->toArray();
$datas = [];
foreach (range(1, 30) as $key => $value) {
$datas[] = [
'name' => $faker->name ,
'short_desc' => $faker->text ,
'long_desc' => $faker->text ,
'price' => $faker->randomFloat() ,
'shop_id' => $faker->randomElement($shop_ids) ,
'created_at' => \Carbon\Carbon::now()->toDateTimeString() ,
'updated_at' => \Carbon\Carbon::now()->toDateTimeString()
];
}
DB::table('products')->insert($datas);
}
}
php artisan db:seed
3.寫個簡單View視圖(1)用Repository Pattern來組織程式碼
//app/Repository
namespace App\Repository;
interface ShopRepositoryInterface
{
public function all();
}
//app/Repository/Eloquent
namespace App\Repository\Eloquent;
use App\Repository\ShopRepositoryInterface;
use App\Shop;
class ShopRepository implements ShopRepositoryInterface
{
/**
* @var Shop
*/
public $shop;
public function __construct(Shop $shop)
{
$this->shop = $shop;
}
public function all()
{
// TODO: Implement all() method.
$shops = $this->shop->all();
return $shops;
}
}
//app/provider/ShopRepositoryServiceProvider
//php artisan make:provider ShopRepositoryServiceProvider
/**
* Register the application services.
*
* @return void
*/
public function register()
{
$this->app->bind(ShopRepositoryInterface::class, ShopRepository::class);
}
//app/Http/Controllers/ShopController.php
class ShopController extends Controller
{
/**
* @var ShopRepositoryInterface
*/
public $shop;
/**
* ShopController constructor.
* @param ShopRepositoryInterface $shopRepositoryInterface
*/
public function __construct(ShopRepositoryInterface $shopRepositoryInterface)
{
$this->shop = $shopRepositoryInterface;
}
public function all()
{
$shops = $this->shop->all();
return view('shop.index', compact('shops'));
}
}
//视图
//resources/views/shop/layout.blade.php
<meta>
<meta>
<meta>
<!-- 上述3个meta标签*必须*放在最前面，任何其他内容都*必须*跟随其后！ -->
<title>Bootstrap Template</title>
<!-- 新 Bootstrap 核心 CSS 文件 -->
<link>
<style>
html,body{
width: 100%;
height: 100%;
}
*{
margin: 0;
border: 0;
}
</style>
<p>
</p><p>
</p><p>
@yield('content')
</p>
<!-- jQuery文件。务必在bootstrap.min.js 之前引入 -->
<script></script>
<!-- 最新的 Bootstrap 核心 JavaScript 文件 -->
<script></script>
<script>
</script>
//resources/views/shop/index.blade.php
@extends('shop.layout')
@section('content')
-
@foreach($shops as $shop)
-
Store:{{$shop->name}}
Member:{{$shop->merchant->first_name.' '.$shop->merchant->last_name}} {{--这里数组取电话号码--}} Phone:{{$shop->merchant->phone['number']}}-
@foreach($shop->products as $product)
-
Name:{{$product->name}}
Desc:{{$product->short_desc}}
Price:{{$product->price}}
{{-- {!! Debugbar::info('products:'.$product->id) !!}--}}
@endforeach
@endforeach
-
(2)Debugbar查看程式執行資料
可以看到，執行了121次query，耗時38.89ms，效率很低，仔細觀察每一個statement就發現這是先掃描shops表，再根據shops中每一個merchant_id去查找merchants表，查找products表也是這樣，又有很多次query，這是N 1查找問題。
預先載入查詢
(1)嵌套預先載入
Eloquent在透過屬性存取關聯資料時是延遲載入的，就是只有該關聯資料只有在透過屬性存取它時才會被載入。在尋找上層模型時可以透過預先載入關聯數據，避免N 1問題。 而且，使用預載超簡單。
只要修改一行：
//app/Repository/Eloquent/ShopRepository
public function all()
{
// TODO: Implement all() method.
// $shops = $this->shop->all();
//通过`点`语法嵌套预加载，多种关联就写对应的关联方法
//Shop这个Model里关联方法是Merchant()和Products()，Merchant Model里关联方法是Phone()
$shops = $this->shop->with(['merchant.phone', 'products'])->get();
return $shops;
}
不需要修改其他程式碼，再看Debugbar裡的查詢：
It is working! !!
發現：只有4個query，耗時3.58ms，效率提升很多。把原來的N 1這種query改造成了where..in..這種query，效率提高不少。可以用EXPLAIN來查看SQL語句的執行計劃。
(2)預先載入條件限制
也可以對預先載入進行條件限制，例如對products進行預先排序，程式碼也很好修改，只需：
//app/Repository/Eloquent/ShopRepository
public function all()
{
// TODO: Implement all() method.
// $shops = $this->shop->all();
// $shops = $this->shop->with(['merchant.phone', 'products'])->get();
$shops = $this->shop->with(['members.phone', 'products'=>function($query){
// $query->orderBy('price', 'desc');
$query->orderBy('price', 'asc');
}])->get();
return $shops;
}
透過加個限制條件，就等於在預先載入products時SQL語句上加個排序。截圖就不截取了。
總結：關聯模型預先載入的確是個有意思的功能，效率提高不少。最近都在瞎研究，遇到好玩的東西再分享出來吧，到時見。