[4기 - 김민희] SpringBoot Part3 WeeklyMission 제출합니다. by KimMinheee · Pull Request #867 · prgrms-be-devcourse/springboot-basic

KimMinheee · 2023-07-29T03:27:36Z

📌 과제 설명

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

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

`VoucherManagement Rest API 개발`

- ExceptionHandler 이용
- BaseResponse를 이용한 응답 데이터 형식 통일화

`2주차 이후 수정한 내용`

- Voucher, Member, Wallet의 id값을 UUID -> ULID로 수정
- DTO를 계층별로 구분 및 Mapper 이용
- SQL 쿼리 키워드 대문자로 수정
- BaseTimeEntity를 이용하여 created_at 데이터 추가

- mapStruct - spring-boot-starter-seb

- ErrorCode 내에서 관리하도록 수정

@Valid

- Mapper 사용 - Controller Dto @Valid로 유효성 확인

- memberUUID -> memberId로 변경

- created_at 필드 구현

- created_at 컬럼 추가

- 매개변수로 value 값 전달받도록 수정

…출 추가

devYSK · 2023-07-29T08:52:06Z

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

+import java.time.LocalDateTime;
+import java.time.format.DateTimeFormatter;
+
+@Component


이 entity는 Component가 아닌것 같아요

devYSK · 2023-07-29T08:53:40Z

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

+     */
+    @ExceptionHandler(MethodArgumentNotValidException.class)
+    protected ResponseEntity<ErrorResponse> handleMethodArgumentNotValidException(MethodArgumentNotValidException e) {
+        log.error("Handle MothodArgumentNotValidException", e.getMessage());


TRACE, DEBUG, INFO, WARN, ERROR 등
로그의 레벨이 나뉘어져 있어요.
각각 나뉜 의도가 있습니다.
MethodArgumentNotValidExceptionr가 발생하면 error일까요?
그렇다면 이 로그는 error일까요?

devYSK · 2023-07-29T08:55:35Z

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

+@RequiredArgsConstructor
+@RestControllerAdvice
+@Slf4j
+public class GlobalExceptionHandler {


이름좋은데요!
Rest Controller에 관련된 예외를 처리하는 handler다 라고 조금 더 명확하게 주면 어떨까요?

devYSK · 2023-07-29T08:56:26Z

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

+    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);


ResponseEntity.badRequest().body() 라는 정적 팩토리 메소드가 존재합니다.

devYSK · 2023-07-29T08:56:55Z

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

+    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);


ResponseEntity.ok()

devYSK · 2023-07-29T09:10:40Z

src/main/java/org/programmers/VoucherManagement/voucher/domain/VoucherFactory.java

        return switch (discountType) {
            case FIXED ->
-                    new FixedAmountVoucher(UUID.randomUUID(), discountType, new DiscountValue(voucherCreateRequest.discountValue()));
+                    new FixedAmountVoucher(UlidCreator.getUlid().toString(), discountType, new DiscountValue(voucherCreateRequest.discountValue()));


이렇게 static 메소드에 직접 의존하면 테스트하기도 어려울뿐더러
지금처럼 UUID -> ULID로 바뀌었을때도 상당히 많은 부분이 바뀌어야 하네요.
어떻게 해결할 수 있을까요?

devYSK · 2023-07-29T09:11:27Z

src/main/java/org/programmers/VoucherManagement/voucher/presentation/VoucherRestController.java

+     * @return BaseResponse<VoucherCreateResponse>
+     */
+    @PostMapping()
+    public BaseResponse<VoucherCreateResponseData> createVoucher(@Valid @RequestBody VoucherCreateRequestData data) {


RequestData 라는 말이 저는 중복같아요보여요
Data 또는 Request 하나만 써도 될 것 같은데 어떻게 생각하세요?

devYSK · 2023-07-29T09:11:52Z

src/main/java/org/programmers/VoucherManagement/voucher/presentation/VoucherRestController.java

+     * @param data
+     * @return BaseResponse<String>
+     */
+    @PatchMapping("/{voucherId}")


PATCH와 PUT는 어떤 차이점이 있을까요?

devYSK · 2023-07-29T09:12:42Z

...ava/org/programmers/VoucherManagement/voucher/presentation/dto/VoucherCreateRequestData.java

+        @NotBlank
+        String discountType,


enum으로도 받을 수 있습니다.

devYSK · 2023-07-29T09:20:27Z

src/main/java/org/programmers/VoucherManagement/wallet/application/WalletService.java

                .orElseThrow(() -> new MemberException(NOT_FOUND_MEMBER));

-        Wallet wallet = new Wallet(UUID.randomUUID(),
+        Wallet wallet = new Wallet(UlidCreator.getUlid().toString(),


직접의존!

WooSungHwan

민희님 바우처 과제 하시느라 수고 많으셨습니다. 추후 다른 과제에서도 지금처럼 좋은 모습 보여주세요 ㅎㅎ
성실하게 마무리해주셔서 감사합니다.

WooSungHwan · 2023-07-30T13:17:17Z

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

+        final ErrorResponse response = ErrorResponse.of(ErrorCode.INTERNAL_SERVER_ERROR, e.getMessage());
+        return new ResponseEntity<>(response, HttpStatus.OK);


Exception은 internal server error가 맞는 것 같아요.

WooSungHwan · 2023-07-30T13:19:02Z

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

+    @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);
+    }


404 혹은 400이 맞는 에러코드인 것 같습니다. 멤버를 못찾는 요청이 잘못된 경우(400), 찾는 멤버가 없는 경우(404)

WooSungHwan · 2023-07-30T13:19:58Z

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

+    @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);
+    }


permission denied에 맞는 http status 를 알아보시면 좋을 것 같네요. 아래도 마찬가지고요.
인증과 인가 두 개념에 대해서 http status 값에 맞는 경우를 탐구해보면 좋을 것 같습니다.

혹은 단순히 400으로 볼 수도 있고요. 순전히 요청이 잘못됐다고 서버가 판단해야하는 포괄적인 경우 http status 에 의해서 비즈니스가 노출될 수 있으니깐요.

WooSungHwan · 2023-07-30T13:20:14Z

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

+    @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);
+    }


permission denied에 맞는 http status 를 알아보시면 좋을 것 같네요. 아래도 마찬가지고요.
인증과 인가 두 개념에 대해서 http status 값에 맞는 경우를 탐구해보면 좋을 것 같습니다.

혹은 단순히 400으로 볼 수도 있고요. 순전히 요청이 잘못됐다고 서버가 판단해야하는 포괄적인 경우 http status 에 의해서 비즈니스가 노출될 수 있으니깐요.

WooSungHwan · 2023-07-30T13:24:19Z

...java/org/programmers/VoucherManagement/member/infrastructure/JdbcMemberReaderRepository.java

    @Override
    public List<Member> findAll() {
-        String sql = "select member_id, member_status, name from member_table";
+        String sql = "SELECT member_id, member_status, name FROM member_table";


비슷한 의견으로 member 테이블의 id인데 굳이 member_id 라는 명명이 되어야 하는지도요~

WooSungHwan · 2023-07-30T13:28:05Z

src/main/java/org/programmers/VoucherManagement/wallet/presentation/WalletRestController.java

+    @GetMapping("/voucher/{voucherId}")
+    public BaseResponse<WalletGetResponses> getWalletsByVoucherId(@PathVariable String voucherId) {
+        WalletGetResponses responses = walletService.getWalletsByVoucherId(voucherId);
+        return new BaseResponse<>(responses);
+    }
+
+
+    @GetMapping("/member/{memberId}")
+    public BaseResponse<WalletGetResponses> getWalletsByMemberId(@PathVariable String memberId) {
+        WalletGetResponses responses = walletService.getWalletsByMemberId(memberId);
+        return new BaseResponse<>(responses);
+    }


지갑 목록에서 바우처 아이디, 멤버 아이디 두 파라미터를 받아 검색하는 지갑 목록 api로도 작성해볼 수 있겠네요 ㅎㅎ

사실 지금도 좋긴합니다. 오히려 ocp에는 굉장히 만족스러운 행위입니다. 다만 처음에 개발할 당시엔 공통되는 부분은 최대한 로직의 재사용을 할 수 있도록 해주면 좋아요.

KimMinheee added 27 commits July 28, 2023 01:18

[Feat] : build.gradle 의존성 추가

c3ede23

- mapStruct - spring-boot-starter-seb

[Feat] : @service 어노테이션으로 변경

58b7672

[Feat] : 기존 에러메시지 -> ErrorCode로 수정

ac57590

- ErrorCode 내에서 관리하도록 수정

[Feat] : 요청 성공시 사용하는 BaseResponse 구현

3fc14eb

[Feat] : ErrorResponse 및 ExceptionHandler 구현

0994f2b

[Feat] : 요청 성공시 내려주는 SuccessCode 구현

f372e31

[Feat] : VoucherRestController 구현

ae7edeb

[Feat] : controller - service 사이 mapper 구현 및 dto 분리

4ba6d1c

[Feat] : DiscountValue 생성자 내에서 유효성 검사하도록 수정

1d463a8

[Feat] : ErrorCode로의 수정으로 인한 import문 변경

48125fd

[Feat] : Voucher 도메인 layer 별로 dto 구분

3cd95ee

- Mapper 사용 - Controller Dto @Valid로 유효성 확인

[Feat] : 에러코드(10002) 메시지 수정

845c28c

[Feat] : 기존 ExceptionMessage enum 파일 삭제

b21a1c3

[Feat] : 기존 Member 도메인 id 변수명 수정

7d85b6c

- memberUUID -> memberId로 변경

[Feat] : Member RestAPI 개발 및 계층 별 dto 사용하도록 수정

7f990fe

[Feat] : VoucherMapper 내 메소드명 수정

6f1e443

[Feat] : Wallet RestApi 개발 및 계층 별 dto 구현

503e7d7

[Refactor] : sql 쿼리 문 내 키워드 대문자로 수정

a250699

[Refactor] : BaseTimeEntity 구현

f4fdb1f

- created_at 필드 구현

[Feat] : Ulid 의존성 추가

98797c9

[Feat] : Member 객체 id Ulid로 변경

09b519e

[Feat] : Voucher 객체 id Ulid로 변경

bb5fd7e

[Feat] : Wallet 객체 id Ulid로 변경

5c5bd26

[Feat] : 테스트 db sql문 수정

8597271

- created_at 컬럼 추가

[Refactor] : DiscountValue 생성시 validate 확인 메소드 수정

7d99b66

- 매개변수로 value 값 전달받도록 수정

[Feat] : Wallet,Member,Voucher Exception 생성자 내 RuntimeException 생성자 호…

c9777fe

…출 추가

[Feat] : 코드 변경에 따른 테스트 코드 수정

c1d69a3

KimMinheee added the Team-Blackdog label Jul 29, 2023

KimMinheee requested review from WooSungHwan and devYSK July 29, 2023 03:27

KimMinheee self-assigned this Jul 29, 2023

devYSK approved these changes Jul 29, 2023

View reviewed changes

WooSungHwan approved these changes Jul 30, 2023

View reviewed changes

		final ErrorResponse response = ErrorResponse.of(ErrorCode.INTERNAL_SERVER_ERROR, e.getMessage());
		return new ResponseEntity<>(response, HttpStatus.OK);

Conversation

KimMinheee commented Jul 29, 2023

📌 과제 설명

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

VoucherManagement Rest API 개발

2주차 이후 수정한 내용

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!

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!

WooSungHwan left a comment

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!

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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

`VoucherManagement Rest API 개발`

`2주차 이후 수정한 내용`