Job.php
5.91 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
<?php
namespace common\components\jqueue\base;
use Yii;
use yii\base\Component;
use common\models\FailedJobsReason as FailedJobsReasonModel;
use function json_decode;
use function time;
/**
* Class Job
* @package common\components\jqueue\base
*/
abstract class Job extends Component
{
const DEBUG = true; // 调试开关(开启日志)
/**
* 统一控制日志输出
* @param $level
* @param $msg
*/
private static function Log($msg) {
if (self::DEBUG == false || YII_ENV_PROD) { // 正式服屏蔽消息日志
return ;
}
Yii::$app->dlog->debug($msg);
}
/**
* 任务所属队列的名称
* @var string
*/
protected $queueName;
/**
* Queue实例
* @var Queue
*/
public $queueInstance;
/**
* 任务是否删除标识
* @var bool
*/
protected $deleted = false;
/**
* 任务是否released标识
* @var bool
*/
protected $released = false;
/**
* 获取任务已经尝试执行的次数
* @return int
*/
abstract public function getAttempts();
/**
* 获取任务的数据
* @return string
*/
abstract public function getPayload();
/**
* 检测任务是否被重新加入队列
* @return bool
*/
public function isReleased()
{
return $this->released;
}
/**
* 检测任务是否被删除或者被released
* @return bool
*/
public function isDeletedOrReleased()
{
return $this->isDeleted() || $this->isReleased();
}
/**
* 删除任务,子类需要实现具体的删除
* @return void
*/
public function delete()
{
$this->deleted = true;
}
/**
* 判断任务是否被删除
* @return bool
*/
public function isDeleted()
{
return $this->deleted;
}
/**
* 将任务重新加入队列
* @param int $delay
* @return void
*/
public function release($delay = 0)
{
$this->released = true;
}
/**
* 执行任务
* @return void
*/
public function execute($callback)
{
$this->resolveAndFire($callback);
}
/**
* @param $callback
*/
protected function resolveAndFire($callback)
{
$payload = $this->getPayload();
$payload = json_decode($payload, true);//以为数组的形式返回
if($callback instanceof \Closure){
try {
$result = $callback($this, $payload);
//self::Log('任务执行结果=>[' . json_encode($result) . '] | 任务数据=>[' . json_encode($payload) . ']');
} catch (Exception $e){
$failReason = '任务执行异常=>' . $e->getMessage();
$details = $e->getTraceAsString();
self::Log($failReason . ': ' . $details);
self::handleFailJob($payload['id'], $failReason, $details);
throw $e;
}
}
if (empty($result) || !isset($result['success'])) {
self::Log('resolveAndFire(): ####### doJob返回结果未设置, 删除任务 #######');
if (!$this->isDeletedOrReleased()) {
$this->delete();
}
} else {
// 任务执行成功
if ($result['success']) {
self::Log('resolveAndFire(): 任务执行成功, 从队列删除任务');
if (!$this->isDeletedOrReleased()) {
$this->delete();
}
} else { // 任务执行失败, 写入数据库
$failReason = '应用层任务回调返回错误';
$details = $result['errcode'] . '=>' . $result['errmsg'];
self::handleFailJob($payload['id'], $failReason, $details);
}
}
}
/**
* 失败任务处理(记录到数据库方便分析原因)
* @param $payloadId
* @param $failReason
* @param $details
*/
public static function handleFailJob($payloadId, $failReason, $details)
{
$reasonModel = FailedJobsReasonModel::findOne(['payload_id' => $payloadId]);
if ($reasonModel) {
$reasonModel->reason = $failReason;
$reasonModel->details = $details;
$reasonModel->created_at = time();
$reasonModel->save();
self::Log('handleFailJob(): [更新]任务失败原因: ' . $failReason . ' | payload_id=' . $payloadId);
}else {
Yii::$app->db->createCommand()->insert('failed_jobs_reason', [
'payload_id' => $payloadId,
'reason' => $failReason,
'details' => $details,
'created_at' => time()
])->execute();
self::Log('handleFailJob(): [添加]任务失败原因: ' . $failReason . ' | payload_id=' . $payloadId);
}
}
/**
* 任务执行失败后的处理方法(调用handler的failed方法)
* @return boolean
*/
public function failed()
{
if ($this->queueInstance->failed['logFail'] === true) {
$failedProvider = Yii::createObject($this->queueInstance->failed['provider']);
return $failedProvider->log($this->getQueueName(), $this->getPayload());
}
return false;
}
/**
* 获取队列名称
* @return string
*/
public function getQueueName()
{
return $this->queueName;
}
/**
* 设置队列名称
* @param $queue
*/
public function setQueueName($queueName)
{
$this->queueName = $queueName;
}
/**
* 获取Queue实例
* @return mixed
*/
public function getQueueInstance()
{
return $this->queueInstance;
}
/**
* 设置Queue实例
* @param $queueInstance
*/
public function setQueueInstance($queueInstance)
{
$this->queueInstance = $queueInstance;
}
}