third_codes/PowerJob
1
0
Fork 1
mirror of https://github.com/PowerJob/PowerJob.git synced 2025-07-17 00:00:04 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: translate for OhMyClient

Browse Source
This commit is contained in:
tjq 2021-01-10 11:20:13 +08:00
parent 078db73bce
commit b97c26c78b
4 changed files with 89 additions and 106 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

187
powerjob-client/src/main/java/com/github/kfcfans/powerjob/client/OhMyClient.java
View File

@ -41,8 +41,9 @@ public class OhMyClient {
/** /**
* Init OhMyClient with domain, appName and password. * Init OhMyClient with domain, appName and password.
* @param domain 比如 www.powerjob-server.com（内网域名，自行完成 DNS & Proxy） * @param domain like powerjob-server.apple-inc.com (Intranet Domain)
* @param appName name of the application * @param appName name of the application
* @param password password of the application
*/ */
public OhMyClient(String domain, String appName, String password) { public OhMyClient(String domain, String appName, String password) {
this(Lists.newArrayList(domain), appName, password); this(Lists.newArrayList(domain), appName, password);
@ -50,9 +51,10 @@ public class OhMyClient {
/** /**
* nit OhMyClient with server address, appName and password. * Init OhMyClient with server address, appName and password.
* @param addressList IP:Port address list * @param addressList IP:Port address list, like 192.168.1.1:7700
* @param appName name of the application * @param appName name of the application
* @param password password of the application
*/ */
public OhMyClient(List<String> addressList, String appName, String password) { public OhMyClient(List<String> addressList, String appName, String password) {
@ -79,7 +81,7 @@ public class OhMyClient {
} }
if (StringUtils.isEmpty(currentAddress)) { if (StringUtils.isEmpty(currentAddress)) {
throw new PowerJobException("no server available"); throw new PowerJobException("no server available for OhMyClient");
} }
log.info("[OhMyClient] {}'s OhMyClient bootstrap successfully, using server: {}", appName, currentAddress); log.info("[OhMyClient] {}'s OhMyClient bootstrap successfully, using server: {}", appName, currentAddress);
} }
@ -101,12 +103,12 @@ public class OhMyClient {
/* ************* Job 区 ************* */ /* ************* Job 区 ************* */
/** /**
* 保存任务（包括创建与修改） * Save one Job
* @param request 任务详细参数 * When an ID exists in SaveJobInfoRequest, it is an update operation. Otherwise, it is a crate operation.
* @return 创建的任务ID * @param request Job meta info
* @throws PowerJobException 异常 * @return jobId
*/ */
public ResultDTO<Long> saveJob(SaveJobInfoRequest request) throws PowerJobException { public ResultDTO<Long> saveJob(SaveJobInfoRequest request) {
request.setAppId(appId); request.setAppId(appId);
MediaType jsonType = MediaType.parse("application/json; charset=utf-8"); MediaType jsonType = MediaType.parse("application/json; charset=utf-8");
@ -116,12 +118,11 @@ public class OhMyClient {
} }
/** /**
* 根据 jobId 查询任务信息 * Query JobInfo by jobId
* @param jobId 任务ID * @param jobId jobId
* @return 任务详细信息 * @return Job meta info
* @throws PowerJobException 异常
*/ */
public ResultDTO<JobInfoDTO> fetchJob(Long jobId) throws PowerJobException { public ResultDTO<JobInfoDTO> fetchJob(Long jobId) {
RequestBody body = new FormBody.Builder() RequestBody body = new FormBody.Builder()
.add("jobId", jobId.toString()) .add("jobId", jobId.toString())
.add("appId", appId.toString()) .add("appId", appId.toString())
@ -131,12 +132,11 @@ public class OhMyClient {
} }
/** /**
* 禁用某个任务 * Disable one Job by jobId
* @param jobId 任务ID * @param jobId jobId
* @return 标准返回对象 * @return Standard return object
* @throws PowerJobException 异常
*/ */
public ResultDTO<Void> disableJob(Long jobId) throws PowerJobException { public ResultDTO<Void> disableJob(Long jobId) {
RequestBody body = new FormBody.Builder() RequestBody body = new FormBody.Builder()
.add("jobId", jobId.toString()) .add("jobId", jobId.toString())
.add("appId", appId.toString()) .add("appId", appId.toString())
@ -146,12 +146,11 @@ public class OhMyClient {
} }
/** /**
* 启用某个任务 * Enable one job by jobId
* @param jobId 任务ID * @param jobId jobId
* @return 标准返回对象 * @return Standard return object
* @throws PowerJobException 异常
*/ */
public ResultDTO<Void> enableJob(Long jobId) throws PowerJobException { public ResultDTO<Void> enableJob(Long jobId) {
RequestBody body = new FormBody.Builder() RequestBody body = new FormBody.Builder()
.add("jobId", jobId.toString()) .add("jobId", jobId.toString())
.add("appId", appId.toString()) .add("appId", appId.toString())
@ -161,12 +160,11 @@ public class OhMyClient {
} }
/** /**
* 删除某个任务 * Delete one job by jobId
* @param jobId 任务ID * @param jobId jobId
* @return 标准返回对象 * @return Standard return object
* @throws PowerJobException 异常
*/ */
public ResultDTO<Void> deleteJob(Long jobId) throws PowerJobException { public ResultDTO<Void> deleteJob(Long jobId) {
RequestBody body = new FormBody.Builder() RequestBody body = new FormBody.Builder()
.add("jobId", jobId.toString()) .add("jobId", jobId.toString())
.add("appId", appId.toString()) .add("appId", appId.toString())
@ -176,14 +174,13 @@ public class OhMyClient {
} }
/** /**
* 运行某个任务 * Run a job once
* @param jobId 任务ID * @param jobId ID of the job to be run
* @param instanceParams 任务实例的参数 * @param instanceParams Runtime parameters of the job (TaskContext#instanceParams)
* @param delayMS 延迟时间，单位毫秒 * @param delayMS Delay time（Milliseconds）
* @return 任务实例ID（instanceId） * @return instanceId
* @throws PowerJobException 异常
*/ */
public ResultDTO<Long> runJob(Long jobId, String instanceParams, long delayMS) throws PowerJobException { public ResultDTO<Long> runJob(Long jobId, String instanceParams, long delayMS) {
FormBody.Builder builder = new FormBody.Builder() FormBody.Builder builder = new FormBody.Builder()
.add("jobId", jobId.toString()) .add("jobId", jobId.toString())
.add("appId", appId.toString()) .add("appId", appId.toString())
@ -201,12 +198,11 @@ public class OhMyClient {
/* ************* Instance API list ************* */ /* ************* Instance API list ************* */
/** /**
* 停止应用实例 * Stop one job instance
* @param instanceId 应用实例ID * @param instanceId instanceId
* @return true 停止成功，false 停止失败 * @return Standard return object
* @throws PowerJobException 异常
*/ */
public ResultDTO<Void> stopInstance(Long instanceId) throws PowerJobException { public ResultDTO<Void> stopInstance(Long instanceId) {
RequestBody body = new FormBody.Builder() RequestBody body = new FormBody.Builder()
.add("instanceId", instanceId.toString()) .add("instanceId", instanceId.toString())
.add("appId", appId.toString()) .add("appId", appId.toString())
@ -216,13 +212,12 @@ public class OhMyClient {
} }
/** /**
* 取消任务实例 * Cancel a job instance that is not yet running
* 接口使用条件：调用接口时间与待取消任务的预计执行时间有一定时间间隔，否则不保证可靠性！ * Notice：There is a time interval between the call interface time and the expected execution time of the job instance to be cancelled, otherwise reliability is not guaranteed
* @param instanceId 任务实例ID * @param instanceId instanceId
* @return true 代表取消成功，false 取消失败 * @return Standard return object
* @throws PowerJobException 异常
*/ */
public ResultDTO<Void> cancelInstance(Long instanceId) throws PowerJobException { public ResultDTO<Void> cancelInstance(Long instanceId) {
RequestBody body = new FormBody.Builder() RequestBody body = new FormBody.Builder()
.add("instanceId", instanceId.toString()) .add("instanceId", instanceId.toString())
.add("appId", appId.toString()) .add("appId", appId.toString())
@ -232,13 +227,12 @@ public class OhMyClient {
} }
/** /**
* 重试任务实例 * Retry failed job instance
* 只有完成状态（成功、失败、手动停止、被取消）的任务才能被重试，且暂不支持工作流内任务实例的重试 * Notice: Only job instance with completion status (success, failure, manually stopped, cancelled) can be retried, and retries of job instances within workflows are not supported yet.
* @param instanceId 任务实例ID * @param instanceId instanceId
* @return true 代表取消成功，false 取消失败 * @return Standard return object
* @throws PowerJobException 异常
*/ */
public ResultDTO<Void> retryInstance(Long instanceId) throws PowerJobException { public ResultDTO<Void> retryInstance(Long instanceId) {
RequestBody body = new FormBody.Builder() RequestBody body = new FormBody.Builder()
.add("instanceId", instanceId.toString()) .add("instanceId", instanceId.toString())
.add("appId", appId.toString()) .add("appId", appId.toString())
@ -248,12 +242,11 @@ public class OhMyClient {
} }
/** /**
* 查询任务实例状态 * Query status about a job instance
* @param instanceId 应用实例ID * @param instanceId instanceId
* @return {@link InstanceStatus} 的枚举值 * @return {@link InstanceStatus}
* @throws PowerJobException 异常
*/ */
public ResultDTO<Integer> fetchInstanceStatus(Long instanceId) throws PowerJobException { public ResultDTO<Integer> fetchInstanceStatus(Long instanceId) {
RequestBody body = new FormBody.Builder() RequestBody body = new FormBody.Builder()
.add("instanceId", instanceId.toString()) .add("instanceId", instanceId.toString())
.build(); .build();
@ -262,12 +255,11 @@ public class OhMyClient {
} }
/** /**
* 查询任务实例的信息 * Query detail about a job instance
* @param instanceId 任务实例ID * @param instanceId instanceId
* @return 任务实例信息 * @return instance detail
* @throws PowerJobException 潜在的异常
*/ */
public ResultDTO<InstanceInfoDTO> fetchInstanceInfo(Long instanceId) throws PowerJobException { public ResultDTO<InstanceInfoDTO> fetchInstanceInfo(Long instanceId) {
RequestBody body = new FormBody.Builder() RequestBody body = new FormBody.Builder()
.add("instanceId", instanceId.toString()) .add("instanceId", instanceId.toString())
.build(); .build();
@ -277,12 +269,12 @@ public class OhMyClient {
/* ************* Workflow API list ************* */ /* ************* Workflow API list ************* */
/** /**
* 保存工作流（包括创建和修改） * Save one workflow
* @param request 创建/修改 Workflow 请求 * When an ID exists in SaveWorkflowRequest, it is an update operation. Otherwise, it is a crate operation.
* @return 工作流ID * @param request Workflow meta info
* @throws PowerJobException 异常 * @return workflowId
*/ */
public ResultDTO<Long> saveWorkflow(SaveWorkflowRequest request) throws PowerJobException { public ResultDTO<Long> saveWorkflow(SaveWorkflowRequest request) {
request.setAppId(appId); request.setAppId(appId);
MediaType jsonType = MediaType.parse(OmsConstant.JSON_MEDIA_TYPE); MediaType jsonType = MediaType.parse(OmsConstant.JSON_MEDIA_TYPE);
// 中坑记录：用 FastJSON 序列化会导致 Server 接收时 pEWorkflowDAG 为 null，无语.jpg // 中坑记录：用 FastJSON 序列化会导致 Server 接收时 pEWorkflowDAG 为 null，无语.jpg
@ -292,12 +284,11 @@ public class OhMyClient {
} }
/** /**
* 根据 workflowId 查询工作流信息 * Query Workflow by workflowId
* @param workflowId workflowId * @param workflowId workflowId
* @return 工作流信息 * @return Workflow meta info
* @throws PowerJobException 异常
*/ */
public ResultDTO<WorkflowInfoDTO> fetchWorkflow(Long workflowId) throws PowerJobException { public ResultDTO<WorkflowInfoDTO> fetchWorkflow(Long workflowId) {
RequestBody body = new FormBody.Builder() RequestBody body = new FormBody.Builder()
.add("workflowId", workflowId.toString()) .add("workflowId", workflowId.toString())
.add("appId", appId.toString()) .add("appId", appId.toString())
@ -307,12 +298,11 @@ public class OhMyClient {
} }
/** /**
* 禁用某个工作流 * Disable Workflow by workflowId
* @param workflowId 工作流ID * @param workflowId workflowId
* @return 标准返回对象 * @return Standard return object
* @throws PowerJobException 异常
*/ */
public ResultDTO<Void> disableWorkflow(Long workflowId) throws PowerJobException { public ResultDTO<Void> disableWorkflow(Long workflowId) {
RequestBody body = new FormBody.Builder() RequestBody body = new FormBody.Builder()
.add("workflowId", workflowId.toString()) .add("workflowId", workflowId.toString())
.add("appId", appId.toString()) .add("appId", appId.toString())
@ -322,12 +312,11 @@ public class OhMyClient {
} }
/** /**
* 启用某个工作流 * Enable Workflow by workflowId
* @param workflowId workflowId * @param workflowId workflowId
* @return 标准返回对象 * @return Standard return object
* @throws PowerJobException 异常
*/ */
public ResultDTO<Void> enableWorkflow(Long workflowId) throws PowerJobException { public ResultDTO<Void> enableWorkflow(Long workflowId) {
RequestBody body = new FormBody.Builder() RequestBody body = new FormBody.Builder()
.add("workflowId", workflowId.toString()) .add("workflowId", workflowId.toString())
.add("appId", appId.toString()) .add("appId", appId.toString())
@ -337,12 +326,11 @@ public class OhMyClient {
} }
/** /**
* 删除某个工作流 * Delete Workflow by workflowId
* @param workflowId workflowId * @param workflowId workflowId
* @return 标准返回对象 * @return Standard return object
* @throws PowerJobException 异常
*/ */
public ResultDTO<Void> deleteWorkflow(Long workflowId) throws PowerJobException { public ResultDTO<Void> deleteWorkflow(Long workflowId) {
RequestBody body = new FormBody.Builder() RequestBody body = new FormBody.Builder()
.add("workflowId", workflowId.toString()) .add("workflowId", workflowId.toString())
.add("appId", appId.toString()) .add("appId", appId.toString())
@ -352,14 +340,13 @@ public class OhMyClient {
} }
/** /**
* 运行工作流 * Run a workflow once
* @param workflowId 工作流ID * @param workflowId workflowId
* @param initParams 启动参数 * @param initParams workflow startup parameters
* @param delayMS 延迟时间，单位毫秒 ms * @param delayMS Delay time（Milliseconds）
* @return 工作流实例ID * @return workflow instanceId
* @throws PowerJobException 异常信息
*/ */
public ResultDTO<Long> runWorkflow(Long workflowId, String initParams, long delayMS) throws PowerJobException { public ResultDTO<Long> runWorkflow(Long workflowId, String initParams, long delayMS) {
FormBody.Builder builder = new FormBody.Builder() FormBody.Builder builder = new FormBody.Builder()
.add("workflowId", workflowId.toString()) .add("workflowId", workflowId.toString())
.add("appId", appId.toString()) .add("appId", appId.toString())
@ -376,10 +363,9 @@ public class OhMyClient {
/* ************* Workflow Instance API list ************* */ /* ************* Workflow Instance API list ************* */
/** /**
* 停止应用实例 * Stop one workflow instance
* @param wfInstanceId 工作流实例ID * @param wfInstanceId workflow instanceId
* @return true 停止成功 ； false 停止失败 * @return Standard return object
* @throws PowerJobException 异常
*/ */
public ResultDTO<Void> stopWorkflowInstance(Long wfInstanceId) throws PowerJobException { public ResultDTO<Void> stopWorkflowInstance(Long wfInstanceId) throws PowerJobException {
RequestBody body = new FormBody.Builder() RequestBody body = new FormBody.Builder()
@ -391,12 +377,11 @@ public class OhMyClient {
} }
/** /**
* 查询任务实例的信息 * Query detail about a workflow instance
* @param wfInstanceId 任务实例ID * @param wfInstanceId workflow instanceId
* @return 任务实例信息 * @return detail about a workflow
* @throws PowerJobException 潜在的异常
*/ */
public ResultDTO<WorkflowInstanceInfoDTO> fetchWorkflowInstanceInfo(Long wfInstanceId) throws PowerJobException { public ResultDTO<WorkflowInstanceInfoDTO> fetchWorkflowInstanceInfo(Long wfInstanceId) {
RequestBody body = new FormBody.Builder() RequestBody body = new FormBody.Builder()
.add("wfInstanceId", wfInstanceId.toString()) .add("wfInstanceId", wfInstanceId.toString())
.add("appId", appId.toString()) .add("appId", appId.toString())

2
powerjob-common/src/main/java/com/github/kfcfans/powerjob/common/InstanceStatus.java
View File

@ -7,7 +7,7 @@ import lombok.Getter;
import java.util.List; import java.util.List;
/** /**
* 任务运行状态 * Status of the job instance
* *
* @author tjq * @author tjq
* @since 2020/3/17 * @since 2020/3/17

2
powerjob-common/src/main/java/com/github/kfcfans/powerjob/common/response/InstanceInfoDTO.java
View File

@ -6,7 +6,7 @@ import lombok.Data;
import java.util.Date; import java.util.Date;
/** /**
* instanceInfo 对外输出对象 * instanceInfo Network transmission object
* *
* @author tjq * @author tjq
* @since 2020/5/14 * @since 2020/5/14

4
powerjob-common/src/main/java/com/github/kfcfans/powerjob/common/response/ResultDTO.java
View File

@ -7,7 +7,7 @@ import lombok.ToString;
import org.apache.commons.lang3.exception.ExceptionUtils; import org.apache.commons.lang3.exception.ExceptionUtils;
/** /**
* 请求返回的结果对象 * The result object returned by the request
* *
* @author tjq * @author tjq
* @since 2020/3/30 * @since 2020/3/30
@ -18,9 +18,7 @@ import org.apache.commons.lang3.exception.ExceptionUtils;
public class ResultDTO<T> implements OmsSerializable { public class ResultDTO<T> implements OmsSerializable {
private boolean success; private boolean success;
// 数据（success为 true 时存在）
private T data; private T data;
// 错误信息（success为 false 时存在）
private String message; private String message;
public static <T> ResultDTO<T> success(T data) { public static <T> ResultDTO<T> success(T data) {