From 2bfc1ae801f17e761c8cb1c8982410f11f65d3cf Mon Sep 17 00:00:00 2001 From: Pil0tXia <41445332+Pil0tXia@users.noreply.github.com> Date: Tue, 31 Oct 2023 20:43:44 +0800 Subject: [PATCH] [ISSUE #4521] A poor naming. (#4524) * rename common package to constant * rename Errors enum to Status and Message sub-class to StatusMessage * Exact 'Types' to first level of classification 'Category' * remove 'error' in Status javadoc --- .../admin/config/AdminProperties.java | 2 +- .../admin/config/MetaTypeConfig.java | 4 +- .../{common => constant}/ConfigConst.java | 2 +- .../{common => constant}/NacosConst.java | 2 +- .../apache/eventmesh/admin/dto/Result.java | 50 +++++++++---------- .../admin/enums/{Errors.java => Status.java} | 30 +++++------ .../admin/exception/BaseException.java | 20 ++++---- .../exception/EventMeshAdminException.java | 6 +-- .../exception/GlobalExceptionHandler.java | 9 ++-- .../admin/exception/MetaException.java | 10 ++-- .../impl/NacosSubscriptionService.java | 16 +++--- .../ExceptionUtil.java} | 4 +- 12 files changed, 78 insertions(+), 77 deletions(-) rename eventmesh-admin/src/main/java/org/apache/eventmesh/admin/{common => constant}/ConfigConst.java (96%) rename eventmesh-admin/src/main/java/org/apache/eventmesh/admin/{common => constant}/NacosConst.java (97%) rename eventmesh-admin/src/main/java/org/apache/eventmesh/admin/enums/{Errors.java => Status.java} (65%) rename eventmesh-admin/src/main/java/org/apache/eventmesh/admin/{utils/ExceptionUtils.java => util/ExceptionUtil.java} (94%) diff --git a/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/config/AdminProperties.java b/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/config/AdminProperties.java index cce6607287..bb4e01eb65 100644 --- a/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/config/AdminProperties.java +++ b/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/config/AdminProperties.java @@ -17,7 +17,7 @@ package org.apache.eventmesh.admin.config; -import org.apache.eventmesh.admin.common.ConfigConst; +import org.apache.eventmesh.admin.constant.ConfigConst; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.stereotype.Component; diff --git a/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/config/MetaTypeConfig.java b/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/config/MetaTypeConfig.java index 4be7801594..5f2602c6b4 100644 --- a/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/config/MetaTypeConfig.java +++ b/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/config/MetaTypeConfig.java @@ -17,8 +17,8 @@ package org.apache.eventmesh.admin.config; -import static org.apache.eventmesh.admin.common.ConfigConst.META_TYPE_ETCD; -import static org.apache.eventmesh.admin.common.ConfigConst.META_TYPE_NACOS; +import static org.apache.eventmesh.admin.constant.ConfigConst.META_TYPE_ETCD; +import static org.apache.eventmesh.admin.constant.ConfigConst.META_TYPE_NACOS; import org.apache.eventmesh.admin.service.ConnectionService; import org.apache.eventmesh.admin.service.SubscriptionService; diff --git a/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/common/ConfigConst.java b/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/constant/ConfigConst.java similarity index 96% rename from eventmesh-admin/src/main/java/org/apache/eventmesh/admin/common/ConfigConst.java rename to eventmesh-admin/src/main/java/org/apache/eventmesh/admin/constant/ConfigConst.java index 150231672c..70bf5008da 100644 --- a/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/common/ConfigConst.java +++ b/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/constant/ConfigConst.java @@ -15,7 +15,7 @@ * limitations under the License. */ -package org.apache.eventmesh.admin.common; +package org.apache.eventmesh.admin.constant; public class ConfigConst { diff --git a/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/common/NacosConst.java b/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/constant/NacosConst.java similarity index 97% rename from eventmesh-admin/src/main/java/org/apache/eventmesh/admin/common/NacosConst.java rename to eventmesh-admin/src/main/java/org/apache/eventmesh/admin/constant/NacosConst.java index 07e7d93787..1b78b87abd 100644 --- a/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/common/NacosConst.java +++ b/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/constant/NacosConst.java @@ -15,7 +15,7 @@ * limitations under the License. */ -package org.apache.eventmesh.admin.common; +package org.apache.eventmesh.admin.constant; public class NacosConst { diff --git a/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/dto/Result.java b/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/dto/Result.java index 15b3dc2f42..1fe2f09fc9 100644 --- a/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/dto/Result.java +++ b/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/dto/Result.java @@ -17,9 +17,9 @@ package org.apache.eventmesh.admin.dto; -import static org.apache.eventmesh.admin.enums.Errors.SUCCESS; +import static org.apache.eventmesh.admin.enums.Status.SUCCESS; -import org.apache.eventmesh.admin.enums.Errors; +import org.apache.eventmesh.admin.enums.Status; import org.apache.eventmesh.admin.exception.BaseException; import org.springframework.http.HttpStatus; @@ -44,10 +44,10 @@ public class Result { private Integer pages; - private Message message; + private StatusMessage message; - public Result(Message message) { - this.message = message; + public Result(StatusMessage statusMessage) { + this.message = statusMessage; } public Result(T data, Integer pages) { @@ -59,16 +59,16 @@ public Result(T data, Integer pages) { * The request is valid and the result is wrapped in {@link Result}. */ public static Result success() { - return new Result<>(new Message(SUCCESS)); + return new Result<>(new StatusMessage(SUCCESS)); } public static Result success(Result result) { - result.setMessage(new Message(SUCCESS)); + result.setMessage(new StatusMessage(SUCCESS)); return result; } public static Result success(T data) { - return new Result<>(data, null, new Message(SUCCESS)); + return new Result<>(data, null, new StatusMessage(SUCCESS)); } /** @@ -76,11 +76,11 @@ public static Result success(T data) { * Logic issues should use 422 Unprocessable Entity instead of 200 OK. */ public static ResponseEntity> ok() { - return ResponseEntity.ok(new Result<>(new Message(SUCCESS))); + return ResponseEntity.ok(new Result<>(new StatusMessage(SUCCESS))); } public static ResponseEntity> ok(Result result) { - result.setMessage(new Message(SUCCESS)); + result.setMessage(new StatusMessage(SUCCESS)); return ResponseEntity.ok(result); } @@ -88,42 +88,42 @@ public static ResponseEntity> ok(Result result) { * The request is invalid. */ public static ResponseEntity> badRequest(String message) { - return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(new Result<>(new Message(message))); + return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(new Result<>(new StatusMessage(message))); } /** * The request is valid but cannot be processed due to business logic issues. */ public static ResponseEntity> unprocessable(String message) { - return ResponseEntity.status(HttpStatus.UNPROCESSABLE_ENTITY).body(new Result<>(new Message(message))); + return ResponseEntity.status(HttpStatus.UNPROCESSABLE_ENTITY).body(new Result<>(new StatusMessage(message))); } /** * Uncaught exception happened in EventMeshAdmin application. */ public static ResponseEntity> internalError(String message) { - return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(new Result<>(new Message(message))); + return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(new Result<>(new StatusMessage(message))); } /** * Upstream service unavailable such as Meta. */ public static ResponseEntity> badGateway(String message) { - return ResponseEntity.status(HttpStatus.BAD_GATEWAY).body(new Result<>(new Message(message))); + return ResponseEntity.status(HttpStatus.BAD_GATEWAY).body(new Result<>(new StatusMessage(message))); } @Data - public static class Message { + public static class StatusMessage { - private String name; + private String status; - private String type; + private String category; private String desc; - public Message(BaseException e) { - this.name = e.getErrors().name(); - this.type = e.getErrors().getType().name(); + public StatusMessage(BaseException e) { + this.status = e.getStatus().name(); + this.category = e.getStatus().getCategory().name(); this.desc = e.getMessage(); } @@ -131,13 +131,13 @@ public Message(BaseException e) { * Only recommended for returning successful results, * the stack trace cannot be displayed when returning unsuccessful results. */ - public Message(Errors errors) { - this.name = errors.name(); - this.type = errors.getType().name(); - this.desc = errors.getDesc(); // no stack trace + public StatusMessage(Status status) { + this.status = status.name(); + this.category = status.getCategory().name(); + this.desc = status.getDesc(); // no stack trace } - public Message(String desc) { + public StatusMessage(String desc) { this.desc = desc; } } diff --git a/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/enums/Errors.java b/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/enums/Status.java similarity index 65% rename from eventmesh-admin/src/main/java/org/apache/eventmesh/admin/enums/Errors.java rename to eventmesh-admin/src/main/java/org/apache/eventmesh/admin/enums/Status.java index 3854993a46..e5039468cb 100644 --- a/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/enums/Errors.java +++ b/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/enums/Status.java @@ -17,7 +17,7 @@ package org.apache.eventmesh.admin.enums; -import static org.apache.eventmesh.admin.common.ConfigConst.COLON; +import static org.apache.eventmesh.admin.constant.ConfigConst.COLON; import org.springframework.http.HttpStatus; @@ -27,50 +27,50 @@ * An enumeration class that conforms to the RESTful specifications and custom error reporting requirements. *
    *
  • The 'code' field is used to return the HTTP status code using {@link HttpStatus}.
    • - *
  • The 'type' field represents the major category of the error.
    • + *
  • The 'category' field represents the major category of the error.
    • *
  • the 'desc' field represents the detailed subcategory and information of the error.
    • *
*/ @Getter -public enum Errors { +public enum Status { - SUCCESS(HttpStatus.OK, Types.SUCCESS, "Operation success."), + SUCCESS(HttpStatus.OK, Category.SUCCESS, "Operation success."), - NACOS_SDK_CONFIG_ERR(HttpStatus.INTERNAL_SERVER_ERROR, Types.SDK_CONFIG_ERR, + NACOS_SDK_CONFIG_ERR(HttpStatus.INTERNAL_SERVER_ERROR, Category.SDK_CONFIG_ERR, "Failed to create Nacos ConfigService. Please check EventMeshAdmin application configuration."), - NACOS_GET_CONFIGS_ERR(HttpStatus.BAD_GATEWAY, Types.META_COM_ERR, "Failed to retrieve Nacos config(s)."), + NACOS_GET_CONFIGS_ERR(HttpStatus.BAD_GATEWAY, Category.META_COM_ERR, "Failed to retrieve Nacos config(s)."), - NACOS_EMPTY_RESP_ERR(HttpStatus.BAD_GATEWAY, Types.META_COM_ERR, "No result returned by Nacos. Please check Nacos."), + NACOS_EMPTY_RESP_ERR(HttpStatus.BAD_GATEWAY, Category.META_COM_ERR, "No result returned by Nacos. Please check Nacos."), - NACOS_LOGIN_ERR(HttpStatus.UNAUTHORIZED, Types.META_COM_ERR, "Nacos login failed."), + NACOS_LOGIN_ERR(HttpStatus.UNAUTHORIZED, Category.META_COM_ERR, "Nacos login failed."), - NACOS_LOGIN_EMPTY_RESP_ERR(HttpStatus.BAD_GATEWAY, Types.META_COM_ERR, "Nacos didn't return accessToken. Please check Nacos status."), + NACOS_LOGIN_EMPTY_RESP_ERR(HttpStatus.BAD_GATEWAY, Category.META_COM_ERR, "Nacos didn't return accessToken. Please check Nacos status."), ; // error code private final HttpStatus code; // error type - private final Types type; + private final Category category; // error message private final String desc; - Errors(HttpStatus code, Types type, String desc) { + Status(HttpStatus code, Category category, String desc) { this.code = code; - this.type = type; + this.category = category; this.desc = desc; } @Override public String toString() { - return name() + " of " + type + COLON + desc; + return name() + " of " + category + COLON + desc; } @Getter - public enum Types { + public enum Category { SUCCESS("Successfully received and processed"), @@ -84,7 +84,7 @@ public enum Types { */ private final String desc; - Types(String desc) { + Category(String desc) { this.desc = desc; } } diff --git a/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/exception/BaseException.java b/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/exception/BaseException.java index db2e3fd501..dfaee05550 100644 --- a/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/exception/BaseException.java +++ b/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/exception/BaseException.java @@ -17,10 +17,10 @@ package org.apache.eventmesh.admin.exception; -import static org.apache.eventmesh.admin.common.ConfigConst.COLON; +import static org.apache.eventmesh.admin.constant.ConfigConst.COLON; -import org.apache.eventmesh.admin.enums.Errors; -import org.apache.eventmesh.admin.utils.ExceptionUtils; +import org.apache.eventmesh.admin.enums.Status; +import org.apache.eventmesh.admin.util.ExceptionUtil; import lombok.Getter; @@ -33,7 +33,7 @@ public class BaseException extends RuntimeException { private static final long serialVersionUID = 3509261993355721168L; - private Errors errors; + private Status status; public BaseException(String message) { super(message); @@ -42,13 +42,13 @@ public BaseException(String message) { /** * Customized error reporting using enums and exceptions */ - public BaseException(Errors errors, Throwable cause) { - super(ExceptionUtils.trimDesc(errors.getDesc()) + COLON + cause.getMessage(), cause); - this.errors = errors; + public BaseException(Status status, Throwable cause) { + super(ExceptionUtil.trimDesc(status.getDesc()) + COLON + cause.getMessage(), cause); + this.status = status; } - public BaseException(Errors errors) { - super(errors.getDesc()); - this.errors = errors; + public BaseException(Status status) { + super(status.getDesc()); + this.status = status; } } diff --git a/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/exception/EventMeshAdminException.java b/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/exception/EventMeshAdminException.java index 3847f680cc..00feec5dbf 100644 --- a/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/exception/EventMeshAdminException.java +++ b/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/exception/EventMeshAdminException.java @@ -17,7 +17,7 @@ package org.apache.eventmesh.admin.exception; -import org.apache.eventmesh.admin.enums.Errors; +import org.apache.eventmesh.admin.enums.Status; /** * EventMeshAdmin Application side exception @@ -34,7 +34,7 @@ public EventMeshAdminException(String message) { /** * Customized error reporting using enums and exceptions */ - public EventMeshAdminException(Errors errors, Throwable cause) { - super(errors, cause); + public EventMeshAdminException(Status status, Throwable cause) { + super(status, cause); } } diff --git a/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/exception/GlobalExceptionHandler.java b/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/exception/GlobalExceptionHandler.java index a54e17a58c..814fe0f6bd 100644 --- a/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/exception/GlobalExceptionHandler.java +++ b/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/exception/GlobalExceptionHandler.java @@ -18,7 +18,7 @@ package org.apache.eventmesh.admin.exception; import org.apache.eventmesh.admin.dto.Result; -import org.apache.eventmesh.admin.dto.Result.Message; +import org.apache.eventmesh.admin.dto.Result.StatusMessage; import javax.servlet.http.HttpServletRequest; @@ -29,7 +29,7 @@ import lombok.extern.slf4j.Slf4j; /** - * This class, in conjunction with {@linkplain org.apache.eventmesh.admin.enums.Errors Errors} and {@link BaseException}, + * This class, in conjunction with {@linkplain org.apache.eventmesh.admin.enums.Status Status} and {@link BaseException}, * collectively implements customized error reporting. */ @@ -40,8 +40,9 @@ public class GlobalExceptionHandler { @ExceptionHandler(BaseException.class) public ResponseEntity> baseHandler(BaseException e, HttpServletRequest request) { String uri = request.getRequestURI(); - log.error("RESTful API {} service error occurred, name: {}, type: {}", uri, e.getErrors().name(), e.getErrors().getType().name(), e); - return ResponseEntity.status(e.getErrors().getCode()).body(new Result<>(new Message(e))); + log.error("RESTful API {} service error occurred, name: {}, category: {}", + uri, e.getStatus().name(), e.getStatus().getCategory().name(), e); + return ResponseEntity.status(e.getStatus().getCode()).body(new Result<>(new StatusMessage(e))); } @ExceptionHandler(RuntimeException.class) diff --git a/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/exception/MetaException.java b/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/exception/MetaException.java index 9302102466..2028eae387 100644 --- a/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/exception/MetaException.java +++ b/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/exception/MetaException.java @@ -17,7 +17,7 @@ package org.apache.eventmesh.admin.exception; -import org.apache.eventmesh.admin.enums.Errors; +import org.apache.eventmesh.admin.enums.Status; /** * Meta side exception with EventMeshAdmin Application @@ -34,11 +34,11 @@ public MetaException(String message) { /** * Customized error reporting using enums and exceptions */ - public MetaException(Errors errors, Throwable cause) { - super(errors, cause); + public MetaException(Status status, Throwable cause) { + super(status, cause); } - public MetaException(Errors errors) { - super(errors); + public MetaException(Status status) { + super(status); } } diff --git a/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/service/impl/NacosSubscriptionService.java b/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/service/impl/NacosSubscriptionService.java index 29241d31c3..282dab135b 100644 --- a/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/service/impl/NacosSubscriptionService.java +++ b/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/service/impl/NacosSubscriptionService.java @@ -17,15 +17,15 @@ package org.apache.eventmesh.admin.service.impl; -import static org.apache.eventmesh.admin.enums.Errors.NACOS_EMPTY_RESP_ERR; -import static org.apache.eventmesh.admin.enums.Errors.NACOS_GET_CONFIGS_ERR; -import static org.apache.eventmesh.admin.enums.Errors.NACOS_LOGIN_EMPTY_RESP_ERR; -import static org.apache.eventmesh.admin.enums.Errors.NACOS_LOGIN_ERR; -import static org.apache.eventmesh.admin.enums.Errors.NACOS_SDK_CONFIG_ERR; - -import org.apache.eventmesh.admin.common.ConfigConst; -import org.apache.eventmesh.admin.common.NacosConst; +import static org.apache.eventmesh.admin.enums.Status.NACOS_EMPTY_RESP_ERR; +import static org.apache.eventmesh.admin.enums.Status.NACOS_GET_CONFIGS_ERR; +import static org.apache.eventmesh.admin.enums.Status.NACOS_LOGIN_EMPTY_RESP_ERR; +import static org.apache.eventmesh.admin.enums.Status.NACOS_LOGIN_ERR; +import static org.apache.eventmesh.admin.enums.Status.NACOS_SDK_CONFIG_ERR; + import org.apache.eventmesh.admin.config.AdminProperties; +import org.apache.eventmesh.admin.constant.ConfigConst; +import org.apache.eventmesh.admin.constant.NacosConst; import org.apache.eventmesh.admin.dto.Result; import org.apache.eventmesh.admin.exception.EventMeshAdminException; import org.apache.eventmesh.admin.exception.MetaException; diff --git a/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/utils/ExceptionUtils.java b/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/util/ExceptionUtil.java similarity index 94% rename from eventmesh-admin/src/main/java/org/apache/eventmesh/admin/utils/ExceptionUtils.java rename to eventmesh-admin/src/main/java/org/apache/eventmesh/admin/util/ExceptionUtil.java index 1069e082fd..db82be63f7 100644 --- a/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/utils/ExceptionUtils.java +++ b/eventmesh-admin/src/main/java/org/apache/eventmesh/admin/util/ExceptionUtil.java @@ -15,9 +15,9 @@ * limitations under the License. */ -package org.apache.eventmesh.admin.utils; +package org.apache.eventmesh.admin.util; -public class ExceptionUtils { +public class ExceptionUtil { /** * Remove the last period of exception description.