Queue.php
14.2 KB
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
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
<?php
namespace App\Common\TencentMQ;
class Queue
{
private $queue_name;
private $cmq_client;
private $encoding;
public function __construct($queue_name, $cmq_client, $encoding=false) {
$this->queue_name = $queue_name;
$this->cmq_client = $cmq_client;
$this->encoding = $encoding;
}
/* 设置是否对消息体进行base64编码
@type encoding: bool
@param encoding: 是否对消息体进行base64编码
*/
public function set_encoding($encoding) {
$this->encoding = $encoding;
}
/* 创建队列
@type queue_meta: QueueMeta object
@param queue_meta: QueueMeta对象,设置队列的属性
*/
public function create($queue_meta) {
$params = array(
'queueName' => $this->queue_name,
'pollingWaitSeconds' => $queue_meta->pollingWaitSeconds,
'visibilityTimeout' => $queue_meta->visibilityTimeout,
'maxMsgSize' => $queue_meta->maxMsgSize,
'msgRetentionSeconds' => $queue_meta->msgRetentionSeconds,
'rewindSeconds' => $queue_meta->rewindSeconds,
);
if ($queue_meta->maxMsgHeapNum > 0) {
$params['maxMsgHeapNum'] = $queue_meta->maxMsgHeapNum;
}
$this->cmq_client->create_queue($params);
}
/* 获取队列属性
@rtype: QueueMeta object
@return 队列的属性
*/
public function get_attributes() {
$params = array(
'queueName' => $this->queue_name
);
$resp = $this->cmq_client->get_queue_attributes($params);
$queue_meta = new QueueMeta();
$queue_meta->queueName = $this->queue_name;
$this->__resp2meta__($queue_meta, $resp);
return $queue_meta;
}
/* 设置队列属性
@type queue_meta: QueueMeta object
@param queue_meta: QueueMeta对象,设置队列的属性
*/
public function set_attributes($queue_meta) {
$params = array(
'queueName' => $this->queue_name,
'pollingWaitSeconds' => $queue_meta->pollingWaitSeconds,
'visibilityTimeout' => $queue_meta->visibilityTimeout,
'maxMsgSize' => $queue_meta->maxMsgSize,
'msgRetentionSeconds' => $queue_meta->msgRetentionSeconds,
'rewindSeconds' => $queue_meta->rewindSeconds
);
if ($queue_meta->maxMsgHeapNum > 0) {
$params['maxMsgHeapNum'] = $queue_meta->maxMsgHeapNum;
}
$this->cmq_client->set_queue_attributes($params);
}
public function rewindQueue($backTrackingTime){
$params = array(
'queueName' => $this->queue_name,
'startConsumeTime' => $backTrackingTime
);
$this->cmq_client->rewindQueue($params);
}
/* 删除队列
*/
public function delete() {
$params = array('queueName' => $this->queue_name);
$this->cmq_client->delete_queue($params);
}
/* 发送消息
@type message: Message object
@param message: 发送的Message object
@rtype: Message object
@return 消息发送成功的返回属性,包含MessageId
*/
public function send_message($message, $delayTime = 0) {
if ($this->encoding) {
$msgBody = base64_encode($message->msgBody);
}
else {
$msgBody = $message->msgBody;
}
$params = array(
'queueName' => $this->queue_name,
'msgBody' => $msgBody,
'delaySeconds' => $delayTime
);
$msgId = $this->cmq_client->send_message($params);
$retmsg = new Message();
$retmsg->msgId = $msgId;
return $retmsg;
}
/* 批量发送消息
@type messages: list of Message object
@param messages: 发送的Message object list
@rtype: list of Message object
@return 多条消息发送成功的返回属性,包含MessageId
*/
public function batch_send_message($messages,$delayTime = 0) {
$params = array(
'queueName' => $this->queue_name,
'delaySeconds' => $delayTime
);
$n = 1;
foreach ($messages as $message) {
$key = 'msgBody.' . $n;
if ($this->encoding) {
$params[$key] = base64_encode($message->msgBody);
}
else {
$params[$key] = $message->msgBody;
}
$n += 1;
}
$msgList = $this->cmq_client->batch_send_message($params);
$retMessageList = array();
foreach ($msgList as $msg) {
$retmsg = new Message();
$retmsg->msgId = $msg['msgId'];
$retMessageList [] = $retmsg;
}
return $retMessageList;
}
/* 消费消息
@type polling_wait_seconds: int
@param polling_wait_seconds: 本次请求的长轮询时间,单位:秒
@rtype: Message object
@return Message object中包含基本属性、临时句柄
*/
public function receive_message($polling_wait_seconds = NULL) {
$params = array('queueName'=>$this->queue_name);
if ($polling_wait_seconds != NULL) {
$params['UserpollingWaitSeconds'] = $polling_wait_seconds;
$params['pollingWaitSeconds'] = $polling_wait_seconds;
}
else
{
$params['UserpollingWaitSeconds'] =30;
}
$resp = $this->cmq_client->receive_message($params);
$msg = new Message();
if ($this->encoding) {
$msg->msgBody = base64_decode($resp['msgBody']);
}
else {
$msg->msgBody = $resp['msgBody'];
}
$msg->msgId = $resp['msgId'];
$msg->receiptHandle = $resp['receiptHandle'];
$msg->enqueueTime = $resp['enqueueTime'];
$msg->nextVisibleTime = $resp['nextVisibleTime'];
$msg->dequeueCount = $resp['dequeueCount'];
$msg->firstDequeueTime = $resp['firstDequeueTime'];
return $msg;
}
/* 批量消费消息
@type num_of_msg: int
@param num_of_msg: 本次请求最多获取的消息条数
@type polling_wait_seconds: int
@param polling_wait_seconds: 本次请求的长轮询时间,单位:秒
@rtype: list of Message object
@return 多条消息的属性,包含消息的基本属性、临时句柄
*/
public function batch_receive_message($num_of_msg, $polling_wait_seconds = NULL) {
$params = array('queueName'=>$this->queue_name, 'numOfMsg'=>$num_of_msg);
if ($polling_wait_seconds != NULL) {
$params['UserpollingWaitSeconds'] = $polling_wait_seconds;
$params['pollingWaitSeconds'] = $polling_wait_seconds;
}
else{
$params['UserpollingWaitSeconds'] = 30;
}
$msgInfoList = $this->cmq_client->batch_receive_message($params);
$retMessageList = array();
foreach ($msgInfoList as $msg) {
$retmsg = new Message();
if ($this->encoding) {
$retmsg->msgBody = base64_decode($msg['msgBody']);
}
else {
$retmsg->msgBody = $msg['msgBody'];
}
$retmsg->msgId = $msg['msgId'];
$retmsg->receiptHandle = $msg['receiptHandle'];
$retmsg->enqueueTime = $msg['enqueueTime'];
$retmsg->nextVisibleTime = $msg['nextVisibleTime'];
$retmsg->dequeueCount = $msg['dequeueCount'];
$retmsg->firstDequeueTime = $msg['firstDequeueTime'];
$retMessageList [] = $retmsg;
}
return $retMessageList;
}
/* 删除消息
@type receipt_handle: string
@param receipt_handle: 最近一次操作该消息返回的临时句柄
*/
public function delete_message($receipt_handle) {
$params = array('queueName'=>$this->queue_name, 'receiptHandle'=>$receipt_handle);
$this->cmq_client->delete_message($params);
}
/* 批量删除消息
@type receipt_handle_list: list
@param receipt_handle_list: batch_receive_message返回的多条消息的临时句柄
*/
public function batch_delete_message($receipt_handle_list) {
$params = array('queueName'=>$this->queue_name);
$n = 1;
foreach ($receipt_handle_list as $receipt_handle) {
$key = 'receiptHandle.' . $n;
$params[$key] = $receipt_handle;
$n += 1;
}
$this->cmq_client->batch_delete_message($params);
}
protected function __resp2meta__($queue_meta, $resp) {
if (isset($resp['queueName'])) {
$queue_meta->queueName = $resp['queueName'];
}
if (isset($resp['maxMsgHeapNum'])) {
$queue_meta->maxMsgHeapNum = $resp['maxMsgHeapNum'];
}
if (isset($resp['pollingWaitSeconds'])) {
$queue_meta->pollingWaitSeconds = $resp['pollingWaitSeconds'];
}
if (isset($resp['visibilityTimeout'])) {
$queue_meta->visibilityTimeout = $resp['visibilityTimeout'];
}
if (isset($resp['maxMsgSize'])) {
$queue_meta->maxMsgSize = $resp['maxMsgSize'];
}
if (isset($resp['msgRetentionSeconds'])) {
$queue_meta->msgRetentionSeconds = $resp['msgRetentionSeconds'];
}
if (isset($resp['createTime'])) {
$queue_meta->createTime = $resp['createTime'];
}
if (isset($resp['lastModifyTime'])) {
$queue_meta->lastModifyTime = $resp['lastModifyTime'];
}
if (isset($resp['activeMsgNum'])) {
$queue_meta->activeMsgNum = $resp['activeMsgNum'];
}
if (isset($resp['rewindSeconds'])) {
$queue_meta->rewindSeconds = $resp['rewindSeconds'];
}
if (isset($resp['inactiveMsgNum'])) {
$queue_meta->inactiveMsgNum = $resp['inactiveMsgNum'];
}
if (isset($resp['rewindmsgNum'])) {
$queue_meta->rewindmsgNum = $resp['rewindmsgNum'];
}
if (isset($resp['minMsgTime'])) {
$queue_meta->minMsgTime = $resp['minMsgTime'];
}
if (isset($resp['delayMsgNum'])) {
$queue_meta->delayMsgNum = $resp['delayMsgNum'];
}
}
}
class QueueMeta
{
public $queueName;
public $maxMsgHeapNum;
public $pollingWaitSeconds;
public $visibilityTimeout;
public $maxMsgSize;
public $msgRetentionSeconds;
public $createTime;
public $lastModifyTime;
public $activeMsgNum;
public $inactiveMsgNum;
public $rewindSeconds;
public $rewindmsgNum;
public $minMsgTime;
public $delayMsgNum;
/* 队列属性
@note: 设置属性
:: maxMsgHeapNum: 最大堆积消息数
:: pollingWaitSeconds: receive message时,长轮询时间,单位:秒
:: visibilityTimeout: 消息可见性超时, 单位:秒
:: maxMsgSize: 消息最大长度, 单位:Byte
:: msgRetentionSeconds: 消息保留周期,单位:秒
:: rewindSeconds : 最大回溯时间, 单位:秒
@note: 非设置属性
:: activeMsgNum: 可消费消息数,近似值
:: inactiveMsgNum: 正在被消费的消息数,近似值
:: createTime: queue创建时间,单位:秒
:: lastModifyTime: 修改queue属性的最近时间,单位:秒
:: queue_name: 队列名称
:: rewindmsgNum:已删除,但是任然在回溯保留时间内的消息数量
:: minMsgTime: 消息最小未消费时间,单位为秒
:: delayMsgNum:延时消息数量
*/
public function __construct() {
$this->queueName = "";
$this->maxMsgHeapNum = -1;
$this->pollingWaitSeconds = 0;
$this->visibilityTimeout = 30;
$this->maxMsgSize = 65536;
$this->msgRetentionSeconds = 345600;
$this->createTime = -1;
$this->lastModifyTime = -1;
$this->activeMsgNum = -1;
$this->inactiveMsgNum = -1;
$this->rewindSeconds = 0 ;
$this->rewindmsgNum = 0;
$this->minMsgTime = 0;
$this->delayMsgNum = 0 ;
}
public function __toString()
{
$info = array("visibilityTimeout" => $this->visibilityTimeout,
"maxMsgHeapNum" => $this->maxMsgHeapNum,
"maxMsgSize" => $this->maxMsgSize,
"msgRetentionSeconds" => $this->msgRetentionSeconds,
"pollingWaitSeconds" => $this->pollingWaitSeconds,
"activeMsgNum" => $this->activeMsgNum,
"inactiveMsgNum" => $this->inactiveMsgNum,
"createTime" => date("Y-m-d H:i:s", $this->createTime),
"lastModifyTime" => date("Y-m-d H:i:s", $this->lastModifyTime),
"QueueName" => $this->queueName,
"rewindSeconds" => $this->rewindSeconds,
"rewindmsgNum" => $this->rewindmsgNum,
"minMsgTime" => $this->minMsgTime,
"delayMsgNum" => $this->delayMsgNum);
return json_encode($info);
}
}
class Message
{
public $msgBody;
public $msgId;
public $enqueueTime;
public $receiptHandle;
/* 消息属性
@note: send_message 指定属性
:: msgBody 消息体
@note: send_message 返回属性
:: msgId 消息编号
@note: receive_message 返回属性,除基本属性外
:: receiptHandle 下次删除或修改消息的临时句柄
:: enqueueTime 消息入队时间
:: nextVisibleTime 下次可被再次消费的时间
:: dequeueCount 总共被消费的次数
:: firstDequeueTime 第一次被消费的时间
*/
public function __construct($message_body = "") {
$this->msgBody = $message_body;
$this->msgId = "";
$this->enqueueTime = -1;
$this->receiptHandle = "";
$this->nextVisibleTime = -1;
$this->dequeueCount = -1;
$this->firstDequeueTime = -1;
}
public function __toString()
{
$info = array("msgBody" => $this->msgBody,
"msgId" => $this->msgId,
"enqueueTime" => date("Y-m-d H:i:s", $this->enqueueTime),
"nextVisibleTime" => date("Y-m-d H:i:s", $this->nextVisibleTime),
"firstDequeueTime" => date("Y-m-d H:i:s", $this->firstDequeueTime),
"dequeueCount" => $this->dequeueCount,
"receiptHandle" => $this->receiptHandle);
return json_encode($info);
}
}