Eloquent 關聯
📝 此頁面為 Laravel 官方文檔的繁體中文翻譯。查看原始英文版本
Eloquent:關聯
簡介
資料庫表通常是相互關聯的。例如,部落格文章可能有許多評論,或者訂單可能與下單的使用者相關聯。Eloquent 使管理和使用這些關聯變得容易,並支援多種常見的關聯:
定義關聯
Eloquent 關聯被定義為 Eloquent 模型類別上的方法。由於關聯也作為強大的查詢建構器,將關聯定義為方法提供了強大的方法鏈和查詢功能。例如,我們可以在此 posts 關聯上鏈接查詢約束:
$user->posts()->where('active', 1)->get();
但是,在深入了解使用關聯之前,讓我們學習如何定義 Eloquent 支援的每種關聯類型。
一對一 / Has One
一對一關聯是一種非常基本的資料庫關聯類型。例如,User 模型可能與一個 Phone 模型相關聯。要定義此關聯,我們將在 User 模型上放置一個 phone 方法。phone 方法應調用 hasOne 方法並返回其結果。hasOne 方法可透過模型的 Illuminate\Database\Eloquent\Model 基礎類別使用:
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\HasOne;
class User extends Model
{
/**
* 獲取與使用者關聯的手機。
*/
public function phone(): HasOne
{
return $this->hasOne(Phone::class);
}
}
傳遞給 hasOne 方法的第一個參數是關聯模型類別的名稱。定義關聯後,我們可以使用 Eloquent 的動態屬性來檢索關聯記錄。動態屬性允許您像存取模型上定義的屬性一樣存取關聯方法:
$phone = User::find(1)->phone;
Eloquent 根據父模型名稱確定關聯的外鍵。在這種情況下,Phone 模型自動被假設具有一個 user_id 外鍵。如果您想覆蓋此慣例,您可以向 hasOne 方法傳遞第二個參數:
return $this->hasOne(Phone::class, 'foreign_key');
此外,Eloquent 假定外鍵應具有與父級主鍵列匹配的值。換句話說,Eloquent 將在 Phone 記錄的 user_id 列中查找使用者 id 列的值。如果您希望關聯使用除 id 或模型主鍵之外的主鍵值,您可以向 hasOne 方法傳遞第三個參數:
return $this->hasOne(Phone::class, 'foreign_key', 'local_key');
定義關聯的反向
因此,我們可以從 User 模型存取 Phone 模型。接下來,讓我們在 Phone 模型上定義一個關聯,該關聯將允許我們存取擁有手機的使用者。我們可以使用 belongsTo 方法定義 hasOne 關聯的反向:
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
class Phone extends Model
{
/**
* 獲取擁有該手機的使用者。
*/
public function user(): BelongsTo
{
return $this->belongsTo(User::class);
}
}
調用 user 方法時,Eloquent 將嘗試查找具有與 Phone 模型上的 user_id 列匹配的 id 的 User 模型。
Eloquent 透過檢查關聯方法的名稱並在方法名稱後添加 _id 後綴來確定外鍵名稱。因此,在這種情況下,Eloquent 假定 Phone 模型具有 user_id 列。但是,如果 Phone 模型上的外鍵不是 user_id,您可以向 belongsTo 方法傳遞一個自訂金鑰名稱作為第二個參數:
/**
* 獲取擁有該手機的使用者。
*/
public function user(): BelongsTo
{
return $this->belongsTo(User::class, 'foreign_key');
}
如果父模型不使用 id 作為其主鍵,或者您希望使用不同的欄位來查找關聯模型,您可以向 belongsTo 方法傳遞第三個參數來指定父表的自訂金鑰:
/**
* 獲取擁有該手機的使用者。
*/
public function user(): BelongsTo
{
return $this->belongsTo(User::class, 'foreign_key', 'owner_key');
}
一對多 / Has Many
一對多關聯用於定義單個模型是多個子模型的父級的關聯。例如,部落格文章可能有無限數量的評論。與所有其他 Eloquent 關聯一樣,一對多關聯透過在 Eloquent 模型上定義方法來定義:
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\HasMany;
class Post extends Model
{
/**
* 獲取部落格文章的評論。
*/
public function comments(): HasMany
{
return $this->hasMany(Comment::class);
}
}
請記住,Eloquent 將自動確定 Comment 模型的正確外鍵欄位。按照慣例,Eloquent 將取父模型的「蛇形命名法」名稱並添加 _id 後綴。因此,在此範例中,Eloquent 將假定 Comment 模型上的外鍵欄位是 post_id。
定義關聯方法後,我們可以透過存取 comments 屬性來存取關聯評論的集合。請記住,由於 Eloquent 提供「動態關聯屬性」,我們可以像存取模型上定義的屬性一樣存取關聯方法:
use App\Models\Post;
$comments = Post::find(1)->comments;
foreach ($comments as $comment) {
// ...
}
由於所有關聯也作為查詢建構器,您可以透過調用 comments 方法並繼續在查詢上鏈接條件來向關聯查詢添加更多約束:
$comment = Post::find(1)->comments()
->where('title', 'foo')
->first();
與 hasOne 方法一樣,您可以透過向 hasMany 方法傳遞額外參數來覆蓋外鍵和本機鍵:
return $this->hasMany(Comment::class, 'foreign_key');
return $this->hasMany(Comment::class, 'foreign_key', 'local_key');
自動在子級上填充父模型
即使使用 Eloquent 預先載入,如果您嘗試在迭代子模型時從子模型存取父模型,也可能會出現「N + 1」查詢問題:
$posts = Post::with('comments')->get();
foreach ($posts as $post) {
foreach ($post->comments as $comment) {
echo $comment->post->title;
}
}
在上面的範例中,已經引入了一個「N + 1」查詢問題,因為即使為每個 Post 模型預先載入了評論,Eloquent 也不會自動在每個子 Comment 模型上填充父 Post。
如果您希望 Eloquent 自動在子級上填充父模型,您可以在定義 hasMany 關聯時調用 chaperone 方法:
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\HasMany;
class Post extends Model
{
/**
* 獲取部落格文章的評論。
*/
public function comments(): HasMany
{
return $this->hasMany(Comment::class)->chaperone();
}
}
或者,如果您想在運行時選擇加入自動父級填充,您可以在預先載入關聯時調用 chaperone 模型:
use App\Models\Post;
$posts = Post::with([
'comments' => fn ($comments) => $comments->chaperone(),
])->get();
一對多(反向)/ Belongs To
現在我們可以存取文章的所有評論,讓我們定義一個關聯,允許評論存取其父文章。要定義 hasMany 關聯的反向,請在子模型上定義一個調用 belongsTo 方法的關聯方法:
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
class Comment extends Model
{
/**
* 獲取擁有該評論的文章。
*/
public function post(): BelongsTo
{
return $this->belongsTo(Post::class);
}
}
定義關聯後,我們可以透過存取 post「動態關聯屬性」來檢索評論的父文章:
use App\Models\Comment;
$comment = Comment::find(1);
return $comment->post->title;
在上面的範例中,Eloquent 將嘗試查找具有與 Comment 模型上的 post_id 列匹配的 id 的 Post 模型。
Eloquent 透過檢查關聯方法的名稱並在方法名稱後添加 _ 加上父模型主鍵列的名稱來確定預設外鍵名稱。因此,在此範例中,Eloquent 將假定 Post 模型在 comments 表上的外鍵是 post_id。
但是,如果關聯的外鍵不遵循這些慣例,您可以向 belongsTo 方法傳遞一個自訂外鍵名稱作為第二個參數:
/**
* 獲取擁有該評論的文章。
*/
public function post(): BelongsTo
{
return $this->belongsTo(Post::class, 'foreign_key');
}
如果您的父模型不使用 id 作為其主鍵,或者您希望使用不同的欄位來查找關聯模型,您可以向 belongsTo 方法傳遞第三個參數來指定父表的自訂金鑰:
/**
* 獲取擁有該評論的文章。
*/
public function post(): BelongsTo
{
return $this->belongsTo(Post::class, 'foreign_key', 'owner_key');
}
預設模型
belongsTo、hasOne、hasOneThrough 和 morphOne 關聯允許您定義一個預設模型,如果給定的關聯為 null,則返回該模型。此模式通常被稱為空物件模式,可以幫助消除程式碼中的條件檢查。在以下範例中,如果 Post 模型上沒有附加使用者,user 關聯將返回一個空的 App\Models\User 模型:
/**
* 獲取文章的作者。
*/
public function user(): BelongsTo
{
return $this->belongsTo(User::class)->withDefault();
}
要用屬性填充預設模型,您可以向 withDefault 方法傳遞一個陣列或閉包:
/**
* 獲取文章的作者。
*/
public function user(): BelongsTo
{
return $this->belongsTo(User::class)->withDefault([
'name' => 'Guest Author',
]);
}
/**
* 獲取文章的作者。
*/
public function user(): BelongsTo
{
return $this->belongsTo(User::class)->withDefault(function (User $user, Post $post) {
$user->name = 'Guest Author';
});
}
查詢 Belongs To 關聯
查詢「屬於」關聯的子級時,您可以手動建立 where 子句來檢索相應的 Eloquent 模型:
use App\Models\Post;
$posts = Post::where('user_id', $user->id)->get();
但是,您可能會發現使用 whereBelongsTo 方法更方便,它將自動確定給定模型的正確關聯和外鍵:
$posts = Post::whereBelongsTo($user)->get();
您還可以向 whereBelongsTo 方法提供一個集合實例。這樣做時,Laravel 將檢索屬於集合中任何父模型的模型:
$users = User::where('vip', true)->get();
$posts = Post::whereBelongsTo($users)->get();
預設情況下,Laravel 將根據模型的類別名稱確定與給定模型關聯的關聯;但是,您可以透過向 whereBelongsTo 方法提供關聯名稱作為第二個參數來手動指定關聯名稱:
$posts = Post::whereBelongsTo($user, 'author')->get();
Has One of Many
有時一個模型可能有多個關聯模型,但您想要輕鬆檢索關聯的「最新」或「最舊」關聯模型。例如,User 模型可能與多個 Order 模型相關聯,但您想要定義一種方便的方法來與使用者下達的最近訂單進行互動。您可以使用 hasOne 關聯類型結合 ofMany 方法來完成此操作:
/**
* 獲取使用者最近的訂單。
*/
public function latestOrder(): HasOne
{
return $this->hasOne(Order::class)->latestOfMany();
}
同樣,您可以定義一個方法來檢索關聯的「最舊」或第一個關聯模型:
/**
* 獲取使用者最舊的訂單。
*/
public function oldestOrder(): HasOne
{
return $this->hasOne(Order::class)->oldestOfMany();
}
預設情況下,latestOfMany 和 oldestOfMany 方法將根據模型的主鍵(必須可排序)檢索最新或最舊的關聯模型。但是,有時您可能希望使用不同的排序標準從較大的關聯中檢索單個模型。
例如,使用 ofMany 方法,您可以檢索使用者最昂貴的訂單。ofMany 方法接受可排序的列作為其第一個參數,以及在查詢關聯模型時要應用的聚合函數(min 或 max):
/**
* 獲取使用者最大的訂單。
*/
public function largestOrder(): HasOne
{
return $this->hasOne(Order::class)->ofMany('price', 'max');
}
[!WARNING] 由於 PostgreSQL 不支援對 UUID 列執行
MAX函數,因此目前無法將 one-of-many 關聯與 PostgreSQL UUID 列結合使用。
將「多」關聯轉換為 Has One 關聯
通常,使用 latestOfMany、oldestOfMany 或 ofMany 方法檢索單個模型時,您已經為同一個模型定義了一個「has many」關聯。為了方便,Laravel 允許您透過在關聯上調用 one 方法輕鬆地將此關聯轉換為「has one」關聯:
/**
* 獲取使用者的訂單。
*/
public function orders(): HasMany
{
return $this->hasMany(Order::class);
}
/**
* 獲取使用者最大的訂單。
*/
public function largestOrder(): HasOne
{
return $this->orders()->one()->ofMany('price', 'max');
}
您還可以使用 one 方法將 HasManyThrough 關聯轉換為 HasOneThrough 關聯:
public function latestDeployment(): HasOneThrough
{
return $this->deployments()->one()->latestOfMany();
}
進階 Has One of Many 關聯
可以建立更進階的「has one of many」關聯。例如,Product 模型可能有多個關聯的 Price 模型,即使在發布新定價後仍保留在系統中。此外,產品的新定價資料可以透過 published_at 列提前發布,以便在未來日期生效。
因此,總之,我們需要檢索已發布日期不是未來的最新已發布定價。此外,如果兩個價格具有相同的發佈日期,我們將優先選擇具有最大 ID 的價格。為此,我們必須向 ofMany 方法傳遞一個包含確定最新價格的可排序列的陣列。此外,一個閉包將作為第二個參數提供給 ofMany 方法。此閉包將負責向關聯查詢添加額外的發佈日期約束:
/**
* 獲取產品的當前定價。
*/
public function currentPricing(): HasOne
{
return $this->hasOne(Price::class)->ofMany([
'published_at' => 'max',
'id' => 'max',
], function (Builder $query) {
$query->where('published_at', '<', now());
});
}
Has One Through
「has-one-through」關聯定義了與另一個模型的一對一關聯。但是,此關聯表示聲明模型可以透過經過第三個模型與另一個模型的一個實例匹配。
例如,在車輛維修店應用程式中,每個 Mechanic 模型可能與一個 Car 模型相關聯,每個 Car 模型可能與一個 Owner 模型相關聯。雖然技師和車主在資料庫中沒有直接關聯,但技師可以透過 Car 模型存取車主。讓我們看看定義此關聯所需的表:
mechanics
id - integer
name - string
cars
id - integer
model - string
mechanic_id - integer
owners
id - integer
name - string
car_id - integer
現在我們已經檢查了關聯的表結構,讓我們在 Mechanic 模型上定義關聯:
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\HasOneThrough;
class Mechanic extends Model
{
/**
* 獲取汽車的車主。
*/
public function carOwner(): HasOneThrough
{
return $this->hasOneThrough(Owner::class, Car::class);
}
}
傳遞給 hasOneThrough 方法的第一個參數是我們希望存取的最終模型的名稱,而第二個參數是中間模型的名稱。
或者,如果相關關聯已在關聯中涉及的所有模型上定義,您可以透過調用 through 方法並提供這些關聯的名稱來流暢地定義「has-one-through」關聯。例如,如果 Mechanic 模型具有 cars 關聯,而 Car 模型具有 owner 關聯,您可以像這樣定義連接技師和車主的「has-one-through」關聯:
// 基於字串的語法...
return $this->through('cars')->has('owner');
// 動態語法...
return $this->throughCars()->hasOwner();
金鑰慣例
執行關聯查詢時將使用典型的 Eloquent 外鍵慣例。如果您想自訂關聯的金鑰,可以將它們作為第三個和第四個參數傳遞給 hasOneThrough 方法。第三個參數是中間模型上的外鍵名稱。第四個參數是最終模型上的外鍵名稱。第五個參數是本機鍵,而第六個參數是中間模型的本機鍵:
class Mechanic extends Model
{
/**
* 獲取汽車的車主。
*/
public function carOwner(): HasOneThrough
{
return $this->hasOneThrough(
Owner::class,
Car::class,
'mechanic_id', // cars 表上的外鍵...
'car_id', // owners 表上的外鍵...
'id', // mechanics 表上的本機鍵...
'id' // cars 表上的本機鍵...
);
}
}
或者,如前所述,如果相關關聯已在關聯中涉及的所有模型上定義,您可以透過調用 through 方法並提供這些關聯的名稱來流暢地定義「has-one-through」關聯。這種方法提供了重用現有關聯上已定義的金鑰慣例的優勢:
// 基於字串的語法...
return $this->through('cars')->has('owner');
// 動態語法...
return $this->throughCars()->hasOwner();
Has Many Through
「has-many-through」關聯提供了一種透過中間關聯存取遠端關聯的方便方法。例如,讓我們假設我們正在建立一個像 Laravel Cloud 這樣的部署平台。Application 模型可能透過中間 Environment 模型存取許多 Deployment 模型。使用此範例,您可以輕鬆收集給定應用程式的所有部署。讓我們看看定義此關聯所需的表:
applications
id - integer
name - string
environments
id - integer
application_id - integer
name - string
deployments
id - integer
environment_id - integer
commit_hash - string
現在我們已經檢查了關聯的表結構,讓我們在 Application 模型上定義關聯:
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\HasManyThrough;
class Application extends Model
{
/**
* 獲取應用程式的所有部署。
*/
public function deployments(): HasManyThrough
{
return $this->hasManyThrough(Deployment::class, Environment::class);
}
}
傳遞給 hasManyThrough 方法的第一個參數是我們希望存取的最終模型的名稱,而第二個參數是中間模型的名稱。
或者,如果相關關聯已在關聯中涉及的所有模型上定義,您可以透過調用 through 方法並提供這些關聯的名稱來流暢地定義「has-many-through」關聯。例如,如果 Application 模型具有 environments 關聯,而 Environment 模型具有 deployments 關聯,您可以像這樣定義連接應用程式和部署的「has-many-through」關聯:
// 基於字串的語法...
return $this->through('environments')->has('deployments');
// 動態語法...
return $this->throughEnvironments()->hasDeployments();
儘管 Deployment 模型的表不包含 application_id 列,但 hasManyThrough 關聯提供了透過 $application->deployments 存取應用程式部署的途徑。要檢索這些模型,Eloquent 會檢查中間 Environment 模型表上的 application_id 列。找到相關的環境 ID 後,它們將用於查詢 Deployment 模型的表。
金鑰慣例
執行關聯查詢時將使用典型的 Eloquent 外鍵慣例。如果您想自訂關聯的金鑰,可以將它們作為第三個和第四個參數傳遞給 hasManyThrough 方法。第三個參數是中間模型上的外鍵名稱。第四個參數是最終模型上的外鍵名稱。第五個參數是本機鍵,而第六個參數是中間模型的本機鍵:
class Application extends Model
{
public function deployments(): HasManyThrough
{
return $this->hasManyThrough(
Deployment::class,
Environment::class,
'application_id', // environments 表上的外鍵...
'environment_id', // deployments 表上的外鍵...
'id', // applications 表上的本機鍵...
'id' // environments 表上的本機鍵...
);
}
}
或者,如前所述,如果相關關聯已在關聯中涉及的所有模型上定義,您可以透過調用 through 方法並提供這些關聯的名稱來流暢地定義「has-many-through」關聯。這種方法提供了重用現有關聯上已定義的金鑰慣例的優勢:
// 基於字串的語法...
return $this->through('environments')->has('deployments');
// 動態語法...
return $this->throughEnvironments()->hasDeployments();
作用域關聯
向約束關聯的模型添加其他方法是很常見的。例如,您可能會向 User 模型添加一個 featuredPosts 方法,該方法使用額外的 where 約束來約束更廣泛的 posts 關聯:
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\HasMany;
class User extends Model
{
/**
* 獲取使用者的文章。
*/
public function posts(): HasMany
{
return $this->hasMany(Post::class)->latest();
}
/**
* 獲取使用者的特色文章。
*/
public function featuredPosts(): HasMany
{
return $this->posts()->where('featured', true);
}
}
但是,如果您嘗試透過 featuredPosts 方法建立模型,其 featured 屬性不會被設置為 true。如果您想透過關聯方法建立模型,同時指定應添加到透過該關聯建立的所有模型的屬性,您可以在建立關聯查詢時使用 withAttributes 方法:
/**
* 獲取使用者的特色文章。
*/
public function featuredPosts(): HasMany
{
return $this->posts()->withAttributes(['featured' => true]);
}
withAttributes 方法將使用給定的屬性向查詢添加 where 條件,並且還會將給定的屬性添加到透過該關聯方法建立的任何模型中:
$post = $user->featuredPosts()->create(['title' => 'Featured Post']);
$post->featured; // true
要指示 withAttributes 方法不向查詢添加 where 條件,您可以將 asConditions 參數設置為 false:
return $this->posts()->withAttributes(['featured' => true], asConditions: false);
多對多關聯
多對多關聯比 hasOne 和 hasMany 關聯稍微複雜一些。多對多關聯的一個範例是一個使用者具有多個角色,而這些角色也被應用程式中的其他使用者共享。例如,一個使用者可能被分配了「作者」和「編輯」角色;但是,這些角色也可能被分配給其他使用者。因此,一個使用者有多個角色,一個角色有多個使用者。
表結構
要定義此關聯,需要三個資料庫表:users、roles 和 role_user。role_user 表是從關聯模型名稱的字母順序派生的,包含 user_id 和 role_id 列。此表用作連接使用者和角色的中間表。
請記住,由於一個角色可以屬於多個使用者,我們不能簡單地在 roles 表上放置一個 user_id 列。這意味著一個角色只能屬於一個使用者。為了支援將角色分配給多個使用者,需要 role_user 表。我們可以像這樣總結關聯的表結構:
users
id - integer
name - string
roles
id - integer
name - string
role_user
user_id - integer
role_id - integer
模型結構
多對多關聯透過編寫一個返回 belongsToMany 方法結果的方法來定義。belongsToMany 方法由您應用程式的所有 Eloquent 模型使用的 Illuminate\Database\Eloquent\Model 基礎類別提供。例如,讓我們在 User 模型上定義一個 roles 方法。傳遞給此方法的第一個參數是關聯模型類別的名稱:
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsToMany;
class User extends Model
{
/**
* 屬於該使用者的角色。
*/
public function roles(): BelongsToMany
{
return $this->belongsToMany(Role::class);
}
}
定義關聯後,您可以使用 roles 動態關聯屬性存取使用者的角色:
use App\Models\User;
$user = User::find(1);
foreach ($user->roles as $role) {
// ...
}
由於所有關聯也作為查詢建構器,您可以透過調用 roles 方法並繼續在查詢上鏈接條件來向關聯查詢添加更多約束:
$roles = User::find(1)->roles()->orderBy('name')->get();
要確定關聯的中間表的表名,Eloquent 將按字母順序連接兩個關聯模型名稱。但是,您可以自由地覆蓋此慣例。您可以透過向 belongsToMany 方法傳遞第二個參數來實現:
return $this->belongsToMany(Role::class, 'role_user');
除了自訂中間表的名稱外,您還可以透過向 belongsToMany 方法傳遞額外參數來自訂表上的金鑰列名。第三個參數是您定義關聯的模型的外鍵名稱,而第四個參數是您要連接的模型的外鍵名稱:
return $this->belongsToMany(Role::class, 'role_user', 'user_id', 'role_id');
定義關聯的反向
要定義多對多關聯的「反向」,您應該在關聯模型上定義一個也返回 belongsToMany 方法結果的方法。為了完成我們的使用者/角色範例,讓我們在 Role 模型上定義 users 方法:
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsToMany;
class Role extends Model
{
/**
* 屬於該角色的使用者。
*/
public function users(): BelongsToMany
{
return $this->belongsToMany(User::class);
}
}
如您所見,關聯的定義與其 User 模型對應物完全相同,只是引用了 App\Models\User 模型。由於我們正在重用 belongsToMany 方法,因此在定義多對多關聯的「反向」時,所有常見的表和金鑰自訂選項都可用。
檢索中間表欄位
正如您已經了解到的,使用多對多關聯需要中間表的存在。Eloquent 提供了一些非常有幫助的方法來與此表互動。例如,讓我們假設我們的 User 模型與許多 Role 模型相關聯。存取此關聯後,我們可以使用模型上的 pivot 屬性來存取中間表:
use App\Models\User;
$user = User::find(1);
foreach ($user->roles as $role) {
echo $role->pivot->created_at;
}
請注意,我們檢索的每個 Role 模型都自動被分配了一個 pivot 屬性。此屬性包含一個代表中間表的模型。
預設情況下,pivot 模型上只會存在模型金鑰。如果您的中間表包含額外的屬性,您必須在定義關聯時指定它們:
return $this->belongsToMany(Role::class)->withPivot('active', 'created_by');
如果您希望中間表具有由 Eloquent 自動維護的 created_at 和 updated_at 時間戳,請在定義關聯時調用 withTimestamps 方法:
return $this->belongsToMany(Role::class)->withTimestamps();
[!WARNING] 使用 Eloquent 自動維護的時間戳的中間表需要同時具有
created_at和updated_at時間戳列。
自訂 pivot 屬性名稱
如前所述,可以透過 pivot 屬性在模型上存取中間表的屬性。但是,您可以自由地自訂此屬性的名稱,以更好地反映其在應用程式中的用途。
例如,如果您的應用程式包含可能訂閱播客的使用者,您可能在使用者和播客之間有一個多對多關聯。如果是這種情況,您可能希望將中間表屬性重新命名為 subscription 而不是 pivot。這可以使用 as 方法在定義關聯時完成:
return $this->belongsToMany(Podcast::class)
->as('subscription')
->withTimestamps();
指定自訂中間表屬性後,您可以使用自訂名稱存取中間表資料:
$users = User::with('podcasts')->get();
foreach ($users->flatMap->podcasts as $podcast) {
echo $podcast->subscription->created_at;
}
透過中間表欄位過濾查詢
您還可以在定義關聯時使用 wherePivot、wherePivotIn、wherePivotNotIn、wherePivotBetween、wherePivotNotBetween、wherePivotNull 和 wherePivotNotNull 方法來過濾 belongsToMany 關聯查詢返回的結果:
return $this->belongsToMany(Role::class)
->wherePivot('approved', 1);
return $this->belongsToMany(Role::class)
->wherePivotIn('priority', [1, 2]);
return $this->belongsToMany(Role::class)
->wherePivotNotIn('priority', [1, 2]);
return $this->belongsToMany(Podcast::class)
->as('subscriptions')
->wherePivotBetween('created_at', ['2020-01-01 00:00:00', '2020-12-31 00:00:00']);
return $this->belongsToMany(Podcast::class)
->as('subscriptions')
->wherePivotNotBetween('created_at', ['2020-01-01 00:00:00', '2020-12-31 00:00:00']);
return $this->belongsToMany(Podcast::class)
->as('subscriptions')
->wherePivotNull('expired_at');
return $this->belongsToMany(Podcast::class)
->as('subscriptions')
->wherePivotNotNull('expired_at');
wherePivot 向查詢添加一個 where 子句約束,但在透過定義的關聯建立新模型時不添加指定的值。如果您需要使用特定的樞紐值同時查詢和建立關聯,您可以使用 withPivotValue 方法:
return $this->belongsToMany(Role::class)
->withPivotValue('approved', 1);
透過中間表欄位排序查詢
您可以使用 orderByPivot 和 orderByPivotDesc 方法對 belongsToMany 關聯查詢返回的結果進行排序。在以下範例中,我們將檢索使用者的所有最新徽章:
return $this->belongsToMany(Badge::class)
->where('rank', 'gold')
->orderByPivotDesc('created_at');
定義自訂中間表模型
如果您想定義一個自訂模型來表示多對多關聯的中間表,您可以在定義關聯時調用 using 方法。自訂樞紐模型為您提供了在樞紐模型上定義額外行為的機會,例如方法和轉換器。
自訂多對多樞紐模型應繼承 Illuminate\Database\Eloquent\Relations\Pivot 類別,而自訂多型多對多樞紐模型應繼承 Illuminate\Database\Eloquent\Relations\MorphPivot 類別。例如,我們可以定義一個使用自訂 RoleUser 樞紐模型的 Role 模型:
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsToMany;
class Role extends Model
{
/**
* 屬於該角色的使用者。
*/
public function users(): BelongsToMany
{
return $this->belongsToMany(User::class)->using(RoleUser::class);
}
}
定義 RoleUser 模型時,您應該繼承 Illuminate\Database\Eloquent\Relations\Pivot 類別:
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Relations\Pivot;
class RoleUser extends Pivot
{
// ...
}
[!WARNING] 樞紐模型不能使用
SoftDeletestrait。如果您需要軟刪除樞紐記錄,請考慮將您的樞紐模型轉換為實際的 Eloquent 模型。
自訂樞紐模型和遞增 ID
如果您定義了使用自訂樞紐模型的多對多關聯,並且該樞紐模型具有自動遞增的主鍵,您應該確保您的自訂樞紐模型類別使用 Table 屬性,其中 incrementing 設為 true:
use Illuminate\Database\Eloquent\Attributes\Table;
use Illuminate\Database\Eloquent\Relations\Pivot;
#[Table(incrementing: true)]
class RoleUser extends Pivot
{
// ...
}
多型關聯
多型關聯允許子模型使用單個關聯屬於多種類型的模型。例如,想像您正在建立一個允許使用者分享部落格文章和影片的應用程式。在這樣的應用程式中,Comment 模型可能同時屬於 Post 和 Video 模型。
一對一(多型)
表結構
一對多多型關聯類似於典型的一對一關聯;但是,子模型可以使用單個關聯屬於多種類型的模型。例如,部落格 Post 和 User 可能共享與 Image 模型的多型關聯。使用一對多多型關聯允許您擁有一個唯一的圖片表,該表可以與文章和使用者相關聯。首先,讓我們檢查表結構:
posts
id - integer
name - string
users
id - integer
name - string
images
id - integer
url - string
imageable_type - string
imageable_id - integer
請注意 images 表上的 imageable_id 和 imageable_type 列。imageable_id 列將包含文章或使用者的 ID 值,而 imageable_type 列將包含父模型的類別名稱。imageable_type 列被 Eloquent 用於在存取 imageable 關聯時確定要返回哪種「類型」的父模型。在這種情況下,該列將包含 App\Models\Post 或 App\Models\User。
模型結構
接下來,讓我們檢查建立此關聯所需的模型定義:
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\MorphTo;
class Image extends Model
{
/**
* 獲取父 imageable 模型(使用者或文章)。
*/
public function imageable(): MorphTo
{
return $this->morphTo();
}
}
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\MorphOne;
class Post extends Model
{
/**
* 獲取文章的圖片。
*/
public function image(): MorphOne
{
return $this->morphOne(Image::class, 'imageable');
}
}
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\MorphOne;
class User extends Model
{
/**
* 獲取使用者的圖片。
*/
public function image(): MorphOne
{
return $this->morphOne(Image::class, 'imageable');
}
}
檢索關聯
定義資料庫表和模型後,您可以透過模型存取關聯。例如,要檢索文章的圖片,我們可以存取 image 動態關聯屬性:
use App\Models\Post;
$post = Post::find(1);
$image = $post->image;
您可以透過存取執行 morphTo 呼叫的方法名稱來檢索多型模型的父級。在這種情況下,這是 Image 模型上的 imageable 方法。因此,我們將作為動態關聯屬性存取該方法:
use App\Models\Image;
$image = Image::find(1);
$imageable = $image->imageable;
Image 模型上的 imageable 關聯將返回 Post 或 User 實例,具體取決於哪種類型的模型擁有圖片。
金鑰慣例
如有必要,您可以指定多型子模型使用的「id」和「type」列的名稱。如果這樣做,請確保始終將關聯名稱作為第一個參數傳遞給 morphTo 方法。通常,此值應與方法名稱匹配,因此您可以使用 PHP 的 __FUNCTION__ 常數:
/**
* 獲取圖片所屬的模型。
*/
public function imageable(): MorphTo
{
return $this->morphTo(__FUNCTION__, 'imageable_type', 'imageable_id');
}
一對多(多型)
表結構
一對多多型關聯類似於典型的一對多關聯;但是,子模型可以使用單個關聯屬於多種類型的模型。例如,想像您應用程式的使用者可以對文章和影片「評論」。使用多型關聯,您可以使用單個 comments 表來包含文章和影片的評論。首先,讓我們檢查建立此關聯所需的表結構:
posts
id - integer
title - string
body - text
videos
id - integer
title - string
url - string
comments
id - integer
body - text
commentable_type - string
commentable_id - integer
模型結構
接下來,讓我們檢查建立此關聯所需的模型定義:
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\MorphTo;
class Comment extends Model
{
/**
* 獲取父 commentable 模型(文章或影片)。
*/
public function commentable(): MorphTo
{
return $this->morphTo();
}
}
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\MorphMany;
class Post extends Model
{
/**
* 獲取文章的所有評論。
*/
public function comments(): MorphMany
{
return $this->morphMany(Comment::class, 'commentable');
}
}
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\MorphMany;
class Video extends Model
{
/**
* 獲取影片的所有評論。
*/
public function comments(): MorphMany
{
return $this->morphMany(Comment::class, 'commentable');
}
}
檢索關聯
定義資料庫表和模型後,您可以透過模型的動態關聯屬性存取關聯。例如,要存取文章的所有評論,我們可以使用 comments 動態屬性:
use App\Models\Post;
$post = Post::find(1);
foreach ($post->comments as $comment) {
// ...
}
您還可以透過存取執行 morphTo 呼叫的方法名稱來檢索多型子模型的父級。在這種情況下,這是 Comment 模型上的 commentable 方法。因此,我們將作為動態關聯屬性存取該方法以存取評論的父模型:
use App\Models\Comment;
$comment = Comment::find(1);
$commentable = $comment->commentable;
Comment 模型上的 commentable 關聯將返回 Post 或 Video 實例,具體取決於哪種類型的模型是評論的父級。
自動在子級上填充父模型
即使使用 Eloquent 預先載入,如果您嘗試在迭代子模型時從子模型存取父模型,也可能會出現「N + 1」查詢問題:
$posts = Post::with('comments')->get();
foreach ($posts as $post) {
foreach ($post->comments as $comment) {
echo $comment->commentable->title;
}
}
在上面的範例中,已經引入了一個「N + 1」查詢問題,因為即使為每個 Post 模型預先載入了評論,Eloquent 也不會自動在每個子 Comment 模型上填充父 Post。
如果您希望 Eloquent 自動在子級上填充父模型,您可以在定義 morphMany 關聯時調用 chaperone 方法:
class Post extends Model
{
/**
* 獲取文章的所有評論。
*/
public function comments(): MorphMany
{
return $this->morphMany(Comment::class, 'commentable')->chaperone();
}
}
或者,如果您想在運行時選擇加入自動父級填充,您可以在預先載入關聯時調用 chaperone 模型:
use App\Models\Post;
$posts = Post::with([
'comments' => fn ($comments) => $comments->chaperone(),
])->get();
One of Many(多型)
有時一個模型可能有多個關聯模型,但您想要輕鬆檢索關聯的「最新」或「最舊」關聯模型。例如,User 模型可能與多個 Image 模型相關聯,但您想要定義一種方便的方法來與使用者上傳的最近圖片進行互動。您可以使用 morphOne 關聯類型結合 ofMany 方法來完成此操作:
/**
* 獲取使用者最近的圖片。
*/
public function latestImage(): MorphOne
{
return $this->morphOne(Image::class, 'imageable')->latestOfMany();
}
同樣,您可以定義一個方法來檢索關聯的「最舊」或第一個關聯模型:
/**
* 獲取使用者最舊的圖片。
*/
public function oldestImage(): MorphOne
{
return $this->morphOne(Image::class, 'imageable')->oldestOfMany();
}
預設情況下,latestOfMany 和 oldestOfMany 方法將根據模型的主鍵(必須可排序)檢索最新或最舊的關聯模型。但是,有時您可能希望使用不同的排序標準從較大的關聯中檢索單個模型。
例如,使用 ofMany 方法,您可以檢索使用者最受歡迎的圖片。ofMany 方法接受可排序的列作為其第一個參數,以及在查詢關聯模型時要應用的聚合函數(min 或 max):
/**
* 獲取使用者最受歡迎的圖片。
*/
public function bestImage(): MorphOne
{
return $this->morphOne(Image::class, 'imageable')->ofMany('likes', 'max');
}
[!NOTE] 可以建立更進階的「one of many」關聯。有關更多資訊,請查閱has one of many 文檔。
多對多(多型)
表結構
多對多多型關聯比「morph one」和「morph many」關聯稍微複雜一些。例如,Post 模型和 Video 模型可能共享與 Tag 模型的多型關聯。在此情況下使用多對多多型關聯將允許您的應用程式擁有一個唯一的標籤表,該表可以與文章或影片相關聯。首先,讓我們檢查建立此關聯所需的表結構:
posts
id - integer
name - string
videos
id - integer
name - string
tags
id - integer
name - string
taggables
tag_id - integer
taggable_type - string
taggable_id - integer
[!NOTE] 在深入了解多對多多型關聯之前,您可能需要閱讀有關多對多關聯的文檔。
模型結構
接下來,我們準備好在模型上定義關聯。Post 和 Video 模型都將包含一個 tags 方法,該方法調用基礎 Eloquent 模型類別提供的 morphToMany 方法。
morphToMany 方法接受關聯模型的名稱以及「關聯名稱」。根據我們分配給中間表名和它包含的金鑰的名稱,我們將稱此關聯為「taggable」:
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\MorphToMany;
class Post extends Model
{
/**
* 獲取文章的所有標籤。
*/
public function tags(): MorphToMany
{
return $this->morphToMany(Tag::class, 'taggable');
}
}
定義關聯的反向
接下來,在 Tag 模型上,您應該為其每個可能的父模型定義一個方法。因此,在此範例中,我們將定義一個 posts 方法和一個 videos 方法。這兩個方法都應返回 morphedByMany 方法的結果。
morphedByMany 方法接受關聯模型的名稱以及「關聯名稱」。根據我們分配給中間表名和它包含的金鑰的名稱,我們將稱此關聯為「taggable」:
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\MorphToMany;
class Tag extends Model
{
/**
* 獲取分配了此標籤的所有文章。
*/
public function posts(): MorphToMany
{
return $this->morphedByMany(Post::class, 'taggable');
}
/**
* 獲取分配了此標籤的所有影片。
*/
public function videos(): MorphToMany
{
return $this->morphedByMany(Video::class, 'taggable');
}
}
檢索關聯
定義資料庫表和模型後,您可以透過模型存取關聯。例如,要存取文章的所有標籤,您可以使用 tags 動態關聯屬性:
use App\Models\Post;
$post = Post::find(1);
foreach ($post->tags as $tag) {
// ...
}
您可以透過存取執行 morphedByMany 呼叫的方法名稱來從多型子模型檢索多型關聯的父級。在這種情況下,這是 Tag 模型上的 posts 或 videos 方法:
use App\Models\Tag;
$tag = Tag::find(1);
foreach ($tag->posts as $post) {
// ...
}
foreach ($tag->videos as $video) {
// ...
}
自訂多型類型
預設情況下,Laravel 將使用完全限定的類別名稱來儲存關聯模型的「類型」。例如,給定上面的多型一對多關聯範例,其中 Comment 模型可能屬於 Post 或 Video 模型,預設的 commentable_type 將分別為 App\Models\Post 或 App\Models\Video。但是,您可能希望將這些值與應用程式的內部結構解耦。
例如,我們可以使用簡單的字串(如 post 和 video)代替使用模型名稱作為「類型」。這樣做後,即使模型被重新命名,我們資料庫中的多型「類型」列值仍將有效:
use Illuminate\Database\Eloquent\Relations\Relation;
Relation::enforceMorphMap([
'post' => 'App\Models\Post',
'video' => 'App\Models\Video',
]);
您可以在 App\Providers\AppServiceProvider 類別的 boot 方法中調用 enforceMorphMap 方法,或者如果您願意,可以建立一個單獨的服務提供者。
您可以使用模型的 getMorphClass 方法在運行時確定給定模型的形態別名。相反,您可以使用 Relation::getMorphedModel 方法確定與形態別名關聯的完全限定類別名稱:
use Illuminate\Database\Eloquent\Relations\Relation;
$alias = $post->getMorphClass();
$class = Relation::getMorphedModel($alias);
[!WARNING] 向現有應用程式添加「形態映射」時,資料庫中仍包含完全限定類別的每個可形態
*_type列值都需要轉換為其「映射」名稱。
動態關聯
您可以使用 resolveRelationUsing 方法在運行時定義 Eloquent 模型之間的關係。雖然通常不建議用於正常的應用程式開發,但在開發 Laravel 套件時偶爾會很有用。
resolveRelationUsing 方法接受所需的關聯名稱作為其第一個參數。傳遞給方法的第二個參數應是一個接受模型實例並返回有效 Eloquent 關聯定義的閉包。通常,您應該在服務提供者的 boot 方法中配置動態關聯:
use App\Models\Order;
use App\Models\Customer;
Order::resolveRelationUsing('customer', function (Order $orderModel) {
return $orderModel->belongsTo(Customer::class, 'customer_id');
});
[!WARNING] 定義動態關聯時,請始終向 Eloquent 關聯方法提供明確的金鑰名稱參數。
查詢關聯
由於所有 Eloquent 關聯都是透過方法定義的,您可以調用這些方法來獲取關聯的實例,而無需實際執行查詢來載入關聯模型。此外,所有類型的 Eloquent 關聯也作為查詢建構器,允許您在最終對資料庫執行 SQL 查詢之前繼續在關聯查詢上鏈接約束。
例如,想像一個部落格應用程式,其中 User 模型具有許多關聯的 Post 模型:
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\HasMany;
class User extends Model
{
/**
* 獲取使用者的所有文章。
*/
public function posts(): HasMany
{
return $this->hasMany(Post::class);
}
}
您可以查詢 posts 關聯並向關聯添加額外的約束:
use App\Models\User;
$user = User::find(1);
$user->posts()->where('active', 1)->get();
您可以在關聯上使用 Laravel 查詢建構器的所有方法,因此請務必探索查詢建構器文檔以了解所有可用的方法。
在關聯後鏈接 orWhere 子句
如上面的範例所示,您可以在查詢關聯時向關聯添加額外的約束。但是,在關聯上鏈接 orWhere 子句時要小心,因為 orWhere 子句將在與關聯約束相同的層級上進行邏輯分組:
$user->posts()
->where('active', 1)
->orWhere('votes', '>=', 100)
->get();
上面的範例將產生以下 SQL。如您所見,or 子句指示查詢返回任何投票數大於 100 的文章。查詢不再約束於特定使用者:
select *
from posts
where user_id = ? and active = 1 or votes >= 100
在大多數情況下,您應該使用邏輯分組將條件檢查分組在括號內:
use Illuminate\Database\Eloquent\Builder;
$user->posts()
->where(function (Builder $query) {
return $query->where('active', 1)
->orWhere('votes', '>=', 100);
})
->get();
上面的範例將產生以下 SQL。請注意,邏輯分組已正確地對約束進行了分組,並且查詢仍然約束於特定使用者:
select *
from posts
where user_id = ? and (active = 1 or votes >= 100)
關聯方法 vs. 動態屬性
如果您不需要向 Eloquent 關聯查詢添加額外的約束,您可以像存取屬性一樣存取關聯。例如,繼續使用我們的 User 和 Post 範例模型,我們可以像這樣存取使用者的所有文章:
use App\Models\User;
$user = User::find(1);
foreach ($user->posts as $post) {
// ...
}
動態關聯屬性執行「延遲載入」,這意味著它們只會在您實際存取時才載入其關聯資料。因此,開發者通常使用預先載入來預載入他們知道將在載入模型後存取的關聯。預先載入顯著減少了必須執行的 SQL 查詢數量以載入模型的關聯。
查詢關聯存在性
檢索模型記錄時,您可能希望根據關聯的存在性來限制結果。例如,想像您想檢索至少有一條評論的所有部落格文章。為此,您可以將關聯名稱傳遞給 has 和 orHas 方法:
use App\Models\Post;
// 檢索至少有一條評論的所有文章...
$posts = Post::has('comments')->get();
您還可以指定一個運算符和計數值來進一步自訂查詢:
// 檢索有三條或更多評論的所有文章...
$posts = Post::has('comments', '>=', 3)->get();
巢狀 has 語句可以使用「點」語法建立。例如,您可以檢索至少有一條帶圖片的評論的所有文章:
// 檢索至少有一條帶圖片評論的文章...
$posts = Post::has('comments.images')->get();
如果您需要更強大的功能,您可以使用 whereHas 和 orWhereHas 方法在 has 查詢上定義額外的查詢約束,例如檢查評論的內容:
use Illuminate\Database\Eloquent\Builder;
// 檢索至少有一條包含類似 code% 詞語的評論的文章...
$posts = Post::whereHas('comments', function (Builder $query) {
$query->where('content', 'like', 'code%');
})->get();
// 檢索至少有十條包含類似 code% 詞語的評論的文章...
$posts = Post::whereHas('comments', function (Builder $query) {
$query->where('content', 'like', 'code%');
}, '>=', 10)->get();
[!WARNING] Eloquent 目前不支援跨資料庫查詢關聯存在性。關聯必須存在於同一資料庫中。
多對多關聯存在性查詢
whereAttachedTo 方法可用於查詢與模型或模型集合具有多對多附屬關係的模型:
$users = User::whereAttachedTo($role)->get();
您還可以向 whereAttachedTo 方法提供一個集合實例。這樣做時,Laravel 將檢索附屬於集合中任何模型的模型:
$tags = Tag::whereLike('name', '%laravel%')->get();
$posts = Post::whereAttachedTo($tags)->get();
內聯關聯存在性查詢
如果您想使用附加到關聯查詢的單個、簡單的 where 條件查詢關聯的存在性,您可能會發現使用 whereRelation、orWhereRelation、whereMorphRelation 和 orWhereMorphRelation 方法更方便。例如,我們可以查詢所有具有未批准評論的文章:
use App\Models\Post;
$posts = Post::whereRelation('comments', 'is_approved', false)->get();
當然,與查詢建構器的 where 方法一樣,您還可以指定一個運算符:
$posts = Post::whereRelation(
'comments', 'created_at', '>=', now()->minus(hours: 1)
)->get();
查詢關聯不存在性
檢索模型記錄時,您可能希望根據關聯的不存在性來限制結果。例如,想像您想檢索沒有任何評論的所有部落格文章。為此,您可以將關聯名稱傳遞給 doesntHave 和 orDoesntHave 方法:
use App\Models\Post;
$posts = Post::doesntHave('comments')->get();
如果您需要更強大的功能,您可以使用 whereDoesntHave 和 orWhereDoesntHave 方法在 doesntHave 查詢上添加額外的查詢約束,例如檢查評論的內容:
use Illuminate\Database\Eloquent\Builder;
$posts = Post::whereDoesntHave('comments', function (Builder $query) {
$query->where('content', 'like', 'code%');
})->get();
您可以使用「點」語法對巢狀關聯執行查詢。例如,以下查詢將檢索沒有評論的文章以及具有一些來自被禁用使用者的評論的文章:
use Illuminate\Database\Eloquent\Builder;
$posts = Post::whereDoesntHave('comments.author', function (Builder $query) {
$query->where('banned', 1);
})->get();
查詢 Morph To 關聯
要查詢「morph to」關聯的存在性,您可以使用 whereHasMorph 和 whereDoesntHaveMorph 方法。這些方法接受關聯名稱作為其第一個參數。接下來,這些方法接受您希望包含在查詢中的關聯模型的名稱。最後,您可以提供一個自訂關聯查詢的閉包:
use App\Models\Comment;
use App\Models\Post;
use App\Models\Video;
use Illuminate\Database\Eloquent\Builder;
// 檢索與標題類似 code% 的文章或影片關聯的評論...
$comments = Comment::whereHasMorph(
'commentable',
[Post::class, Video::class],
function (Builder $query) {
$query->where('title', 'like', 'code%');
}
)->get();
// 檢索與標題不類似 code% 的文章關聯的評論...
$comments = Comment::whereDoesntHaveMorph(
'commentable',
Post::class,
function (Builder $query) {
$query->where('title', 'like', 'code%');
}
)->get();
有時您可能需要根據關聯多型模型的「類型」添加查詢約束。傳遞給 whereHasMorph 方法的閉包可以接收一個 $type 值作為其第二個參數。此參數允許您檢查正在建立的查詢的「類型」:
use Illuminate\Database\Eloquent\Builder;
$comments = Comment::whereHasMorph(
'commentable',
[Post::class, Video::class],
function (Builder $query, string $type) {
$column = $type === Post::class ? 'content' : 'title';
$query->where($column, 'like', 'code%');
}
)->get();
有時您可能想查詢「morph to」關聯父級的子級。您可以使用 whereMorphedTo 和 whereNotMorphedTo 方法來完成此操作,它們將自動確定給定模型的正確形態類型映射。這些方法接受 morphTo 關聯的名稱作為其第一個參數,並接受關聯的父模型作為其第二個參數:
$comments = Comment::whereMorphedTo('commentable', $post)
->orWhereMorphedTo('commentable', $video)
->get();
查詢所有關聯模型
不是傳遞可能的多型模型的陣列,您可以提供 * 作為萬用字元值。這將指示 Laravel 從資料庫中檢索所有可能的多型類型。Laravel 將執行額外的查詢來執行此操作:
use Illuminate\Database\Eloquent\Builder;
$comments = Comment::whereHasMorph('commentable', '*', function (Builder $query) {
$query->where('title', 'like', 'foo%');
})->get();
聚合關聯模型
計算關聯模型
有時您可能想要計算給定關聯的關聯模型數量,而無需實際載入模型。為此,您可以使用 withCount 方法。withCount 方法將在結果模型上放置一個 {relation}_count 屬性:
use App\Models\Post;
$posts = Post::withCount('comments')->get();
foreach ($posts as $post) {
echo $post->comments_count;
}
透過向 withCount 方法傳遞一個陣列,您可以添加多個關聯的「計數」以及向查詢添加額外的約束:
use Illuminate\Database\Eloquent\Builder;
$posts = Post::withCount(['votes', 'comments' => function (Builder $query) {
$query->where('content', 'like', 'code%');
}])->get();
echo $posts[0]->votes_count;
echo $posts[0]->comments_count;
您還可以為關聯計數結果設置別名,允許在同一關聯上進行多個計數:
use Illuminate\Database\Eloquent\Builder;
$posts = Post::withCount([
'comments',
'comments as pending_comments_count' => function (Builder $query) {
$query->where('approved', false);
},
])->get();
echo $posts[0]->comments_count;
echo $posts[0]->pending_comments_count;
延遲計數載入
使用 loadCount 方法,您可以在父模型已經被檢索後載入關聯計數:
$book = Book::first();
$book->loadCount('genres');
如果您需要在計數查詢上設置額外的查詢約束,您可以傳遞一個以您要計數的關聯為鍵的陣列。陣列值應為接收查詢建構器實例的閉包:
$book->loadCount(['reviews' => function (Builder $query) {
$query->where('rating', 5);
}])
關聯計數和自訂 SELECT 語句
如果您正在將 withCount 與 select 語句結合使用,請確保在 select 方法之後調用 withCount:
$posts = Post::select(['title', 'body'])
->withCount('comments')
->get();
其他聚合函數
除了 withCount 方法外,Eloquent 還提供 withMin、withMax、withAvg、withSum 和 withExists 方法。這些方法將在您的結果模型上放置一個 {relation}_{function}_{column} 屬性:
use App\Models\Post;
$posts = Post::withSum('comments', 'votes')->get();
foreach ($posts as $post) {
echo $post->comments_sum_votes;
}
如果您希望使用另一個名稱存取聚合函數的結果,您可以指定自己的別名:
$posts = Post::withSum('comments as total_comments', 'votes')->get();
foreach ($posts as $post) {
echo $post->total_comments;
}
與 loadCount 方法一樣,這些方法的延遲版本也適用。這些額外的聚合操作可以在已經被檢索的 Eloquent 模型上執行:
$post = Post::first();
$post->loadSum('comments', 'votes');
如果您正在將這些聚合方法與 select 語句結合使用,請確保在 select 方法之後調用聚合方法:
$posts = Post::select(['title', 'body'])
->withExists('comments')
->get();
在 Morph To 關聯上計算關聯模型
如果您想預先載入「morph to」關聯,以及該關聯可能返回的各種實體的關聯模型計數,您可以使用 with 方法結合 morphTo 關聯的 morphWithCount 方法。
在此範例中,讓我們假設 Photo 和 Post 模型可能建立 ActivityFeed 模型。我們將假設 ActivityFeed 模型定義了一個名為 parentable 的「morph to」關聯,該關聯允許我們檢索給定 ActivityFeed 實例的父 Photo 或 Post 模型。此外,讓我們假設 Photo 模型「has many」Tag 模型,而 Post 模型「has many」Comment 模型。
現在,讓我們想像我們想要檢索 ActivityFeed 實例,並為每個 ActivityFeed 實例預先載入 parentable 父模型。此外,我們想要檢索與每個父圖片關聯的標籤數量以及與每個父文章關聯的評論數量:
use Illuminate\Database\Eloquent\Relations\MorphTo;
$activities = ActivityFeed::with([
'parentable' => function (MorphTo $morphTo) {
$morphTo->morphWithCount([
Photo::class => ['tags'],
Post::class => ['comments'],
]);
}])->get();
延遲計數載入
讓我們假設我們已經檢索了一組 ActivityFeed 模型,現在我們想要載入與活動摘要關聯的各種 parentable 模型的巢狀關聯計數。您可以使用 loadMorphCount 方法來完成此操作:
$activities = ActivityFeed::with('parentable')->get();
$activities->loadMorphCount('parentable', [
Photo::class => ['tags'],
Post::class => ['comments'],
]);
預先載入
當作為屬性存取 Eloquent 關聯時,關聯模型會被「延遲載入」。這意味著關聯資料直到您第一次存取屬性時才會實際載入。但是,Eloquent 可以在查詢父模型時「預先載入」關聯。預先載入減輕了「N + 1」查詢問題。為了說明 N + 1 查詢問題,考慮一個「屬於」Author 模型的 Book 模型:
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
class Book extends Model
{
/**
* 獲取撰寫該書的作者。
*/
public function author(): BelongsTo
{
return $this->belongsTo(Author::class);
}
}
現在,讓我們檢索所有書籍及其作者:
use App\Models\Book;
$books = Book::all();
foreach ($books as $book) {
echo $book->author->name;
}
此迴圈將執行一個查詢以從資料庫表中檢索所有書籍,然後為每本書執行另一個查詢以檢索書籍的作者。因此,如果我們有 25 本書,上面的程式碼將運行 26 個查詢:一個用於原始書籍,25 個額外查詢用於檢索每本書的作者。
謝天謝地,我們可以使用預先載入將此操作減少到只有兩個查詢。建立查詢時,您可以使用 with 方法指定應預先載入哪些關聯:
$books = Book::with('author')->get();
foreach ($books as $book) {
echo $book->author->name;
}
對於此操作,只會執行兩個查詢——一個查詢檢索所有書籍,一個查詢檢索所有書籍的所有作者:
select * from books
select * from authors where id in (1, 2, 3, 4, 5, ...)
預先載入多個關聯
有時您可能需要預先載入幾個不同的關聯。為此,只需向 with 方法傳遞一個關聯陣列:
$books = Book::with(['author', 'publisher'])->get();
巢狀預先載入
要預先載入關聯的關聯,您可以使用「點」語法。例如,讓我們預先載入所有書籍的作者和所有作者的個人聯絡人:
$books = Book::with('author.contacts')->get();
或者,您可以透過向 with 方法提供巢狀陣列來指定巢狀預先載入的關聯,這在預先載入多個巢狀關聯時很方便:
$books = Book::with([
'author' => [
'contacts',
'publisher',
],
])->get();
巢狀預先載入 morphTo 關聯
如果您想預先載入 morphTo 關聯,以及該關聯可能返回的各種實體的巢狀關聯,您可以使用 with 方法結合 morphTo 關聯的 morphWith 方法。為了幫助說明此方法,讓我們考慮以下模型:
<?php
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\MorphTo;
class ActivityFeed extends Model
{
/**
* 獲取活動摘要記錄的父級。
*/
public function parentable(): MorphTo
{
return $this->morphTo();
}
}
在此範例中,讓我們假設 Event、Photo 和 Post 模型可能建立 ActivityFeed 模型。此外,讓我們假設 Event 模型屬於 Calendar 模型,Photo 模型與 Tag 模型相關聯,而 Post 模型屬於 Author 模型。
使用這些模型定義和關聯,我們可以檢索 ActivityFeed 模型實例,並預先載入所有 parentable 模型及其各自的巢狀關聯:
use Illuminate\Database\Eloquent\Relations\MorphTo;
$activities = ActivityFeed::query()
->with(['parentable' => function (MorphTo $morphTo) {
$morphTo->morphWith([
Event::class => ['calendar'],
Photo::class => ['tags'],
Post::class => ['author'],
]);
}])->get();
預先載入特定列
您可能並非總是需要從正在檢索的關聯中獲取每個列。出於這個原因,Eloquent 允許您指定您希望檢索的關聯的哪些列:
$books = Book::with('author:id,name,book_id')->get();
[!WARNING] 使用此功能時,您應始終在您希望檢索的列列表中包含
id列和任何相關的外鍵列。
預設預先載入
有時您可能想要在檢索模型時始終載入某些關聯。為此,您可以在模型上定義一個 $with 屬性:
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
class Book extends Model
{
/**
* 應始終載入的關聯。
*
* @var array
*/
protected $with = ['author'];
/**
* 獲取撰寫該書的作者。
*/
public function author(): BelongsTo
{
return $this->belongsTo(Author::class);
}
/**
* 獲取書籍的類型。
*/
public function genre(): BelongsTo
{
return $this->belongsTo(Genre::class);
}
}
如果您想在單個查詢中從 $with 屬性中移除一個項目,您可以使用 without 方法:
$books = Book::without('author')->get();
如果您想在單個查詢中覆蓋 $with 屬性中的所有項目,您可以使用 withOnly 方法:
$books = Book::withOnly('genre')->get();
約束預先載入
有時您可能希望預先載入一個關聯,但同時指定預先載入查詢的額外查詢條件。您可以透過向 with 方法傳遞一個關聯陣列來完成此操作,其中陣列鍵是關聯名稱,陣列值是向預先載入查詢添加額外約束的閉包:
use App\Models\User;
$users = User::with(['posts' => function ($query) {
$query->where('title', 'like', '%code%');
}])->get();
在此範例中,Eloquent 將僅預先載入 title 列包含單詞 code 的文章。您可以調用其他查詢建構器方法來進一步自訂預先載入操作:
$users = User::with(['posts' => function ($query) {
$query->orderBy('created_at', 'desc');
}])->get();
約束 morphTo 關聯的預先載入
如果您正在預先載入 morphTo 關聯,Eloquent 將運行多個查詢來獲取每種類型的關聯模型。您可以使用 MorphTo 關聯的 constrain 方法向這些查詢中的每一個添加額外的約束:
use Illuminate\Database\Eloquent\Relations\MorphTo;
$comments = Comment::with(['commentable' => function (MorphTo $morphTo) {
$morphTo->constrain([
Post::class => function ($query) {
$query->whereNull('hidden_at');
},
Video::class => function ($query) {
$query->where('type', 'educational');
},
]);
}])->get();
在此範例中,Eloquent 將僅預先載入未被隱藏的文章以及 type 值為「教育」的影片。
使用關聯存在性約束預先載入
有時您可能會發現自己需要在根據相同條件預先載入關聯的同時檢查關聯的存在性。例如,您可能只想檢索具有匹配給定查詢條件的子 Post 模型的 User 模型,同時也預先載入匹配的文章。您可以使用 withWhereHas 方法來完成此操作:
use App\Models\User;
$users = User::withWhereHas('posts', function ($query) {
$query->where('featured', true);
})->get();
延遲預先載入
有時您可能需要在父模型已經被檢索後預先載入一個關聯。例如,如果您需要動態決定是否載入關聯模型,這可能很有用:
use App\Models\Book;
$books = Book::all();
if ($condition) {
$books->load('author', 'publisher');
}
如果您需要在預先載入查詢上設置額外的查詢約束,您可以傳遞一個以您要載入的關聯為鍵的陣列。陣列值應為接收查詢實例的閉包實例:
$author->load(['books' => function ($query) {
$query->orderBy('published_date', 'asc');
}]);
要僅在尚未載入關聯時載入它,請使用 loadMissing 方法:
$book->loadMissing('author');
巢狀延遲預先載入和 morphTo
如果您想預先載入 morphTo 關聯,以及該關聯可能返回的各種實體的巢狀關聯,您可以使用 loadMorph 方法。
此方法接受 morphTo 關聯的名稱作為其第一個參數,並接受模型/關聯對的陣列作為其第二個參數。為了幫助說明此方法,讓我們考慮以下模型:
<?php
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\MorphTo;
class ActivityFeed extends Model
{
/**
* 獲取活動摘要記錄的父級。
*/
public function parentable(): MorphTo
{
return $this->morphTo();
}
}
在此範例中,讓我們假設 Event、Photo 和 Post 模型可能建立 ActivityFeed 模型。此外,讓我們假設 Event 模型屬於 Calendar 模型,Photo 模型與 Tag 模型相關聯,而 Post 模型屬於 Author 模型。
使用這些模型定義和關聯,我們可以檢索 ActivityFeed 模型實例,並預先載入所有 parentable 模型及其各自的巢狀關聯:
$activities = ActivityFeed::with('parentable')
->get()
->loadMorph('parentable', [
Event::class => ['calendar'],
Photo::class => ['tags'],
Post::class => ['author'],
]);
自動預先載入
[!WARNING] 此功能目前處於 beta 階段,以收集社群回饋。此功能的行為和功能即使在補丁版本中也可能發生變化。
在許多情況下,Laravel 可以自動預先載入您存取的關聯。要啟用自動預先載入,您應該在應用程式的 AppServiceProvider 的 boot 方法中調用 Model::automaticallyEagerLoadRelationships 方法:
use Illuminate\Database\Eloquent\Model;
/**
* 引導任何應用程式服務。
*/
public function boot(): void
{
Model::automaticallyEagerLoadRelationships();
}
啟用此功能後,Laravel 將嘗試自動載入您存取的任何尚未先前載入的關聯。例如,考慮以下場景:
use App\Models\User;
$users = User::all();
foreach ($users as $user) {
foreach ($user->posts as $post) {
foreach ($post->comments as $comment) {
echo $comment->content;
}
}
}
通常,上面的程式碼將為每個使用者執行一個查詢以檢索其文章,並為每篇文章執行一個查詢以檢索其評論。但是,當啟用 automaticallyEagerLoadRelationships 功能時,當您嘗試存取任何已檢索使用者的文章時,Laravel 將自動延遲預先載入使用者集合中所有使用者的文章。同樣,當您嘗試存取任何已檢索文章的評論時,所有評論都將為最初檢索的所有文章延遲預先載入。
如果您不想全域啟用自動預先載入,您仍然可以透過在集合上調用 withRelationshipAutoloading 方法為單個 Eloquent 集合實例啟用此功能:
$users = User::where('vip', true)->get();
return $users->withRelationshipAutoloading();
防止延遲載入
如前所述,預先載入關聯通常可以為您的應用程式提供顯著的效能優勢。因此,如果您願意,您可以指示 Laravel 始終防止延遲載入關聯。為此,您可以調用基礎 Eloquent 模型類別提供的 preventLazyLoading 方法。通常,您應該在應用程式的 AppServiceProvider 類別的 boot 方法中調用此方法。
preventLazyLoading 方法接受一個可選的布林參數,該參數指示是否應防止延遲載入。例如,您可能只想在非生產環境中禁用延遲載入,以便您的生產環境即使在生產程式碼中意外存在延遲載入的關聯時也能繼續正常運行:
use Illuminate\Database\Eloquent\Model;
/**
* 引導任何應用程式服務。
*/
public function boot(): void
{
Model::preventLazyLoading(! $this->app->isProduction());
}
防止延遲載入後,當您的應用程式嘗試延遲載入任何 Eloquent 關聯時,Eloquent 將拋出 Illuminate\Database\LazyLoadingViolationException 異常。
您可以使用 handleLazyLoadingViolationsUsing 方法自訂延遲載入違規的行為。例如,使用此方法,您可以指示延遲載入違規僅被記錄而不是使用異常中斷應用程式的執行:
Model::handleLazyLoadingViolationUsing(function (Model $model, string $relation) {
$class = $model::class;
info("嘗試在模型 [{$class}] 上延遲載入 [{$relation}]。");
});
插入和更新關聯模型
save 方法
Eloquent 提供了將新模型添加到關聯的便利方法。例如,您可能需要向文章添加一條新評論。不是手動在 Comment 模型上設置 post_id 屬性,您可以使用關聯的 save 方法插入評論:
use App\Models\Comment;
use App\Models\Post;
$comment = new Comment(['message' => 'A new comment.']);
$post = Post::find(1);
$post->comments()->save($comment);
請注意,我們沒有將 comments 關聯作為動態屬性存取。相反,我們調用了 comments 方法來獲取關聯的實例。save 方法將自動將相應的 post_id 值添加到新的 Comment 模型。
如果您需要儲存多個關聯模型,您可以使用 saveMany 方法:
$post = Post::find(1);
$post->comments()->saveMany([
new Comment(['message' => 'A new comment.']),
new Comment(['message' => 'Another new comment.']),
]);
save 和 saveMany 方法將持久化給定的模型實例,但不會將新持久化的模型添加到已經載入到父模型上的任何記憶體中關聯。如果您計劃在使用 save 或 saveMany 方法後存取該關聯,您可能希望使用 refresh 方法重新載入模型及其關聯:
$post->comments()->save($comment);
$post->refresh();
// 所有評論,包括新儲存的評論...
$post->comments;
遞迴儲存模型和關聯
如果您想儲存您的模型及其所有關聯的關聯,您可以使用 push 方法。在此範例中,Post 模型將被儲存,以及其評論和評論的作者:
$post = Post::find(1);
$post->comments[0]->message = 'Message';
$post->comments[0]->author->name = 'Author Name';
$post->push();
pushQuietly 方法可用於儲存模型及其關聯的關聯,而不觸發任何事件:
$post->pushQuietly();
create 方法
除了 save 和 saveMany 方法外,您還可以使用 create 方法,該方法接受一個屬性陣列、建立一個模型並將其插入資料庫。save 和 create 之間的區別在於 save 接受一個完整的 Eloquent 模型實例,而 create 接受一個普通的 PHP array。新建立的模型將由 create 方法返回:
use App\Models\Post;
$post = Post::find(1);
$comment = $post->comments()->create([
'message' => 'A new comment.',
]);
您可以使用 createMany 方法建立多個關聯模型:
$post = Post::find(1);
$post->comments()->createMany([
['message' => 'A new comment.'],
['message' => 'Another new comment.'],
]);
createQuietly 和 createManyQuietly 方法可用於建立模型而不觸發任何事件:
$user = User::find(1);
$user->posts()->createQuietly([
'title' => 'Post title.',
]);
$user->posts()->createManyQuietly([
['title' => 'First post.'],
['title' => 'Second post.'],
]);
您還可以使用 findOrNew、firstOrNew、firstOrCreate 和 updateOrCreate 方法在關聯上建立和更新模型。
[!NOTE] 使用
create方法之前,請務必查看批量賦值文檔。
Belongs To 關聯
如果您想將子模型分配給新的父模型,您可以使用 associate 方法。在此範例中,User 模型定義了到 Account 模型的 belongsTo 關聯。此 associate 方法將在子模型上設置外鍵:
use App\Models\Account;
$account = Account::find(10);
$user->account()->associate($account);
$user->save();
要從子模型移除父模型,您可以使用 dissociate 方法。此方法將把關聯的外鍵設置為 null:
$user->account()->dissociate();
$user->save();
多對多關聯
附加/分離
Eloquent 還提供了使使用多對多關聯更加方便的方法。例如,讓我們想像一個使用者可以有多個角色,一個角色可以有多個使用者。您可以使用 attach 方法透過在關聯的中間表中插入一條記錄來將角色附加到使用者:
use App\Models\User;
$user = User::find(1);
$user->roles()->attach($roleId);
將關聯附加到模型時,您還可以傳遞一個要插入中間表的額外資料陣列:
$user->roles()->attach($roleId, ['expires' => $expires]);
有時可能需要從使用者中移除一個角色。要移除多對多關聯記錄,請使用 detach 方法。detach 方法將從中間表中刪除相應的記錄;但是,兩個模型將保留在資料庫中:
// 從使用者中分離一個角色...
$user->roles()->detach($roleId);
// 從使用者中分離所有角色...
$user->roles()->detach();
為了方便,attach 和 detach 也接受 ID 陣列作為輸入:
$user = User::find(1);
$user->roles()->detach([1, 2, 3]);
$user->roles()->attach([
1 => ['expires' => $expires],
2 => ['expires' => $expires],
]);
同步關聯
您還可以使用 sync 方法來建立多對多關聯。sync 方法接受一個要放在中間表上的 ID 陣列。不在給定陣列中的任何 ID 都將從中間表中移除。因此,此操作完成後,只有給定陣列中的 ID 將存在於中間表中:
$user->roles()->sync([1, 2, 3]);
您還可以傳遞與 ID 一起的額外中間表值:
$user->roles()->sync([1 => ['expires' => true], 2, 3]);
如果您想為每個同步的模型 ID 插入相同的中間表值,您可以使用 syncWithPivotValues 方法:
$user->roles()->syncWithPivotValues([1, 2, 3], ['active' => true]);
如果您不想分離缺少給定陣列中的現有 ID,您可以使用 syncWithoutDetaching 方法:
$user->roles()->syncWithoutDetaching([1, 2, 3]);
切換關聯
多對多關聯還提供了一個 toggle 方法,用於「切換」給定關聯模型 ID 的附加狀態。如果給定的 ID 當前已附加,則將被分離。同樣,如果它當前已分離,則將被附加:
$user->roles()->toggle([1, 2, 3]);
您還可以傳遞與 ID 一起的額外中間表值:
$user->roles()->toggle([
1 => ['expires' => true],
2 => ['expires' => true],
]);
事務性樞紐操作
上面討論的每個樞紐操作還有一個 OrFail 變體(attachOrFail、detachOrFail、syncOrFail、syncWithoutDetachingOrFail 和 toggleOrFail),它將操作包裝在資料庫事務中,以便如果拋出異常,所有更改都將自動回滾:
$user->roles()->attachOrFail([1, 2, 3]);
$user->roles()->syncOrFail([1, 2, 3]);
更新中間表上的記錄
如果您需要更新關聯的中間表中的現有行,您可以使用 updateExistingPivot 方法。此方法接受中間記錄外鍵和要更新的屬性陣列:
$user = User::find(1);
$user->roles()->updateExistingPivot($roleId, [
'active' => false,
]);
觸及父級時間戳
當模型定義了到另一個模型的 belongsTo 或 belongsToMany 關聯時,例如屬於 Post 的 Comment,有時在更新子模型時更新父級的時間戳會很有幫助。
例如,當 Comment 模型被更新時,您可能希望自動「觸及」擁有 Post 的 updated_at 時間戳,使其設定為當前日期和時間。為此,您可以在子模型上使用 Touches 屬性,該屬性包含應在子模型更新時更新其 updated_at 時間戳的關聯名稱:
<?php
namespace App\Models;
use Illuminate\Database\Eloquent\Attributes\Touches;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
#[Touches(['post'])]
class Comment extends Model
{
/**
* 獲取評論所屬的文章。
*/
public function post(): BelongsTo
{
return $this->belongsTo(Post::class);
}
}
[!WARNING] 只有當子模型使用 Eloquent 的
save方法更新時,父模型時間戳才會被更新。