关联预载入
版本 | 功能调整 |
---|---|
5.0.7 | 嵌套关联支持数组方式定义 |
5.0.5 | 增加延迟关联预载入 |
5.0.5 | 一对一关联预载入默认采用IN查询方式 |
5.0.4 | 一对一关联支持JOIN和IN两种方式预载入查询 |
关联查询的预查询载入功能,主要解决了N+1
次查询的问题,例如下面的查询如果有3个记录,会执行4次查询:
$list = User::all([1,2,3]); foreach($list as $user){ // 获取用户关联的profile模型数据 dump($user->profile); }
如果使用关联预查询功能,对于一对一关联来说,只有一次查询,对于一对多关联的话,就可以变成2次查询,有效提高性能。
$list = User::with('profile')->select([1,2,3]); foreach($list as $user){ // 获取用户关联的profile模型数据 dump($user->profile); }
支持预载入多个关联,例如:
$list = User::with('profile,book')->select([1,2,3]);
也可以支持嵌套预载入,例如:
$list = User::with('profile.phone')->select([1,2,3]); foreach($list as $user){ // 获取用户关联的phone模型 dump($user->profile->phone); }
V5.0.7
版本以上,支持使用数组方式定义嵌套预载入,例如下面的预载入要同时获取用户的Profile
关联模型的Phone
、Job
和Img
子关联模型数据:
$list = User::with(['profile'=>['phone','job','img']])->select([1,2,3]); foreach($list as $user){ // 获取用户关联 dump($user->profile->phone); dump($user->profile->job); dump($user->profile->img); }
可以在模型的get和all方法中使用预载入,和使用select方法是等效的:
$list = User::all([1,2,3],'profile,book');
如果要指定属性查询,可以使用:
$list = User::field('id,name')->with(['profile'=>function($query){$query->field('email,phone');}])->select([1,2,3]); foreach($list as $user){ // 获取用户关联的profile模型数据 dump($user->profile); }
关联预载入名称是关联方法名,从V5.0.4+
版本开始,支持传入方法名的小写和下划线定义方式,例如如果关联方法名是userProfile
和userBook
的话:
$list = User::with('userProfile,userBook')->select([1,2,3]);
等效于:
$list = User::with('user_profile,user_book')->select([1,2,3]);
V5.0.4+
版本开始一对一关联预载入支持两种方式:JOIN
方式(一次查询)和IN
方式(两次查询),如果要使用IN
方式关联预载入,在关联定义方法中添加
<?php namespace app\index\model; use think\Model; class User extends Model { public function profile() { // 设置预载入查询方式为IN方式 return $this->hasOne('Profile')->setEagerlyType(1); } }
V5.0.5+
版本开始,默认使用IN查询方式,如果需要改为JOIN查询方式,使用
// 设置预载入查询方式为JOIN方式 return $this->hasOne('Profile')->setEagerlyType(0);
延迟预载入(V5.0.5+
)
有些情况下,需要根据查询出来的数据来决定是否需要使用关联预载入,当然关联查询本身就能解决这个问题,因为关联查询是惰性的,不过用预载入的理由也很明显,性能具有优势。
延迟预载入仅针对多个数据的查询,因为单个数据的查询用延迟预载入和关联惰性查询没有任何区别,所以不需要使用延迟预载入。
如果你的数据集查询返回的是数据集对象,可以使用调用数据集对象的load
实现延迟预载入:
// 查询数据集 $list = User::all([1,2,3]); // 延迟预载入 $list->load('cards'); foreach($list as $user){ // 获取用户关联的card模型数据 dump($user->cards); }
如果你的数据集查询返回的是数组,系统提供了一个load_relation
助手函数可以完成同样的功能。
// 查询数据集 $list = User::all([1,2,3]); // 延迟预载入 $list = load_relation($list,'cards'); foreach($list as $user){ // 获取用户关联的card模型数据 dump($user->cards); }