-
Notifications
You must be signed in to change notification settings - Fork 6
/
QueryHelper.php
368 lines (337 loc) · 11 KB
/
QueryHelper.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
<?php
/**
*
* author: Wei Chang Yue
* date: 2017/12/08 14:07
* version: 1.0
*/
namespace sndwow\rest;
use yii\db\ActiveQuery;
use Yii;
use yii\helpers\ArrayHelper;
class QueryHelper
{
/*
* 允许的查询规则,例如
* [
* 'id'=>['eq','!eq'], // 仅支持等于和不等于查询
* 'name'=>'*', //支持所有查询类型
* 'store.id'=>['eq'] // 关联表并查询id
* ]
*/
public $ruleWhere = [];
// 支持的排序的字段,支持关联表,例如['id','create_time','store.id']
public $ruleSort = [];
// 分页下每页支持的最大数据条目数量,支持关联表。第一个元素是主表的值 例如:[20,'store'=>10,'store.storePost'=>10]
public $rulePerpage = [];
// 预处理查询数据集合
public $prepareData = [];
/* 支持的查询条件 */
private $conditions = [
'eq', // name = 'jack'
'!eq', // name != 'jack'
'like', // name LIKE '%jack%'
'llike', // name LIKE '%jack'
'rlike', // name LIKE 'jack%'
'null', // name IS NULL
'!null', // name IS NOT NULL
'less_than', // money < 10
'more_than', // money > 10
'less_than_eq', // money <= 10
'more_than_eq', // money >= 10
'in', // id IN ('1','2')
'!in', // id NOT IN ('1','2')
];
// 查询参数(不包含扩展参数)
private $_where = [];
// 扩展查询
private $_extend = [
'_sort' => null, // 排序,支持多表:_sort=id,subtable.id.desc
'_fields' => null, // 结果集仅包含哪些字段,支持多表:_fields=id,name,subtable.id
'_expand' => null, // 欲关联查询:_expand=subtable,subtable.other
];
/* @var ActiveQuery $query */
private $_mainQuery = null;
/* @var ActiveQuery $query */
private $_query = null;
function __construct($modelClass)
{
/* @var $modelClass \yii\db\BaseActiveRecord */
$this->_mainQuery = $modelClass::find();
$this->_query = clone $this->_mainQuery;
}
/**
* 批量设置接口开放的规则
* @param array $rule
*/
private function setRules(array $rule)
{
if (isset($rule['sort'])) {
$this->ruleSort = $rule['sort'];
}
if (isset($rule['where'])) {
$this->ruleWhere = $rule['where'];
}
}
/**
* 初始化url查询参数
*/
private function parseParams()
{
$paramString = Yii::$app->request->queryString;
$params = [];
foreach (explode('&', $paramString) as $pair) {
$tmp = explode('=', $pair, 2);
if (count($tmp) === 2) {
$params[$tmp[0]] = urldecode($tmp[1]);
}
}
// 提取扩展查询参数
foreach ($this->_extend as $k => $v) {
if (isset($params[$k])) {
$this->_extend[$k] = $params[$k];
unset($params[$k]);
}
}
$this->_where = $params;
}
public function build(array $rules)
{
// 设置可用的查询规则
$this->setRules($rules);
// 解析请求参数
$this->parseParams();
// 预处理关联查询
$this->prepareRelated();
// 预处理搜索条件
$this->prepareWhere();
// 预处理排序条件
$this->prepareOrderBy();
// 应用查询参数
$this->applyData();
return $this->_query;
}
/**
* 获取请求参数,并匹配所设置的查询规则,返回格式化后的查询数据
* @return array
*/
private function formatWhereParams()
{
$format = [];
foreach ($this->ruleWhere as $rKey => $rVal) {
foreach ($this->_where as $pKey => $pVal) {
// 匹配允许查询的字段
if ($pKey != $rKey)
continue;
// 拆解参数值
$value = explode(':', $pVal, 2);
if (count($value) === 2) {
// 格式为:id=like:10
if (in_array($value[0], $this->conditions)) {
$_rule = $value[0];
$_val = $value[1];
} else {
// 若查询条件不存在,默认为eq查询
$_rule = 'eq';
$_val = $pVal;
}
} else {
// 格式为:id=100
if ($pVal == 'null' || $pVal == '!null') {
// id = null || id = !null
$_rule = $pVal;
$_val = null;
} else {
// id = 10
$_rule = 'eq';
$_val = $pVal;
}
}
// 检测查询参数是否在ruleWhere内设置
if (is_array($rVal)) {
if (!in_array($_rule, $rVal))
continue;
} elseif ($rVal != '*') {
continue;
}
$format[] = [
'rule' => $_rule,
'field' => $rKey,
'value' => $_val,
];
}
}
return $format;
}
/**
* 预处理查询条件
*/
private function prepareWhere()
{
$formats = $this->formatWhereParams();
// 归类查询条件
foreach ($formats as $format) {
$pairs = explode('.', $format['field']);
if (count($pairs) === 1) {
// 主表查询条件
$this->prepareData = ArrayHelper::merge($this->prepareData, [
'_' => [
'where' => [$this->ruleConverter($format['rule'], $format['field'], $format['value'])]
]
]);
} else {
// 关联表
$fieldName = array_pop($pairs);
$relation = implode('.', $pairs);
$this->prepareData = ArrayHelper::merge($this->prepareData, [
$relation => ['where' => [$this->ruleConverter($format['rule'], $fieldName, $format['value'])]]
]);
}
}
}
/**
* url规则转换为Yii query格式
* @param string $rule
* @param string $field
* @param string $value
* @return array
*/
private function ruleConverter($rule, $field, $value)
{
$rules = [
'eq' => [$field => $value],
'!eq' => ['NOT', [$field => $value]],
'like' => ['LIKE', $field, $value],
'llike' => ['LIKE', $field, '%'.$value, false],
'rlike' => ['LIKE', $field, $value.'%', false],
'null' => [$field => null],
'!null' => ['NOT', [$field => null]],
'less_than' => ['<', $field, $value],
'more_than' => ['>', $field, $value],
'less_than_eq' => ['<=', $field, $value],
'more_than_eq' => ['>=', $field, $value],
'in' => ['IN', $field, explode(',', $value)],
'!in' => ['NOT IN', $field, explode(',', $value)],
];
return isset($rules[$rule]) ? $rules[$rule] : [];
}
/**
* 格式化排序规则,过滤可用排序
* @return array
*/
private function formatSortParams()
{
if (!$this->ruleSort || !$this->_extend['_sort']) {
return [];
}
$sortArray = explode(',', $this->_extend['_sort']);
$params = [];
foreach ($sortArray as $item) {
$pairs = $this->fetchSort($item);
if (in_array($pairs['field'], $this->ruleSort)) {
$params[$pairs['field']] = $pairs['sort'];
}
}
return $params;
}
/**
* 预处理排序条件,url参数格式:http://localhost?_sort=id.desc,name.asc
*/
private function prepareOrderBy()
{
$params = $this->formatSortParams();
foreach ($params as $k => $v) {
$pairs = explode('.', $k);
if (count($pairs) === 1) {
$this->prepareData = ArrayHelper::merge($this->prepareData, [
'_' => ['orderBy' => [[$k => $v]]]
]);
} else {
// 关联表查询
$fieldName = array_pop($pairs);
$way = implode('.', $pairs);
$this->prepareData = ArrayHelper::merge($this->prepareData, [
$way => ['orderBy' => [[$fieldName => $v]]]
]);
}
}
}
/**
* 提取排序规则
* @param string $str
* @return array
*/
private function fetchSort($str)
{
$pairs = explode('.', $str);
if (in_array(strtoupper(end($pairs)), ['ASC', 'DESC'])) {
$sortWay = strtoupper(array_pop($pairs));
} else {
$sortWay = 'ASC';
}
$refs = [
'ASC' => SORT_ASC,
'DESC' => SORT_DESC,
];
return [
'field' => implode('.', $pairs),
'sort' => $refs[$sortWay]
];
}
/**
* 预处理关联表信息
*/
private function prepareRelated()
{
if (!$this->_extend['_expand']) {
return;
}
$withs = explode(',', $this->_extend['_expand']);
foreach ($withs as $item) {
$this->prepareData = ArrayHelper::merge($this->prepareData, [
$item => []
]);
}
}
/**
* 应用查询数据
*/
private function applyData()
{
if (isset($this->prepareData['_'])) {
foreach ($this->prepareData['_'] as $k => $v) {
if ($k == 'where') {
foreach ($v as $item) {
$this->_query->andWhere($item);
}
} elseif ($k == 'orderBy') {
foreach ($v as $item) {
$this->_query->addOrderBy($item);
}
}
}
}
$with = [];
foreach ($this->prepareData as $k => $params) {
if ($k == '_') {
continue;
}
if (empty($params)) {
$with[] = $k;
} else {
$with[$k] = function(ActiveQuery $query) use ($params){
foreach ($params as $pkey => $pVal) {
if ($pkey == 'where') {
foreach ($pVal as $item)
$query->andWhere($item);
} elseif ($pkey == 'orderBy') {
foreach ($pVal as $item)
$query->addOrderBy($item);
}
}
};
}
}
$this->_query->with($with);
}
}