yii2 ActiveRecord多表关联以及多表关联搜索的实现
一个老生常谈的问题。最近通过群里的反馈,觉得很多人还是没有去理解这个问题。今天把这个问题讲明白了,看看yii2 ActiveRecord是怎么个多表关联以及如何去优化这个关联。
场景需求:
假设我们有一张用户表user和一张用户渠道表auth,两张数据表通过user.id和auth.uid进行一对一关联。现需要在user列表展示auth表的来源渠道source,且该渠道可搜索。
首先我们先通过gii生成user和auth系列相关的model和操作。此处不做详细说明,有关gii的操作可参考xxx
我看继续看重要的几个操作步骤:
1、找到user表对应的AR模型类 appmodelsUser.php,在该类文件中进行关联auth表
/**
* 关联auth表
*/
public function getAuth()
{
// hasOne要求返回两个参数 第一个参数是关联表的类名 第二个参数是两张表的关联关系
// 这里uid是auth表关联id, 关联user表的uid id是当前模型的主键id
return $this->hasOne(commonmodelsAuth::className(), ['uid' => 'id']);
}
设置好了之后,并不代表两张数据表自动进行关联了!我们访问user列表页(该列表页采用gii生成,目前我们没操作过),通过debug查看Database Queries不难发现,实际中的query并没有进行关联auth表
2、在gridview中添加关联表的来源渠道字段source
<?= GridView::widget([
// other codes
'columns' => [
// other columns
'auth.source',
]
]); ?>
有同学感觉疑问了,上面不是说了没进行关联吗,这个怎么可以直接使用auth.source?
先别急,此时我们打开debug看看实际的query。
我们会发现有很多类似 select * from auth
where uid = xxx;之类的操作,如果你的分页默认20条数据时,会有20个类似的query。
我们先搞明白发生了什么?
实际上这属于php的基础知识了。读取和写入对象的一个不存在的成员变量时, get() set() 魔术函数会被自动调用。yii也是利用了这一点对其进行了实现!
该操作跟大部分人在gridview中封装方法获取关联表数据几乎一致,但是!20条sql的查询明显增加了众多的开销。如果这里是left join操作多好!
3、优化sql
我们需要优化的是:
20条sql变1条sql
只获取关联表需要的字段
有同学要嚷嚷了,这里是yii自带的操作,怎么优化?我们回到数据源的获取上,发现user列表的数据是通过userSearch model的search方法提供的。
也就是说我们的数据查询实际上就没有去进行关联表查询!既然如此,我们就在UserSearch加上关联查询
$query = User::find();
$query->joinWith(['auth']);
$query->select("user.*, auth.source");
我们再来刷新下user列表页,然后通过debug分析发现有两条sql引起了我们的注意
SELECT `user`.*, `auth`.`source` FROM `user` LEFT JOIN `auth` ON `user`.`id` = `auth`.`uid` LIMIT 20
SELECT * FROM `auth` WHERE `user_id` IN (20个uid);
也就是说我么已经达到了优化sql的目的,通过debug分析发现,DB的查询时间少了很多。
4、关联表字段增加查询
gridview中的搜索模型也是通过searchModel实现的,该模型通过rules控制着哪个字段可搜索,哪个字段不可搜索。
我们现在需要增加关联表的source可搜索,因此我们在searchModel中定义一个属性source且添加到rules中
public $source;
public function rules()
{
return [
// other rules
['source', 'safe'],
];
}
接着我们把gridview中的auth.source修改一下
// 'auth.source',
[
'attribute' => 'source',
'value' => 'auth.source',
'label' => '渠道来源',
],
到这里我们界面上是ok的,要实现程序上的搜索还差一步,我们在数据源获取的地方加上新增的source条件即可
$query->andFilterWhere([
// other params
'auth.source' => $this->source,
]);
实例如下:
手册中yii2的关联模型:
查询关联的数据
使用 AR 方法也可以查询数据表的关联数据(如,选出表A的数据可以拉出表B的关联数据)。 有了 AR, 返回的关联数据连接就像连接关联主表的 AR 对象的属性一样。
建立关联关系后,通过 $customer->orders
可以获取 一个 Order
对象的数组,该数组代表当前客户对象的订单集。
定义关联关系使用一个可以返回 yiidbActiveQuery 对象的 getter 方法, yiidbActiveQuery对象有关联上下文的相关信息,因此可以只查询关联数据。
例如:
class Customer extends yiidbActiveRecord
{
public function getOrders()
{
// 客户和订单通过 Order.customer_id -> id 关联建立一对多关系
return $this->hasMany(Order::className(), ['customer_id' => 'id']);
}
}
class Order extends yiidbActiveRecord
{
// 订单和客户通过 Customer.id -> customer_id 关联建立一对一关系
public function getCustomer()
{
return $this->hasOne(Customer::className(), ['id' => 'customer_id']);
}
}