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

Hchanghyeon · 2023-07-16T10:56:28Z

📌 과제 설명

3주차 미션

3-1

Spring MVC를 적용해서 thymeleaf 템플릿을 설정해보세요.
커맨드로 지원했던 기능을 thymeleaf를 이용해서 관리페이지를 만들고 다음 기능을 지원가능하게 해보세요
- 조회페이지
- 상세페이지
- 입력페이지
- 삭제기능

3-2

Spring MVC를 적용해서 JSON과 XML을 지원하는 REST API를 개발해보세요
- 전체 조회기능
- 조건별 조회기능 (바우처 생성기간 및 특정 할인타입별)
- 바우처 추가기능
- 바우처 삭제기능
- 바우처 아이디로 조회 기능

👩‍💻 요구 사항과 구현 내용

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 Api Test

✅ PR 포인트 & 궁금한 점

API Controller를 추가하여 REST API로 동작하도록 했습니다!
만들어둔 API에 대해서는 Postman으로 테스트 해보았고 예외 테스트로 에러코드와 메시지가 잘 전달되는지 확인했습니다!

…rse/springboot-basic into changhyeon/w3-2

Hchanghyeon · 2023-07-16T11:15:38Z

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


 @Slf4j
-@ControllerAdvice
+// @ControllerAdvice


RestControllerAdvice에서도 동일한 클래스에 대한 예외 처리를 하고 있어서 @ControllerAdvice를 주석처리하여 사용하지 않도록 했습니다!

동일한 클래스에 대해서 ControllerAdvice와 RestControllerAdvice 2개를 동시에 사용할 수 있는지 확인해보았을 때 basePackage 설정을 통해 할 수는 있었으나 현재 디렉토리 구조성 불가하다고 판단되어 주석처리로 미사용 상태로 두었습니다!

ControllerAdvice와 RestControllerAdvice 차이점은 무엇일까요?

ControllerAdvice는 에러처리 후 반환 값으로 ViewResolver를 통해 페이지를 반환하지만 RestControllerAdvice는 ResponseBody를 이용해 객체를 반환합니다!

Controller와 RestController처럼 Rest 붙고 안붙고의 차이는 @ResponseBody 인 것 같습니다!

그래서 위 처럼 생각했을 때 RestController API로 작동하는 URI의 경우 RestControllerAdvice를 통해 동작할 것이고
Controller API로 작동하는 URI의 경우 ControllerAdvice로 작동해서 서로 다르게 처리할 줄 알았지만 테스트해보니 무조건 Controller로 동작되는 것을 확인할 수 있었습니다! 그래서 위와같이 // 주석처리하여 RestControllerAdivce가 동작할 수 있도록 했습니다!

그렇다면 제거?ㅎㅎ

hanjo8813

창현님 수고하셨습니다~!
thymeleaf 미션 PR과 중복되는 리뷰는 생략했습니다.
해당 PR부터 리팩토링 후 읽어주세요~~

hanjo8813 · 2023-07-16T18:04:40Z

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

+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+@RequestMapping("/api/customer")


rest api url 규칙을 읽어보시고, 반드시 지켜주세요!
구글링해서 아무거나 ... https://velog.io/@pjh612/REST-API-URI-%EA%B7%9C%EC%B9%99

아래 리뷰부터는 꼭 공부하시고 읽어주세요~

리소스는 복수형으로 써주세요

Suggested change

@RequestMapping("/api/customer")

@RequestMapping("/api/customers")

생각보다 정말 많은 규칙이 있는데 너무 마음대로 사용했던 것 같습니다..!

확실히 rest api uri 규칙을 지키면 간결하고 가독성도 좋은 것 같아요ㅎㅎ 말씀하신대로 다 적용해서 고쳐보도록 하겠습니다!

복수형으로 변경한 커밋 : fa951d0

hanjo8813 · 2023-07-16T18:06:55Z

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

+    @PostMapping("/save")
+    public ResponseEntity<CustomerResponse> save(@Validated CustomerCreateRequest customerCreateRequest) {
+        CustomerValidator.validateCustomer(
+                customerCreateRequest.getCustomerName(),
+                customerCreateRequest.getCustomerEmail(),
+                customerCreateRequest.getCustomerType()
+        );


검증 관련한 부분은 이전 PR리뷰를 참고해주세요.

rest api의 uri에는 동사 사용을 지양해주세요.

POST /api/customers

http 메소드와 리소스만으로도 어떤 api인지 바로 알아볼 수 있어야합니다,

검증 부분은 1차 PR에서 삭제처리하고 dto에서 검증할 수 있도록 처리했습니다!

말씀하신 uri에서 동사를 제외하고 메소드와 리소스만으로도 알 수 있도록 뒤에 /save부분을 삭제처리했습니다!

적용 커밋 : fa951d0

hanjo8813 · 2023-07-16T18:08:20Z

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

+        return new ResponseEntity<>(customerResponse, HttpStatus.CREATED);
+    }
+
+    @GetMapping("/find")


여기도 ~

GET /api/customers

/find 삭제처리했습니다!

적용 커밋 : fa951d0

hanjo8813 · 2023-07-16T18:08:59Z

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

+        return ResponseEntity.ok(customerListResponse.getCustomerList());
+    }
+
+    @GetMapping("/find/{id}")


여기도 ~

GET /api/customers/{id}

어떤 api인지 바로 읽히나요?

http메소드를 보고 보니까 오히려 find를 적었을 때보다 더 이해하기 쉬운 것 같아요!

감사합니다!

적용 커밋 : fa951d0

hanjo8813 · 2023-07-16T18:09:24Z

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

+        return ResponseEntity.ok(customerResponse);
+    }
+
+    @GetMapping("/delete/{id}")


Suggested change

@GetMapping("/delete/{id}")

@DeleteMapping("/{id}")

http method 종류에 대해 공부해봅시다!
https://inpa.tistory.com/entry/WEB-%F0%9F%8C%90-HTTP-%EB%A9%94%EC%84%9C%EB%93%9C-%EC%A2%85%EB%A5%98-%ED%86%B5%EC%8B%A0-%EA%B3%BC%EC%A0%95-%F0%9F%92%AF-%EC%B4%9D%EC%A0%95%EB%A6%AC

예전에 흘려듣기로 Delete와 Put메소드를 사용하면 보안에 좋지 않다라는 말을 들었었는데 찾아보니 제가 잘 안찾아보고 그냥 안썼던거네요ㅠ http method 종류를 직접 적용할 수 있도록 해보겠습니다!!

delete method 적용 커밋 : fa951d0

관련된 내용은 요거같네요
https://velog.io/@awdsza/HTTPMethod-PUTDELETE%EB%B3%B4%EC%95%88-%EC%9C%84%ED%97%98%EC%84%B1

http method의 멱등성에 대해서도 공부해보시길 바랍니다~

hanjo8813 · 2023-07-16T18:11:55Z

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

+@RestController
+@RequestMapping("/api/voucher")
+@RequiredArgsConstructor
+public class VoucherApiController {


customer 쪽과 동일하게 리팩토링해주세요~~

말씀하신대로 동일하게 반영했습니다!

hanjo8813 · 2023-07-16T18:18:16Z

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

+
+        VoucherResponse voucherResponse = voucherService.save(voucherCreateRequest);
+
+        return new ResponseEntity<>(voucherResponse, HttpStatus.CREATED);


아래처럼 쓸수도 있습니다~~

Suggested change

return new ResponseEntity<>(voucherResponse, HttpStatus.CREATED);

return ResponseEntity.status(HttpStatus.CREATED).body(voucherResponse);

헉 이런 방법이! 오히려 builder형식으로 쓰니까 통일성 있어서 더 좋은 것 같아요!

반영했습니다!

적용 커밋 : 51f51b3

hanjo8813

창현님은 과제를 빨리 하셨기 때문에...!
리뷰 반영하시면서 추가로 아래와 같은 요구사항도 구현해보시면 좋을것 같습니다~
(여유가 없으시다면 그냥 지나치셔도 됩니다. 어차피 게시판 미션에서 하게됩니다 ㅋㅋ)

voucher 업데이트 api
voucher 타입별 조회 api (fixed, rate를 파라미터로 받아서 조회하기)
voucher 전체 페이징 조회 api

…rse/springboot-basic into changhyeon/w3-2

Hchanghyeon · 2023-07-18T07:22:01Z

미리 경험해보는 것도 좋을 것 같아서 조금 늦더라도 1차 프로젝트 과제 기한 지키면서 조금씩 추가해보겠습니다!! 👍👍

mentor-tyler

수고하셨습니다.

mentor-tyler · 2023-07-18T22:29:43Z

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

+        CustomerValidator.validateCustomer(
+                customerCreateRequest.getCustomerName(),
+                customerCreateRequest.getCustomerEmail(),
+                customerCreateRequest.getCustomerType()
+        );


Custom Validator 를 적용하면 한방에 처리되지 않을까요?

mentor-tyler · 2023-07-18T22:31:24Z

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


 @Slf4j
-@ControllerAdvice
+// @ControllerAdvice


그렇다면 제거?ㅎㅎ

mentor-tyler · 2023-07-18T22:32:09Z

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

+
+    @ExceptionHandler(NoSuchElementException.class)
+    public ResponseEntity<ErrorResponse> handleNoSuchElementException(NoSuchElementException e) {
+        log.warn("RestGlobalExceptionHandler - NoSuchElementException 발생, 찾는 데이터가 없음 {}", e.getMessage(), e);


Suggested change

log.warn("RestGlobalExceptionHandler - NoSuchElementException 발생, 찾는 데이터가 없음 {}", e.getMessage(), e);

log.warn("찾는 데이터가 없음", e);

Hchanghyeon added 7 commits July 16, 2023 15:51

feat: 고객 CREATE, READ, DELETE 기능을 하는 RestController 구현

f0b4c04

feat: RestControllerAdvice를 활용하여 API ErrorHandling 기능 구현

2f36332

refactor: RestControllerAdive에 ResponseStatus 제외

71137a2

feat: 바우처 CREATE, READ, DELETE 기능을 하는 RestController 구현

c033680

refactor: modelAttribute 어노테이션 추가

9896465

docs: 기능 명세 추가, 과제 설명 추가

389b423

docs: 미션 구현 테스트 사진 추가

583b133

Hchanghyeon added 🔥 매운맛 Team-Tyler labels Jul 16, 2023

Hchanghyeon requested review from hanjo8813 and mentor-tyler July 16, 2023 10:56

Hchanghyeon self-assigned this Jul 16, 2023

Merge branch 'changhyeon/w3-1' into changhyeon/w3-2

2ebb955

Hchanghyeon changed the title ~~[4기 - 황창현] Week 3-2 REST API로 바우처 관리페이지 구현, RestControllerAdvice를 통한 예외 처리~~ [4기 - 황창현] Week 3-2 REST API로 바우처 관리 구현, RestControllerAdvice를 통한 예외 처리 Jul 16, 2023

Hchanghyeon added 2 commits July 16, 2023 20:07

refactor: ModelAttribute제외

fa56608

Merge branch 'changhyeon/w3-2' of https://github.com/prgrms-be-devcou…

6e8dd1a

…rse/springboot-basic into changhyeon/w3-2

Hchanghyeon commented Jul 16, 2023

View reviewed changes

Hchanghyeon marked this pull request as ready for review July 16, 2023 11:18

Hchanghyeon added 2 commits July 16, 2023 20:29

refactor: VoucherCreateDto Validation 수정

5488b63

refactor: 접근제어자, 기본 제어자 순서 변경

2d8a83a

hanjo8813 reviewed Jul 16, 2023

View reviewed changes

Merge branch 'changhyeon/w3-1' into changhyeon/w3-2

1f885b1

hanjo8813 reviewed Jul 18, 2023

View reviewed changes

Hchanghyeon added 3 commits July 18, 2023 16:09

refactor: uri 경로, http 메서드 수정

fa951d0

refactor: ResponseEntity body, status 이용하기

51f51b3

Merge branch 'changhyeon/w3-2' of https://github.com/prgrms-be-devcou…

686db55

…rse/springboot-basic into changhyeon/w3-2

Hchanghyeon requested a review from hanjo8813 July 18, 2023 07:21

mentor-tyler reviewed Jul 18, 2023

View reviewed changes

Merge branch 'changhyeon/w3-1' into changhyeon/w3-2

3655a01

	@RequestMapping("/api/customer")
	@RequestMapping("/api/customers")


		VoucherResponse voucherResponse = voucherService.save(voucherCreateRequest);

		return new ResponseEntity<>(voucherResponse, HttpStatus.CREATED);

	return new ResponseEntity<>(voucherResponse, HttpStatus.CREATED);
	return ResponseEntity.status(HttpStatus.CREATED).body(voucherResponse);

	log.warn("RestGlobalExceptionHandler - NoSuchElementException 발생, 찾는 데이터가 없음 {}", e.getMessage(), e);
	log.warn("찾는 데이터가 없음", e);

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

Are you sure you want to change the base?

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

Uh oh!

Conversation

Hchanghyeon commented Jul 16, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📌 과제 설명

3주차 미션

👩‍💻 요구 사항과 구현 내용

3-2 JSON을 지원하는 바우처 관리페이지 REST API 구현

요약

Voucher(api)

Customer(api)

RestControllerAdvice

Postman Api Test

✅ PR 포인트 & 궁금한 점

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hanjo8813 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hanjo8813 Jul 16, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Hchanghyeon Jul 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hanjo8813 Jul 16, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Hchanghyeon Jul 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Hchanghyeon Jul 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Hchanghyeon Jul 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Hchanghyeon Jul 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Hchanghyeon Jul 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hanjo8813 left a comment • edited by Hchanghyeon Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Hchanghyeon commented Jul 16, 2023 •

edited

Loading

hanjo8813 left a comment •

edited

Loading

hanjo8813 Jul 16, 2023 •

edited

Loading

Hchanghyeon Jul 18, 2023 •

edited

Loading

hanjo8813 Jul 16, 2023 •

edited

Loading

Hchanghyeon Jul 18, 2023 •

edited

Loading

Hchanghyeon Jul 18, 2023 •

edited

Loading

Hchanghyeon Jul 18, 2023 •

edited

Loading

Hchanghyeon Jul 18, 2023 •

edited

Loading

Hchanghyeon Jul 18, 2023 •

edited

Loading

hanjo8813 left a comment •

edited by Hchanghyeon

Loading