Improve exception handling.

Author: Anton Hrytsenko

pom.xml

@@ -5,7 +5,7 @@
 
     <groupId>com.github.hrytsenko</groupId>
     <artifactId>json-data-spring-boot</artifactId>
-    <version>0.2.1</version>
+    <version>0.3.0</version>
 
     <url>https://github.com/hrytsenko/json-data-spring-boot</url>
     <inceptionYear>2020</inceptionYear>

src/main/java/com/github/hrytsenko/jsondata/springboot/error/ExceptionAdvice.java

@@ -0,0 +1,86 @@
+/*
+ * Copyright (C) 2020 Anton Hrytsenko
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.github.hrytsenko.jsondata.springboot.error;
+
+import com.github.hrytsenko.jsondata.JsonBean;
+import lombok.AllArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.core.annotation.Order;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.MediaType;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.bind.annotation.RestControllerAdvice;
+
+@RestControllerAdvice
+@Order
+@Slf4j
+@AllArgsConstructor
+class ExceptionAdvice {
+
+    CorrelationSource correlationSource;
+
+    @ExceptionHandler(Exception.class)
+    ResponseEntity<?> onUnexpectedError(Exception exception) {
+        log.error("Unexpected error", exception);
+        return errorResponse(HttpStatus.INTERNAL_SERVER_ERROR, "INTERNAL_ERROR");
+    }
+
+    @ExceptionHandler(ServiceException.BadRequest.class)
+    ResponseEntity<?> onBadRequest(ServiceException.BadRequest exception) {
+        log.error("Bad request", exception);
+        return errorResponse(HttpStatus.BAD_REQUEST, exception.getCode());
+    }
+
+    @ExceptionHandler(ServiceException.Unauthorized.class)
+    ResponseEntity<?> onUnauthorized(ServiceException.Unauthorized exception) {
+        log.error("Unauthorized", exception);
+        return errorResponse(HttpStatus.UNAUTHORIZED, exception.getCode());
+    }
+
+    @ExceptionHandler(ServiceException.Forbidden.class)
+    ResponseEntity<?> onForbidden(ServiceException.Forbidden exception) {
+        log.error("Forbidden", exception);
+        return errorResponse(HttpStatus.FORBIDDEN, exception.getCode());
+    }
+
+    @ExceptionHandler(ServiceException.NotFound.class)
+    ResponseEntity<?> onNotFound(ServiceException.NotFound exception) {
+        log.error("Not found", exception);
+        return errorResponse(HttpStatus.NOT_FOUND, exception.getCode());
+    }
+
+    @ExceptionHandler(ServiceException.InternalError.class)
+    ResponseEntity<?> onInternalError(ServiceException.InternalError exception) {
+        log.error("Internal error", exception);
+        return errorResponse(HttpStatus.INTERNAL_SERVER_ERROR, exception.getCode());
+    }
+
+    @ExceptionHandler(ServiceException.ServiceUnavailable.class)
+    ResponseEntity<?> onServiceUnavailable(ServiceException.ServiceUnavailable exception) {
+        log.error("Service unavailable", exception);
+        return errorResponse(HttpStatus.SERVICE_UNAVAILABLE, exception.getCode());
+    }
+
+    private ResponseEntity<?> errorResponse(HttpStatus status, String code) {
+        return ResponseEntity.status(status)
+                .contentType(MediaType.APPLICATION_JSON)
+                .body(new JsonBean()
+                        .putString("error.correlation", correlationSource.getCorrelation())
+                        .putString("error.code", code));
+    }
+
+}

src/main/java/com/github/hrytsenko/jsondata/springboot/error/ExceptionAdvices.java

@@ -17,15 +17,14 @@
 
 import com.github.hrytsenko.jsondata.JsonEntity;
 import com.github.hrytsenko.jsondata.JsonValidatorException;
+import com.github.hrytsenko.jsondata.springboot.error.ServiceException;
 import lombok.AllArgsConstructor;
 import org.aspectj.lang.JoinPoint;
 import org.aspectj.lang.annotation.Aspect;
 import org.aspectj.lang.annotation.Before;
 import org.springframework.context.annotation.Configuration;
-import org.springframework.core.annotation.Order;
 
 @Aspect
-@Order(0)
 @Configuration
 @AllArgsConstructor
 class ValidateRequestAspect {
@@ -41,7 +40,7 @@ void handle(JoinPoint point, ValidateRequest config) {
             validatorSource.getValidator(schemaName)
                     .validate(target);
         } catch (JsonValidatorException exception) {
-            throw new ValidateRequestException("Invalid request " + schemaName, exception);
+            throw new ServiceException.BadRequest("INVALID_REQUEST", exception);
         }
     }
 

src/main/java/com/github/hrytsenko/jsondata/springboot/web/ValidateRequestAspect.java

@@ -17,16 +17,15 @@
 
 import com.github.hrytsenko.jsondata.JsonEntity;
 import com.github.hrytsenko.jsondata.JsonValidatorException;
+import com.github.hrytsenko.jsondata.springboot.error.ServiceException;
 import lombok.AllArgsConstructor;
 import lombok.SneakyThrows;
 import org.aspectj.lang.ProceedingJoinPoint;
 import org.aspectj.lang.annotation.Around;
 import org.aspectj.lang.annotation.Aspect;
 import org.springframework.context.annotation.Configuration;
-import org.springframework.core.annotation.Order;
 
 @Aspect
-@Order(0)
 @Configuration
 @AllArgsConstructor
 class ValidateResponseAspect {
@@ -43,7 +42,7 @@ Object handle(ProceedingJoinPoint point, ValidateResponse config) {
             validatorSource.getValidator(config.value())
                     .validate(target);
         } catch (JsonValidatorException exception) {
-            throw new ValidateResponseException("Invalid response " + schemaName, exception);
+            throw new ServiceException.InternalError("INVALID_RESPONSE", exception);
         }
 
         return target;