improve message bundle and add messageContainer and message for unified message around the app

PouyaPouryaie · PouyaPouryaie · commit ac977c8a20a1 · 2022-07-28T15:57:13.000+04:30
diff --git a/src/main/java/ir/bigz/springbootreal/commons/util/Utils.java b/src/main/java/ir/bigz/springbootreal/commons/util/Utils.java
@@ -121,7 +121,7 @@ public static List<Sort.Order> getSortOrderFromPagedQuery(PagedQuery pagedQuery,
                         orders.add(order);
                     }catch (Exception e){
                         throw AppException.newInstance(
-                                HttpErrorCode.ERR_10705, String.format("field %s ordering is wrong", orderParam)
+                                HttpErrorCode.CREATE_QUERY_ERROR, String.format("field %s ordering is wrong", orderParam)
                         );
                     }
                 }
diff --git a/src/main/java/ir/bigz/springbootreal/controller/AbstractController.java b/src/main/java/ir/bigz/springbootreal/controller/AbstractController.java
@@ -1,12 +1,22 @@
 package ir.bigz.springbootreal.controller;
 
+import ir.bigz.springbootreal.commons.util.Utils;
 import ir.bigz.springbootreal.dto.PagedQuery;
+import ir.bigz.springbootreal.exception.ExceptionType;
+import ir.bigz.springbootreal.exception.HttpExceptionModel;
+import ir.bigz.springbootreal.messages.MessageContainer;
+import org.springframework.context.MessageSource;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.MediaType;
+import org.springframework.http.ResponseEntity;
 import org.springframework.web.context.request.RequestContextHolder;
 import org.springframework.web.context.request.ServletRequestAttributes;
 
 import javax.servlet.http.HttpServletRequest;
 import java.util.HashMap;
+import java.util.Locale;
 import java.util.Map;
+import java.util.Objects;
 import java.util.stream.Collectors;
 
 public abstract class AbstractController {
@@ -42,4 +52,25 @@ protected Map<String, String> getUnlimitedSizeParam() {
             }
         };
     }
+
+    protected ResponseEntity<?> getSuccessMessage(MessageSource messageSource, MessageContainer messageContainer, Locale locale) {
+        return ResponseEntity.status(HttpStatus.OK)
+                .headers(httpHeaders -> httpHeaders.set("Content-Type", MediaType.APPLICATION_JSON_VALUE + "; charset=utf-8"))
+                .body(messageSource.getMessage(messageContainer.getMessages().get(0).getMessageKey(),
+                        messageContainer.getMessages().get(0).getMessageParams(), Objects.nonNull(locale) ? locale : Locale.getDefault()));
+    }
+
+    protected ResponseEntity<?> getErrorMessage(MessageSource messageSource, ExceptionType exceptionType, Object[] messageParams) {
+        return ResponseEntity.status(exceptionType.getHttpStatus())
+                .headers(httpHeaders -> httpHeaders.set("Content-Type", MediaType.APPLICATION_JSON_VALUE + "; charset=utf-8"))
+                .body(getErrorModelResponse(exceptionType, messageSource, messageParams));
+    }
+
+    private HttpExceptionModel getErrorModelResponse(ExceptionType exceptionType, MessageSource messageSource, Object... messageParams) {
+        return HttpExceptionModel.builder()
+                .errorCode(exceptionType.getErrorCode())
+                .message(messageSource.getMessage(exceptionType.getReasonMessage(), messageParams, Locale.getDefault()))
+                .timestamp(Utils.getTimestampNow().toString())
+                .build();
+    }
 }
diff --git a/src/main/java/ir/bigz/springbootreal/controller/SampleController.java b/src/main/java/ir/bigz/springbootreal/controller/SampleController.java
@@ -1,6 +1,7 @@
 package ir.bigz.springbootreal.controller;
 
 import ir.bigz.springbootreal.dto.PageResult;
+import ir.bigz.springbootreal.messages.MessageContainer;
 import ir.bigz.springbootreal.service.UserService;
 import ir.bigz.springbootreal.viewmodel.UserModel;
 import ir.bigz.springbootreal.viewmodel.search.UserSearchDto;
@@ -47,7 +48,9 @@ public ResponseEntity<?> getErrorMessage(
     public ResponseEntity<?> getLocaleMessage(
             @RequestHeader(name = "Accept-Language", required = false) final Locale locale,
             @RequestParam(name = "username", defaultValue = "Java Geek", required = false) final String username) {
-        return ResponseEntity.ok(source.getMessage("welcome.message", new Object[]{username}, locale));
+        MessageContainer messageContainer = MessageContainer.create();
+        messageContainer.add("welcome.message", new Object[]{username});
+        return getSuccessMessage(source, messageContainer, locale);
     }
 
 
diff --git a/src/main/java/ir/bigz/springbootreal/dal/DaoRepositoryImpl.java b/src/main/java/ir/bigz/springbootreal/dal/DaoRepositoryImpl.java
@@ -173,7 +173,7 @@ public PageResult<T> pageCreateQuery(String nativeQuery, PagedQuery pagedQuery,
                         orderString.append(orderColumn + " " + order);
                     }catch (Exception e){
                         throw AppException.newInstance(
-                                HttpErrorCode.ERR_10705, String.format("field %s ordering is wrong", orderParam)
+                                HttpErrorCode.CREATE_QUERY_ERROR, String.format("field %s ordering is wrong", orderParam)
                         );
                     }
                 }
diff --git a/src/main/java/ir/bigz/springbootreal/exception/AppException.java b/src/main/java/ir/bigz/springbootreal/exception/AppException.java
@@ -26,11 +26,11 @@ static public AppException newInstance(HttpStatus status, String message, Throwa
     }
 
     static public AppException newInstance(HttpErrorCode errorCode, String message, Throwable cause) {
-        return new AppException(errorCode.getStatus(), message, cause, errorCode, null);
+        return new AppException(errorCode.getHttpStatus(), message, cause, errorCode, null);
     }
 
     static public AppException newInstance(HttpErrorCode errorCode, String detail) {
-        return new AppException(errorCode.getStatus(), null, null, errorCode, detail);
+        return new AppException(errorCode.getHttpStatus(), null, null, errorCode, detail);
     }
 
 
diff --git a/src/main/java/ir/bigz/springbootreal/exception/CustomExceptionType.java b/src/main/java/ir/bigz/springbootreal/exception/CustomExceptionType.java
@@ -0,0 +1,15 @@
+package ir.bigz.springbootreal.exception;
+
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Getter;
+import org.springframework.http.HttpStatus;
+
+@Getter
+@AllArgsConstructor
+@Builder
+public class CustomExceptionType implements ExceptionType{
+    HttpStatus httpStatus;
+    int errorCode;
+    String reasonMessage;
+}
diff --git a/src/main/java/ir/bigz/springbootreal/exception/ExceptionType.java b/src/main/java/ir/bigz/springbootreal/exception/ExceptionType.java
@@ -0,0 +1,9 @@
+package ir.bigz.springbootreal.exception;
+
+import org.springframework.http.HttpStatus;
+
+public interface ExceptionType {
+    HttpStatus getHttpStatus();
+    int getErrorCode();
+    String getReasonMessage();
+}
diff --git a/src/main/java/ir/bigz/springbootreal/exception/HttpErrorCode.java b/src/main/java/ir/bigz/springbootreal/exception/HttpErrorCode.java
@@ -2,34 +2,37 @@
 
 import org.springframework.http.HttpStatus;
 
-public enum HttpErrorCode {
-
-    ERR_10700	(10700, "Invalid Entity For Persist", HttpStatus.BAD_REQUEST),
-    ERR_10701	(10701, "process of the request has been error", HttpStatus.BAD_REQUEST),
-    ERR_10702	(10702, "User Not Found", HttpStatus.NOT_FOUND),
-    ERR_10703	(10703, "Invalid Entity For Update", HttpStatus.BAD_REQUEST),
-    ERR_10704	(10704, "validation Error", HttpStatus.BAD_REQUEST),
-    ERR_10705	(10705, "create query process has been error", HttpStatus.BAD_REQUEST);
-
-    private final int code;
-    private final HttpStatus status;
-    private final String reason;
-
-    HttpErrorCode(int code, String reason, HttpStatus status) {
-        this.code = code;
-        this.status = status;
-        this.reason = reason;
+public enum HttpErrorCode implements ExceptionType{
+
+    INVALID_ENTITY_FOR_INSERT  (10700, "invalid_entity_for_insert", HttpStatus.BAD_REQUEST),
+    INTERNAL_ERROR             (10701, "internal_server_error", HttpStatus.INTERNAL_SERVER_ERROR),
+    USER_NOT_FOUND             (10702, "user_not_found", HttpStatus.NOT_FOUND),
+    INVALID_ENTITY_FOR_UPDATE  (10703, "invalid_entity_for_update", HttpStatus.BAD_REQUEST),
+    VALIDATION_ERROR           (10704, "validation_error", HttpStatus.BAD_REQUEST),
+    CREATE_QUERY_ERROR         (10705, "create_query_error", HttpStatus.BAD_REQUEST);
+
+    private final CustomExceptionType customExceptionType;
+
+    HttpErrorCode(int errorCode, String reasonMessage, HttpStatus httpStatus) {
+        this.customExceptionType = new CustomExceptionType(httpStatus, errorCode, reasonMessage);
+    }
+
+    @Override
+    public HttpStatus getHttpStatus() {
+        return this.customExceptionType.httpStatus;
     }
 
-    public int getCode() {
-        return code;
+    @Override
+    public int getErrorCode() {
+        return this.customExceptionType.errorCode;
     }
 
-    public HttpStatus getStatus() {
-        return status;
+    @Override
+    public String getReasonMessage() {
+        return this.customExceptionType.reasonMessage;
     }
 
-    public String getReason() {
-        return reason;
+    public CustomExceptionType getCustomExceptionType() {
+        return customExceptionType;
     }
 }
diff --git a/src/main/java/ir/bigz/springbootreal/exception/HttpExceptionHandler.java b/src/main/java/ir/bigz/springbootreal/exception/HttpExceptionHandler.java
@@ -8,18 +8,20 @@
 import java.time.ZoneId;
 import java.time.ZonedDateTime;
 import java.time.format.DateTimeFormatter;
+import java.util.UUID;
 
 @ControllerAdvice
 public class HttpExceptionHandler {
 
     @ExceptionHandler(value = {AppException.class})
     public ResponseEntity<Object> handleApiRequestException(AppException e){
+        UUID uuid = UUID.randomUUID();
 
-        HttpExceptionModel apiException = new HttpExceptionModel(e.getDetail(),
-                e.getHttpErrorCode(),
+        HttpExceptionModel apiException = new HttpExceptionModel(uuid.toString(),
+                e.getHttpErrorCode().getErrorCode(),  e.getDetail(),
                 timeLog(), null);
 
-        return new ResponseEntity<>(apiException, e.getHttpErrorCode().getStatus());
+        return new ResponseEntity<>(apiException, e.getHttpErrorCode().getHttpStatus());
     }
 
     private String timeLog(){
diff --git a/src/main/java/ir/bigz/springbootreal/exception/HttpExceptionModel.java b/src/main/java/ir/bigz/springbootreal/exception/HttpExceptionModel.java
@@ -10,8 +10,9 @@
 @Builder
 public class HttpExceptionModel {
 
+    private String uuid;
+    private final int errorCode;
     private final String message;
-    private final HttpErrorCode httpErrorCode;
     private final String timestamp;
     private final ValidationErrorResponseModel validationError;
 }
diff --git a/src/main/java/ir/bigz/springbootreal/exception/validation/ErrorController.java b/src/main/java/ir/bigz/springbootreal/exception/validation/ErrorController.java
@@ -33,10 +33,10 @@ protected ResponseEntity<Object> handleMethodArgumentNotValid(MethodArgumentNotV
             errors.put(fieldName, errorMessage);
         });
 
-        return ResponseEntity.status(HttpErrorCode.ERR_10704.getStatus())
+        return ResponseEntity.status(HttpErrorCode.VALIDATION_ERROR.getHttpStatus())
                 .body(HttpExceptionModel.builder()
-                        .httpErrorCode(HttpErrorCode.ERR_10704)
-                        .message(HttpErrorCode.ERR_10704.getReason())
+                        .errorCode(HttpErrorCode.VALIDATION_ERROR.getErrorCode())
+                        .message(HttpErrorCode.VALIDATION_ERROR.getReasonMessage())
                         .timestamp(timeLog())
                         .validationError(ValidationErrorResponseModel.builder()
                                 .errors(errors)
diff --git a/src/main/java/ir/bigz/springbootreal/messages/Message.java b/src/main/java/ir/bigz/springbootreal/messages/Message.java
@@ -0,0 +1,17 @@
+package ir.bigz.springbootreal.messages;
+
+import lombok.Builder;
+import lombok.Getter;
+
+@Getter
+@Builder
+public class Message {
+
+    private final String messageKey;
+    private final Object[] messageParams;
+
+    public Message(String messageKey, Object... messageParams) {
+        this.messageKey = messageKey;
+        this.messageParams = messageParams;
+    }
+}
diff --git a/src/main/java/ir/bigz/springbootreal/messages/MessageContainer.java b/src/main/java/ir/bigz/springbootreal/messages/MessageContainer.java
@@ -0,0 +1,83 @@
+package ir.bigz.springbootreal.messages;
+
+import java.util.ArrayList;
+import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.Map;
+
+public class MessageContainer {
+
+    private final Map<String, List<Message>> messages;
+    public static final String GLOBAL_MESSAGE =
+            "GLOBAL_MESSAGE";
+    public static final String ERROR_MESSAGE =
+            "ERROR_MESSAGE";
+
+    private MessageContainer() {
+        messages = new LinkedHashMap<>();
+        messages.put(GLOBAL_MESSAGE, new ArrayList());
+        messages.put(ERROR_MESSAGE, new ArrayList());
+    }
+
+    public static MessageContainer create() {
+        return new MessageContainer();
+    }
+
+    public MessageContainer add(String messageKey, Object... messageParams) {
+        return add(new Message(messageKey, messageParams));
+    }
+
+    public MessageContainer add(String property, String messageKey, Object... messageParams) {
+        return add(property, new Message(messageKey, messageParams));
+    }
+
+    public MessageContainer addError(String messageKey, Object... messageParams) {
+        return addError(new Message(messageKey, messageParams));
+    }
+
+    public MessageContainer add(Message message) {
+        messages.get(GLOBAL_MESSAGE).add(message);
+        return this;
+    }
+
+    public MessageContainer add(String property, Message message) {
+        if(!messages.containsKey(property)) {
+            messages.put(property, new ArrayList());
+        }
+        messages.get(property).add(message);
+        return this;
+    }
+
+    public MessageContainer addError(Message message) {
+        messages.get(ERROR_MESSAGE).add(message);
+        return this;
+    }
+
+    public List<Message> getMessages() {
+        return messages.keySet().stream()
+                .map(k -> messages.get(k))
+                .collect(ArrayList::new, List::addAll, List::addAll);
+    }
+
+    public List<Message> getErrorMessages() {
+        return messages.get(ERROR_MESSAGE);
+    }
+
+    public List<Message> getGlobalMessages() {
+        return messages.get(GLOBAL_MESSAGE);
+    }
+
+    public List<Message> getMessages(String key) {
+        return messages.containsKey(key) ? messages.get(key) : new ArrayList();
+    }
+
+    public int errorSize() {
+        return messages.get(ERROR_MESSAGE).size();
+    }
+
+    public int size() {
+        return messages.keySet().stream()
+                .map(k -> messages.get(k).size())
+                .reduce(0, Integer::sum);
+    }
+}
diff --git a/src/main/java/ir/bigz/springbootreal/service/UserServiceImpl.java b/src/main/java/ir/bigz/springbootreal/service/UserServiceImpl.java
diff --git a/src/main/resources/lang/error/code_en.properties b/src/main/resources/lang/error/code_en.properties
diff --git a/src/main/resources/lang/messages_fa.properties b/src/main/resources/lang/messages_fa.properties

Original file line number	Diff line number	Diff line change
`@@ -121,7 +121,7 @@ public static List<Sort.Order> getSortOrderFromPagedQuery(PagedQuery pagedQuery,`
`121`	`121`	`orders.add(order);`
`122`	`122`	`}catch (Exception e){`
`123`	`123`	`throw AppException.newInstance(`
`124`		`- HttpErrorCode.ERR_10705, String.format("field %s ordering is wrong", orderParam)`
	`124`	`+ HttpErrorCode.CREATE_QUERY_ERROR, String.format("field %s ordering is wrong", orderParam)`
`125`	`125`	`);`
`126`	`126`	`}`
`127`	`127`	`}`
Original file line number	Diff line number	Diff line change
`@@ -173,7 +173,7 @@ public PageResult<T> pageCreateQuery(String nativeQuery, PagedQuery pagedQuery,`
`173`	`173`	`orderString.append(orderColumn + " " + order);`
`174`	`174`	`}catch (Exception e){`
`175`	`175`	`throw AppException.newInstance(`
`176`		`- HttpErrorCode.ERR_10705, String.format("field %s ordering is wrong", orderParam)`
	`176`	`+ HttpErrorCode.CREATE_QUERY_ERROR, String.format("field %s ordering is wrong", orderParam)`
`177`	`177`	`);`
`178`	`178`	`}`
`179`	`179`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,11 +26,11 @@ static public AppException newInstance(HttpStatus status, String message, Throwa`
`26`	`26`	`}`
`27`	`27`
`28`	`28`	`static public AppException newInstance(HttpErrorCode errorCode, String message, Throwable cause) {`
`29`		`- return new AppException(errorCode.getStatus(), message, cause, errorCode, null);`
	`29`	`+ return new AppException(errorCode.getHttpStatus(), message, cause, errorCode, null);`
`30`	`30`	`}`
`31`	`31`
`32`	`32`	`static public AppException newInstance(HttpErrorCode errorCode, String detail) {`
`33`		`- return new AppException(errorCode.getStatus(), null, null, errorCode, detail);`
	`33`	`+ return new AppException(errorCode.getHttpStatus(), null, null, errorCode, detail);`
`34`	`34`	`}`
`35`	`35`
`36`	`36`