From 8384f9a74655bbb8cbf83c3b2de6991f0cedf17c Mon Sep 17 00:00:00 2001 From: srzou Date: Thu, 10 Oct 2024 13:39:09 +0800 Subject: [PATCH] =?UTF-8?q?feat:(1.2.0-beta2):=20=E4=BC=98=E5=8C=96?= =?UTF-8?q?=E5=AE=8C=E5=96=84openapi=EF=BC=8C=E5=A2=9E=E5=8A=A0=E7=9B=B8?= =?UTF-8?q?=E5=85=B3=E5=B8=B8=E9=87=8F?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../client/job/core/enums/JobTypeEnum.java | 13 +++++ .../core/handler/AbstractRequestHandler.java | 1 + .../job/core/handler/RequestAddHandler.java | 55 +++++++++++-------- .../job/core/handler/RequestQueryHandler.java | 2 +- .../handler/RequestTriggerJobHandler.java | 13 +++-- .../core/handler/RequestUpdateHandler.java | 11 ++-- .../handler/RequestUpdateStatusHandler.java | 9 +-- .../job/core/openapi/SnailJobOpenApi.java | 9 +-- 8 files changed, 71 insertions(+), 42 deletions(-) create mode 100644 snail-job-client/snail-job-client-job-core/src/main/java/com/aizuda/snailjob/client/job/core/enums/JobTypeEnum.java diff --git a/snail-job-client/snail-job-client-job-core/src/main/java/com/aizuda/snailjob/client/job/core/enums/JobTypeEnum.java b/snail-job-client/snail-job-client-job-core/src/main/java/com/aizuda/snailjob/client/job/core/enums/JobTypeEnum.java new file mode 100644 index 000000000..99289d110 --- /dev/null +++ b/snail-job-client/snail-job-client-job-core/src/main/java/com/aizuda/snailjob/client/job/core/enums/JobTypeEnum.java @@ -0,0 +1,13 @@ +package com.aizuda.snailjob.client.job.core.enums; + +import lombok.AllArgsConstructor; +import lombok.Getter; + +@AllArgsConstructor +@Getter +public enum JobTypeEnum { + JOB(1), + WORKFLOW(2); + + private final int type; +} diff --git a/snail-job-client/snail-job-client-job-core/src/main/java/com/aizuda/snailjob/client/job/core/handler/AbstractRequestHandler.java b/snail-job-client/snail-job-client-job-core/src/main/java/com/aizuda/snailjob/client/job/core/handler/AbstractRequestHandler.java index 9c87e6360..19bc328ce 100644 --- a/snail-job-client/snail-job-client-job-core/src/main/java/com/aizuda/snailjob/client/job/core/handler/AbstractRequestHandler.java +++ b/snail-job-client/snail-job-client-job-core/src/main/java/com/aizuda/snailjob/client/job/core/handler/AbstractRequestHandler.java @@ -9,6 +9,7 @@ import com.aizuda.snailjob.client.common.exception.SnailJobClientException; */ public abstract class AbstractRequestHandler implements RequestHandler { + protected static final String SHARD_NUM = "shardNum"; /** * 具体调用 * @return diff --git a/snail-job-client/snail-job-client-job-core/src/main/java/com/aizuda/snailjob/client/job/core/handler/RequestAddHandler.java b/snail-job-client/snail-job-client-job-core/src/main/java/com/aizuda/snailjob/client/job/core/handler/RequestAddHandler.java index e480d2149..e3e79a18b 100644 --- a/snail-job-client/snail-job-client-job-core/src/main/java/com/aizuda/snailjob/client/job/core/handler/RequestAddHandler.java +++ b/snail-job-client/snail-job-client-job-core/src/main/java/com/aizuda/snailjob/client/job/core/handler/RequestAddHandler.java @@ -6,10 +6,7 @@ import com.aizuda.snailjob.client.job.core.dto.RequestAddJobDTO; import com.aizuda.snailjob.client.job.core.enums.AllocationAlgorithmEnum; import com.aizuda.snailjob.client.job.core.enums.TriggerTypeEnum; import com.aizuda.snailjob.client.job.core.util.ValidatorUtils; -import com.aizuda.snailjob.common.core.enums.BlockStrategyEnum; -import com.aizuda.snailjob.common.core.enums.ExecutorTypeEnum; -import com.aizuda.snailjob.common.core.enums.JobTaskTypeEnum; -import com.aizuda.snailjob.common.core.enums.StatusEnum; +import com.aizuda.snailjob.common.core.enums.*; import com.aizuda.snailjob.common.core.util.JsonUtil; import com.aizuda.snailjob.common.log.SnailJobLog; @@ -17,7 +14,7 @@ import java.util.HashMap; import java.util.Map; public class RequestAddHandler extends AbstractRequestHandler { - private RequestAddJobDTO requestAddJobDTO; + private final RequestAddJobDTO requestAddJobDTO; public RequestAddHandler(JobTaskTypeEnum taskType, Integer shardNum) { this.requestAddJobDTO = new RequestAddJobDTO(); @@ -28,9 +25,9 @@ public class RequestAddHandler extends AbstractRequestHandler { // 默认java requestAddJobDTO.setExecutorType(ExecutorTypeEnum.JAVA.getType()); // 设置分片 - if (shardNum != null){ + if (shardNum != null) { Map map = new HashMap<>(1); - map.put("shardNum", shardNum); + map.put(SHARD_NUM, shardNum); requestAddJobDTO.setArgsStr(JsonUtil.toJsonString(map)); } } @@ -47,11 +44,11 @@ public class RequestAddHandler extends AbstractRequestHandler { boolean validated = ValidatorUtils.validateEntity(requestAddJobDTO); // 如果校验正确，则正对进行相关筛选 if (validated) { - if (requestAddJobDTO.getTaskType() == JobTaskTypeEnum.CLUSTER.getType()){ + if (requestAddJobDTO.getTaskType() == JobTaskTypeEnum.CLUSTER.getType()) { // 集群模式只允许并发为 1 setParallelNum(1); } - if (requestAddJobDTO.getTriggerType() == TriggerTypeEnum.WORK_FLOW.getType()){ + if (requestAddJobDTO.getTriggerType() == TriggerTypeEnum.WORK_FLOW.getType()) { // 工作流没有调度时间 setTriggerInterval("*"); } @@ -61,6 +58,7 @@ public class RequestAddHandler extends AbstractRequestHandler { /** * 设置任务名 + * * @param jobName 任务名 * @return */ @@ -71,65 +69,69 @@ public class RequestAddHandler extends AbstractRequestHandler { /** * 设置参数 + * * @param argsStr * @return */ private RequestAddHandler setArgsStr(Map argsStr) { Map args = new HashMap<>(); - if (StrUtil.isNotBlank(requestAddJobDTO.getArgsStr())){ + if (StrUtil.isNotBlank(requestAddJobDTO.getArgsStr())) { args = JsonUtil.parseHashMap(requestAddJobDTO.getArgsStr()); } args.putAll(argsStr); requestAddJobDTO.setArgsStr(JsonUtil.toJsonString(args)); - requestAddJobDTO.setArgsType(2); + requestAddJobDTO.setArgsType(JobArgsTypeEnum.JSON.getArgsType()); return this; } /** * 添加参数，可支持多次添加 * 静态分片不可使用该方法 - * @param argsKey 参数名 + * + * @param argsKey 参数名 * @param argsValue 参数值 * @return */ public RequestAddHandler addArgsStr(String argsKey, Object argsValue) { - if (requestAddJobDTO.getTaskType().equals(JobTaskTypeEnum.SHARDING.getType())){ + if (requestAddJobDTO.getTaskType().equals(JobTaskTypeEnum.SHARDING.getType())) { SnailJobLog.LOCAL.warn("静态分片任务，不可使用该方法添加相关任务参数，请使用addShardingArgs"); return this; } Map map = new HashMap<>(); - if (StrUtil.isNotBlank(requestAddJobDTO.getArgsStr())){ + if (StrUtil.isNotBlank(requestAddJobDTO.getArgsStr())) { map = JsonUtil.parseHashMap(requestAddJobDTO.getArgsStr()); } map.put(argsKey, argsValue); requestAddJobDTO.setArgsStr(JsonUtil.toJsonString(map)); - requestAddJobDTO.setArgsType(2); + requestAddJobDTO.setArgsType(JobArgsTypeEnum.JSON.getArgsType()); return this; } /** * 添加静态分片相关参数 + * * @param shardingValue * @return */ - public RequestAddHandler addShardingArgs(String[] shardingValue){ - if (!requestAddJobDTO.getTaskType().equals(JobTaskTypeEnum.SHARDING.getType())){ + public RequestAddHandler addShardingArgs(String[] shardingValue) { + if (!requestAddJobDTO.getTaskType().equals(JobTaskTypeEnum.SHARDING.getType())) { SnailJobLog.LOCAL.warn("非静态分片任务，不可使用该方法添加相关任务参数，请使用addArgsStr"); return this; } requestAddJobDTO.setArgsStr(JsonUtil.toJsonString(shardingValue)); - requestAddJobDTO.setArgsType(1); + requestAddJobDTO.setArgsType(JobArgsTypeEnum.TEXT.getArgsType()); return this; } /** * 设置路由 + * * @param algorithmEnum 路由算法 * @return */ public RequestAddHandler setRouteKey(AllocationAlgorithmEnum algorithmEnum) { // 非集群模式 路由策略只能为轮询 - if (requestAddJobDTO.getTaskType() != JobTaskTypeEnum.CLUSTER.getType()){ + if (requestAddJobDTO.getTaskType() != JobTaskTypeEnum.CLUSTER.getType()) { setRouteKey(AllocationAlgorithmEnum.ROUND); SnailJobLog.LOCAL.warn("非集群模式 路由策略只能为轮询"); return this; @@ -140,6 +142,7 @@ public class RequestAddHandler extends AbstractRequestHandler { /** * 设置执行器信息 + * * @param executorInfo * @return */ @@ -150,12 +153,13 @@ public class RequestAddHandler extends AbstractRequestHandler { /** * 设置调度类型 + * * @param triggerType * @return */ public RequestAddHandler setTriggerType(TriggerTypeEnum triggerType) { requestAddJobDTO.setTriggerType(triggerType.getType()); - if (requestAddJobDTO.getTriggerType() == TriggerTypeEnum.WORK_FLOW.getType()){ + if (requestAddJobDTO.getTriggerType() == TriggerTypeEnum.WORK_FLOW.getType()) { // 工作流没有调度时间 setTriggerInterval("*"); } @@ -166,6 +170,7 @@ public class RequestAddHandler extends AbstractRequestHandler { * 设置触发间隔； * 单位：秒 * 工作流无需配置 + * * @param triggerInterval * @return */ @@ -176,14 +181,15 @@ public class RequestAddHandler extends AbstractRequestHandler { /** * 设置阻塞策略 + * * @param blockStrategy * @return */ public RequestAddHandler setBlockStrategy(BlockStrategyEnum blockStrategy) { // 非集群模式 路由策略只能为轮询 if (requestAddJobDTO.getTaskType() == JobTaskTypeEnum.CLUSTER.getType() - && blockStrategy.getBlockStrategy() == BlockStrategyEnum.CONCURRENCY.getBlockStrategy()){ - throw new SnailJobClientException("集群模式不能使用并行阻塞策略"); + && blockStrategy.getBlockStrategy() == BlockStrategyEnum.CONCURRENCY.getBlockStrategy()) { + throw new SnailJobClientException("集群模式不能使用并行阻塞策略"); } requestAddJobDTO.setBlockStrategy(blockStrategy.getBlockStrategy()); return this; @@ -191,6 +197,7 @@ public class RequestAddHandler extends AbstractRequestHandler { /** * 设置执行器超时时间 + * * @param executorTimeout * @return */ @@ -201,6 +208,7 @@ public class RequestAddHandler extends AbstractRequestHandler { /** * 设置任务最大重试次数 + * * @param maxRetryTimes * @return */ @@ -211,6 +219,7 @@ public class RequestAddHandler extends AbstractRequestHandler { /** * 设置重试间隔 + * * @param retryInterval * @return */ @@ -221,6 +230,7 @@ public class RequestAddHandler extends AbstractRequestHandler { /** * 设置并发数量 + * * @param parallelNum * @return */ @@ -231,6 +241,7 @@ public class RequestAddHandler extends AbstractRequestHandler { /** * 设置定时任务描述 + * * @param description * @return */ diff --git a/snail-job-client/snail-job-client-job-core/src/main/java/com/aizuda/snailjob/client/job/core/handler/RequestQueryHandler.java b/snail-job-client/snail-job-client-job-core/src/main/java/com/aizuda/snailjob/client/job/core/handler/RequestQueryHandler.java index 84a7fb170..88af1ec4b 100644 --- a/snail-job-client/snail-job-client-job-core/src/main/java/com/aizuda/snailjob/client/job/core/handler/RequestQueryHandler.java +++ b/snail-job-client/snail-job-client-job-core/src/main/java/com/aizuda/snailjob/client/job/core/handler/RequestQueryHandler.java @@ -9,7 +9,7 @@ import com.aizuda.snailjob.common.core.util.JsonUtil; import java.util.Objects; public class RequestQueryHandler extends AbstractRequestHandler { - private Long queryJobId; + private final Long queryJobId; public RequestQueryHandler(Long queryJobId) { this.queryJobId = queryJobId; diff --git a/snail-job-client/snail-job-client-job-core/src/main/java/com/aizuda/snailjob/client/job/core/handler/RequestTriggerJobHandler.java b/snail-job-client/snail-job-client-job-core/src/main/java/com/aizuda/snailjob/client/job/core/handler/RequestTriggerJobHandler.java index 924e5ca4a..1cce3441b 100644 --- a/snail-job-client/snail-job-client-job-core/src/main/java/com/aizuda/snailjob/client/job/core/handler/RequestTriggerJobHandler.java +++ b/snail-job-client/snail-job-client-job-core/src/main/java/com/aizuda/snailjob/client/job/core/handler/RequestTriggerJobHandler.java @@ -1,23 +1,24 @@ package com.aizuda.snailjob.client.job.core.handler; import com.aizuda.snailjob.client.common.exception.SnailJobClientException; +import com.aizuda.snailjob.client.job.core.enums.JobTypeEnum; public class RequestTriggerJobHandler extends AbstractRequestHandler{ - private Long triggerJobId; + private final Long triggerJobId; // 1: job; 2: workflow - private int triggerType; + private final int triggerType; - public RequestTriggerJobHandler(Long tiggerJobId, int triggerType) { - this.triggerJobId = tiggerJobId; + public RequestTriggerJobHandler(Long triggerJobId, int triggerType) { + this.triggerJobId = triggerJobId; this.triggerType = triggerType; } @Override protected Boolean doExecute() { - if (triggerType == 1) { + if (triggerType == JobTypeEnum.JOB.getType()) { return (Boolean) client.triggerJob(triggerJobId).getData(); } - if (triggerType == 2) { + if (triggerType == JobTypeEnum.WORKFLOW.getType()) { return (Boolean) client.triggerWorkFlow(triggerJobId).getData(); } throw new SnailJobClientException("snail job openapi check error"); diff --git a/snail-job-client/snail-job-client-job-core/src/main/java/com/aizuda/snailjob/client/job/core/handler/RequestUpdateHandler.java b/snail-job-client/snail-job-client-job-core/src/main/java/com/aizuda/snailjob/client/job/core/handler/RequestUpdateHandler.java index 5981e0fa8..c6d682275 100644 --- a/snail-job-client/snail-job-client-job-core/src/main/java/com/aizuda/snailjob/client/job/core/handler/RequestUpdateHandler.java +++ b/snail-job-client/snail-job-client-job-core/src/main/java/com/aizuda/snailjob/client/job/core/handler/RequestUpdateHandler.java @@ -8,6 +8,7 @@ import com.aizuda.snailjob.client.job.core.enums.TriggerTypeEnum; import com.aizuda.snailjob.client.job.core.util.ValidatorUtils; import com.aizuda.snailjob.common.core.enums.BlockStrategyEnum; import com.aizuda.snailjob.common.core.enums.ExecutorTypeEnum; +import com.aizuda.snailjob.common.core.enums.JobArgsTypeEnum; import com.aizuda.snailjob.common.core.enums.JobTaskTypeEnum; import com.aizuda.snailjob.common.core.util.JsonUtil; import com.aizuda.snailjob.common.log.SnailJobLog; @@ -16,7 +17,7 @@ import java.util.HashMap; import java.util.Map; public class RequestUpdateHandler extends AbstractRequestHandler { - private RequestUpdateJobDTO requestUpdateJobDTO; + private final RequestUpdateJobDTO requestUpdateJobDTO; public RequestUpdateHandler(Long jobId) { this.requestUpdateJobDTO = new RequestUpdateJobDTO(); @@ -67,7 +68,7 @@ public class RequestUpdateHandler extends AbstractRequestHandler { // 设置分片 if (shardNum != null){ Map map = new HashMap<>(1); - map.put("shardNum", shardNum); + map.put(SHARD_NUM, shardNum); requestUpdateJobDTO.setArgsStr(JsonUtil.toJsonString(map)); } }else { @@ -99,7 +100,7 @@ public class RequestUpdateHandler extends AbstractRequestHandler { } args.putAll(argsStr); requestUpdateJobDTO.setArgsStr(JsonUtil.toJsonString(args)); - requestUpdateJobDTO.setArgsType(2); + requestUpdateJobDTO.setArgsType(JobArgsTypeEnum.JSON.getArgsType()); return this; } @@ -123,7 +124,7 @@ public class RequestUpdateHandler extends AbstractRequestHandler { } map.put(argsKey, argsValue); requestUpdateJobDTO.setArgsStr(JsonUtil.toJsonString(map)); - requestUpdateJobDTO.setArgsType(2); + requestUpdateJobDTO.setArgsType(JobArgsTypeEnum.JSON.getArgsType()); return this; } @@ -139,7 +140,7 @@ public class RequestUpdateHandler extends AbstractRequestHandler { return this; } requestUpdateJobDTO.setArgsStr(JsonUtil.toJsonString(shardingValue)); - requestUpdateJobDTO.setArgsType(1); + requestUpdateJobDTO.setArgsType(JobArgsTypeEnum.TEXT.getArgsType()); return this; } diff --git a/snail-job-client/snail-job-client-job-core/src/main/java/com/aizuda/snailjob/client/job/core/handler/RequestUpdateStatusHandler.java b/snail-job-client/snail-job-client-job-core/src/main/java/com/aizuda/snailjob/client/job/core/handler/RequestUpdateStatusHandler.java index adbf3a414..68958e5c7 100644 --- a/snail-job-client/snail-job-client-job-core/src/main/java/com/aizuda/snailjob/client/job/core/handler/RequestUpdateStatusHandler.java +++ b/snail-job-client/snail-job-client-job-core/src/main/java/com/aizuda/snailjob/client/job/core/handler/RequestUpdateStatusHandler.java @@ -2,14 +2,15 @@ package com.aizuda.snailjob.client.job.core.handler; import com.aizuda.snailjob.client.common.exception.SnailJobClientException; import com.aizuda.snailjob.client.job.core.dto.RequestUpdateStatusDTO; +import com.aizuda.snailjob.client.job.core.enums.JobTypeEnum; import com.aizuda.snailjob.client.job.core.util.ValidatorUtils; import com.aizuda.snailjob.common.core.enums.StatusEnum; public class RequestUpdateStatusHandler extends AbstractRequestHandler{ - private RequestUpdateStatusDTO statusDTO; + private final RequestUpdateStatusDTO statusDTO; // 1: job; 2: workflow - private int type; + private final int type; public RequestUpdateStatusHandler(Long id, int type) { this.statusDTO = new RequestUpdateStatusDTO(); @@ -19,10 +20,10 @@ public class RequestUpdateStatusHandler extends AbstractRequestHandler{ @Override protected Boolean doExecute() { - if (type == 1){ + if (type == JobTypeEnum.JOB.getType()){ return (Boolean) client.updateJobStatus(statusDTO).getData(); } - if (type == 2){ + if (type == JobTypeEnum.WORKFLOW.getType()){ return (Boolean) client.updateWorkFlowStatus(statusDTO).getData(); } throw new SnailJobClientException("snail job openapi check error"); diff --git a/snail-job-client/snail-job-client-job-core/src/main/java/com/aizuda/snailjob/client/job/core/openapi/SnailJobOpenApi.java b/snail-job-client/snail-job-client-job-core/src/main/java/com/aizuda/snailjob/client/job/core/openapi/SnailJobOpenApi.java index 1cdef3295..1f6c3f4e4 100644 --- a/snail-job-client/snail-job-client-job-core/src/main/java/com/aizuda/snailjob/client/job/core/openapi/SnailJobOpenApi.java +++ b/snail-job-client/snail-job-client-job-core/src/main/java/com/aizuda/snailjob/client/job/core/openapi/SnailJobOpenApi.java @@ -1,5 +1,6 @@ package com.aizuda.snailjob.client.job.core.openapi; +import com.aizuda.snailjob.client.job.core.enums.JobTypeEnum; import com.aizuda.snailjob.client.job.core.handler.*; import com.aizuda.snailjob.common.core.enums.JobTaskTypeEnum; @@ -85,7 +86,7 @@ public final class SnailJobOpenApi { * @return */ public static RequestTriggerJobHandler triggerJob(Long jobId) { - return new RequestTriggerJobHandler(jobId, 1); + return new RequestTriggerJobHandler(jobId, JobTypeEnum.JOB.getType()); } /** @@ -95,7 +96,7 @@ public final class SnailJobOpenApi { * @return */ public static RequestTriggerJobHandler triggerWorkFlow(Long id) { - return new RequestTriggerJobHandler(id, 2); + return new RequestTriggerJobHandler(id, JobTypeEnum.WORKFLOW.getType()); } /** @@ -105,7 +106,7 @@ public final class SnailJobOpenApi { * @return */ public static RequestUpdateStatusHandler updateJobStatus(Long jobId) { - return new RequestUpdateStatusHandler(jobId, 1); + return new RequestUpdateStatusHandler(jobId, JobTypeEnum.JOB.getType()); } /** @@ -115,6 +116,6 @@ public final class SnailJobOpenApi { * @return */ public static RequestUpdateStatusHandler updateWorkFlowStatus(Long workFlowId) { - return new RequestUpdateStatusHandler(workFlowId, 2); + return new RequestUpdateStatusHandler(workFlowId, JobTypeEnum.WORKFLOW.getType()); } }