You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by zh...@apache.org on 2020/06/15 08:21:00 UTC
[shardingsphere-elastic-job-cloud] branch master updated: Replace Chinese comments with English - common module （#22） (#27)
This is an automated email from the ASF dual-hosted git repository.
zhangliang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/shardingsphere-elastic-job-cloud.git
The following commit(s) were added to refs/heads/master by this push:
new 84a2b43 Replace Chinese comments with English - common module （#22） (#27)
84a2b43 is described below
commit 84a2b43640d5c992ed76aa28210621c91904d2a8
Author: Tboy <gu...@immomo.com>
AuthorDate: Mon Jun 15 16:20:54 2020 +0800
Replace Chinese comments with English - common module （#22） (#27)
---
.../elasticjob/cloud/api/ElasticJob.java | 4 +-
.../elasticjob/cloud/api/JobType.java | 4 +-
.../elasticjob/cloud/api/ShardingContext.java | 26 ++--
.../elasticjob/cloud/api/dataflow/DataflowJob.java | 18 +--
.../elasticjob/cloud/api/script/ScriptJob.java | 4 +-
.../elasticjob/cloud/api/simple/SimpleJob.java | 8 +-
.../cloud/config/JobCoreConfiguration.java | 87 +++++------
.../cloud/config/JobRootConfiguration.java | 12 +-
.../cloud/config/JobTypeConfiguration.java | 27 ++--
.../config/dataflow/DataflowJobConfiguration.java | 5 +-
.../config/script/ScriptJobConfiguration.java | 5 +-
.../config/simple/SimpleJobConfiguration.java | 5 +-
.../elasticjob/cloud/context/ExecutionType.java | 12 +-
.../elasticjob/cloud/context/TaskContext.java | 57 ++++---
.../elasticjob/cloud/event/JobEvent.java | 12 +-
.../elasticjob/cloud/event/JobEventBus.java | 11 +-
.../cloud/event/JobEventConfiguration.java | 14 +-
.../elasticjob/cloud/event/JobEventIdentity.java | 12 +-
.../elasticjob/cloud/event/JobEventListener.java | 16 +-
.../JobEventListenerConfigurationException.java | 4 +-
.../elasticjob/cloud/event/rdb/DatabaseType.java | 14 +-
.../cloud/event/rdb/JobEventRdbConfiguration.java | 4 +-
.../cloud/event/rdb/JobEventRdbIdentity.java | 4 +-
.../cloud/event/rdb/JobEventRdbListener.java | 4 +-
.../cloud/event/rdb/JobEventRdbSearch.java | 36 ++---
.../cloud/event/rdb/JobEventRdbStorage.java | 20 ++-
.../cloud/event/type/JobExecutionEvent.java | 34 ++---
.../event/type/JobExecutionEventThrowable.java | 4 +-
.../cloud/event/type/JobStatusTraceEvent.java | 4 +-
.../cloud/exception/AppConfigurationException.java | 4 +-
.../elasticjob/cloud/exception/ExceptionUtil.java | 12 +-
.../cloud/exception/JobConfigurationException.java | 4 +-
.../JobExecutionEnvironmentException.java | 4 +-
.../cloud/exception/JobStatisticException.java | 4 +-
.../cloud/exception/JobSystemException.java | 4 +-
.../cloud/executor/AbstractElasticJobExecutor.java | 10 +-
.../cloud/executor/JobExecutorFactory.java | 14 +-
.../elasticjob/cloud/executor/JobFacade.java | 122 +++++++--------
.../cloud/executor/ShardingContexts.java | 32 ++--
.../executor/handler/ExecutorServiceHandler.java | 18 +--
.../handler/ExecutorServiceHandlerRegistry.java | 22 ++-
.../executor/handler/JobExceptionHandler.java | 14 +-
.../cloud/executor/handler/JobProperties.java | 54 ++++---
.../impl/DefaultExecutorServiceHandler.java | 4 +-
.../handler/impl/DefaultJobExceptionHandler.java | 4 +-
.../cloud/executor/type/DataflowJobExecutor.java | 4 +-
.../cloud/executor/type/ScriptJobExecutor.java | 5 +-
.../cloud/executor/type/SimpleJobExecutor.java | 4 +-
.../cloud/reg/base/CoordinatorRegistryCenter.java | 84 +++++------
.../cloud/reg/base/ElectionCandidate.java | 24 +--
.../elasticjob/cloud/reg/base/RegistryCenter.java | 79 +++++-----
.../cloud/reg/exception/RegException.java | 4 +-
.../cloud/reg/exception/RegExceptionHandler.java | 14 +-
.../reg/zookeeper/ZookeeperConfiguration.java | 51 +++----
.../reg/zookeeper/ZookeeperElectionService.java | 13 +-
.../reg/zookeeper/ZookeeperRegistryCenter.java | 14 +-
.../cloud/statistics/StatisticInterval.java | 4 +-
.../statistics/rdb/StatisticRdbRepository.java | 166 ++++++++++-----------
.../type/job/JobExecutionTypeStatistics.java | 4 +-
.../statistics/type/job/JobRegisterStatistics.java | 4 +-
.../statistics/type/job/JobRunningStatistics.java | 4 +-
.../statistics/type/job/JobTypeStatistics.java | 4 +-
.../statistics/type/task/TaskResultStatistics.java | 4 +-
.../type/task/TaskRunningStatistics.java | 4 +-
.../util/concurrent/ExecutorServiceObject.java | 27 ++--
.../cloud/util/config/ShardingItemParameters.java | 8 +-
.../cloud/util/config/ShardingItems.java | 20 ++-
.../elasticjob/cloud/util/digest/Encryption.java | 14 +-
.../elasticjob/cloud/util/env/HostException.java | 4 +-
.../elasticjob/cloud/util/env/IpUtils.java | 30 ++--
.../elasticjob/cloud/util/env/TimeService.java | 12 +-
.../AbstractJobConfigurationGsonTypeAdapter.java | 7 +-
.../elasticjob/cloud/util/json/GsonFactory.java | 22 ++-
73 files changed, 628 insertions(+), 799 deletions(-)
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/api/ElasticJob.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/api/ElasticJob.java
index a4b30d3..32e1636 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/api/ElasticJob.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/api/ElasticJob.java
@@ -18,9 +18,7 @@
package org.apache.shardingsphere.elasticjob.cloud.api;
/**
- * 弹性化分布式作业标识接口.
- *
- * @author zhangliang
+ * ElasticJob interface.
*/
public interface ElasticJob {
}
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/api/JobType.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/api/JobType.java
index 6753be9..b44b445 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/api/JobType.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/api/JobType.java
@@ -18,9 +18,7 @@
package org.apache.shardingsphere.elasticjob.cloud.api;
/**
- * 作业类型.
- *
- * @author caohao
+ * Job type.
*/
public enum JobType {
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/api/ShardingContext.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/api/ShardingContext.java
index 5266524..4f8ae8b 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/api/ShardingContext.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/api/ShardingContext.java
@@ -22,42 +22,42 @@ import lombok.Getter;
import lombok.ToString;
/**
- * 分片上下文.
- *
- * @author zhangliang
+ * Sharding context.
*/
@Getter
@ToString
public final class ShardingContext {
/**
- * 作业名称.
+ * job name.
*/
private final String jobName;
/**
- * 作业任务ID.
+ * task ID.
*/
private final String taskId;
/**
- * 分片总数.
+ * sharding total count.
*/
private final int shardingTotalCount;
-
+
/**
- * 作业自定义参数.
- * 可以配置多个相同的作业, 但是用不同的参数作为不同的调度实例.
+ * job parameter.
+ *
+ * <p>Can configure for same job class, but use different parameter for different job schedule instance.</p>
+ *
*/
private final String jobParameter;
-
+
/**
- * 分配于本作业实例的分片项.
+ * Sharding item assigned for this sharding.
*/
private final int shardingItem;
-
+
/**
- * 分配于本作业实例的分片参数.
+ * Sharding parameter assigned for this sharding.
*/
private final String shardingParameter;
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/api/dataflow/DataflowJob.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/api/dataflow/DataflowJob.java
index 965bba0..d2157c1 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/api/dataflow/DataflowJob.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/api/dataflow/DataflowJob.java
@@ -23,27 +23,25 @@ import org.apache.shardingsphere.elasticjob.cloud.api.ShardingContext;
import java.util.List;
/**
- * 数据流分布式作业接口.
+ * Dataflow job.
*
- * @author zhangliang
- *
- * @param <T> 数据类型
+ * @param <T> type of data
*/
public interface DataflowJob<T> extends ElasticJob {
/**
- * 获取待处理数据.
+ * Fetch to be processed data.
*
- * @param shardingContext 分片上下文
- * @return 待处理的数据集合
+ * @param shardingContext sharding context
+ * @return to be processed data
*/
List<T> fetchData(ShardingContext shardingContext);
/**
- * 处理数据.
+ * Process data.
*
- * @param shardingContext 分片上下文
- * @param data 待处理数据集合
+ * @param shardingContext sharding context
+ * @param data to be processed data
*/
void processData(ShardingContext shardingContext, List<T> data);
}
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/api/script/ScriptJob.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/api/script/ScriptJob.java
index 50df666..258e73d 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/api/script/ScriptJob.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/api/script/ScriptJob.java
@@ -20,9 +20,7 @@ package org.apache.shardingsphere.elasticjob.cloud.api.script;
import org.apache.shardingsphere.elasticjob.cloud.api.ElasticJob;
/**
- * 脚本分布式作业接口.
- *
- * @author zhangliang
+ * Script job.
*/
public interface ScriptJob extends ElasticJob {
}
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/api/simple/SimpleJob.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/api/simple/SimpleJob.java
index 584a15c..a2ac08e 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/api/simple/SimpleJob.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/api/simple/SimpleJob.java
@@ -21,16 +21,14 @@ import org.apache.shardingsphere.elasticjob.cloud.api.ElasticJob;
import org.apache.shardingsphere.elasticjob.cloud.api.ShardingContext;
/**
- * 简单分布式作业接口.
- *
- * @author zhangliang
+ * Simple job.
*/
public interface SimpleJob extends ElasticJob {
/**
- * 执行作业.
+ * Execute job.
*
- * @param shardingContext 分片上下文
+ * @param shardingContext sharding context
*/
void execute(ShardingContext shardingContext);
}
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/config/JobCoreConfiguration.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/config/JobCoreConfiguration.java
index 495a0a1..72cf1f4 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/config/JobCoreConfiguration.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/config/JobCoreConfiguration.java
@@ -26,9 +26,7 @@ import lombok.Getter;
import lombok.RequiredArgsConstructor;
/**
- * 作业核心配置.
- *
- * @author zhangliang
+ * Job core configuration.
*/
@AllArgsConstructor(access = AccessLevel.PRIVATE)
@Getter
@@ -51,14 +49,14 @@ public final class JobCoreConfiguration {
private final String description;
private final JobProperties jobProperties;
-
+
/**
- * 创建简单作业配置构建器.
+ * Create simple job configuration builder.
*
- * @param jobName 作业名称
- * @param cron 作业启动时间的cron表达式
- * @param shardingTotalCount 作业分片总数
- * @return 简单作业配置构建器
+ * @param jobName job name
+ * @param cron cron expression for job trigger
+ * @param shardingTotalCount sharding total count
+ * @return simple job configuration builder
*/
public static Builder newBuilder(final String jobName, final String cron, final int shardingTotalCount) {
return new Builder(jobName, cron, shardingTotalCount);
@@ -84,20 +82,21 @@ public final class JobCoreConfiguration {
private String description = "";
private final JobProperties jobProperties = new JobProperties();
-
+
/**
- * 设置分片序列号和个性化参数对照表.
+ * Set mapper of sharding items and sharding parameters.
*
* <p>
- * 分片序列号和参数用等号分隔, 多个键值对用逗号分隔. 类似map.
- * 分片序列号从0开始, 不可大于或等于作业分片总数.
- * 如:
+ * sharding item and sharding parameter split by =, multiple sharding items and sharding parameters split by comma, just like map.
+ * Sharding item start from zero, cannot equal to great than sharding total count.
+ *
+ * For example:
* 0=a,1=b,2=c
* </p>
*
- * @param shardingItemParameters 分片序列号和个性化参数对照表
+ * @param shardingItemParameters mapper of sharding items and sharding parameters
*
- * @return 作业配置构建器
+ * @return job configuration builder
*/
public Builder shardingItemParameters(final String shardingItemParameters) {
if (null != shardingItemParameters) {
@@ -105,17 +104,13 @@ public final class JobCoreConfiguration {
}
return this;
}
-
+
/**
- * 设置作业自定义参数.
+ * Set job parameter.
*
- * <p>
- * 可以配置多个相同的作业, 但是用不同的参数作为不同的调度实例.
- * </p>
+ * @param jobParameter job parameter
*
- * @param jobParameter 作业自定义参数
- *
- * @return 作业配置构建器
+ * @return job configuration builder
*/
public Builder jobParameter(final String jobParameter) {
if (null != jobParameter) {
@@ -123,41 +118,41 @@ public final class JobCoreConfiguration {
}
return this;
}
-
+
/**
- * 设置是否开启失效转移.
+ * Set enable failover.
*
* <p>
- * 只有对monitorExecution的情况下才可以开启失效转移.
- * </p>
+ * Only for `monitorExecution` enabled.
+ * </p>
*
- * @param failover 是否开启失效转移
+ * @param failover enable or disable failover
*
- * @return 作业配置构建器
+ * @return job configuration builder
*/
public Builder failover(final boolean failover) {
this.failover = failover;
return this;
}
-
+
/**
- * 设置是否开启misfire.
+ * Set enable misfire.
*
- * @param misfire 是否开启misfire
+ * @param misfire enable or disable misfire
*
- * @return 作业配置构建器
+ * @return job configuration builder
*/
public Builder misfire(final boolean misfire) {
this.misfire = misfire;
return this;
}
-
+
/**
- * 设置作业描述信息.
+ * Set job description.
*
- * @param description 作业描述信息
+ * @param description job description
*
- * @return 作业配置构建器
+ * @return job configuration builder
*/
public Builder description(final String description) {
if (null != description) {
@@ -165,24 +160,24 @@ public final class JobCoreConfiguration {
}
return this;
}
-
+
/**
- * 设置作业属性.
+ * Set job properties.
*
- * @param key 属性键
- * @param value 属性值
+ * @param key property key
+ * @param value property value
*
- * @return 作业配置构建器
+ * @return job configuration builder
*/
public Builder jobProperties(final String key, final String value) {
jobProperties.put(key, value);
return this;
}
-
+
/**
- * 构建作业配置对象.
+ * Build Job.
*
- * @return 作业配置对象
+ * @return job configuration builder
*/
public final JobCoreConfiguration build() {
Preconditions.checkArgument(!Strings.isNullOrEmpty(jobName), "jobName can not be empty.");
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/config/JobRootConfiguration.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/config/JobRootConfiguration.java
index 1c816a4..1be7357 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/config/JobRootConfiguration.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/config/JobRootConfiguration.java
@@ -18,16 +18,14 @@
package org.apache.shardingsphere.elasticjob.cloud.config;
/**
- * 作业配置根接口.
- *
- * @author zhangliang
+ * Job root configuration.
*/
public interface JobRootConfiguration {
-
+
/**
- * 获取作业类型配置.
- *
- * @return 作业类型配置
+ * Get type Configuration.
+ *
+ * @return Job type configuration
*/
JobTypeConfiguration getTypeConfig();
}
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/config/JobTypeConfiguration.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/config/JobTypeConfiguration.java
index 8e49833..0c8bfda 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/config/JobTypeConfiguration.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/config/JobTypeConfiguration.java
@@ -20,31 +20,28 @@ package org.apache.shardingsphere.elasticjob.cloud.config;
import org.apache.shardingsphere.elasticjob.cloud.api.JobType;
/**
- * 作业类型配置.
- *
- * @author caohao
- * @author zhangliang
+ * Job type configuration.
*/
public interface JobTypeConfiguration {
-
+
/**
- * 获取作业类型.
- *
- * @return 作业类型
+ * Get job type.
+ *
+ * @return job type
*/
JobType getJobType();
-
+
/**
- * 获取作业实现类名称.
+ * Get job class name.
*
- * @return 作业实现类名称
+ * @return job class name
*/
String getJobClass();
-
+
/**
- * 获取作业核心配置.
- *
- * @return 作业核心配置
+ * Get job core configuration.
+ *
+ * @return job core configuration
*/
JobCoreConfiguration getCoreConfig();
}
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/config/dataflow/DataflowJobConfiguration.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/config/dataflow/DataflowJobConfiguration.java
index 562c926..04aa42c 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/config/dataflow/DataflowJobConfiguration.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/config/dataflow/DataflowJobConfiguration.java
@@ -24,10 +24,7 @@ import lombok.Getter;
import lombok.RequiredArgsConstructor;
/**
- * 数据流作业配置信息.
- *
- * @author caohao
- * @author zhangliang
+ * Dataflow job configuration.
*/
@RequiredArgsConstructor
@Getter
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/config/script/ScriptJobConfiguration.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/config/script/ScriptJobConfiguration.java
index fa9e4c9..acd0289 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/config/script/ScriptJobConfiguration.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/config/script/ScriptJobConfiguration.java
@@ -25,10 +25,7 @@ import lombok.Getter;
import lombok.RequiredArgsConstructor;
/**
- * 脚本作业配置.
- *
- * @author caohao
- * @author zhangliang
+ * Script job configuration.
*/
@RequiredArgsConstructor
@Getter
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/config/simple/SimpleJobConfiguration.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/config/simple/SimpleJobConfiguration.java
index 4c92bdc..856bd35 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/config/simple/SimpleJobConfiguration.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/config/simple/SimpleJobConfiguration.java
@@ -24,10 +24,7 @@ import lombok.Getter;
import lombok.RequiredArgsConstructor;
/**
- * 简单作业配置.
- *
- * @author caohao
- * @author zhangliang
+ * Simple job configuration.
*/
@RequiredArgsConstructor
@Getter
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/context/ExecutionType.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/context/ExecutionType.java
index a1cfcd2..08444b2 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/context/ExecutionType.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/context/ExecutionType.java
@@ -18,19 +18,17 @@
package org.apache.shardingsphere.elasticjob.cloud.context;
/**
- * 执行类型.
- *
- * @author zhangliang
+ * Execution type.
*/
public enum ExecutionType {
-
+
/**
- * 准备执行的任务.
+ * Ready of execute.
*/
READY,
-
+
/**
- * 失效转移的任务.
+ * Failover execution.
*/
FAILOVER
}
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/context/TaskContext.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/context/TaskContext.java
index 465dcd3..55403ca 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/context/TaskContext.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/context/TaskContext.java
@@ -33,10 +33,7 @@ import java.util.List;
import java.util.UUID;
/**
- * 任务运行时上下文.
- *
- * @author zhangliang
- * @author caohao
+ * Task runtime context.
*/
@Getter
@EqualsAndHashCode(of = "id")
@@ -75,60 +72,60 @@ public final class TaskContext {
this.type = type;
this.slaveId = slaveId;
}
-
+
/**
- * 根据任务主键获取任务上下文.
+ * Get task context via task ID.
*
- * @param id 任务主键
- * @return 任务上下文
+ * @param id task ID
+ * @return task context
*/
public static TaskContext from(final String id) {
String[] result = id.split(DELIMITER);
Preconditions.checkState(5 == result.length);
return new TaskContext(id, MetaInfo.from(result[0] + DELIMITER + result[1]), ExecutionType.valueOf(result[2]), result[3]);
}
-
+
/**
- * 获取未分配执行服务器前的任务主键.
+ * Get unassigned task ID before job execute.
*
- * @param id 任务主键
- * @return 未分配执行服务器前的任务主键
+ * @param id task ID
+ * @return unassigned task ID before job execute
*/
public static String getIdForUnassignedSlave(final String id) {
return id.replaceAll(TaskContext.from(id).getSlaveId(), UNASSIGNED_SLAVE_ID);
}
-
+
/**
- * 设置任务执行服务器主键.
- *
- * @param slaveId 任务执行服务器主键
+ * Set job server ID.
+ *
+ * @param slaveId job server ID
*/
public void setSlaveId(final String slaveId) {
id = id.replaceAll(this.slaveId, slaveId);
this.slaveId = slaveId;
}
-
+
/**
- * 获取任务名称.
+ * Get task name.
*
- * @return 任务名称
+ * @return task name
*/
public String getTaskName() {
return Joiner.on(DELIMITER).join(metaInfo, type, slaveId);
}
-
+
/**
- * 获取任务执行器主键.
- *
- * @param appName 应用名称
- * @return 任务执行器主键
+ * Get executor ID.
+ *
+ * @param appName application name
+ * @return executor ID
*/
public String getExecutorId(final String appName) {
return Joiner.on(DELIMITER).join(appName, slaveId);
}
-
+
/**
- * 任务元信息.
+ * Task meta data.
*/
@RequiredArgsConstructor
@Getter
@@ -138,12 +135,12 @@ public final class TaskContext {
private final String jobName;
private final List<Integer> shardingItems;
-
+
/**
- * 根据任务元信息字符串获取元信息对象.
+ * Get task meta data info via string.
*
- * @param value 任务元信息字符串
- * @return 元信息对象
+ * @param value task meta data info string
+ * @return task meta data info
*/
public static MetaInfo from(final String value) {
String[] result = value.split(DELIMITER);
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/JobEvent.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/JobEvent.java
index e25edd5..95223b6 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/JobEvent.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/JobEvent.java
@@ -18,16 +18,14 @@
package org.apache.shardingsphere.elasticjob.cloud.event;
/**
- * 作业事件接口.
- *
- * @author zhangliang
+ * Job event.
*/
public interface JobEvent {
-
+
/**
- * 获取作业名称.
- *
- * @return 作业名称
+ * Get job name.
+ *
+ * @return job name
*/
String getJobName();
}
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/JobEventBus.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/JobEventBus.java
index 10f3cc6..4bffc03 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/JobEventBus.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/JobEventBus.java
@@ -23,10 +23,7 @@ import org.apache.shardingsphere.elasticjob.cloud.util.concurrent.ExecutorServic
import lombok.extern.slf4j.Slf4j;
/**
- * 运行痕迹事件总线.
- *
- * @author zhangliang
- * @author caohao
+ * Job event bus.
*/
@Slf4j
public final class JobEventBus {
@@ -60,11 +57,11 @@ public final class JobEventBus {
log.error("Elastic job: create JobEventListener failure, error is: ", ex);
}
}
-
+
/**
- * 发布事件.
+ * Post event.
*
- * @param event 作业事件
+ * @param event job event
*/
public void post(final JobEvent event) {
if (isRegistered && !executorServiceObject.isShutdown()) {
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/JobEventConfiguration.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/JobEventConfiguration.java
index 258c443..8de6952 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/JobEventConfiguration.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/JobEventConfiguration.java
@@ -18,17 +18,15 @@
package org.apache.shardingsphere.elasticjob.cloud.event;
/**
- * 作业事件配置标识接口.
- *
- * @author caohao
+ * Job event configuration.
*/
public interface JobEventConfiguration extends JobEventIdentity {
-
+
/**
- * 创建作业事件监听器.
- *
- * @return 作业事件监听器.
- * @throws JobEventListenerConfigurationException 作业事件监听器配置异常
+ * Create job event listener.
+ *
+ * @return Job event listener
+ * @throws JobEventListenerConfigurationException job event listener configuration exception
*/
JobEventListener createJobEventListener() throws JobEventListenerConfigurationException;
}
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/JobEventIdentity.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/JobEventIdentity.java
index ffc6d76..a3367fb 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/JobEventIdentity.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/JobEventIdentity.java
@@ -18,16 +18,14 @@
package org.apache.shardingsphere.elasticjob.cloud.event;
/**
- * 作业事件标识.
- *
- * @author zhangliang
+ * Job event identity.
*/
public interface JobEventIdentity {
-
+
/**
- * 获取作业事件标识.
- *
- * @return 作业事件标识
+ * Get identity.
+ *
+ * @return identity
*/
String getIdentity();
}
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/JobEventListener.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/JobEventListener.java
index 565d6c5..36a2111 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/JobEventListener.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/JobEventListener.java
@@ -23,25 +23,23 @@ import org.apache.shardingsphere.elasticjob.cloud.event.type.JobExecutionEvent;
import org.apache.shardingsphere.elasticjob.cloud.event.type.JobStatusTraceEvent;
/**
- * 作业事件监听器.
- *
- * @author zhangliang
+ * Job event listener.
*/
public interface JobEventListener extends JobEventIdentity {
-
+
/**
- * 作业执行事件监听执行.
+ * Listen job execution event.
*
- * @param jobExecutionEvent 作业执行事件
+ * @param jobExecutionEvent job execution event
*/
@Subscribe
@AllowConcurrentEvents
void listen(JobExecutionEvent jobExecutionEvent);
-
+
/**
- * 作业状态痕迹事件监听执行.
+ * Listen job status trace event.
*
- * @param jobStatusTraceEvent 作业状态痕迹事件
+ * @param jobStatusTraceEvent job status trace event
*/
@Subscribe
@AllowConcurrentEvents
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/JobEventListenerConfigurationException.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/JobEventListenerConfigurationException.java
index d755086..ac33ae6 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/JobEventListenerConfigurationException.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/JobEventListenerConfigurationException.java
@@ -18,9 +18,7 @@
package org.apache.shardingsphere.elasticjob.cloud.event;
/**
- * 作业事件监听器配置异常.
- *
- * @author zhangliang
+ * Job event listener configuration exception.
*/
public final class JobEventListenerConfigurationException extends Exception {
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/rdb/DatabaseType.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/rdb/DatabaseType.java
index 1efaf98..126ebdf 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/rdb/DatabaseType.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/rdb/DatabaseType.java
@@ -24,9 +24,7 @@ import com.google.common.collect.Iterators;
import java.util.Arrays;
/**
- * 支持的数据库类型.
- *
- * @author caohao
+ * Database type.
*/
public enum DatabaseType {
@@ -37,12 +35,12 @@ public enum DatabaseType {
DatabaseType(final String productName) {
this.productName = productName;
}
-
+
/**
- * 获取数据库类型枚举.
- *
- * @param databaseProductName 数据库类型
- * @return 数据库类型枚举
+ * Get database type.
+ *
+ * @param databaseProductName database product name
+ * @return database type
*/
public static DatabaseType valueFrom(final String databaseProductName) {
Optional<DatabaseType> databaseTypeOptional = Iterators.tryFind(Arrays.asList(DatabaseType.values()).iterator(), new Predicate<DatabaseType>() {
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/rdb/JobEventRdbConfiguration.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/rdb/JobEventRdbConfiguration.java
index 66ec1cc..f608caf 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/rdb/JobEventRdbConfiguration.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/rdb/JobEventRdbConfiguration.java
@@ -28,9 +28,7 @@ import java.io.Serializable;
import java.sql.SQLException;
/**
- * 作业数据库事件配置.
- *
- * @author caohao
+ * Job event RDB configuration.
*/
@RequiredArgsConstructor
@Getter
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/rdb/JobEventRdbIdentity.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/rdb/JobEventRdbIdentity.java
index 229c467..1857f44 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/rdb/JobEventRdbIdentity.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/rdb/JobEventRdbIdentity.java
@@ -20,9 +20,7 @@ package org.apache.shardingsphere.elasticjob.cloud.event.rdb;
import org.apache.shardingsphere.elasticjob.cloud.event.JobEventIdentity;
/**
- * 关系型数据库作业事件标识.
- *
- * @author zhangliang
+ * Job event RDB identity.
*/
public class JobEventRdbIdentity implements JobEventIdentity {
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/rdb/JobEventRdbListener.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/rdb/JobEventRdbListener.java
index 04c1e16..9027db0 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/rdb/JobEventRdbListener.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/rdb/JobEventRdbListener.java
@@ -25,9 +25,7 @@ import javax.sql.DataSource;
import java.sql.SQLException;
/**
- * 运行痕迹事件数据库监听器.
- *
- * @author caohao
+ * Job event RDB listener.
*/
public final class JobEventRdbListener extends JobEventRdbIdentity implements JobEventListener {
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/rdb/JobEventRdbSearch.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/rdb/JobEventRdbSearch.java
index a12446b..54fa230 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/rdb/JobEventRdbSearch.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/rdb/JobEventRdbSearch.java
@@ -41,9 +41,7 @@ import java.util.List;
import java.util.Map;
/**
- * 运行痕迹事件数据库检索.
- *
- * @author liguangyun
+ * Job event RDB search.
*/
@RequiredArgsConstructor
@Slf4j
@@ -60,22 +58,22 @@ public final class JobEventRdbSearch {
Lists.newArrayList("id", "job_name", "original_task_id", "task_id", "slave_id", "source", "execution_type", "sharding_item", "state", "message", "creation_time");
private final DataSource dataSource;
-
+
/**
- * 检索作业运行执行轨迹.
- *
- * @param condition 查询条件
- * @return 作业执行轨迹检索结果
+ * Find job execution events.
+ *
+ * @param condition query condition
+ * @return job execution events
*/
public Result<JobExecutionEvent> findJobExecutionEvents(final Condition condition) {
return new Result<>(getEventCount(TABLE_JOB_EXECUTION_LOG, FIELDS_JOB_EXECUTION_LOG, condition), getJobExecutionEvents(condition));
}
-
+
/**
- * 检索作业运行状态轨迹.
- *
- * @param condition 查询条件
- * @return 作业状态轨迹检索结果
+ * Find job status trace events.
+ *
+ * @param condition query condition
+ * @return job status trace events
*/
public Result<JobStatusTraceEvent> findJobStatusTraceEvents(final Condition condition) {
return new Result<>(getEventCount(TABLE_JOB_STATUS_TRACE_LOG, FIELDS_JOB_STATUS_TRACE_LOG, condition), getJobStatusTraceEvents(condition));
@@ -97,7 +95,7 @@ public final class JobEventRdbSearch {
result.add(jobExecutionEvent);
}
} catch (final SQLException ex) {
- // TODO 记录失败直接输出日志,未来可考虑配置化
+ // TODO log failure directly to output log, consider to be configurable in the future
log.error("Fetch JobExecutionEvent from DB error:", ex);
}
return result;
@@ -117,7 +115,7 @@ public final class JobEventRdbSearch {
result.add(jobStatusTraceEvent);
}
} catch (final SQLException ex) {
- // TODO 记录失败直接输出日志,未来可考虑配置化
+ // TODO log failure directly to output log, consider to be configurable in the future
log.error("Fetch JobStatusTraceEvent from DB error:", ex);
}
return result;
@@ -133,7 +131,7 @@ public final class JobEventRdbSearch {
resultSet.next();
result = resultSet.getInt(1);
} catch (final SQLException ex) {
- // TODO 记录失败直接输出日志,未来可考虑配置化
+ // TODO log failure directly to output log, consider to be configurable in the future
log.error("Fetch EventCount from DB error:", ex);
}
return result;
@@ -266,11 +264,9 @@ public final class JobEventRdbSearch {
}
return sqlBuilder.toString();
}
-
+
/**
- * 查询条件对象.
- *
- * @author liguangyun
+ * Query condition.
*/
@RequiredArgsConstructor
@Getter
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/rdb/JobEventRdbStorage.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/rdb/JobEventRdbStorage.java
index 133760e..7dd30ce 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/rdb/JobEventRdbStorage.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/rdb/JobEventRdbStorage.java
@@ -37,9 +37,7 @@ import java.util.List;
import java.util.UUID;
/**
- * 运行痕迹事件数据库存储.
- *
- * @author caohao
+ * Job event RDB storage.
*/
@Slf4j
final class JobEventRdbStorage {
@@ -178,7 +176,7 @@ final class JobEventRdbStorage {
result = true;
} catch (final SQLException ex) {
if (!isDuplicateRecord(ex)) {
- // TODO 记录失败直接输出日志,未来可考虑配置化
+ // TODO log failure directly to output log, consider to be configurable in the future
log.error(ex.getMessage());
}
}
@@ -205,7 +203,7 @@ final class JobEventRdbStorage {
}
result = true;
} catch (final SQLException ex) {
- // TODO 记录失败直接输出日志,未来可考虑配置化
+ // TODO log failure directly to output log, consider to be configurable in the future
log.error(ex.getMessage());
}
return result;
@@ -234,7 +232,7 @@ final class JobEventRdbStorage {
if (isDuplicateRecord(ex)) {
return updateJobExecutionEventWhenSuccess(jobExecutionEvent);
}
- // TODO 记录失败直接输出日志,未来可考虑配置化
+ // TODO log failure directly to output log, consider to be configurable in the future
log.error(ex.getMessage());
}
return result;
@@ -255,7 +253,7 @@ final class JobEventRdbStorage {
}
result = true;
} catch (final SQLException ex) {
- // TODO 记录失败直接输出日志,未来可考虑配置化
+ // TODO log failure directly to output log, consider to be configurable in the future
log.error(ex.getMessage());
}
return result;
@@ -284,7 +282,7 @@ final class JobEventRdbStorage {
if (isDuplicateRecord(ex)) {
return updateJobExecutionEventFailure(jobExecutionEvent);
}
- // TODO 记录失败直接输出日志,未来可考虑配置化
+ // TODO log failure directly to output log, consider to be configurable in the future
log.error(ex.getMessage());
}
return result;
@@ -315,7 +313,7 @@ final class JobEventRdbStorage {
preparedStatement.execute();
result = true;
} catch (final SQLException ex) {
- // TODO 记录失败直接输出日志,未来可考虑配置化
+ // TODO log failure directly to output log, consider to be configurable in the future
log.error(ex.getMessage());
}
return result;
@@ -333,7 +331,7 @@ final class JobEventRdbStorage {
return resultSet.getString("original_task_id");
}
} catch (final SQLException ex) {
- // TODO 记录失败直接输出日志,未来可考虑配置化
+ // TODO log failure directly to output log, consider to be configurable in the future
log.error(ex.getMessage());
}
return result;
@@ -358,7 +356,7 @@ final class JobEventRdbStorage {
result.add(jobStatusTraceEvent);
}
} catch (final SQLException | ParseException ex) {
- // TODO 记录失败直接输出日志,未来可考虑配置化
+ // TODO log failure directly to output log, consider to be configurable in the future
log.error(ex.getMessage());
}
return result;
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/type/JobExecutionEvent.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/type/JobExecutionEvent.java
index dbb11f1..931c656 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/type/JobExecutionEvent.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/type/JobExecutionEvent.java
@@ -29,9 +29,7 @@ import java.util.Date;
import java.util.UUID;
/**
- * 作业执行事件.
- *
- * @author zhangliang
+ * Job execution event.
*/
@RequiredArgsConstructor
@AllArgsConstructor
@@ -62,11 +60,11 @@ public final class JobExecutionEvent implements JobEvent {
@Setter
private JobExecutionEventThrowable failureCause;
-
+
/**
- * 作业执行成功.
- *
- * @return 作业执行事件
+ * Execution success.
+ *
+ * @return job execution event
*/
public JobExecutionEvent executionSuccess() {
JobExecutionEvent result = new JobExecutionEvent(id, hostname, ip, taskId, jobName, source, shardingItem, startTime, completeTime, success, failureCause);
@@ -74,12 +72,12 @@ public final class JobExecutionEvent implements JobEvent {
result.setSuccess(true);
return result;
}
-
+
/**
- * 作业执行失败.
- *
- * @param failureCause 失败原因
- * @return 作业执行事件
+ * execution failure.
+ *
+ * @param failureCause failure cause
+ * @return job execution event
*/
public JobExecutionEvent executionFailure(final Throwable failureCause) {
JobExecutionEvent result = new JobExecutionEvent(id, hostname, ip, taskId, jobName, source, shardingItem, startTime, completeTime, success, new JobExecutionEventThrowable(failureCause));
@@ -87,18 +85,18 @@ public final class JobExecutionEvent implements JobEvent {
result.setSuccess(false);
return result;
}
-
+
/**
- * 获取失败原因.
- *
- * @return 失败原因
+ * Get failure cause.
+ *
+ * @return failure cause
*/
public String getFailureCause() {
return ExceptionUtil.transform(failureCause == null ? null : failureCause.getThrowable());
}
-
+
/**
- * 执行来源.
+ * Execution source.
*/
public enum ExecutionSource {
NORMAL_TRIGGER, MISFIRE, FAILOVER
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/type/JobExecutionEventThrowable.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/type/JobExecutionEventThrowable.java
index 4adff2e..a0d0a17 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/type/JobExecutionEventThrowable.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/type/JobExecutionEventThrowable.java
@@ -23,9 +23,7 @@ import lombok.RequiredArgsConstructor;
import lombok.ToString;
/**
- * 作业执行事件Throwable.
- *
- * @author liguangyun
+ * Job execution event throwable.
*/
@RequiredArgsConstructor
@AllArgsConstructor
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/type/JobStatusTraceEvent.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/type/JobStatusTraceEvent.java
index 4049fbc..70f1229 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/type/JobStatusTraceEvent.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/event/type/JobStatusTraceEvent.java
@@ -28,9 +28,7 @@ import java.util.Date;
import java.util.UUID;
/**
- * 作业状态痕迹事件.
- *
- * @author caohao
+ * Job status trace event.
*/
@RequiredArgsConstructor
@AllArgsConstructor
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/exception/AppConfigurationException.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/exception/AppConfigurationException.java
index 60e935e..1e6c661 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/exception/AppConfigurationException.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/exception/AppConfigurationException.java
@@ -18,9 +18,7 @@
package org.apache.shardingsphere.elasticjob.cloud.exception;
/**
- * 作业App配置异常.
- *
- * @author caohao
+ * Application configuration exception.
*/
public final class AppConfigurationException extends RuntimeException {
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/exception/ExceptionUtil.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/exception/ExceptionUtil.java
index 5692165..ec6a710 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/exception/ExceptionUtil.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/exception/ExceptionUtil.java
@@ -24,18 +24,16 @@ import java.io.PrintWriter;
import java.io.StringWriter;
/**
- * 异常处理工具类.
- *
- * @author caohao
+ * Exception utility.
*/
@NoArgsConstructor(access = AccessLevel.PRIVATE)
public final class ExceptionUtil {
-
+
/**
- * 将Throwable异常转换为字符串.
+ * Transform throwable to string.
*
- * @param cause 需要转换的异常
- * @return 转换后的异常字符串
+ * @param cause cause
+ * @return string
*/
public static String transform(final Throwable cause) {
if (null == cause) {
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/exception/JobConfigurationException.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/exception/JobConfigurationException.java
index 836a707..e82e205 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/exception/JobConfigurationException.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/exception/JobConfigurationException.java
@@ -18,9 +18,7 @@
package org.apache.shardingsphere.elasticjob.cloud.exception;
/**
- * 作业配置异常.
- *
- * @author zhangliang
+ * Job configuration exception.
*/
public final class JobConfigurationException extends RuntimeException {
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/exception/JobExecutionEnvironmentException.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/exception/JobExecutionEnvironmentException.java
index a149162..f29c232 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/exception/JobExecutionEnvironmentException.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/exception/JobExecutionEnvironmentException.java
@@ -18,9 +18,7 @@
package org.apache.shardingsphere.elasticjob.cloud.exception;
/**
- * 作业执行环境异常.
- *
- * @author zhangliang
+ * Job execution environment exception.
*/
public final class JobExecutionEnvironmentException extends Exception {
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/exception/JobStatisticException.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/exception/JobStatisticException.java
index 0f8e6c2..9bfcd18 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/exception/JobStatisticException.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/exception/JobStatisticException.java
@@ -18,9 +18,7 @@
package org.apache.shardingsphere.elasticjob.cloud.exception;
/**
- * 作业统计异常.
- *
- * @author liguangyun
+ * Job statistic exception.
*/
public final class JobStatisticException extends RuntimeException {
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/exception/JobSystemException.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/exception/JobSystemException.java
index 3cb073a..b52ff05 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/exception/JobSystemException.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/exception/JobSystemException.java
@@ -18,9 +18,7 @@
package org.apache.shardingsphere.elasticjob.cloud.exception;
/**
- * 作业系统异常.
- *
- * @author zhangliang
+ * Job system exception.
*/
public final class JobSystemException extends RuntimeException {
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/AbstractElasticJobExecutor.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/AbstractElasticJobExecutor.java
index 6e532ca..8e0d2a3 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/AbstractElasticJobExecutor.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/AbstractElasticJobExecutor.java
@@ -39,9 +39,7 @@ import java.util.concurrent.CountDownLatch;
import java.util.concurrent.ExecutorService;
/**
- * 弹性化分布式作业执行器.
- *
- * @author zhangliang
+ * ElasticJob executor.
*/
@Slf4j
public abstract class AbstractElasticJobExecutor {
@@ -90,9 +88,9 @@ public abstract class AbstractElasticJobExecutor {
throw new JobSystemException(e);
}
}
-
+
/**
- * 执行作业.
+ * Execute job.
*/
public final void execute() {
try {
@@ -149,7 +147,7 @@ public abstract class AbstractElasticJobExecutor {
try {
process(shardingContexts, executionSource);
} finally {
- // TODO 考虑增加作业失败的状态，并且考虑如何处理作业失败的整体回路
+ // TODO Consider increasing the status of job failure, and how to handle the overall loop of job failure
jobFacade.registerJobCompleted(shardingContexts);
if (itemErrorMessages.isEmpty()) {
if (shardingContexts.isAllowSendJobEvent()) {
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/JobExecutorFactory.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/JobExecutorFactory.java
index 063bac8..2ed1aa7 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/JobExecutorFactory.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/JobExecutorFactory.java
@@ -28,19 +28,17 @@ import lombok.AccessLevel;
import lombok.NoArgsConstructor;
/**
- * 作业执行器工厂.
- *
- * @author zhangliang
+ * Job executor factory.
*/
@NoArgsConstructor(access = AccessLevel.PRIVATE)
public final class JobExecutorFactory {
-
+
/**
- * 获取作业执行器.
+ * Get job executor.
*
- * @param elasticJob 分布式弹性作业
- * @param jobFacade 作业内部服务门面服务
- * @return 作业执行器
+ * @param elasticJob elasticJob object
+ * @param jobFacade job facade
+ * @return job executor
*/
@SuppressWarnings("unchecked")
public static AbstractElasticJobExecutor getJobExecutor(final ElasticJob elasticJob, final JobFacade jobFacade) {
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/JobFacade.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/JobFacade.java
index cfa3924..8f00324 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/JobFacade.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/JobFacade.java
@@ -19,124 +19,126 @@ package org.apache.shardingsphere.elasticjob.cloud.executor;
import org.apache.shardingsphere.elasticjob.cloud.config.JobRootConfiguration;
import org.apache.shardingsphere.elasticjob.cloud.event.type.JobExecutionEvent;
-import org.apache.shardingsphere.elasticjob.cloud.event.type.JobStatusTraceEvent;
+import org.apache.shardingsphere.elasticjob.cloud.event.type.JobStatusTraceEvent.State;
import org.apache.shardingsphere.elasticjob.cloud.exception.JobExecutionEnvironmentException;
import java.util.Collection;
/**
- * 作业内部服务门面服务.
- *
- * @author zhangliang
+ * Job facade.
*/
public interface JobFacade {
-
+
/**
- * 读取作业配置.
- *
- * @param fromCache 是否从缓存中读取
- * @return 作业配置
+ * Load job root configuration.
+ *
+ * @param fromCache load from cache or not
+ * @return job root configuration
*/
JobRootConfiguration loadJobRootConfiguration(boolean fromCache);
-
+
/**
- * 检查作业执行环境.
- *
- * @throws JobExecutionEnvironmentException 作业执行环境异常
+ * check job execution environment.
+ *
+ * @throws JobExecutionEnvironmentException job execution environment exception
*/
void checkJobExecutionEnvironment() throws JobExecutionEnvironmentException;
-
+
/**
- * 如果需要失效转移, 则执行作业失效转移.
+ * Failover If necessary.
*/
void failoverIfNecessary();
-
+
/**
- * 注册作业启动信息.
+ * Register job begin.
*
- * @param shardingContexts 分片上下文
+ * @param shardingContexts sharding contexts
*/
void registerJobBegin(ShardingContexts shardingContexts);
-
+
/**
- * 注册作业完成信息.
+ * Register job completed.
*
- * @param shardingContexts 分片上下文
+ * @param shardingContexts sharding contexts
*/
void registerJobCompleted(ShardingContexts shardingContexts);
-
+
/**
- * 获取当前作业服务器的分片上下文.
+ * Get sharding contexts.
*
- * @return 分片上下文
+ * @return sharding contexts
*/
ShardingContexts getShardingContexts();
-
+
/**
- * 设置任务被错过执行的标记.
+ * Set task misfire flag.
*
- * @param shardingItems 需要设置错过执行的任务分片项
- * @return 是否满足misfire条件
+ * @param shardingItems sharding items to be set misfire flag
+ * @return whether satisfy misfire condition
*/
boolean misfireIfRunning(Collection<Integer> shardingItems);
-
+
/**
- * 清除任务被错过执行的标记.
+ * Clear misfire flag.
*
- * @param shardingItems 需要清除错过执行的任务分片项
+ * @param shardingItems sharding items to be cleared misfire flag
*/
void clearMisfire(Collection<Integer> shardingItems);
-
+
/**
- * 判断作业是否需要执行错过的任务.
- *
- * @param shardingItems 任务分片项集合
- * @return 作业是否需要执行错过的任务
+ * Judge job whether need to execute misfire tasks.
+ *
+ * @param shardingItems sharding items
+ * @return whether need to execute misfire tasks
*/
boolean isExecuteMisfired(Collection<Integer> shardingItems);
-
+
/**
- * 判断作业是否符合继续运行的条件.
- *
- * <p>如果作业停止或需要重分片或非流式处理则作业将不会继续运行.</p>
- *
- * @return 作业是否符合继续运行的条件
+ * Judge job whether eligible running.
+ *
+ * <p>The ineligible job includes:
+ * 1. Need to shutdown;
+ * 2. Need to resharding;
+ * 3. Not stream job.
+ *
+ * @return job is eligible running or not
*/
boolean isEligibleForJobRunning();
-
- /**判断是否需要重分片.
+
+ /**
+ * Judge job whether need resharding.
*
- * @return 是否需要重分片
+ * @return whether need resharding
*/
boolean isNeedSharding();
-
+
/**
- * 作业执行前的执行的方法.
+ * Call before job executed.
*
- * @param shardingContexts 分片上下文
+ * @param shardingContexts sharding contexts
*/
void beforeJobExecuted(ShardingContexts shardingContexts);
-
+
/**
- * 作业执行后的执行的方法.
+ * Call after job executed.
*
- * @param shardingContexts 分片上下文
+ * @param shardingContexts sharding contexts
*/
void afterJobExecuted(ShardingContexts shardingContexts);
-
+
/**
- * 发布执行事件.
+ * Post job execution event.
*
- * @param jobExecutionEvent 作业执行事件
+ * @param jobExecutionEvent job execution event
*/
void postJobExecutionEvent(JobExecutionEvent jobExecutionEvent);
-
+
/**
- * 发布作业状态追踪事件.
+ * Post job status trace event.
*
- * @param taskId 作业Id
- * @param state 作业执行状态
- * @param message 作业执行消息
+ * @param taskId task Id
+ * @param state job state
+ * @param message job message
*/
- void postJobStatusTraceEvent(String taskId, JobStatusTraceEvent.State state, String message);
+ void postJobStatusTraceEvent(String taskId, State state, String message);
}
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/ShardingContexts.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/ShardingContexts.java
index 942fb18..48be43f 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/ShardingContexts.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/ShardingContexts.java
@@ -26,9 +26,7 @@ import java.io.Serializable;
import java.util.Map;
/**
- * 分片上下文集合.
- *
- * @author zhangliang
+ * Sharding contexts.
*/
@RequiredArgsConstructor
@Getter
@@ -38,44 +36,44 @@ public final class ShardingContexts implements Serializable {
private static final long serialVersionUID = -4585977349142082152L;
/**
- * 作业任务ID.
+ * task ID.
*/
private final String taskId;
/**
- * 作业名称.
+ * job name.
*/
private final String jobName;
-
+
/**
- * 分片总数.
+ * sharding total count.
*/
private final int shardingTotalCount;
-
+
/**
- * 作业自定义参数.
- * 可以配置多个相同的作业, 但是用不同的参数作为不同的调度实例.
+ * Job parameter.
+ * Can configure multiple identical jobs, but use different parameters as different scheduling instances
*/
private final String jobParameter;
-
+
/**
- * 分配于本作业实例的分片项和参数的Map.
+ * Sharding items and parameters map.
*/
private final Map<Integer, String> shardingItemParameters;
-
+
/**
- * 作业事件采样统计数.
+ * Job event sampling count.
*/
private int jobEventSamplingCount;
-
+
/**
- * 当前作业事件采样统计数.
+ * Current job event sampling count.
*/
@Setter
private int currentJobEventSamplingCount;
/**
- * 是否允许可以发送作业事件.
+ * Whether allow send job event.
*/
@Setter
private boolean allowSendJobEvent = true;
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/handler/ExecutorServiceHandler.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/handler/ExecutorServiceHandler.java
index ad2604e..0018d36 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/handler/ExecutorServiceHandler.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/handler/ExecutorServiceHandler.java
@@ -20,20 +20,16 @@ package org.apache.shardingsphere.elasticjob.cloud.executor.handler;
import java.util.concurrent.ExecutorService;
/**
- * 线程池服务处理器.
- *
- * <p>用于作业内部的线程池处理使用.</p>
- *
- * @author zhangliang
+ * Executor service handler.
*/
public interface ExecutorServiceHandler {
-
+
/**
- * 创建线程池服务对象.
- *
- * @param jobName 作业名
- *
- * @return 线程池服务对象
+ * Create executor service.
+ *
+ * @param jobName job name
+ *
+ * @return executor service
*/
ExecutorService createExecutorService(String jobName);
}
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/handler/ExecutorServiceHandlerRegistry.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/handler/ExecutorServiceHandlerRegistry.java
index 4e35e3e..e36dd94 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/handler/ExecutorServiceHandlerRegistry.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/handler/ExecutorServiceHandlerRegistry.java
@@ -25,21 +25,19 @@ import java.util.Map;
import java.util.concurrent.ExecutorService;
/**
- * 线程池服务处理器注册表.
- *
- * @author zhangliang
+ * Executor service handler registry.
*/
@NoArgsConstructor(access = AccessLevel.PRIVATE)
public final class ExecutorServiceHandlerRegistry {
private static final Map<String, ExecutorService> REGISTRY = new HashMap<>();
-
+
/**
- * 获取线程池服务.
- *
- * @param jobName 作业名称
- * @param executorServiceHandler 线程池服务处理器
- * @return 线程池服务
+ * Get executor service handler.
+ *
+ * @param jobName job name
+ * @param executorServiceHandler executor service handler
+ * @return executor service
*/
public static synchronized ExecutorService getExecutorServiceHandler(final String jobName, final ExecutorServiceHandler executorServiceHandler) {
if (!REGISTRY.containsKey(jobName)) {
@@ -47,11 +45,11 @@ public final class ExecutorServiceHandlerRegistry {
}
return REGISTRY.get(jobName);
}
-
+
/**
- * 从注册表中删除该作业线程池服务.
+ * Remove executor service from executor service handler registry.
*
- * @param jobName 作业名称
+ * @param jobName job name
*/
public static synchronized void remove(final String jobName) {
REGISTRY.remove(jobName);
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/handler/JobExceptionHandler.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/handler/JobExceptionHandler.java
index f101059..51ede85 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/handler/JobExceptionHandler.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/handler/JobExceptionHandler.java
@@ -18,17 +18,15 @@
package org.apache.shardingsphere.elasticjob.cloud.executor.handler;
/**
- * 作业异常处理器.
- *
- * @author zhangliang
+ * Job exception handler.
*/
public interface JobExceptionHandler {
-
+
/**
- * 处理作业异常.
- *
- * @param jobName 作业名称
- * @param cause 异常原因
+ * Handle exception.
+ *
+ * @param jobName job name
+ * @param cause cause
*/
void handleException(String jobName, Throwable cause);
}
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/handler/JobProperties.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/handler/JobProperties.java
index a2505ae..2fbf548 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/handler/JobProperties.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/handler/JobProperties.java
@@ -30,21 +30,19 @@ import java.util.LinkedHashMap;
import java.util.Map;
/**
- * 作业属性配置.
- *
- * @author zhangliang
+ * Job properties.
*/
@AllArgsConstructor
@NoArgsConstructor
public final class JobProperties {
private EnumMap<JobPropertiesEnum, String> map = new EnumMap<>(JobPropertiesEnum.class);
-
+
/**
- * 设置作业属性.
- *
- * @param key 属性键
- * @param value 属性值
+ * Put job property.
+ *
+ * @param key property key
+ * @param value property value
*/
public void put(final String key, final String value) {
JobPropertiesEnum jobPropertiesEnum = JobPropertiesEnum.from(key);
@@ -53,21 +51,21 @@ public final class JobProperties {
}
map.put(jobPropertiesEnum, value);
}
-
+
/**
- * 获取作业属性.
- *
- * @param jobPropertiesEnum 作业属性枚举
- * @return 属性值
+ * Get job property.
+ *
+ * @param jobPropertiesEnum job properties enum
+ * @return property value
*/
public String get(final JobPropertiesEnum jobPropertiesEnum) {
return map.containsKey(jobPropertiesEnum) ? map.get(jobPropertiesEnum) : jobPropertiesEnum.getDefaultValue();
}
-
+
/**
- * 获取所有键.
- *
- * @return 键集合
+ * Get all keys.
+ *
+ * @return all keys
*/
public String json() {
Map<String, String> jsonMap = new LinkedHashMap<>(JobPropertiesEnum.values().length, 1);
@@ -76,21 +74,21 @@ public final class JobProperties {
}
return GsonFactory.getGson().toJson(jsonMap);
}
-
+
/**
- * 作业属性枚举.
+ * Job properties enum.
*/
@RequiredArgsConstructor
@Getter
public enum JobPropertiesEnum {
-
+
/**
- * 作业异常处理器.
+ * Job execution handler.
*/
JOB_EXCEPTION_HANDLER("job_exception_handler", JobExceptionHandler.class, DefaultJobExceptionHandler.class.getCanonicalName()),
-
+
/**
- * 线程池服务处理器.
+ * Executor service handler.
*/
EXECUTOR_SERVICE_HANDLER("executor_service_handler", ExecutorServiceHandler.class, DefaultExecutorServiceHandler.class.getCanonicalName());
@@ -99,12 +97,12 @@ public final class JobProperties {
private final Class<?> classType;
private final String defaultValue;
-
+
/**
- * 通过属性键获取枚举.
- *
- * @param key 属性键
- * @return 枚举
+ * Get job properties enum via key.
+ *
+ * @param key property key
+ * @return job properties enum
*/
public static JobPropertiesEnum from(final String key) {
for (JobPropertiesEnum each : JobPropertiesEnum.values()) {
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/handler/impl/DefaultExecutorServiceHandler.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/handler/impl/DefaultExecutorServiceHandler.java
index b384a94..e9f6eac 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/handler/impl/DefaultExecutorServiceHandler.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/handler/impl/DefaultExecutorServiceHandler.java
@@ -23,9 +23,7 @@ import org.apache.shardingsphere.elasticjob.cloud.executor.handler.ExecutorServi
import java.util.concurrent.ExecutorService;
/**
- * 默认线程池服务处理器.
- *
- * @author zhangliang
+ * Default executor service handler.
*/
public final class DefaultExecutorServiceHandler implements ExecutorServiceHandler {
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/handler/impl/DefaultJobExceptionHandler.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/handler/impl/DefaultJobExceptionHandler.java
index ea4233f..6402bf7 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/handler/impl/DefaultJobExceptionHandler.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/handler/impl/DefaultJobExceptionHandler.java
@@ -21,9 +21,7 @@ import org.apache.shardingsphere.elasticjob.cloud.executor.handler.JobExceptionH
import lombok.extern.slf4j.Slf4j;
/**
- * 默认作业异常处理器.
- *
- * @author zhangliang
+ * Default job exception handler.
*/
@Slf4j
public final class DefaultJobExceptionHandler implements JobExceptionHandler {
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/type/DataflowJobExecutor.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/type/DataflowJobExecutor.java
index db03930..83a33d3 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/type/DataflowJobExecutor.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/type/DataflowJobExecutor.java
@@ -26,9 +26,7 @@ import org.apache.shardingsphere.elasticjob.cloud.executor.JobFacade;
import java.util.List;
/**
- * 数据流作业执行器.
- *
- * @author zhangliang
+ * Dataflow job executor.
*/
public final class DataflowJobExecutor extends AbstractElasticJobExecutor {
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/type/ScriptJobExecutor.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/type/ScriptJobExecutor.java
index 63291a3..87b9a20 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/type/ScriptJobExecutor.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/type/ScriptJobExecutor.java
@@ -30,10 +30,7 @@ import org.apache.commons.exec.DefaultExecutor;
import java.io.IOException;
/**
- * 脚本作业执行器.
- *
- * @author zhangliang
- * @author caohao
+ * Script job executor.
*/
public final class ScriptJobExecutor extends AbstractElasticJobExecutor {
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/type/SimpleJobExecutor.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/type/SimpleJobExecutor.java
index 22473fe..90f5208 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/type/SimpleJobExecutor.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/executor/type/SimpleJobExecutor.java
@@ -23,9 +23,7 @@ import org.apache.shardingsphere.elasticjob.cloud.executor.AbstractElasticJobExe
import org.apache.shardingsphere.elasticjob.cloud.executor.JobFacade;
/**
- * 简单作业执行器.
- *
- * @author zhangliang
+ * Simple job executor.
*/
public final class SimpleJobExecutor extends AbstractElasticJobExecutor {
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/reg/base/CoordinatorRegistryCenter.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/reg/base/CoordinatorRegistryCenter.java
index af8e7b6..8d9025a 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/reg/base/CoordinatorRegistryCenter.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/reg/base/CoordinatorRegistryCenter.java
@@ -20,79 +20,77 @@ package org.apache.shardingsphere.elasticjob.cloud.reg.base;
import java.util.List;
/**
- * 用于协调分布式服务的注册中心.
- *
- * @author zhangliang
+ * Coordinator registry center.
*/
public interface CoordinatorRegistryCenter extends RegistryCenter {
-
+
/**
- * 直接从注册中心而非本地缓存获取数据.
- *
- * @param key 键
- * @return 值
+ * Get value from registry center directly.
+ *
+ * @param key key
+ * @return value
*/
String getDirectly(String key);
-
+
/**
- * 获取子节点名称集合.
- *
- * @param key 键
- * @return 子节点名称集合
+ * Get children keys.
+ *
+ * @param key key
+ * @return children keys
*/
List<String> getChildrenKeys(String key);
-
+
/**
- * 获取子节点数量.
+ * Get children number.
*
- * @param key 键
- * @return 子节点数量
+ * @param key key
+ * @return children number
*/
int getNumChildren(String key);
-
+
/**
- * 持久化临时注册数据.
- *
- * @param key 键
- * @param value 值
+ * Persist ephemeral data.
+ *
+ * @param key key
+ * @param value value
*/
void persistEphemeral(String key, String value);
-
+
/**
- * 持久化顺序注册数据.
+ * Persist sequential data.
*
- * @param key 键
- * @param value 值
- * @return 包含10位顺序数字的znode名称
+ * @param key key
+ * @param value value
+ * @return value which include 10 digital
*/
String persistSequential(String key, String value);
-
+
/**
- * 持久化临时顺序注册数据.
- *
- * @param key 键
+ * Persist ephemeral sequential data.
+ *
+ * @param key key
*/
void persistEphemeralSequential(String key);
-
+
/**
- * 添加本地缓存.
- *
- * @param cachePath 需加入缓存的路径
+ * Add data to cache.
+ *
+ * @param cachePath cache path
*/
void addCacheData(String cachePath);
-
+
/**
- * 释放本地缓存.
+ * Evict data from cache.
*
- * @param cachePath 需释放缓存的路径
+ * @param cachePath cache path
*/
void evictCacheData(String cachePath);
-
+
/**
- * 获取注册中心数据缓存对象.
- *
- * @param cachePath 缓存的节点路径
- * @return 注册中心数据缓存对象
+ * Get raw cache object of registry center.
+ *
+ * @param cachePath cache path
+ * @return raw cache object of registry center
*/
Object getRawCache(String cachePath);
}
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/reg/base/ElectionCandidate.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/reg/base/ElectionCandidate.java
index 04c8189..bae16b3 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/reg/base/ElectionCandidate.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/reg/base/ElectionCandidate.java
@@ -18,23 +18,25 @@
package org.apache.shardingsphere.elasticjob.cloud.reg.base;
/**
- * 选举候选人.
- * 保证{@link #startLeadership()}与{@link #stopLeadership()}方法在同一个线程内交替运行,
- * 且不会出现并发执行的情况.
- *
- * @author gaohongtao
+ * Election candidate.
+ *
+ * <p>
+ * Guarantee {@link #startLeadership()} and {@link #stopLeadership()} method run in same thread.
+ * </p>
*/
public interface ElectionCandidate {
-
+
/**
- * 开始领导状态.
- * @throws Exception 抛出的异常
+ * Start leadership.
+ *
+ * @throws Exception exception
*/
void startLeadership() throws Exception;
-
+
/**
- * 终止领导状态.
- * 实现该方法时不应该抛出任何异常
+ * Stop leadership.
+ *
+ * <p>Should not throw any exception for the implementation class.</p>
*/
void stopLeadership();
}
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/reg/base/RegistryCenter.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/reg/base/RegistryCenter.java
index a96d0bf..1f95c8b 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/reg/base/RegistryCenter.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/reg/base/RegistryCenter.java
@@ -18,74 +18,71 @@
package org.apache.shardingsphere.elasticjob.cloud.reg.base;
/**
- * 注册中心.
- *
- * @author zhangliang
+ * Registry center.
*/
public interface RegistryCenter {
-
+
/**
- * 初始化注册中心.
+ * Initialize registry center.
*/
void init();
-
+
/**
- * 关闭注册中心.
+ * Close registry center.
*/
void close();
-
+
/**
- * 获取注册数据.
- *
- * @param key 键
- * @return 值
+ * Get value.
+ *
+ * @param key key
+ * @return value
*/
String get(String key);
-
+
/**
- * 获取数据是否存在.
- *
- * @param key 键
- * @return 数据是否存在
+ * Judge node is exist or not.
+ *
+ * @param key key
+ * @return node is exist or not
*/
boolean isExisted(String key);
-
+
/**
- * 持久化注册数据.
- *
- * @param key 键
- * @param value 值
+ * Persist data.
+ *
+ * @param key key
+ * @param value value
*/
void persist(String key, String value);
-
+
/**
- * 更新注册数据.
- *
- * @param key 键
- * @param value 值
+ * Update data.
+ *
+ * @param key key
+ * @param value value
*/
void update(String key, String value);
-
+
/**
- * 删除注册数据.
- *
- * @param key 键
+ * Remove data.
+ *
+ * @param key key
*/
void remove(String key);
-
+
/**
- * 获取注册中心当前时间.
- *
- * @param key 用于获取时间的键
- * @return 注册中心当前时间
+ * Get current time from registry center.
+ *
+ * @param key key
+ * @return current time from registry center
*/
long getRegistryCenterTime(String key);
-
+
/**
- * 直接获取操作注册中心的原生客户端.
- * 如：Zookeeper或Redis等原生客户端.
- *
- * @return 注册中心的原生客户端
+ * Get raw client for registry center client.
+ **
+ * @return registry center raw client
*/
Object getRawClient();
}
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/reg/exception/RegException.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/reg/exception/RegException.java
index bd2ca0f..381a87e 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/reg/exception/RegException.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/reg/exception/RegException.java
@@ -18,9 +18,7 @@
package org.apache.shardingsphere.elasticjob.cloud.reg.exception;
/**
- * 注册中心异常.
- *
- * @author zhangliang
+ * Registry center exception.
*/
public final class RegException extends RuntimeException {
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/reg/exception/RegExceptionHandler.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/reg/exception/RegExceptionHandler.java
index 39e1131..63ad3f6 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/reg/exception/RegExceptionHandler.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/reg/exception/RegExceptionHandler.java
@@ -25,20 +25,16 @@ import org.apache.zookeeper.KeeperException.NoNodeException;
import org.apache.zookeeper.KeeperException.NodeExistsException;
/**
- * 注册中心异常处理类.
- *
- * @author zhangliang
+ * Registry center exception handler.
*/
@Slf4j
@NoArgsConstructor(access = AccessLevel.PRIVATE)
public final class RegExceptionHandler {
-
+
/**
- * 处理异常.
- *
- * <p>处理掉中断和连接失效异常并继续抛注册中心.</p>
- *
- * @param cause 待处理异常.
+ * Handle exception.
+ *
+ * @param cause exception to be handled
*/
public static void handleException(final Exception cause) {
if (null == cause) {
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/reg/zookeeper/ZookeeperConfiguration.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/reg/zookeeper/ZookeeperConfiguration.java
index 8719396..73b69a2 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/reg/zookeeper/ZookeeperConfiguration.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/reg/zookeeper/ZookeeperConfiguration.java
@@ -22,61 +22,56 @@ import lombok.RequiredArgsConstructor;
import lombok.Setter;
/**
- * 基于Zookeeper的注册中心配置.
- *
- * @author zhangliang
- * @author caohao
+ * Zookeeper configuration.
*/
@Getter
@Setter
@RequiredArgsConstructor
public final class ZookeeperConfiguration {
-
+
/**
- * 连接Zookeeper服务器的列表.
- * 包括IP地址和端口号.
- * 多个地址用逗号分隔.
- * 如: host1:2181,host2:2181
+ * Server list of ZooKeeper.
+ *
+ * <p>
+ * Include IP addresses and ports,
+ * Multiple IP address split by comma.
+ * For example: host1:2181,host2:2181
+ * </p>
*/
private final String serverLists;
-
+
/**
- * 命名空间.
+ * Namespace.
*/
private final String namespace;
-
+
/**
- * 等待重试的间隔时间的初始值.
- * 单位毫秒.
+ * Base sleep time milliseconds.
*/
private int baseSleepTimeMilliseconds = 1000;
-
+
/**
- * 等待重试的间隔时间的最大值.
- * 单位毫秒.
+ * Max sleep time milliseconds.
*/
private int maxSleepTimeMilliseconds = 3000;
-
+
/**
- * 最大重试次数.
+ * Max retry times.
*/
private int maxRetries = 3;
-
+
/**
- * 会话超时时间.
- * 单位毫秒.
+ * Session timeout milliseconds.
*/
private int sessionTimeoutMilliseconds;
-
+
/**
- * 连接超时时间.
- * 单位毫秒.
+ * Connection timeout milliseconds.
*/
private int connectionTimeoutMilliseconds;
-
+
/**
- * 连接Zookeeper的权限令牌.
- * 缺省为不需要权限验证.
+ * Zookeeper digest.
*/
private String digest;
}
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/reg/zookeeper/ZookeeperElectionService.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/reg/zookeeper/ZookeeperElectionService.java
index a1b3209..6935713 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/reg/zookeeper/ZookeeperElectionService.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/reg/zookeeper/ZookeeperElectionService.java
@@ -27,10 +27,7 @@ import org.apache.curator.framework.recipes.leader.LeaderSelectorListenerAdapter
import java.util.concurrent.CountDownLatch;
/**
- * 使用{@link LeaderSelector}实现选举服务.
- *
- * @author gaohongtao
- * @author caohao
+ * Use {@link LeaderSelector} to implement election service.
*/
@Slf4j
public final class ZookeeperElectionService {
@@ -59,17 +56,17 @@ public final class ZookeeperElectionService {
leaderSelector.autoRequeue();
leaderSelector.setId(identity);
}
-
+
/**
- * 开始选举.
+ * Start election.
*/
public void start() {
log.debug("Elastic job: {} start to elect leadership", leaderSelector.getId());
leaderSelector.start();
}
-
+
/**
- * 停止选举.
+ * Stop election.
*/
public void stop() {
log.info("Elastic job: stop leadership election");
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/reg/zookeeper/ZookeeperRegistryCenter.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/reg/zookeeper/ZookeeperRegistryCenter.java
index a3876d0..2a3caaf 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/reg/zookeeper/ZookeeperRegistryCenter.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/reg/zookeeper/ZookeeperRegistryCenter.java
@@ -47,9 +47,7 @@ import java.util.Map.Entry;
import java.util.concurrent.TimeUnit;
/**
- * 基于Zookeeper的注册中心.
- *
- * @author zhangliang
+ * Registry center of ZooKeeper.
*/
@Slf4j
public final class ZookeeperRegistryCenter implements CoordinatorRegistryCenter {
@@ -116,11 +114,11 @@ public final class ZookeeperRegistryCenter implements CoordinatorRegistryCenter
waitForCacheClose();
CloseableUtils.closeQuietly(client);
}
-
- /* TODO 等待500ms, cache先关闭再关闭client, 否则会抛异常
- * 因为异步处理, 可能会导致client先关闭而cache还未关闭结束.
- * 等待Curator新版本解决这个bug.
- * BUG地址：https://issues.apache.org/jira/browse/CURATOR-157
+
+ /*
+ * TODO
+ * sleep 500ms, let cache client close first and then client, otherwise will throw exception
+ * reference：https://issues.apache.org/jira/browse/CURATOR-157
*/
private void waitForCacheClose() {
try {
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/statistics/StatisticInterval.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/statistics/StatisticInterval.java
index 0928d4d..fc9f7e3 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/statistics/StatisticInterval.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/statistics/StatisticInterval.java
@@ -21,9 +21,7 @@ import lombok.Getter;
import lombok.RequiredArgsConstructor;
/**
- * 统计时间间隔.
- *
- * @author liguangyun
+ * Task running statistics.
*/
@Getter
@RequiredArgsConstructor
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/statistics/rdb/StatisticRdbRepository.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/statistics/rdb/StatisticRdbRepository.java
index 5faf16c..46833a1 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/statistics/rdb/StatisticRdbRepository.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/statistics/rdb/StatisticRdbRepository.java
@@ -38,9 +38,7 @@ import java.util.LinkedList;
import java.util.List;
/**
- * 统计信息数据仓库，基于数据库.
- *
- * @author liguangyun
+ * Statistic RDB repository.
*/
@Slf4j
public class StatisticRdbRepository {
@@ -54,13 +52,7 @@ public class StatisticRdbRepository {
private static final String TABLE_JOB_REGISTER_STATISTICS = "JOB_REGISTER_STATISTICS";
private final DataSource dataSource;
-
- /**
- * 构造函数.
- *
- * @param dataSource 数据源
- * @throws SQLException SQL异常
- */
+
public StatisticRdbRepository(final DataSource dataSource) throws SQLException {
this.dataSource = dataSource;
initTables();
@@ -161,12 +153,12 @@ public class StatisticRdbRepository {
preparedStatement.execute();
}
}
-
+
/**
- * 添加任务运行结果统计数据.
- *
- * @param taskResultStatistics 任务运行结果统计数据对象
- * @return 添加操作是否成功
+ * Add task result statistics.
+ *
+ * @param taskResultStatistics task result statistics
+ * @return add success or not
*/
public boolean add(final TaskResultStatistics taskResultStatistics) {
boolean result = false;
@@ -182,17 +174,17 @@ public class StatisticRdbRepository {
preparedStatement.execute();
result = true;
} catch (final SQLException ex) {
- // TODO 记录失败直接输出日志,未来可考虑配置化
+ // TODO log failure directly to output log, consider to be configurable in the future
log.error("Insert taskResultStatistics to DB error:", ex);
}
return result;
}
-
+
/**
- * 添加运行中的任务统计数据.
- *
- * @param taskRunningStatistics 运行中的任务统计数据对象
- * @return 添加操作是否成功
+ * Add task running statistics.
+ *
+ * @param taskRunningStatistics task running statistics
+ * @return add success or not
*/
public boolean add(final TaskRunningStatistics taskRunningStatistics) {
boolean result = false;
@@ -206,17 +198,17 @@ public class StatisticRdbRepository {
preparedStatement.execute();
result = true;
} catch (final SQLException ex) {
- // TODO 记录失败直接输出日志,未来可考虑配置化
+ // TODO log failure directly to output log, consider to be configurable in the future
log.error("Insert taskRunningStatistics to DB error:", ex);
}
return result;
}
-
+
/**
- * 添加运行中的作业统计数据.
- *
- * @param jobRunningStatistics 运行中的作业统计数据对象
- * @return 添加操作是否成功
+ * Add job running statistics.
+ *
+ * @param jobRunningStatistics job running statistics
+ * @return add success or not
*/
public boolean add(final JobRunningStatistics jobRunningStatistics) {
boolean result = false;
@@ -230,17 +222,17 @@ public class StatisticRdbRepository {
preparedStatement.execute();
result = true;
} catch (final SQLException ex) {
- // TODO 记录失败直接输出日志,未来可考虑配置化
+ // TODO log failure directly to output log, consider to be configurable in the future
log.error("Insert jobRunningStatistics to DB error:", ex);
}
return result;
}
-
+
/**
- * 添加作业注册统计数据.
- *
- * @param jobRegisterStatistics 作业注册统计数据对象
- * @return 添加操作是否成功
+ * Add job register statistics.
+ *
+ * @param jobRegisterStatistics job register statistics
+ * @return add success or not
*/
public boolean add(final JobRegisterStatistics jobRegisterStatistics) {
boolean result = false;
@@ -254,18 +246,18 @@ public class StatisticRdbRepository {
preparedStatement.execute();
result = true;
} catch (final SQLException ex) {
- // TODO 记录失败直接输出日志,未来可考虑配置化
+ // TODO log failure directly to output log, consider to be configurable in the future
log.error("Insert jobRegisterStatistics to DB error:", ex);
}
return result;
}
-
+
/**
- * 获取任务运行结果统计数据集合.
- *
- * @param from 统计开始时间
- * @param statisticInterval 统计时间间隔
- * @return 任务运行结果统计数据集合
+ * Find task result statistics.
+ *
+ * @param from from date to statistics
+ * @param statisticInterval statistic interval
+ * @return task result statistics
*/
public List<TaskResultStatistics> findTaskResultStatistics(final Date from, final StatisticInterval statisticInterval) {
List<TaskResultStatistics> result = new LinkedList<>();
@@ -283,18 +275,18 @@ public class StatisticRdbRepository {
result.add(taskResultStatistics);
}
} catch (final SQLException ex) {
- // TODO 记录失败直接输出日志,未来可考虑配置化
+ // TODO log failure directly to output log, consider to be configurable in the future
log.error("Fetch taskResultStatistics from DB error:", ex);
}
return result;
}
-
+
/**
- * 获取合计后的任务运行结果统计数据.
- *
- * @param from 统计开始时间
- * @param statisticInterval 统计时间间隔
- * @return 合计后的任务运行结果统计数据对象
+ * Get summed task result statistics.
+ *
+ * @param from from date to statistics
+ * @param statisticInterval statistic interval
+ * @return summed task result statistics
*/
public TaskResultStatistics getSummedTaskResultStatistics(final Date from, final StatisticInterval statisticInterval) {
TaskResultStatistics result = new TaskResultStatistics(0, 0, statisticInterval, new Date());
@@ -310,17 +302,17 @@ public class StatisticRdbRepository {
result = new TaskResultStatistics(resultSet.getInt(1), resultSet.getInt(2), statisticInterval, new Date());
}
} catch (final SQLException ex) {
- // TODO 记录失败直接输出日志,未来可考虑配置化
+ // TODO log failure directly to output log, consider to be configurable in the future
log.error("Fetch summed taskResultStatistics from DB error:", ex);
}
return result;
}
-
+
/**
- * 获取最近一条任务运行结果统计数据.
- *
- * @param statisticInterval 统计时间间隔
- * @return 任务运行结果统计数据对象
+ * Find latest task result statistics.
+ *
+ * @param statisticInterval statistic interval
+ * @return task result statistics
*/
public Optional<TaskResultStatistics> findLatestTaskResultStatistics(final StatisticInterval statisticInterval) {
TaskResultStatistics result = null;
@@ -336,17 +328,17 @@ public class StatisticRdbRepository {
statisticInterval, new Date(resultSet.getTimestamp(4).getTime()), new Date(resultSet.getTimestamp(5).getTime()));
}
} catch (final SQLException ex) {
- // TODO 记录失败直接输出日志,未来可考虑配置化
+ // TODO log failure directly to output log, consider to be configurable in the future
log.error("Fetch latest taskResultStatistics from DB error:", ex);
}
return Optional.fromNullable(result);
}
-
+
/**
- * 获取运行中的任务统计数据集合.
- *
- * @param from 统计开始时间
- * @return 运行中的任务统计数据集合
+ * Find task running statistics.
+ *
+ * @param from from date to statistics
+ * @return Task running statistics
*/
public List<TaskRunningStatistics> findTaskRunningStatistics(final Date from) {
List<TaskRunningStatistics> result = new LinkedList<>();
@@ -364,17 +356,17 @@ public class StatisticRdbRepository {
result.add(taskRunningStatistics);
}
} catch (final SQLException ex) {
- // TODO 记录失败直接输出日志,未来可考虑配置化
+ // TODO log failure directly to output log, consider to be configurable in the future
log.error("Fetch taskRunningStatistics from DB error:", ex);
}
return result;
}
-
+
/**
- * 获取运行中的任务统计数据集合.
- *
- * @param from 统计开始时间
- * @return 运行中的任务统计数据集合
+ * Find job running statistics.
+ *
+ * @param from from date to statistics
+ * @return job running statistics
*/
public List<JobRunningStatistics> findJobRunningStatistics(final Date from) {
List<JobRunningStatistics> result = new LinkedList<>();
@@ -392,16 +384,16 @@ public class StatisticRdbRepository {
result.add(jobRunningStatistics);
}
} catch (final SQLException ex) {
- // TODO 记录失败直接输出日志,未来可考虑配置化
+ // TODO log failure directly to output log, consider to be configurable in the future
log.error("Fetch jobRunningStatistics from DB error:", ex);
}
return result;
}
-
+
/**
- * 获取最近一条运行中的任务统计数据.
- *
- * @return 运行中的任务统计数据对象
+ * Find latest task running statistics.
+ *
+ * @return latest task running statistics
*/
public Optional<TaskRunningStatistics> findLatestTaskRunningStatistics() {
TaskRunningStatistics result = null;
@@ -417,16 +409,16 @@ public class StatisticRdbRepository {
new Date(resultSet.getTimestamp(3).getTime()), new Date(resultSet.getTimestamp(4).getTime()));
}
} catch (final SQLException ex) {
- // TODO 记录失败直接输出日志,未来可考虑配置化
+ // TODO log failure directly to output log, consider to be configurable in the future
log.error("Fetch latest taskRunningStatistics from DB error:", ex);
}
return Optional.fromNullable(result);
}
-
+
/**
- * 获取最近一条运行中的任务统计数据.
- *
- * @return 运行中的任务统计数据对象
+ * Find latest job running statistics.
+ *
+ * @return job running statistics
*/
public Optional<JobRunningStatistics> findLatestJobRunningStatistics() {
JobRunningStatistics result = null;
@@ -442,17 +434,17 @@ public class StatisticRdbRepository {
new Date(resultSet.getTimestamp(3).getTime()), new Date(resultSet.getTimestamp(4).getTime()));
}
} catch (final SQLException ex) {
- // TODO 记录失败直接输出日志,未来可考虑配置化
+ // TODO log failure directly to output log, consider to be configurable in the future
log.error("Fetch latest jobRunningStatistics from DB error:", ex);
}
return Optional.fromNullable(result);
}
-
+
/**
- * 获取作业注册统计数据集合.
- *
- * @param from 统计开始时间
- * @return 作业注册统计数据集合
+ * Find job register statistics.
+ *
+ * @param from from date to statistics
+ * @return job register statistics
*/
public List<JobRegisterStatistics> findJobRegisterStatistics(final Date from) {
List<JobRegisterStatistics> result = new LinkedList<>();
@@ -470,16 +462,16 @@ public class StatisticRdbRepository {
result.add(jobRegisterStatistics);
}
} catch (final SQLException ex) {
- // TODO 记录失败直接输出日志,未来可考虑配置化
+ // TODO log failure directly to output log, consider to be configurable in the future
log.error("Fetch jobRegisterStatistics from DB error:", ex);
}
return result;
}
-
+
/**
- * 获取最近一条作业注册统计数据.
- *
- * @return 作业注册统计数据对象
+ * Find latest job register statistics.
+ *
+ * @return job register statistics
*/
public Optional<JobRegisterStatistics> findLatestJobRegisterStatistics() {
JobRegisterStatistics result = null;
@@ -495,7 +487,7 @@ public class StatisticRdbRepository {
new Date(resultSet.getTimestamp(3).getTime()), new Date(resultSet.getTimestamp(4).getTime()));
}
} catch (final SQLException ex) {
- // TODO 记录失败直接输出日志,未来可考虑配置化
+ // TODO log failure directly to output log, consider to be configurable in the future
log.error("Fetch latest jobRegisterStatistics from DB error:", ex);
}
return Optional.fromNullable(result);
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/statistics/type/job/JobExecutionTypeStatistics.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/statistics/type/job/JobExecutionTypeStatistics.java
index 8348678..706fe32 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/statistics/type/job/JobExecutionTypeStatistics.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/statistics/type/job/JobExecutionTypeStatistics.java
@@ -21,9 +21,7 @@ import lombok.AllArgsConstructor;
import lombok.Getter;
/**
- * 作业执行类型统计数据.
- *
- * @author liguangyun
+ * Job execution type statistics.
*/
@Getter
@AllArgsConstructor
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/statistics/type/job/JobRegisterStatistics.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/statistics/type/job/JobRegisterStatistics.java
index 0cb6215..bf62a2a 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/statistics/type/job/JobRegisterStatistics.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/statistics/type/job/JobRegisterStatistics.java
@@ -24,9 +24,7 @@ import lombok.RequiredArgsConstructor;
import java.util.Date;
/**
- * 作业注册到Cloud平台统计数据.
- *
- * @author liguangyun
+ * Job register statistics.
*/
@Getter
@RequiredArgsConstructor
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/statistics/type/job/JobRunningStatistics.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/statistics/type/job/JobRunningStatistics.java
index 4f1d224..dc74a66 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/statistics/type/job/JobRunningStatistics.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/statistics/type/job/JobRunningStatistics.java
@@ -24,9 +24,7 @@ import lombok.RequiredArgsConstructor;
import java.util.Date;
/**
- * 运行中的作业统计数据.
- *
- * @author liguangyun
+ * Job running statistics.
*/
@Getter
@RequiredArgsConstructor
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/statistics/type/job/JobTypeStatistics.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/statistics/type/job/JobTypeStatistics.java
index 1cbe4d6..679c0e0 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/statistics/type/job/JobTypeStatistics.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/statistics/type/job/JobTypeStatistics.java
@@ -21,9 +21,7 @@ import lombok.AllArgsConstructor;
import lombok.Getter;
/**
- * 作业类型统计数据.
- *
- * @author liguangyun
+ * Job type statistics.
*/
@Getter
@AllArgsConstructor
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/statistics/type/task/TaskResultStatistics.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/statistics/type/task/TaskResultStatistics.java
index db42b32..fb3045e 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/statistics/type/task/TaskResultStatistics.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/statistics/type/task/TaskResultStatistics.java
@@ -25,9 +25,7 @@ import lombok.RequiredArgsConstructor;
import java.util.Date;
/**
- * 任务运行结果统计数据.
- *
- * @author liguangyun
+ * Task result statistics.
*/
@Getter
@AllArgsConstructor
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/statistics/type/task/TaskRunningStatistics.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/statistics/type/task/TaskRunningStatistics.java
index 02f6aca..b90af6c 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/statistics/type/task/TaskRunningStatistics.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/statistics/type/task/TaskRunningStatistics.java
@@ -24,9 +24,7 @@ import lombok.RequiredArgsConstructor;
import java.util.Date;
/**
- * 运行中的任务统计数据.
- *
- * @author liguangyun
+ * Task running statistics.
*/
@Getter
@RequiredArgsConstructor
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/util/concurrent/ExecutorServiceObject.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/util/concurrent/ExecutorServiceObject.java
index 3e6d90e..c40980b 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/util/concurrent/ExecutorServiceObject.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/util/concurrent/ExecutorServiceObject.java
@@ -28,9 +28,7 @@ import java.util.concurrent.ThreadPoolExecutor;
import java.util.concurrent.TimeUnit;
/**
- * 线程池执行服务对象.
- *
- * @author zhangliang
+ * Executor service object.
*/
public final class ExecutorServiceObject {
@@ -44,37 +42,38 @@ public final class ExecutorServiceObject {
new BasicThreadFactory.Builder().namingPattern(Joiner.on("-").join(namingPattern, "%s")).build());
threadPoolExecutor.allowCoreThreadTimeOut(true);
}
-
+
/**
- * 创建线程池服务对象.
+ * Create executor service.
*
- * @return 线程池服务对象
+ * @return executor service
*/
public ExecutorService createExecutorService() {
return MoreExecutors.listeningDecorator(MoreExecutors.getExitingExecutorService(threadPoolExecutor));
}
/**
- * Check the executor is shutdown.
- * @return if true, the executor is shutdown,otherwise not.
+ * Whether the threadPoolExecutor has been shut down.
+ *
+ * @return Whether the threadPoolExecutor has been shut down
*/
public boolean isShutdown() {
return threadPoolExecutor.isShutdown();
}
-
+
/**
- * 获取当前活跃的线程数.
+ * Get active thread count.
*
- * @return 当前活跃的线程数
+ * @return active thread count
*/
public int getActiveThreadCount() {
return threadPoolExecutor.getActiveCount();
}
-
+
/**
- * 获取待执行任务数量.
+ * Get work queue size.
*
- * @return 待执行任务数量
+ * @return work queue size
*/
public int getWorkQueueSize() {
return workQueue.size();
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/util/config/ShardingItemParameters.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/util/config/ShardingItemParameters.java
index 6f5ba6a..93caf15 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/util/config/ShardingItemParameters.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/util/config/ShardingItemParameters.java
@@ -27,9 +27,7 @@ import java.util.HashMap;
import java.util.Map;
/**
- * 分片序列号个性化参数.
- *
- * @author zhangliang
+ * Sharding item parameters.
*/
@Getter
public final class ShardingItemParameters {
@@ -68,9 +66,9 @@ public final class ShardingItemParameters {
throw new JobConfigurationException("Sharding item parameters key '%s' is not an integer.", pair[0]);
}
}
-
+
/**
- * 分片项.
+ * Sharding item.
*/
@AllArgsConstructor
private static final class ShardingItem {
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/util/config/ShardingItems.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/util/config/ShardingItems.java
index 6e55997..0709968 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/util/config/ShardingItems.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/util/config/ShardingItems.java
@@ -26,20 +26,18 @@ import java.util.Collections;
import java.util.List;
/**
- * 分片项工具类.
- *
- * @author zhangliang
+ * Sharding items.
*/
@Getter
public final class ShardingItems {
private static final String DELIMITER = ",";
-
+
/**
- * 根据分片项字符串获取分片项列表.
+ * Get sharding items via string.
*
- * @param itemsString 分片项字符串
- * @return 分片项列表
+ * @param itemsString sharding items string
+ * @return sharding items
*/
public static List<Integer> toItemList(final String itemsString) {
if (Strings.isNullOrEmpty(itemsString)) {
@@ -55,12 +53,12 @@ public final class ShardingItems {
}
return result;
}
-
+
/**
- * 根据分片项列表获取分片项字符串.
+ * Get sharding items string.
*
- * @param items 分片项列表
- * @return 分片项字符串
+ * @param items sharding items
+ * @return sharding items string
*/
public static String toItemsString(final List<Integer> items) {
return items.isEmpty() ? "" : Joiner.on(DELIMITER).join(items);
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/util/digest/Encryption.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/util/digest/Encryption.java
index 90d4ba8..17fb18b 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/util/digest/Encryption.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/util/digest/Encryption.java
@@ -26,20 +26,18 @@ import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
/**
- * 字符串加密工具类.
- *
- * @author zhangliang
+ * Encryption.
*/
@NoArgsConstructor(access = AccessLevel.PRIVATE)
public final class Encryption {
private static final String MD5 = "MD5";
-
+
/**
- * 采用MD5算法加密字符串.
- *
- * @param str 需要加密的字符串
- * @return 加密后的字符串
+ * Use md5 to encrypt string.
+ *
+ * @param str string to be encrypted
+ * @return encrypted string
*/
public static String md5(final String str) {
try {
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/util/env/HostException.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/util/env/HostException.java
index 7b24ed5..d786762 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/util/env/HostException.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/util/env/HostException.java
@@ -20,9 +20,7 @@ package org.apache.shardingsphere.elasticjob.cloud.util.env;
import java.io.IOException;
/**
- * 网络主机异常.
- *
- * @author zhangliang
+ * Host exception.
*/
public final class HostException extends RuntimeException {
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/util/env/IpUtils.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/util/env/IpUtils.java
index 3356ec4..6e2d1ae 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/util/env/IpUtils.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/util/env/IpUtils.java
@@ -27,29 +27,19 @@ import java.net.UnknownHostException;
import java.util.Enumeration;
/**
- * 获取真实本机网络的服务.
- *
- * @author zhangliang
+ * IP address utility.
*/
@NoArgsConstructor(access = AccessLevel.PRIVATE)
public final class IpUtils {
-
- /**
- * IP地址的正则表达式.
- */
+
public static final String IP_REGEX = "((\\d|[1-9]\\d|1\\d{2}|2[0-4]\\d|25[0-5])(\\.(\\d|[1-9]\\d|1\\d{2}|2[0-4]\\d|25[0-5])){3})";
private static volatile String cachedIpAddress;
-
+
/**
- * 获取本机IP地址.
- *
- * <p>
- * 有限获取外网IP地址.
- * 也有可能是链接着路由器的最终IP地址.
- * </p>
- *
- * @return 本机IP地址
+ * Get IP address for localhost.
+ *
+ * @return IP address for localhost
*/
public static String getIp() {
if (null != cachedIpAddress) {
@@ -92,11 +82,11 @@ public final class IpUtils {
private static boolean isV6IpAddress(final InetAddress ipAddress) {
return ipAddress.getHostAddress().contains(":");
}
-
+
/**
- * 获取本机Host名称.
- *
- * @return 本机Host名称
+ * Get host name for localhost.
+ *
+ * @return host name for localhost
*/
public static String getHostName() {
try {
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/util/env/TimeService.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/util/env/TimeService.java
index f98094d..d8fc2c7 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/util/env/TimeService.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/util/env/TimeService.java
@@ -18,16 +18,14 @@
package org.apache.shardingsphere.elasticjob.cloud.util.env;
/**
- * 获取时间的服务.
- *
- * @author zhangliang
+ * Time service.
*/
public final class TimeService {
-
+
/**
- * 获取当前时间的毫秒数.
- *
- * @return 当前时间的毫秒数
+ * Get current millis.
+ *
+ * @return current millis
*/
public long getCurrentMillis() {
return System.currentTimeMillis();
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/util/json/AbstractJobConfigurationGsonTypeAdapter.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/util/json/AbstractJobConfigurationGsonTypeAdapter.java
index edb3814..c7652cc 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/util/json/AbstractJobConfigurationGsonTypeAdapter.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/util/json/AbstractJobConfigurationGsonTypeAdapter.java
@@ -36,12 +36,9 @@ import java.util.HashMap;
import java.util.Map;
/**
- * 作业配置的Json转换适配器.
+ * Job configuration gson type adapter.
*
- * @param <T> 作业配置对象泛型
- *
- * @author zhangliang
- * @author caohao
+ * @param <T> type of job root configuration
*/
public abstract class AbstractJobConfigurationGsonTypeAdapter<T extends JobRootConfiguration> extends TypeAdapter<T> {
diff --git a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/util/json/GsonFactory.java b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/util/json/GsonFactory.java
index 5fad3ee..6297965 100644
--- a/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/util/json/GsonFactory.java
+++ b/elastic-job-cloud-common/src/main/java/org/apache/shardingsphere/elasticjob/cloud/util/json/GsonFactory.java
@@ -26,9 +26,7 @@ import lombok.NoArgsConstructor;
import java.lang.reflect.Type;
/**
- * Gson构建器.
- *
- * @author caohao
+ * Gson factory.
*/
@NoArgsConstructor(access = AccessLevel.PRIVATE)
public final class GsonFactory {
@@ -36,22 +34,22 @@ public final class GsonFactory {
private static final GsonBuilder GSON_BUILDER = new GsonBuilder();
private static volatile Gson gson = GSON_BUILDER.create();
-
+
/**
- * 注册Gson解析对象.
- *
- * @param type Gson解析对象类型
- * @param typeAdapter Gson解析对象适配器
+ * Register type adapter.
+ *
+ * @param type Gson type
+ * @param typeAdapter Gson type adapter
*/
public static synchronized void registerTypeAdapter(final Type type, final TypeAdapter typeAdapter) {
GSON_BUILDER.registerTypeAdapter(type, typeAdapter);
gson = GSON_BUILDER.create();
}
-
+
/**
- * 获取Gson实例.
- *
- * @return Gson实例
+ * Get gson instance.
+ *
+ * @return gson instance
*/
public static Gson getGson() {
return gson;