文章目录
介绍
需求场景
环境:yii2.0
在做用户列表展示的时候,需要展示子表的一些字段,并可以根据子表的字段进行排序,进行查询。并且,关联的多个表,其中一个表(用户标签)是一对多的关系。
下面摘出具有代表性的关系表做一下说明,实际使用过程中多个一对一关系不做多次说明。
表关系
主表:memberinfo表——用户信息表
表模型:Memberinfo
主键是 memberinfo_id
, 外键有 memberinfo_account
(别问我为什么不用id做主键,以前系统的设计就是如此)
关联一对一关系(hasOne)
目的:获取用户消费统计数据
用户消费统计表:stat_member_consume
表模型:MemberinfoConsume
关系是一对一:stat_member_consume
表的 stat_member_consume_memberinfo_id
= memberinfo
表的memberinfo_id
关联代码:
Memberinfo.php:
//用户消费信息
public function getMemberinfoConsume()
{
return $this->hasOne(StatMemberConsume::class, ['stat_member_consume_memberinfo_id' => 'memberinfo_id']);
}
通过中间表,关联多对多关系(via),实现一对一关联
目的:获取用户会员卡的等级
会员卡信息存在card表,用户和会员卡的关系存在了memberinfo_card表。想要直接获取card_level需要通过中间表关联一下
会员卡表:card表
表字段是:
card_id 主键id
tag_name 会员卡名称
card_level 会员卡等级
用户会员卡表:memberinfo_card
三者之间的关系是
memberinfo表 | memberinfo_card表 | card表 |
---|---|---|
memberinfo_account | memberinfo_card_memberinfo_account | |
memberinfo_card_card_id | card_id |
关联代码:
Memberinfo.php:
//关联中间表用户会员卡
public function getMemberinfoCard()
{
return $this->hasOne(MemberinfoCard::class, ['memberinfo_card_memberinfo_account' => 'memberinfo_account']);
}
//使用via
public function getCard()
{
// return $this->hasOne(Card::class,['card_id'=>'memberinfo_card_card_id'])->viaTable(MemberinfoCard::class,['memberinfo_card_memberinfo_account'=>'memberinfo_account']);
return $this->hasOne(Card::class, ['card_id'=>'memberinfo_card_card_id'])->via('memberinfoCard');
}
已经了解 via()
和 viaTable()
的读者可以跳过下面这一小节。
via和viaTable
官方地址: 中间关联表(Relations via a Junction Table)
官方说明:
△ 官方截图
via() 和 viaTable() 之间的区别是 前者是根据现有的关联名称来指定连接表,而后者直接使用 连接表。
关联一对多(hasMony)
目的:获取用户所有的标签
标签表tag,模型:Tag
中间关系表:memeber_tag,模型:MemberTag,用于存放用户和标签的关系
三者之间的关系是
memberinfo表 | memeber_tag表 | tag表 |
---|---|---|
memberinfo_account | member_tag_member_account | |
member_tag_tag_id | tag_id |
关联代码:
Memberinfo.php:
//用户标签
public function getMemberinfoTags()
{
return $this->hasMany(Tag::class, ['tag_id' => 'member_tag_tag_id'])
->viaTable(MemberTag::tableName(), ['member_tag_member_account' => 'memberinfo_account']);
}
操作步骤
Step1:在主表Model(Memberinfo.php)建立关联关系
关联代码已经在上一章说明了。
关键是后面步骤
Step2:在SearchModel中添加代码
在MemberSearch中添加需要关联的字段
为什么要有这一步?是因为子表的排序暂时没有发现用 MemberConsume.stat_member_consume_order_sum
传值进行排序的方式。前端调用接口的时候,通过传sort参数来实现接口排序,用太长的名字也不太好。
于是,要使排序的代码可用,需要把这些需要排序和搜索的子表字段添加到主表的对象里
你可以直接在searchModel里添加
public $stat_member_consume_order_sum
不过更建议使用内置的函数去添加。
由于MemberinfoSearch 继承了 Memberinfo ,所以可以通过继承 attributes()
方法添加字段
MemberinfoSearch.php:
public function attributes()
{
// add related fields to searchable attributes
return array_merge(
parent::attributes(),
['stat_member_consume_order_sum', 'stat_member_consume_order_money_amount', 'stat_member_consume_last_order_datetime', 'finance_award', 'card_level', 'tag_name','tag_id']
);
}
要能搜索
在MemberinfoSearch中添加关联查询
MemberinfoSearch.php
public function search($params, $isVerify = null)
{
$query = Memberinfo::find();
//添加下面这句,数组里的值要和关系名保持一致,即get方法后面的名字,首字母小写
$query->JoinWith(['memberinfoConsume', 'card','memberinfoTags']);
}
在MemberSearch中添加过滤搜索
仍然是search()方法中
MemberinfoSearch.php:
1 //在代码里面照着队形添加这一句即可
3 $query->andFilterWhere(['like', 'tag_name', $this->tag_name]) ;
这里发现和 YII关联字段并带搜索排序功能 这篇教程中不一样的地方是,搜索的字段名不需要加关联表的名字,直接用已经加过的关联字段名就可以成功。
上面代码只是一个例子,使用中根据你需要搜索的子表字段进行添加即可,多一个搜索,就多加一条 andFilterWhere
。
我在使用中发现如果要搜数组,比如stat_member_consume_order_sum
的搜索传到后台是以$stat_member_consume_order_sum[0]$stat_member_consume_order_sum[1]的方式,这时不传 andFilterWhere 会报错,所以在外面多加了个判断字段是否为数组。
P.S. andFilterWhere() 可以在有值的时候进行搜索过滤,没有值的时候忽略这个where条件
要能排序
继续在search()方法中修改,ActiveDataProvider类的sort属性
MemberinfoSearch.php:
$dataProvider = new ActiveDataProvider([
'query' => $query,
//排序代码在这里
'sort' => [
'attributes' => [
'stat_member_consume_order_sum',
'stat_member_consume_order_money_amount',
'stat_member_consume_last_order_datetime',
'finance_award',
'card_level'
]
]
]);
也可以在实例化ActiveDataProvider之后,用setSort()添加。
至此,前端传sort参数(对应’sort’里的名字)就可以进行排序啦
Step3: 解决joinWith一对多关系之后分页错误
原本到上面2步就可以解决了,但是在列表显示的时候发现分页不对,明明指定了一页显示10条数据,可是第一页只出来了4条,甚至有时候是3条、5条不等。
原因是yii 的joinWith,当出现一对多的时候,会出现这个问题。
在网上搜索过后,有网友推荐 用 with()
代替 joinWith()
,不是不可以,我发现把一对多关系单独用with之后,分页错乱确实解决了。
例子中的一对多关系是memberinfoTags
$query->with(['memberinfoTags']);
但是引发另一个问题,因为接口需求中,需要用标签搜索,用with()之后,搜索memberinfoTags里的字段就失效了。
尝试解决:仍然使用 joinWith()
,然后 ->distinct(memberinfo_id)
然后yii报了一个错,大意是要把orderBy的字段加到select里,于是,加 ->addSelect([把sort字段都加进来])
。需要注意的是, addSelect()
之前一定要有select()
才行
end
如有疑问或者更好的解决方案,欢迎和我沟通