[4기 - 김민희] SpringBoot Part3 WeeklyMission 제출합니다.

build.gradle

@@ -38,6 +38,19 @@ dependencies {
 
     //configuration
     annotationProcessor "org.springframework.boot:spring-boot-configuration-processor"
+
+    //web
+    implementation 'org.springframework.boot:spring-boot-starter-web'
+
+    //map struct
+    implementation 'org.mapstruct:mapstruct:1.5.5.Final'
+    annotationProcessor 'org.mapstruct:mapstruct-processor:1.5.5.Final'
+
+    //validation
+    implementation 'org.springframework.boot:spring-boot-starter-validation'
+
+    // ulid-creator
+    implementation group: 'com.github.f4b6a3', name: 'ulid-creator', version: '5.1.0'
 }
 
 tasks.named('test') {

src/main/java/org/programmers/VoucherManagement/global/entity/BaseTimeEntity.java

@@ -0,0 +1,19 @@
+package org.programmers.VoucherManagement.global.entity;
+
+import org.springframework.stereotype.Component;
+
+import java.time.LocalDateTime;
+import java.time.format.DateTimeFormatter;
+
+@Component
+public class BaseTimeEntity {
+    protected String createdAt;
+
+    public BaseTimeEntity() {
+        this.createdAt = LocalDateTime.now().format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss"));
+    }
+
+    public String getCreatedAt() {
+        return createdAt;
+    }
+}

src/main/java/org/programmers/VoucherManagement/global/exception/GlobalExceptionHandler.java

@@ -0,0 +1,123 @@
+package org.programmers.VoucherManagement.global.exception;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.programmers.VoucherManagement.global.response.ErrorCode;
+import org.programmers.VoucherManagement.global.response.ErrorResponse;
+import org.programmers.VoucherManagement.member.exception.MemberException;
+import org.programmers.VoucherManagement.voucher.exception.VoucherException;
+import org.programmers.VoucherManagement.wallet.exception.WalletException;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.validation.BindException;
+import org.springframework.web.bind.MethodArgumentNotValidException;
+import org.springframework.web.bind.MissingServletRequestParameterException;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.bind.annotation.RestControllerAdvice;
+import org.springframework.web.method.annotation.MethodArgumentTypeMismatchException;
+
+@RequiredArgsConstructor
+@RestControllerAdvice
+@Slf4j
+public class GlobalExceptionHandler {
+    /**
+     * [Exception] 객체 혹은 파라미터의 데이터 값이 유효하지 않은 경우
+     */
+    @ExceptionHandler(MethodArgumentNotValidException.class)
+    protected ResponseEntity<ErrorResponse> handleMethodArgumentNotValidException(MethodArgumentNotValidException e) {
+        log.error("Handle MothodArgumentNotValidException", e.getMessage());
+        final ErrorResponse response = ErrorResponse.of(ErrorCode.INVALID_METHOD_ERROR, e.getBindingResult());
+        return new ResponseEntity<>(response, HttpStatus.BAD_REQUEST);
+    }
+
+    /**
+     * [Exception] 클라이언트에서 request로 '파라미터로' 데이터가 넘어오지 않았을 경우
+     *
+     * @param ex MissingServletRequestParameterException
+     * @return ResponseEntity<ErrorResponse>
+     */
+    @ExceptionHandler(MissingServletRequestParameterException.class)
+    protected ResponseEntity<ErrorResponse> handleMissingRequestHeaderExceptionException(
+            MissingServletRequestParameterException ex) {
+        log.error("Handle MissingServletRequestParameterException", ex);
+        final ErrorResponse response = ErrorResponse.of(ErrorCode.REQUEST_PARAM_MISSING_ERROR, ex.getMessage());
+        return new ResponseEntity<>(response, HttpStatus.BAD_REQUEST);
+    }
+
+    /**
+     * [Exception] enum type 일치하지 않아 binding 못할 경우
+     * 주로 @RequestParam enum으로 binding 못했을 경우 발생
+     */
+    @ExceptionHandler(MethodArgumentTypeMismatchException.class)
+    protected ResponseEntity<ErrorResponse> handleMethodArgumentTypeMismatchException(MethodArgumentTypeMismatchException e) {
+        log.error("Handle MethodArgumentTypeMismatchException", e);
+        final ErrorResponse response = ErrorResponse.of(ErrorCode.INVALID_INPUT_VALUE_ERROR, e.getMessage());
+        return new ResponseEntity<>(response, HttpStatus.BAD_REQUEST);
+    }
+
+
+    /**
+     * [Exception] com.fasterxml.jackson.core 내에 Exception 발생하는 경우
+     *
+     * @param ex JsonProcessingException
+     * @return ResponseEntity<ErrorResponse>
+     */
+    @ExceptionHandler(JsonProcessingException.class)
+    protected ResponseEntity<ErrorResponse> handleJsonProcessingException(JsonProcessingException ex) {
+        log.error("handleJsonProcessingException", ex);
+        final ErrorResponse response = ErrorResponse.of(ErrorCode.REQUEST_BODY_MISSING_ERROR, ex.getMessage());
+        return new ResponseEntity<>(response, HttpStatus.OK);
+    }
+
+    /**
+     * [Exception] @ModelAttribute 으로 binding error 발생할 경우
+     */
+    @ExceptionHandler(BindException.class)
+    protected ResponseEntity<ErrorResponse> handleBindException(BindException e) {
+        log.error("Handle BindException : ", e);
+        final ErrorResponse response = ErrorResponse.of(ErrorCode.INVALID_INPUT_VALUE_ERROR, e.getBindingResult());
+        return new ResponseEntity<>(response, HttpStatus.BAD_REQUEST);
+    }
+
+    /**
+     * [Exception] 서버에 정의되지 않은 모든 예외
+     */
+    @ExceptionHandler(Exception.class)
+    public ResponseEntity<ErrorResponse> handleAllException(Exception e) {
+        log.error("Handle Exception :", e);
+        final ErrorResponse response = ErrorResponse.of(ErrorCode.INTERNAL_SERVER_ERROR, e.getMessage());
+        return new ResponseEntity<>(response, HttpStatus.OK);
+    }
+
+    /**
+     * [Exception] 커스텀 예외 - MemberException
+     */
+    @ExceptionHandler(MemberException.class)
+    public ResponseEntity<ErrorResponse> handleNotFoundException(MemberException e) {
+        log.error("Handle NotFoundException :", e);
+        final ErrorResponse response = ErrorResponse.of(e.getErrorCode(), e.getMessage());
+        return new ResponseEntity<>(response, HttpStatus.OK);
+    }
+
+    /**
+     * [Exception] 커스텀 예외 - VoucherException
+     */
+    @ExceptionHandler(VoucherException.class)
+    public ResponseEntity<ErrorResponse> handlePermissionDeniedException(VoucherException e) {
+        log.error("Handle PermissionDeniedException :", e);
+        final ErrorResponse response = ErrorResponse.of(e.getErrorCode(), e.getMessage());
+        return new ResponseEntity<>(response, HttpStatus.OK);
+    }
+
+    /**
+     * [Exception] 커스텀 예외 - WalletException
+     */
+    @ExceptionHandler(WalletException.class)
+    public ResponseEntity<ErrorResponse> handlePermissionDeniedException(WalletException e) {
+        log.error("Handle PermissionDeniedException :", e);
+        final ErrorResponse response = ErrorResponse.of(e.getErrorCode(), e.getMessage());
+        return new ResponseEntity<>(response, HttpStatus.OK);
+    }
+
+}

src/main/java/org/programmers/VoucherManagement/global/response/BaseResponse.java

@@ -0,0 +1,39 @@
+package org.programmers.VoucherManagement.global.response;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonPropertyOrder;
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+
+import static org.programmers.VoucherManagement.global.response.SuccessCode.SUCCESS;
+
+@Getter
+@AllArgsConstructor
+@JsonPropertyOrder({"code", "message", "result"})
+public class BaseResponse<T> {
+    private final String message;
+    private final String code;
+    @JsonInclude(JsonInclude.Include.NON_NULL)
+    private T result;
+
+    /**
+     * 요청에 성공하고 반환값이 있는 경우
+     *
+     * @param result
+     */
+    public BaseResponse(T result) {
+        this.message = SUCCESS.getMessage();
+        this.code = SUCCESS.getCode();
+        this.result = result;
+    }
+
+    /**
+     * 요청에 성공하고 반환값이 없는 경우
+     *
+     * @param status
+     */
+    public BaseResponse(SuccessCode status) {
+        this.message = status.getMessage();
+        this.code = status.getCode();
+    }
+}

src/main/java/org/programmers/VoucherManagement/global/response/ErrorCode.java

@@ -0,0 +1,78 @@
+package org.programmers.VoucherManagement.global.response;
+
+public enum ErrorCode {
+    /**
+     * 10000번 -> Global에서 발생하는 에러코드 관리
+     * [Http Status code]
+     * 400 : Bad Request
+     * 401 : Unauthorized
+     * 403 : Forbidden
+     * 404 : Not Found
+     * 405 : Method Not Allowed
+     * 500 : Internal Server Error
+     */
+    FAIL(500, "10000", "요청에 실패하였습니다."),
+    INVALID_INPUT_VALUE_ERROR(400, "10001", "유효하지 않은 입력값입니다."),
+    INVALID_METHOD_ERROR(405, "10002", "Method Argument가 적절하지 않습니다."),
+    REQUEST_BODY_MISSING_ERROR(400, "10003", "RequestBody에 데이터가 존재하지 않습니다."),
+    REQUEST_PARAM_MISSING_ERROR(400, "10004", "RequestParam에 데이터가 전달되지 않았습니다."),
+    INVALID_TYPE_VALUE_ERROR(400, "10005", "타입이 유효하지 않습니다."),
+    INTERNAL_SERVER_ERROR(500, "10006", "서버 오류 입니다."),
+
+    /**
+     * ==========================================================================
+     * 20000번 -> Member에서 발생하는 에러코드 관리
+     * ==========================================================================
+     */
+    NOT_EXIST_MEMBER_STATUS(400, "M20000", "해당하는 회원 상태가 존재하지 않습니다."),
+    NOT_FOUND_MEMBER(404, "M20001", "회원을 찾을 수 없습니다."),
+    FAIL_TO_INSERT_MEMBER(500, "M20002", "데이터가 정상적으로 저장되지 않았습니다."),
+    FAIL_TO_UPDATE_MEMBER(500, "M20003", "데이터가 정상적으로 수정되지 않았습니다."),
+    FAIL_TO_DELETE_MEMBER(500, "M20004", "데이터가 정상적으로 삭제되지 않았습니다."),
+
+    /**
+     * ==========================================================================
+     * 30000번 -> Voucher에서 발생하는 에러코드 관리
+     * ==========================================================================
+     */
+    NOT_INCLUDE_1_TO_100(400, "V30000", "할인율은 1부터 100사이의 값이여야 합니다."),
+    AMOUNT_IS_NOT_NUMBER(400, "V30001", "숫자만 입력가능합니다."),
+    NOT_EXIST_COMMAND(400, "V30002", "해당하는 Command가 존재하지 않습니다."),
+    NOT_EXIST_DISCOUNT_TYPE(400, "V30003", "해당하는 유형의 바우처가 존재하지 않습니다."),
+    NOT_FOUND_VOUCHER(404, "V30004", "바우처를 찾을 수 없습니다."),
+    FAIL_TO_INSERT_VOUCHER(500, "V30005", "데이터가 정상적으로 저장되지 않았습니다."),
+    FAIL_TO_UPDATE_VOUCHER(500, "V30006", "데이터가 정상적으로 수정되지 않았습니다."),
+    FAIL_TO_DELETE_VOUCHER(500, "V30007", "데이터가 정상적으로 삭제되지 않았습니다."),
+
+    /**
+     * ==========================================================================
+     * 40000번 -> Wallet에서 발생하는 에러코드 관리
+     * ==========================================================================
+     */
+    FAIL_TO_INSERT_WALLET(500, "W40000", "데이터가 정상적으로 저장되지 않았습니다."),
+    FAIL_TO_DELETE_WALLET(500, "W40001", "데이터가 정상적으로 삭제되지 않았습니다.");
+
+
+    private final int status; //코드 상태(Http)
+    private final String divisionCode; //서버 내 코드 구분 값
+    private final String message; //에러 코드 메시지
+
+    ErrorCode(int status, String divisionCode, String message) {
+        this.status = status;
+        this.divisionCode = divisionCode;
+        this.message = message;
+    }
+
+    public String getMessage() {
+        return message;
+    }
+
+    public int getStatus() {
+        return status;
+    }
+
+    public String getDivisionCode() {
+        return divisionCode;
+    }
+
+}