From c937917c9609af99f203aabfb922355787864343 Mon Sep 17 00:00:00 2001 From: mabofu Date: Thu, 5 Jan 2023 11:17:10 +0800 Subject: [PATCH] change common module common config comment to English --- .../com/dsms/common/config/CorsConfig.java | 12 ++++++------ .../com/dsms/common/config/Knife4jConfig.java | 10 +++++----- .../dsms/common/config/MybatisPlusConfig.java | 2 +- .../com/dsms/common/config/RedisConfig.java | 16 ++++++++-------- .../common/config/RestTemplateConfig.java | 2 +- .../dsms/common/config/SecurityConfig.java | 8 ++++---- .../common/config/TaskExecutorConfig.java | 14 +++++++------- .../common/constant/DeviceStatusEnum.java | 6 +++--- .../dsms/common/constant/NodeStatusEnum.java | 6 +++--- .../constant/RemoteResponseStatusEnum.java | 8 ++++---- .../com/dsms/common/constant/ResultCode.java | 12 ++++++------ .../com/dsms/common/constant/SystemConst.java | 19 +++++-------------- .../dsms/common/constant/TaskStatusEnum.java | 12 ++++++------ .../dsms/common/constant/TaskTypeEnum.java | 6 +++--- .../com/dsms/common/filter/JwtFilter.java | 6 +++--- .../handler/AccessDeniedHandlerImpl.java | 2 +- .../handler/AuthenticationEntryPointImpl.java | 2 +- .../common/handler/ErrorBaseController.java | 2 +- .../handler/GlobalExceptionHandler.java | 17 +++++++++-------- 19 files changed, 77 insertions(+), 85 deletions(-) diff --git a/dsms-engine-common/src/main/java/com/dsms/common/config/CorsConfig.java b/dsms-engine-common/src/main/java/com/dsms/common/config/CorsConfig.java index 4500e81..798003f 100644 --- a/dsms-engine-common/src/main/java/com/dsms/common/config/CorsConfig.java +++ b/dsms-engine-common/src/main/java/com/dsms/common/config/CorsConfig.java @@ -22,17 +22,17 @@ public class CorsConfig implements WebMvcConfigurer { @Override public void addCorsMappings(CorsRegistry registry) { - // 设置允许跨域的路径 + // allow cors path mapping registry.addMapping("/**") - // 设置允许跨域请求的域名 + // allow cors domain .allowedOriginPatterns("*") - // 是否允许cookie + // config allow cookie .allowCredentials(true) - // 设置允许的请求方式 + // config allowed http method .allowedMethods("GET", "POST", "DELETE", "PUT") - // 设置允许的header属性 + // config allowed header attr .allowedHeaders("*") - // 跨域允许时间 + // cors allow time .maxAge(3600); } } diff --git a/dsms-engine-common/src/main/java/com/dsms/common/config/Knife4jConfig.java b/dsms-engine-common/src/main/java/com/dsms/common/config/Knife4jConfig.java index d7f5075..11adf4e 100644 --- a/dsms-engine-common/src/main/java/com/dsms/common/config/Knife4jConfig.java +++ b/dsms-engine-common/src/main/java/com/dsms/common/config/Knife4jConfig.java @@ -27,7 +27,7 @@ import springfox.documentation.swagger2.annotations.EnableSwagger2; /** - * swagger配置 + * swagger config */ @Configuration @EnableSwagger2 @@ -35,18 +35,18 @@ public class Knife4jConfig { @Bean(value = "dockerBean") public Docket dockerBean() { - //指定使用Swagger2规范 + // use the Swagger2 specification Docket docket = new Docket(DocumentationType.SWAGGER_2) .apiInfo(new ApiInfoBuilder() - //描述字段支持Markdown语法 + //can use Markdown .description("# 分布式文件系统管理平台后端RESTful APIs") .termsOfServiceUrl("https://doc.dsms-info.com/") .version("1.0") .build()) - //分组名称 + //group name .groupName("后端接口") .select() - //这里指定Controller扫描包路径 + //specify the path of the Controller scan package .apis(RequestHandlerSelectors.basePackage("com.dsms")) .paths(PathSelectors.any()) .build(); diff --git a/dsms-engine-common/src/main/java/com/dsms/common/config/MybatisPlusConfig.java b/dsms-engine-common/src/main/java/com/dsms/common/config/MybatisPlusConfig.java index 805dea6..8bed0bf 100644 --- a/dsms-engine-common/src/main/java/com/dsms/common/config/MybatisPlusConfig.java +++ b/dsms-engine-common/src/main/java/com/dsms/common/config/MybatisPlusConfig.java @@ -26,7 +26,7 @@ import org.springframework.context.annotation.Configuration; @Configuration public class MybatisPlusConfig { /** - * 新的分页插件,一缓和二缓遵循mybatis的规则,需要设置 MybatisConfiguration#useDeprecatedExecutor = false 避免缓存出现问题(该属性会在旧插件移除后一同移除) + * mybatis-plus Pagination plugin */ @Bean public MybatisPlusInterceptor mybatisPlusInterceptor() { diff --git a/dsms-engine-common/src/main/java/com/dsms/common/config/RedisConfig.java b/dsms-engine-common/src/main/java/com/dsms/common/config/RedisConfig.java index f33fd8d..0dbd056 100644 --- a/dsms-engine-common/src/main/java/com/dsms/common/config/RedisConfig.java +++ b/dsms-engine-common/src/main/java/com/dsms/common/config/RedisConfig.java @@ -28,14 +28,14 @@ import org.springframework.data.redis.serializer.RedisSerializer; import org.springframework.data.redis.serializer.StringRedisSerializer; /** - * redis 配置 + * redis configuration */ @Configuration public class RedisConfig { /** - * retemplate相关配置 - * @param factory - * @return + * redisTemplate configuration + * @param factory redis connection factory + * @return redisTemplate */ @Bean public RedisTemplate redisTemplate(RedisConnectionFactory factory) { @@ -44,13 +44,13 @@ public class RedisConfig { redisTemplate.setConnectionFactory(factory); RedisSerializer stringSerializer = new StringRedisSerializer(); - // key序列化 + // key serialization redisTemplate.setKeySerializer(stringSerializer); - // value序列化 + // value serialization redisTemplate.setValueSerializer(jackson2JsonRedisSerializer); - // Hash key序列化 + // Hash key serialization redisTemplate.setHashKeySerializer(stringSerializer); - // Hash value序列化 + // Hash value serialization redisTemplate.setHashValueSerializer(jackson2JsonRedisSerializer); redisTemplate.afterPropertiesSet(); return redisTemplate; diff --git a/dsms-engine-common/src/main/java/com/dsms/common/config/RestTemplateConfig.java b/dsms-engine-common/src/main/java/com/dsms/common/config/RestTemplateConfig.java index c3520de..7a515dd 100644 --- a/dsms-engine-common/src/main/java/com/dsms/common/config/RestTemplateConfig.java +++ b/dsms-engine-common/src/main/java/com/dsms/common/config/RestTemplateConfig.java @@ -22,7 +22,7 @@ import org.springframework.context.annotation.Configuration; import org.springframework.web.client.RestTemplate; /** - * RestTemplate配置 + * RestTemplate configuration */ @Configuration public class RestTemplateConfig { diff --git a/dsms-engine-common/src/main/java/com/dsms/common/config/SecurityConfig.java b/dsms-engine-common/src/main/java/com/dsms/common/config/SecurityConfig.java index e6436ca..f50ffd5 100644 --- a/dsms-engine-common/src/main/java/com/dsms/common/config/SecurityConfig.java +++ b/dsms-engine-common/src/main/java/com/dsms/common/config/SecurityConfig.java @@ -44,15 +44,15 @@ public class SecurityConfig { @Bean public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception { http.csrf().disable() - //不通过Session获取SecurityContext + //The Security Context is not obtained through Session .sessionManagement().sessionCreationPolicy(SessionCreationPolicy.STATELESS) .and() .authorizeRequests() - // 对于静态资源，swagger接口文档 允许直接访问 + // For static resources allows direct access .antMatchers(HttpMethod.GET, "/*.html", "/**/*.html", "/**/*.css", "/**/*.js","/favicon.ico", "/swagger**/**", "/v2/**","/websocket/**","/").permitAll() - // 对于登录接口允许匿名访问 + // For the login interface, anonymous access is allowed .antMatchers("/api/login").anonymous() - // 除上面外的所有请求全部需要鉴权认证 + // All requests except the above require authentication .anyRequest().authenticated(); http.addFilterBefore(jwtFilter, UsernamePasswordAuthenticationFilter.class); diff --git a/dsms-engine-common/src/main/java/com/dsms/common/config/TaskExecutorConfig.java b/dsms-engine-common/src/main/java/com/dsms/common/config/TaskExecutorConfig.java index 0a298b5..87f61cc 100644 --- a/dsms-engine-common/src/main/java/com/dsms/common/config/TaskExecutorConfig.java +++ b/dsms-engine-common/src/main/java/com/dsms/common/config/TaskExecutorConfig.java @@ -30,19 +30,19 @@ public class TaskExecutorConfig { @Bean("dsmsExecutor") public ThreadPoolTaskExecutor getTaskExecutor(){ ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor(); - // 设置核心线程数 + // set core threads number executor.setCorePoolSize(4); - // 设置最大线程数 + // set max threads number executor.setMaxPoolSize(4); - // 设置队列容量 + // set the queue capacity executor.setQueueCapacity(4); - // 设置线程活跃时间（秒） + // set thread active time (seconds) executor.setKeepAliveSeconds(60); - // 设置默认线程名称 + // set the thread name prefix executor.setThreadNamePrefix("dsms-engine-task-"); - // 设置拒绝策略 + // set rejected policy executor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy()); - // 等待所有任务结束后再关闭线程池 + // wait for all tasks to complete before closing the thread pool executor.setWaitForTasksToCompleteOnShutdown(true); return executor; } diff --git a/dsms-engine-common/src/main/java/com/dsms/common/constant/DeviceStatusEnum.java b/dsms-engine-common/src/main/java/com/dsms/common/constant/DeviceStatusEnum.java index 2e5f27b..a95ce64 100644 --- a/dsms-engine-common/src/main/java/com/dsms/common/constant/DeviceStatusEnum.java +++ b/dsms-engine-common/src/main/java/com/dsms/common/constant/DeviceStatusEnum.java @@ -19,17 +19,17 @@ import lombok.AllArgsConstructor; import lombok.Getter; /** - * 磁盘状态枚举 + * node disk status enum */ @Getter @AllArgsConstructor public enum DeviceStatusEnum { /** - * 不可用 + * not available */ NOT_AVAILABLE(0, "不可用"), /** - * 可用 + * available */ AVAILABLE(1, "可用"); diff --git a/dsms-engine-common/src/main/java/com/dsms/common/constant/NodeStatusEnum.java b/dsms-engine-common/src/main/java/com/dsms/common/constant/NodeStatusEnum.java index 14553fe..9356abb 100644 --- a/dsms-engine-common/src/main/java/com/dsms/common/constant/NodeStatusEnum.java +++ b/dsms-engine-common/src/main/java/com/dsms/common/constant/NodeStatusEnum.java @@ -20,17 +20,17 @@ import lombok.Getter; /** - * 节点状态枚举 + * node status enum */ @Getter @AllArgsConstructor public enum NodeStatusEnum { /** - * 离线 + * down */ DOWN(0, "离线"), /** - * 在线 + * up */ UP(1, "在线"); diff --git a/dsms-engine-common/src/main/java/com/dsms/common/constant/RemoteResponseStatusEnum.java b/dsms-engine-common/src/main/java/com/dsms/common/constant/RemoteResponseStatusEnum.java index 2fab375..bf55b6a 100644 --- a/dsms-engine-common/src/main/java/com/dsms/common/constant/RemoteResponseStatusEnum.java +++ b/dsms-engine-common/src/main/java/com/dsms/common/constant/RemoteResponseStatusEnum.java @@ -20,21 +20,21 @@ import lombok.Getter; /** - * 响应状态枚举 + * dsms-storage /request api response status enum */ @Getter @AllArgsConstructor public enum RemoteResponseStatusEnum { /** - * 成功 + * success */ SUCCESS(0, "success"), /** - * 等待中 + * pending */ PENDING(1, "pending"), /** - * 失败 + * failed */ FAILED(2, "failed"); diff --git a/dsms-engine-common/src/main/java/com/dsms/common/constant/ResultCode.java b/dsms-engine-common/src/main/java/com/dsms/common/constant/ResultCode.java index d494786..9456faa 100644 --- a/dsms-engine-common/src/main/java/com/dsms/common/constant/ResultCode.java +++ b/dsms-engine-common/src/main/java/com/dsms/common/constant/ResultCode.java @@ -17,14 +17,14 @@ package com.dsms.common.constant; /** - * 状态码枚举 + * Result Code */ public enum ResultCode { /** - * HTTP状态码 + * HTTP standard status code */ OK(200, "请求成功"), - //表示客户端错误，请求包含语法错误或无法完成请求 + //a request that contains a syntax error BAD_REQUEST(400, "客户端错误"), UNAUTHORIZED(401, "账号未登录"), FORBIDDEN(403, "帐号未授权"), @@ -32,7 +32,7 @@ public enum ResultCode { SERVER_ERROR(500, "服务器异常"), /** - * 业务状态码枚举 + * service status code */ SUCCESS(0, "成功"), REMOTE_CALLFAIL(100, "调用分布式文件系统失败"), @@ -60,11 +60,11 @@ public enum ResultCode { ; /** - * 状态码 + * response code */ private int code; /** - * 描述信息 + * response message */ private String message; diff --git a/dsms-engine-common/src/main/java/com/dsms/common/constant/SystemConst.java b/dsms-engine-common/src/main/java/com/dsms/common/constant/SystemConst.java index a027941..15f0ff4 100644 --- a/dsms-engine-common/src/main/java/com/dsms/common/constant/SystemConst.java +++ b/dsms-engine-common/src/main/java/com/dsms/common/constant/SystemConst.java @@ -17,20 +17,11 @@ package com.dsms.common.constant; /** - * 系统相关常量 + * System constant */ public class SystemConst { - /** - * 应用自定义配置文件 - */ public static final String ADDITIONAL_PROPERTIES = "additional.properties"; - /** - * 日志配置文件路径 - */ public static final String LOGCONFIG_PATH = "dsms.engine.logconfig.path"; - /** - * spring 外部扩展配置文件 - */ public static final String SPRING_ADDITIONAL_CONFIG = "spring.config.additional-location"; /** @@ -44,7 +35,7 @@ public class SystemConst { public static final String RELEASE_VERSION_FILE_PATH = "/etc/dsms/version"; /** - * redis 存储token前缀 + * redis storge login token prefix */ public static final String REDIS_TOKEN_PREFIX = "login:"; @@ -59,13 +50,13 @@ public class SystemConst { public static final String HTTP_SCHEME = "http"; /** - * 集群校验超时时间 ms + * dsms-storage validate connect timeout (ms) */ public static final int CONNECT_TIMEOUT = 10000; /** - * dsms storage 接口用户 - * TODO: 默认使用admin用户，后续新增多用户模块后优化 + * dsms-storage default token user + * TODO: default use admin，Optimize after adding multi-user modules */ public static final String DSMS_STORAGE_USER = "admin"; diff --git a/dsms-engine-common/src/main/java/com/dsms/common/constant/TaskStatusEnum.java b/dsms-engine-common/src/main/java/com/dsms/common/constant/TaskStatusEnum.java index 6d0715a..559f85f 100644 --- a/dsms-engine-common/src/main/java/com/dsms/common/constant/TaskStatusEnum.java +++ b/dsms-engine-common/src/main/java/com/dsms/common/constant/TaskStatusEnum.java @@ -20,29 +20,29 @@ import lombok.Getter; /** - * 任务状态枚举 + * Task status enum */ @Getter @AllArgsConstructor public enum TaskStatusEnum { /** - * 未开始 + * add task not start */ INIT(0, "未开始"), /** - * 队列中 + * task waiting executor execute */ QUEUE(1, "队列中"), /** - * 执行中 + * executor running task */ EXECUTING(2, "执行中"), /** - * 完成 + * task run finished */ FINISH(3, "完成"), /** - * 失败 + * task run failed */ FAIL(4, "失败"); diff --git a/dsms-engine-common/src/main/java/com/dsms/common/constant/TaskTypeEnum.java b/dsms-engine-common/src/main/java/com/dsms/common/constant/TaskTypeEnum.java index daba4c4..39f79ef 100644 --- a/dsms-engine-common/src/main/java/com/dsms/common/constant/TaskTypeEnum.java +++ b/dsms-engine-common/src/main/java/com/dsms/common/constant/TaskTypeEnum.java @@ -21,17 +21,17 @@ import lombok.Getter; /** - * 任务类型枚举 + * task type enum */ @Getter @AllArgsConstructor public enum TaskTypeEnum { /** - * 管理磁盘 + * node add osd task */ ADD_OSD("add_osd", "节点管理磁盘"), /** - * 移除磁盘 + * node remove osd task */ REMOVE_OSD("remove_osd", "节点移除磁盘"); diff --git a/dsms-engine-common/src/main/java/com/dsms/common/filter/JwtFilter.java b/dsms-engine-common/src/main/java/com/dsms/common/filter/JwtFilter.java index 7b66a6a..80c6e50 100644 --- a/dsms-engine-common/src/main/java/com/dsms/common/filter/JwtFilter.java +++ b/dsms-engine-common/src/main/java/com/dsms/common/filter/JwtFilter.java @@ -41,8 +41,8 @@ import java.io.IOException; /** - * JWT 过滤器 - * Spring security 过滤器链之前执行 + * JWT Filter + * before Spring security FilterChains */ @Component public class JwtFilter extends OncePerRequestFilter { @@ -59,7 +59,7 @@ public class JwtFilter extends OncePerRequestFilter { filterChain.doFilter(request, response); return; } - //解析token + //parse token String userId = null; try { Claims claims = jwtUtil.parseJWT(token); diff --git a/dsms-engine-common/src/main/java/com/dsms/common/handler/AccessDeniedHandlerImpl.java b/dsms-engine-common/src/main/java/com/dsms/common/handler/AccessDeniedHandlerImpl.java index adcf5df..bdcdd5f 100644 --- a/dsms-engine-common/src/main/java/com/dsms/common/handler/AccessDeniedHandlerImpl.java +++ b/dsms-engine-common/src/main/java/com/dsms/common/handler/AccessDeniedHandlerImpl.java @@ -32,7 +32,7 @@ import java.io.IOException; import java.nio.charset.StandardCharsets; /** - * 自定义授权响应 + * Customize the accessDenied response */ @Component public class AccessDeniedHandlerImpl implements AccessDeniedHandler { diff --git a/dsms-engine-common/src/main/java/com/dsms/common/handler/AuthenticationEntryPointImpl.java b/dsms-engine-common/src/main/java/com/dsms/common/handler/AuthenticationEntryPointImpl.java index 33b8e73..ef10e15 100644 --- a/dsms-engine-common/src/main/java/com/dsms/common/handler/AuthenticationEntryPointImpl.java +++ b/dsms-engine-common/src/main/java/com/dsms/common/handler/AuthenticationEntryPointImpl.java @@ -32,7 +32,7 @@ import java.io.IOException; import java.nio.charset.StandardCharsets; /** - * 自定义认证失败响应 + * Customize the authentication fail response */ @Component public class AuthenticationEntryPointImpl implements AuthenticationEntryPoint { diff --git a/dsms-engine-common/src/main/java/com/dsms/common/handler/ErrorBaseController.java b/dsms-engine-common/src/main/java/com/dsms/common/handler/ErrorBaseController.java index 44f0f9c..9229c2d 100644 --- a/dsms-engine-common/src/main/java/com/dsms/common/handler/ErrorBaseController.java +++ b/dsms-engine-common/src/main/java/com/dsms/common/handler/ErrorBaseController.java @@ -37,7 +37,7 @@ public class ErrorBaseController extends BasicErrorController { } /** - * 覆盖默认的JSON响应 + * Overrides the default JSON response */ @Override public ResponseEntity> error(HttpServletRequest request) { diff --git a/dsms-engine-common/src/main/java/com/dsms/common/handler/GlobalExceptionHandler.java b/dsms-engine-common/src/main/java/com/dsms/common/handler/GlobalExceptionHandler.java index c257284..1db0933 100644 --- a/dsms-engine-common/src/main/java/com/dsms/common/handler/GlobalExceptionHandler.java +++ b/dsms-engine-common/src/main/java/com/dsms/common/handler/GlobalExceptionHandler.java @@ -24,10 +24,7 @@ import org.springframework.http.HttpStatus; import org.springframework.util.ObjectUtils; import org.springframework.validation.FieldError; import org.springframework.web.bind.MethodArgumentNotValidException; -import org.springframework.web.bind.annotation.ExceptionHandler; -import org.springframework.web.bind.annotation.ResponseBody; -import org.springframework.web.bind.annotation.ResponseStatus; -import org.springframework.web.bind.annotation.RestControllerAdvice; +import org.springframework.web.bind.annotation.*; import org.springframework.web.servlet.NoHandlerFoundException; import javax.servlet.http.HttpServletRequest; @@ -35,12 +32,16 @@ import javax.servlet.http.HttpServletResponse; import java.util.Optional; /** - * 全局异常处理 + * Global exception handler */ @RestControllerAdvice @Slf4j public class GlobalExceptionHandler { + /** + * Handle the case where an argument annotated with {@code @Valid} such as + * an {@link RequestBody} or {@link RequestPart} argument fails validation + */ @ResponseBody @ExceptionHandler(MethodArgumentNotValidException.class) public Result handle(MethodArgumentNotValidException e) { @@ -53,7 +54,7 @@ public class GlobalExceptionHandler { } /** - * 处理资源不存在的情况 + * Handle the case where no handler was found during the dispatch */ @ExceptionHandler(NoHandlerFoundException.class) @ResponseStatus(HttpStatus.NOT_FOUND) @@ -63,7 +64,7 @@ public class GlobalExceptionHandler { } /** - * 处理自定义异常 + * Handle the case where custom dsms engine exceptions are thrown */ @ExceptionHandler(value = DsmsEngineException.class) public Result dsmsEngineExceptionHandler(DsmsEngineException e, HttpServletResponse response) { @@ -73,7 +74,7 @@ public class GlobalExceptionHandler { } /** - * 处理异常，返回标准响应体 + * Handle the case where other exceptions are thrown */ @ExceptionHandler(value = Exception.class) public Result exceptionHandler(Exception e) { -- Gitee