refactor(core): 重命名回调请求类以提高一致性

- 将 HandleCallbackRequest 类重命名为 CallbackRequest
- 更新所有相关的导入语句和变量引用
- 修改 AdminBiz 接口中的回调方法参数类型
- 调整 JobThread 和 TriggerCallbackThread 中的回调逻辑
- 更新测试类 AdminBizTest 中的回调请求创建方式
- 修改 OpenApiController 和 JobCompleteHelper 中的回调处理逻辑
- 调整 Gson 序列化和反序列化的类型引用
- 将日志记录中的变量名更新为新的类名
- 确保所有模块对新类名的一致性使用
3.3.0-release
xuxueli 2 weeks ago
parent 96663210f9
commit 6ce8d108ac

@ -3,7 +3,7 @@ package com.xxl.job.admin.scheduler.openapi;
import com.xxl.job.admin.scheduler.config.XxlJobAdminBootstrap;
import com.xxl.job.core.constant.Const;
import com.xxl.job.core.openapi.AdminBiz;
import com.xxl.job.core.openapi.model.HandleCallbackRequest;
import com.xxl.job.core.openapi.model.CallbackRequest;
import com.xxl.job.core.openapi.model.RegistryRequest;
import com.xxl.sso.core.annotation.XxlSso;
import com.xxl.tool.core.StringTool;
@ -57,7 +57,7 @@ public class OpenApiController {
try {
switch (uri) {
case "callback": {
List<HandleCallbackRequest> callbackParamList = GsonTool.fromJson(requestBody, List.class, HandleCallbackRequest.class);
List<CallbackRequest> callbackParamList = GsonTool.fromJson(requestBody, List.class, CallbackRequest.class);
return adminBiz.callback(callbackParamList);
}
case "registry": {

@ -3,7 +3,7 @@ package com.xxl.job.admin.scheduler.thread;
import com.xxl.job.admin.model.XxlJobLog;
import com.xxl.job.admin.scheduler.config.XxlJobAdminBootstrap;
import com.xxl.job.admin.util.I18nUtil;
import com.xxl.job.core.openapi.model.HandleCallbackRequest;
import com.xxl.job.core.openapi.model.CallbackRequest;
import com.xxl.job.core.context.XxlJobContext;
import com.xxl.tool.core.DateTool;
import com.xxl.tool.response.Response;
@ -20,7 +20,7 @@ import java.util.concurrent.*;
* @author xuxueli 2015-9-1 18:05:56
*/
public class JobCompleteHelper {
private static Logger logger = LoggerFactory.getLogger(JobCompleteHelper.class);
private static final Logger logger = LoggerFactory.getLogger(JobCompleteHelper.class);
// ---------------------- monitor ----------------------
@ -137,15 +137,15 @@ public class JobCompleteHelper {
// ---------------------- helper ----------------------
public Response<String> callback(List<HandleCallbackRequest> callbackParamList) {
public Response<String> callback(List<CallbackRequest> callbackParamList) {
callbackThreadPool.execute(new Runnable() {
@Override
public void run() {
for (HandleCallbackRequest handleCallbackParam: callbackParamList) {
Response<String> callbackResult = doCallback(handleCallbackParam);
logger.debug(">>>>>>>>> JobApiController.callback {}, handleCallbackParam={}, callbackResult={}",
(callbackResult.isSuccess()?"success":"fail"), handleCallbackParam, callbackResult);
for (CallbackRequest callbackRequest: callbackParamList) {
Response<String> callbackResult = doCallback(callbackRequest);
logger.debug(">>>>>>>>> JobApiController.callback {}, callbackRequest={}, callbackResult={}",
(callbackResult.isSuccess()?"success":"fail"), callbackRequest, callbackResult);
}
}
});
@ -153,7 +153,7 @@ public class JobCompleteHelper {
return Response.ofSuccess();
}
private Response<String> doCallback(HandleCallbackRequest handleCallbackParam) {
private Response<String> doCallback(CallbackRequest handleCallbackParam) {
// valid log item
XxlJobLog log = XxlJobAdminBootstrap.getInstance().getXxlJobLogMapper().load(handleCallbackParam.getLogId());
if (log == null) {

@ -2,7 +2,7 @@ package com.xxl.job.admin.service.impl;
import com.xxl.job.admin.scheduler.config.XxlJobAdminBootstrap;
import com.xxl.job.core.openapi.AdminBiz;
import com.xxl.job.core.openapi.model.HandleCallbackRequest;
import com.xxl.job.core.openapi.model.CallbackRequest;
import com.xxl.job.core.openapi.model.RegistryRequest;
import com.xxl.tool.response.Response;
import org.springframework.stereotype.Service;
@ -16,8 +16,8 @@ import java.util.List;
public class AdminBizImpl implements AdminBiz {
@Override
public Response<String> callback(List<HandleCallbackRequest> handleCallbackRequestList) {
return XxlJobAdminBootstrap.getInstance().getJobCompleteHelper().callback(handleCallbackRequestList);
public Response<String> callback(List<CallbackRequest> callbackRequestList) {
return XxlJobAdminBootstrap.getInstance().getJobCompleteHelper().callback(callbackRequestList);
}
@Override

@ -2,7 +2,7 @@ package com.xxl.job.openapi;
import com.xxl.job.core.constant.RegistType;
import com.xxl.job.core.openapi.AdminBiz;
import com.xxl.job.core.openapi.model.HandleCallbackRequest;
import com.xxl.job.core.openapi.model.CallbackRequest;
import com.xxl.job.core.openapi.model.RegistryRequest;
import com.xxl.job.core.context.XxlJobContext;
import com.xxl.job.core.constant.Const;
@ -42,11 +42,11 @@ public class AdminBizTest {
public void callback() throws Exception {
AdminBiz adminBiz = buildClient();
HandleCallbackRequest param = new HandleCallbackRequest();
CallbackRequest param = new CallbackRequest();
param.setLogId(1);
param.setHandleCode(XxlJobContext.HANDLE_CODE_SUCCESS);
List<HandleCallbackRequest> callbackParamList = Arrays.asList(param);
List<CallbackRequest> callbackParamList = Arrays.asList(param);
Response<String> returnT = adminBiz.callback(callbackParamList);
assertTrue(returnT.isSuccess());

@ -1,6 +1,6 @@
package com.xxl.job.core.openapi;
import com.xxl.job.core.openapi.model.HandleCallbackRequest;
import com.xxl.job.core.openapi.model.CallbackRequest;
import com.xxl.job.core.openapi.model.RegistryRequest;
import com.xxl.tool.response.Response;
@ -17,10 +17,10 @@ public interface AdminBiz {
/**
* callback
*
* @param handleCallbackRequestList
* @param callbackRequestList
* @return
*/
public Response<String> callback(List<HandleCallbackRequest> handleCallbackRequestList);
public Response<String> callback(List<CallbackRequest> callbackRequestList);
// ---------------------- registry ----------------------

@ -5,7 +5,7 @@ import java.io.Serializable;
/**
* Created by xuxueli on 17/3/2.
*/
public class HandleCallbackRequest implements Serializable {
public class CallbackRequest implements Serializable {
private static final long serialVersionUID = 42L;
private long logId;
@ -14,8 +14,8 @@ public class HandleCallbackRequest implements Serializable {
private int handleCode;
private String handleMsg;
public HandleCallbackRequest(){}
public HandleCallbackRequest(long logId, long logDateTim, int handleCode, String handleMsg) {
public CallbackRequest(){}
public CallbackRequest(long logId, long logDateTim, int handleCode, String handleMsg) {
this.logId = logId;
this.logDateTim = logDateTim;
this.handleCode = handleCode;

@ -1,6 +1,6 @@
package com.xxl.job.core.thread;
import com.xxl.job.core.openapi.model.HandleCallbackRequest;
import com.xxl.job.core.openapi.model.CallbackRequest;
import com.xxl.job.core.openapi.model.TriggerRequest;
import com.xxl.job.core.context.XxlJobContext;
import com.xxl.job.core.context.XxlJobHelper;
@ -201,7 +201,7 @@ public class JobThread extends Thread{
// callback handler info
if (!toStop) {
// common
TriggerCallbackThread.pushCallBack(new HandleCallbackRequest(
TriggerCallbackThread.pushCallBack(new CallbackRequest(
triggerParam.getLogId(),
triggerParam.getLogDateTime(),
XxlJobContext.getXxlJobContext().getHandleCode(),
@ -209,7 +209,7 @@ public class JobThread extends Thread{
);
} else {
// is killed
TriggerCallbackThread.pushCallBack(new HandleCallbackRequest(
TriggerCallbackThread.pushCallBack(new CallbackRequest(
triggerParam.getLogId(),
triggerParam.getLogDateTime(),
XxlJobContext.HANDLE_CODE_FAIL,
@ -225,7 +225,7 @@ public class JobThread extends Thread{
TriggerRequest triggerParam = triggerQueue.poll();
if (triggerParam!=null) {
// is killed
TriggerCallbackThread.pushCallBack(new HandleCallbackRequest(
TriggerCallbackThread.pushCallBack(new CallbackRequest(
triggerParam.getLogId(),
triggerParam.getLogDateTime(),
XxlJobContext.HANDLE_CODE_FAIL,

@ -1,7 +1,7 @@
package com.xxl.job.core.thread;
import com.xxl.job.core.openapi.AdminBiz;
import com.xxl.job.core.openapi.model.HandleCallbackRequest;
import com.xxl.job.core.openapi.model.CallbackRequest;
import com.xxl.job.core.context.XxlJobContext;
import com.xxl.job.core.context.XxlJobHelper;
import com.xxl.job.core.constant.Const;
@ -41,8 +41,8 @@ public class TriggerCallbackThread {
/**
* job results callback queue
*/
private final LinkedBlockingQueue<HandleCallbackRequest> callBackQueue = new LinkedBlockingQueue<>();
public static void pushCallBack(HandleCallbackRequest callback){
private final LinkedBlockingQueue<CallbackRequest> callBackQueue = new LinkedBlockingQueue<>();
public static void pushCallBack(CallbackRequest callback){
getInstance().callBackQueue.add(callback);
logger.debug(">>>>>>>>>>> xxl-job, push callback request, logId:{}", callback.getLogId());
}
@ -72,11 +72,11 @@ public class TriggerCallbackThread {
// normal callback
while(!toStop){
try {
HandleCallbackRequest callback = getInstance().callBackQueue.take();
CallbackRequest callback = getInstance().callBackQueue.take();
if (callback != null) {
// collect callback data
List<HandleCallbackRequest> callbackParamList = new ArrayList<>();
List<CallbackRequest> callbackParamList = new ArrayList<>();
callbackParamList.add(callback); // add one element
int drainToNum = getInstance().callBackQueue.drainTo(callbackParamList); // drainTo other all elements
@ -95,7 +95,7 @@ public class TriggerCallbackThread {
// thead stop, callback lasttime
try {
// collect callback data
List<HandleCallbackRequest> callbackParamList = new ArrayList<>();
List<CallbackRequest> callbackParamList = new ArrayList<>();
int drainToNum = getInstance().callBackQueue.drainTo(callbackParamList);
// do callback
@ -176,7 +176,7 @@ public class TriggerCallbackThread {
*
* @param callbackParamList callback param list
*/
private void doCallback(List<HandleCallbackRequest> callbackParamList){
private void doCallback(List<CallbackRequest> callbackParamList){
boolean callbackRet = false;
// callback, will retry if error
for (AdminBiz adminBiz: XxlJobExecutor.getAdminBizList()) {
@ -201,8 +201,8 @@ public class TriggerCallbackThread {
/**
* callback log
*/
private void callbackLog(List<HandleCallbackRequest> callbackParamList, String logContent){
for (HandleCallbackRequest callbackParam: callbackParamList) {
private void callbackLog(List<CallbackRequest> callbackParamList, String logContent){
for (CallbackRequest callbackParam: callbackParamList) {
String logFileName = XxlJobFileAppender.makeLogFileName(new Date(callbackParam.getLogDateTim()), callbackParam.getLogId());
XxlJobContext.setXxlJobContext(new XxlJobContext(
-1,
@ -232,7 +232,7 @@ public class TriggerCallbackThread {
*
* @param callbackParamList callback param list
*/
private void appendFailCallbackFile(List<HandleCallbackRequest> callbackParamList) {
private void appendFailCallbackFile(List<CallbackRequest> callbackParamList) {
// valid
if (CollectionTool.isEmpty(callbackParamList)) {
return;
@ -285,7 +285,7 @@ public class TriggerCallbackThread {
}
// parse callback param
List<HandleCallbackRequest> callbackParamList = GsonTool.fromJsonList(callbackData, HandleCallbackRequest.class);
List<CallbackRequest> callbackParamList = GsonTool.fromJsonList(callbackData, CallbackRequest.class);
FileTool.delete(callbackLogFile);
// retry callback

Loading…
Cancel
Save