validation feature:

add validation-error message to AppLogAspect . unify ErrorMessage for validation and appException

Author: PouyaPouryaie

src/main/java/ir/bigz/springbootreal/SpringbootRealApplication.java

@@ -9,7 +9,6 @@
 import org.springframework.transaction.annotation.EnableTransactionManagement;
 
 //TODO add pagination to dao
-//TODO add validation
 //TODO complex model
 
 @SpringBootApplication(exclude = {

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

@@ -1,11 +1,10 @@
 package ir.bigz.springbootreal.commons.generallog;
 
+import com.fasterxml.jackson.databind.ObjectMapper;
 import ir.bigz.springbootreal.exception.AppException;
+import ir.bigz.springbootreal.exception.HttpExceptionModel;
 import org.aspectj.lang.JoinPoint;
-import org.aspectj.lang.annotation.AfterReturning;
-import org.aspectj.lang.annotation.AfterThrowing;
-import org.aspectj.lang.annotation.Aspect;
-import org.aspectj.lang.annotation.Before;
+import org.aspectj.lang.annotation.*;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.http.ResponseEntity;
@@ -43,4 +42,13 @@ public void logAfterThrowException(JoinPoint joinPoint, AppException exception){
         LOG.info("exception method: {} | errorCode: {} | message: {}",
                 methodName, exception.getHttpErrorCode(), exception.getDetail());
     }
+
+    @AfterReturning(value = "execution(* ir.bigz.springbootreal.exception.validation.ErrorController.*(..))", returning = "object")
+    public void logAfterThrowValidationException(JoinPoint joinPoint, Object object){
+        HttpExceptionModel httpExceptionModel = (HttpExceptionModel) ((ResponseEntity) object).getBody();
+        LOG.info("validation exception path: {} | errorCode: {} | errors: {}",
+                httpExceptionModel.getValidationError().getPath(),
+                httpExceptionModel.getHttpErrorCode(),
+                httpExceptionModel.getValidationError().getErrors());
+    }
 }

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

@@ -7,7 +7,8 @@ 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_10703	(10703, "Invalid Entity For Update", HttpStatus.BAD_REQUEST),
+    ERR_10704	(10704, "validation Error", HttpStatus.BAD_REQUEST);
 
     private final int code;
     private final HttpStatus status;

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

@@ -17,7 +17,7 @@ public ResponseEntity<Object> handleApiRequestException(AppException e){
 
         HttpExceptionModel apiException = new HttpExceptionModel(e.getDetail(),
                 e.getHttpErrorCode(),
-                timeLog());
+                timeLog(), null);
 
         return new ResponseEntity<>(apiException, e.getHttpErrorCode().getStatus());
     }

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

@@ -1,28 +1,17 @@
 package ir.bigz.springbootreal.exception;
 
-import java.time.ZonedDateTime;
+import ir.bigz.springbootreal.exception.validation.ValidationErrorResponseModel;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Getter;
 
+@Getter
+@AllArgsConstructor
+@Builder
 public class HttpExceptionModel {
 
     private final String message;
     private final HttpErrorCode httpErrorCode;
     private final String timestamp;
-
-    public HttpExceptionModel(String message, HttpErrorCode httpErrorCode, String timestamp) {
-        this.message = message;
-        this.httpErrorCode = httpErrorCode;
-        this.timestamp = timestamp;
-    }
-
-    public String getMessage() {
-        return message;
-    }
-
-    public HttpErrorCode getHttpErrorCode() {
-        return httpErrorCode;
-    }
-
-    public String getTimestamp() {
-        return timestamp;
-    }
+    private final ValidationErrorResponseModel validationError;
 }

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

@@ -1,5 +1,7 @@
 package ir.bigz.springbootreal.exception.validation;
 
+import ir.bigz.springbootreal.exception.HttpErrorCode;
+import ir.bigz.springbootreal.exception.HttpExceptionModel;
 import org.springframework.http.HttpHeaders;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
@@ -26,20 +28,23 @@ protected ResponseEntity<Object> handleMethodArgumentNotValid(MethodArgumentNotV
 
         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 ResponseEntity.status(HttpStatus.BAD_REQUEST).body(ErrorResponseModel.builder()
-                    .errors(errors)
-                    .timestamp(timeLog())
-                    .path(request.getDescription(false)).build());
+            String fieldName = ((FieldError) error).getField();
+            String errorMessage = error.getDefaultMessage();
+            errors.put(fieldName, errorMessage);
+        });
+
+        return ResponseEntity.status(HttpErrorCode.ERR_10704.getStatus())
+                .body(HttpExceptionModel.builder()
+                        .httpErrorCode(HttpErrorCode.ERR_10704)
+                        .message(HttpErrorCode.ERR_10704.getReason())
+                        .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);
     }

…ption/validation/ErrorResponseModel.java …dation/ValidationErrorResponseModel.javasrc/main/java/ir/bigz/springbootreal/exception/validation/ErrorResponseModel.java renamed to src/main/java/ir/bigz/springbootreal/exception/validation/ValidationErrorResponseModel.java src/main/java/ir/bigz/springbootreal/exception/validation/ErrorResponseModel.java renamed to src/main/java/ir/bigz/springbootreal/exception/validation/ValidationErrorResponseModel.java

@@ -7,9 +7,8 @@
 
 @Getter
 @Builder
-public class ErrorResponseModel {
+public class ValidationErrorResponseModel {
 
     private final Map<String, String> errors;
-    private final String timestamp;
     private final String path;
 }