message-bundle feature:

changes:
- use Locale Config to define bean for use message-source
- define message and messageContainer for use to send identical messageResponse for error or normal message
- some improve code

Author: PouyaPouryaie

src/main/java/ir/bigz/springbootreal/commons/generallog/AppLogAspect.java

@@ -54,7 +54,7 @@ public void logAfterThrowException(JoinPoint joinPoint, AppException exception){
                 methodName, exception.getSampleExceptionType().getErrorCode(), exception.getDetail());
     }
 
-    @AfterReturning(value = "execution(* ir.bigz.springbootreal.exception.validation.ErrorController.*(..))", returning = "object")
+    @AfterReturning(value = "@annotation(ir.bigz.springbootreal.validation.annotation.ValidationLogResponseHandled)", returning = "object")
     public void logAfterThrowValidationException(JoinPoint joinPoint, Object object){
         HttpExceptionModel httpExceptionModel = (HttpExceptionModel) ((ResponseEntity) object).getBody();
         LOG.info("validation exception path: {} | errorCode: {} | errors: {}",

src/main/java/ir/bigz/springbootreal/controller/AbstractController.java

@@ -13,10 +13,7 @@
 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.*;
 import java.util.stream.Collectors;
 
 public abstract class AbstractController {
@@ -66,6 +63,7 @@ protected ResponseEntity<?> getErrorMessage(MessageSource messageSource, Excepti
 
     private HttpExceptionModel getErrorModelResponse(ExceptionType exceptionType, MessageSource messageSource, Locale locale, Object... messageParams) {
         return HttpExceptionModel.builder()
+                .uuid(UUID.randomUUID().toString())
                 .errorCode(exceptionType.getErrorCode())
                 .message(messageSource.getMessage(exceptionType.getReasonMessage(), messageParams, Objects.nonNull(locale) ? locale : Locale.getDefault()))
                 .timestamp(Utils.getTimestampNow().toString())

src/main/java/ir/bigz/springbootreal/exception/HttpExceptionHandler.java

@@ -1,32 +1,65 @@
 package ir.bigz.springbootreal.exception;
 
+import ir.bigz.springbootreal.validation.annotation.ValidationLogResponseHandled;
+import ir.bigz.springbootreal.exception.validation.ValidationErrorResponseModel;
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
-import org.springframework.web.bind.annotation.ControllerAdvice;
+import org.springframework.validation.FieldError;
+import org.springframework.web.bind.MethodArgumentNotValidException;
 import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.bind.annotation.RestControllerAdvice;
+import org.springframework.web.context.request.WebRequest;
+import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler;
 
 import java.time.ZoneId;
 import java.time.ZonedDateTime;
 import java.time.format.DateTimeFormatter;
+import java.util.HashMap;
+import java.util.Map;
 import java.util.UUID;
 
-@ControllerAdvice
-public class HttpExceptionHandler {
+@RestControllerAdvice
+public class HttpExceptionHandler extends ResponseEntityExceptionHandler {
 
     @ExceptionHandler(value = {AppException.class})
-    public ResponseEntity<Object> handleApiRequestException(AppException e){
+    public ResponseEntity<HttpExceptionModel> handleApiRequestException(AppException e) {
 
-        UUID uuid = UUID.randomUUID();
-        HttpExceptionModel apiException = new HttpExceptionModel(
-                uuid.toString(),
-                e.getSampleExceptionType().getErrorCode(),
-                e.getDetail(),
-                timeLog(),
-                null);
+        return ResponseEntity.status(e.getSampleExceptionType().getHttpStatus())
+                .body(HttpExceptionModel.builder()
+                        .uuid(UUID.randomUUID().toString())
+                        .errorCode(e.getSampleExceptionType().getErrorCode())
+                        .message(e.getDetail())
+                        .timestamp(timeLog()).build());
+    }
+
+    @Override
+    @ValidationLogResponseHandled
+    protected ResponseEntity<Object> handleMethodArgumentNotValid(MethodArgumentNotValidException ex,
+                                                                  HttpHeaders headers,
+                                                                  HttpStatus status,
+                                                                  WebRequest request) {
+
+        Map<String, String> errors = new HashMap<>();
+        ex.getBindingResult().getAllErrors().forEach((error) -> {
+            String fieldName = ((FieldError) error).getField();
+            String errorMessage = error.getDefaultMessage();
+            errors.put(fieldName, errorMessage);
+        });
 
-        return new ResponseEntity<>(apiException, e.getSampleExceptionType().getHttpStatus());
+        return ResponseEntity.status(SampleExceptionType.VALIDATION_ERROR.getHttpStatus())
+                .body(HttpExceptionModel.builder()
+                        .uuid(UUID.randomUUID().toString())
+                        .errorCode(SampleExceptionType.VALIDATION_ERROR.getErrorCode())
+                        .message(SampleExceptionType.VALIDATION_ERROR.getReasonMessage())
+                        .timestamp(timeLog())
+                        .validationError(ValidationErrorResponseModel.builder()
+                                .errors(errors)
+                                .path(request.getDescription(false))
+                                .build()).build());
     }
 
-    private String timeLog(){
+    private String timeLog() {
         DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyy/MM/dd - HH:mm:ss z");
         return ZonedDateTime.now(ZoneId.of("Asia/Tehran")).format(formatter);
     }

src/main/java/ir/bigz/springbootreal/exception/HttpExceptionModel.java

@@ -1,18 +1,22 @@
 package ir.bigz.springbootreal.exception;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import ir.bigz.springbootreal.exception.validation.ValidationErrorResponseModel;
 import lombok.AllArgsConstructor;
 import lombok.Builder;
 import lombok.Getter;
+import lombok.ToString;
 
 @Getter
 @AllArgsConstructor
 @Builder
+@ToString
 public class HttpExceptionModel {
 
     private String uuid;
     private final int errorCode;
     private final String message;
     private final String timestamp;
+    @JsonIgnore
     private final ValidationErrorResponseModel validationError;
 }

src/main/java/ir/bigz/springbootreal/exception/validation/ErrorController.java

@@ -0,0 +1,12 @@
+package ir.bigz.springbootreal.validation.annotation;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Target(ElementType.METHOD)
+@Retention(RetentionPolicy.RUNTIME)
+public @interface ValidationLogResponseHandled {
+
+}