[4기 - 황창현] Week 3-2 REST API로 바우처 관리 구현, RestControllerAdvice를 통한 예외 처리

README.md

@@ -77,9 +77,9 @@ Type list to list all vouchers.
 
 **3-2**
 
-- [ ] Spring MVC를 적용해서 JSON과 XML을 지원하는 REST API를 개발해보세요
-    - [ ]  전체 조회기능
-    - [ ]  조건별 조회기능 (바우처 생성기간 및 특정 할인타입별)
-    - [ ]  바우처 추가기능
-    - [ ]  바우처 삭제기능
-    - [ ]  바우처 아이디로 조회 기능
+- [x] Spring MVC를 적용해서 JSON과 XML을 지원하는 REST API를 개발해보세요
+    - [x]  전체 조회기능
+    - [x]  조건별 조회기능 (바우처 생성기간 및 특정 할인타입별)
+    - [x]  바우처 추가기능
+    - [x]  바우처 삭제기능
+    - [x]  바우처 아이디로 조회 기능

src/main/java/com/programmers/springweekly/controller/CustomerApiController.java

@@ -0,0 +1,68 @@
+package com.programmers.springweekly.controller;
+
+import com.programmers.springweekly.dto.customer.request.CustomerCreateRequest;
+import com.programmers.springweekly.dto.customer.response.CustomerListResponse;
+import com.programmers.springweekly.dto.customer.response.CustomerResponse;
+import com.programmers.springweekly.service.CustomerService;
+import com.programmers.springweekly.util.validator.CustomerValidator;
+import java.util.List;
+import java.util.NoSuchElementException;
+import java.util.UUID;
+import lombok.RequiredArgsConstructor;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.validation.annotation.Validated;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+@RequestMapping("/api/customer")
+@RequiredArgsConstructor
+public class CustomerApiController {
+
+    private final CustomerService customerService;
+
+    @PostMapping("/save")
+    public ResponseEntity<CustomerResponse> save(@Validated CustomerCreateRequest customerCreateRequest) {
+        CustomerValidator.validateCustomer(
+                customerCreateRequest.getCustomerName(),
+                customerCreateRequest.getCustomerEmail(),
+                customerCreateRequest.getCustomerType()
+        );
+
+        CustomerResponse customerResponse = customerService.save(customerCreateRequest);
+
+        return new ResponseEntity<>(customerResponse, HttpStatus.CREATED);
+    }
+
+    @GetMapping("/find")
+    public ResponseEntity<List<CustomerResponse>> getFindAll() {
+        CustomerListResponse customerListResponse = customerService.findAll();
+
+        return ResponseEntity.ok(customerListResponse.getCustomerList());
+    }
+
+    @GetMapping("/find/{id}")
+    public ResponseEntity<CustomerResponse> findById(@PathVariable("id") UUID customerId) {
+        CustomerResponse customerResponse = customerService.findById(customerId);
+
+        return ResponseEntity.ok(customerResponse);
+    }
+
+    @GetMapping("/delete/{id}")
+    public ResponseEntity<Void> deleteById(@PathVariable("id") UUID customerId) {
+        boolean isExistCustomerId = customerService.existById(customerId);
+
+        if (!isExistCustomerId) {
+            throw new NoSuchElementException("사용자가 삭제하려는 아이디 " + customerId + "는 없는 ID입니다.");
+        }
+
+        customerService.deleteById(customerId);
+
+        return ResponseEntity.noContent().build();
+    }
+
+}

src/main/java/com/programmers/springweekly/controller/VoucherApiController.java

@@ -0,0 +1,67 @@
+package com.programmers.springweekly.controller;
+
+import com.programmers.springweekly.dto.voucher.request.VoucherCreateRequest;
+import com.programmers.springweekly.dto.voucher.response.VoucherListResponse;
+import com.programmers.springweekly.dto.voucher.response.VoucherResponse;
+import com.programmers.springweekly.service.VoucherService;
+import com.programmers.springweekly.util.validator.VoucherValidator;
+import java.util.List;
+import java.util.NoSuchElementException;
+import java.util.UUID;
+import lombok.RequiredArgsConstructor;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.validation.annotation.Validated;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+@RequestMapping("/api/voucher")
+@RequiredArgsConstructor
+public class VoucherApiController {
+
+    private final VoucherService voucherService;
+
+    @PostMapping("/save")
+    public ResponseEntity<VoucherResponse> save(@Validated VoucherCreateRequest voucherCreateRequest) {
+        VoucherValidator.validateVoucher(
+                voucherCreateRequest.getVoucherType(),
+                String.valueOf(voucherCreateRequest.getDiscountAmount())
+        );
+
+        VoucherResponse voucherResponse = voucherService.save(voucherCreateRequest);
+
+        return new ResponseEntity<>(voucherResponse, HttpStatus.CREATED);
+    }
+
+    @GetMapping("/find")
+    public ResponseEntity<List<VoucherResponse>> getFindAll() {
+        VoucherListResponse voucherListResponse = voucherService.findAll();
+
+        return ResponseEntity.ok(voucherListResponse.getVoucherList());
+    }
+
+    @GetMapping("/find/{id}")
+    public ResponseEntity<VoucherResponse> findById(@PathVariable("id") UUID voucherId) {
+        VoucherResponse voucherResponse = voucherService.findById(voucherId);
+
+        return ResponseEntity.ok(voucherResponse);
+    }
+
+    @GetMapping("/delete/{id}")
+    public ResponseEntity<Void> deleteById(@PathVariable("id") UUID voucherId) {
+        boolean isExistVoucherId = voucherService.existById(voucherId);
+
+        if (!isExistVoucherId) {
+            throw new NoSuchElementException("사용자가 삭제하려는 바우처 " + voucherId + "는 없는 ID입니다.");
+        }
+
+        voucherService.deleteById(voucherId);
+
+        return ResponseEntity.noContent().build();
+    }
+
+}

src/main/java/com/programmers/springweekly/docs/specification.md

@@ -194,8 +194,6 @@ blacklist
 
 ![스크린샷 2023-07-10 오전 12 23 51](https://github.com/Hchanghyeon/springboot-basic/assets/92444744/a0c5395b-0b0f-4f21-99ae-f9a5f36a7b03)
 
-
-
 ### Wallet
 
 - NamedParameterJdbcTemplate을 이용
@@ -244,8 +242,36 @@ blacklist
 ![ezgif com-video-to-gif](https://github.com/prgrms-be-devcourse/springboot-basic/assets/92444744/c85de587-903e-493d-8fde-5e2d0ba3116b)
 
 ### 웹 동작 화면(에러)
-![ezgif com-video-to-gif (1)](https://github.com/prgrms-be-devcourse/springboot-basic/assets/92444744/36e41e81-6d1f-4298-8527-43ee10d43e11)
+![ezgif com-video-to-gif (1)](https://github.com/prgrms-be-devcourse/springboot-basic/assets/92444744/36e41e81-6d1f-4298-8527-43ee10d43e11
+
+<hr>
+
+### 3-2 JSON을 지원하는 바우처 관리페이지 REST API 구현
+
+### 요약
+
+- 고객, 바우처 CREATE, UPDATE, DELETE API Controller 구현
+- RestControllerAdvice를 통한 Global 에외 처리
+- 예외 발생시 ErrorResponseDto를 통해 에러 코드와 메시지 전달
 
+### Voucher(api)
 
+- 바우처 입력 기능
+- 바우처 삭제 기능
+- 바우처 전체 조회, 상세 조회 기능
 
+### Customer(api)
+
+- 고객 입력 기능
+- 고객 삭제 기능
+- 고객 전체 조회, 상세 조회 기능
+
+### RestControllerAdvice
+
+- Controller, Serivce, Repository 등 Controller 하위 단에서 발생한 예외를 전역으로 잡는 ExceptionHandler 클래스 생성
+- 프로그램 내에서 발생할 것 같은 예외들을 모두 구분하여 로깅하고, 메세지를 ErrorResponseDto에 담아서 클라이언트에게 응답
+- 예외 별 상태 코드 적용
+- 발생할 것 같은 예외들을 모두 잡고 예상치 못한 예외가 발생했을 때 프로그램이 꺼지지 않도록 제일 하위에 최상위 Exception으로 예외 처리
 
+### Postman Test
+![ezgif com-video-to-gif (2)](https://github.com/prgrms-be-devcourse/springboot-basic/assets/92444744/b3d8ce89-78cd-44be-a16b-eb006f202f81)

src/main/java/com/programmers/springweekly/dto/ErrorResponse.java

@@ -0,0 +1,14 @@
+package com.programmers.springweekly.dto;
+
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+
+
+@Getter
+@RequiredArgsConstructor
+public class ErrorResponse {
+
+    private final int errorCode;
+    private final String errorMsg;
+
+}

src/main/java/com/programmers/springweekly/exception/GlobalExceptionHandler.java

@@ -6,12 +6,11 @@
 import org.springframework.dao.DuplicateKeyException;
 import org.springframework.http.HttpStatus;
 import org.springframework.ui.Model;
-import org.springframework.web.bind.annotation.ControllerAdvice;
 import org.springframework.web.bind.annotation.ExceptionHandler;
 import org.springframework.web.bind.annotation.ResponseStatus;
 
 @Slf4j
-@ControllerAdvice
+// @ControllerAdvice
 public class GlobalExceptionHandler {
 
     private static final String ERROR_MSG = "errorMsg";

src/main/java/com/programmers/springweekly/exception/RestGlobalExceptionHandler.java

@@ -0,0 +1,73 @@
+package com.programmers.springweekly.exception;
+
+import com.programmers.springweekly.dto.ErrorResponse;
+import java.util.NoSuchElementException;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.dao.DataAccessException;
+import org.springframework.dao.DuplicateKeyException;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.bind.annotation.RestControllerAdvice;
+
+@Slf4j
+@RestControllerAdvice
+public class RestGlobalExceptionHandler {
+
+    @ExceptionHandler(NoSuchElementException.class)
+    public ResponseEntity<ErrorResponse> handleNoSuchElementException(NoSuchElementException e) {
+        log.warn("RestGlobalExceptionHandler - NoSuchElementException 발생, 찾는 데이터가 없음 {}", e.getMessage(), e);
+        ErrorResponse errorResponse = new ErrorResponse(HttpStatus.NOT_FOUND.value(), e.getMessage());
+
+        return new ResponseEntity<>(errorResponse, HttpStatus.NOT_FOUND);
+    }
+
+    @ExceptionHandler(NullPointerException.class)
+    public ResponseEntity<ErrorResponse> handleNullPointerException(NullPointerException e) {
+        log.error("RestGlobalExceptionHandler - NullPointerException 발생 {}", e.getMessage(), e);
+        ErrorResponse errorResponse = new ErrorResponse(HttpStatus.INTERNAL_SERVER_ERROR.value(), e.getMessage());
+
+        return new ResponseEntity<>(errorResponse, HttpStatus.INTERNAL_SERVER_ERROR);
+    }
+
+    @ExceptionHandler(IllegalArgumentException.class)
+    public ResponseEntity<ErrorResponse> handleIllegalArgumentException(IllegalArgumentException e) {
+        log.error("RestGlobalExceptionHandler - IllegalArgumentException 발생, 클라이언트의 잘못된 입력 값 예상 {}", e.getMessage(), e);
+        ErrorResponse errorResponse = new ErrorResponse(HttpStatus.BAD_REQUEST.value(), e.getMessage());
+
+        return new ResponseEntity<>(errorResponse, HttpStatus.BAD_REQUEST);
+    }
+
+    @ExceptionHandler(IndexOutOfBoundsException.class)
+    public ResponseEntity<ErrorResponse> handleIndexOutOfBoundsException(IndexOutOfBoundsException e) {
+        log.error("RestGlobalExceptionHandler - IndexOutOfBoundsException 발생, 배열의 범위를 초과한 작업 예상 {}", e.getMessage(), e);
+        ErrorResponse errorResponse = new ErrorResponse(HttpStatus.BAD_REQUEST.value(), e.getMessage());
+
+        return new ResponseEntity<>(errorResponse, HttpStatus.BAD_REQUEST);
+    }
+
+    @ExceptionHandler(DuplicateKeyException.class)
+    public ResponseEntity<ErrorResponse> handleDuplicateKeyException(DuplicateKeyException e) {
+        log.error("RestGlobalExceptionHandler - DuplicateKeyException 발생, 유니크/중복 키 충돌 예상 {}", e.getMessage(), e);
+        ErrorResponse errorResponse = new ErrorResponse(HttpStatus.CONFLICT.value(), e.getMessage());
+
+        return new ResponseEntity<>(errorResponse, HttpStatus.CONFLICT);
+    }
+
+    @ExceptionHandler(DataAccessException.class)
+    public ResponseEntity<ErrorResponse> handleDataAccessException(DataAccessException e) {
+        log.error("RestGlobalExceptionHandler - DataAccessException 발생, 데이터 접근 관련 예외 {}", e.getMessage(), e);
+        ErrorResponse errorResponse = new ErrorResponse(HttpStatus.INTERNAL_SERVER_ERROR.value(), e.getMessage());
+
+        return new ResponseEntity<>(errorResponse, HttpStatus.INTERNAL_SERVER_ERROR);
+    }
+
+    @ExceptionHandler(Exception.class)
+    public ResponseEntity<ErrorResponse> handleException(Exception e) {
+        log.error("RestGlobalExceptionHandler - Exception 발생, 개발자가 잡지 못한 예외 {}", e.getMessage(), e);
+        ErrorResponse errorResponse = new ErrorResponse(HttpStatus.INTERNAL_SERVER_ERROR.value(), e.getMessage());
+
+        return new ResponseEntity<>(errorResponse, HttpStatus.INTERNAL_SERVER_ERROR);
+    }
+
+}

src/main/java/com/programmers/springweekly/service/VoucherService.java

@@ -19,14 +19,16 @@ public class VoucherService {
 
     private final VoucherRepository voucherRepository;
 
-    public void save(VoucherCreateRequest voucherCreateRequest) {
+    public VoucherResponse save(VoucherCreateRequest voucherCreateRequest) {
         Voucher voucher = VoucherFactory.createVoucher(
                 UUID.randomUUID(),
                 voucherCreateRequest.getVoucherType(),
                 voucherCreateRequest.getDiscountAmount()
         );
 
-        voucherRepository.save(voucher);
+        Voucher resultVoucher = voucherRepository.save(voucher);
+
+        return new VoucherResponse(resultVoucher);
     }
 
     public void update(VoucherUpdateRequest voucherUpdateRequest) {