QR Code 발급 및 인증 기능 구현 완료 by cxxxtxxyxx · Pull Request #24 · livable-final/server

cxxxtxxyxx · 2023-09-17T15:45:26Z

QR Code 발급 및 인증 기능 구현 #22

추가 구현 필요

JWT 연동 및 검증
UnitTest 작성
- ControllerTest
- ServiceTest

Invitation, Visitor Repository 생성

zxing 의존성 추가

QrCodeManager 클래스 생성 및 구현 QrPayload 클래스 생성

VisitorId를 통해 해당 방문자의 초대장 Id를 조회

QR 생성 및 유효성 검사를 위해 초대장 시작 및 종료 시간을 조회

VisitationService에서 QrCodeManager를 사용하여 QR 관리

Service, Repository의 의존성을 1대1로 관리하기 위해 Facade 객체 구현

HttpStatus 및 Message 관리 객체

사용하지 않는 불필요한 메서드 제거

컨벤션에 맞도록 메서드 명 수정 get -> create

컨벤션에 맞도록 줄바꿈 추가

VisitationController createQrCode에 대한 MVC 테스트 구현

@builder

RequestBodyDto 객체에 @builder 어노테이션을 붙이는 대신 상속 모킹 객체를 생성해서 대신 사용

VisitationService 테스트

InvitationServiceTest 내부에 MockBean import문 제거

objectMapper.registerModule(new JavaTimeModule()).writeValueAsString(expirationPeriodMap)로 수정

cxxxtxxyxx · 2023-09-18T07:52:51Z

src/main/java/com/livable/server/visitation/controller/VisitationController.java

+        Long visitorId = 1L;
+        VisitationResponse.InvitationTimeDto invitationTime = visitationFacadeService.findInvitationTime(visitorId);
+        String base64QrCode = visitationFacadeService.createQrCode(invitationTime.getStartDateTime().minusHours(1), invitationTime.getEndDateTime().plusHours(1));
+
+        return ApiResponse.success(base64QrCode, HttpStatus.OK);


이 부분은 JWT 연동 이후 토큰에서 값 가져오도록 수정할 것 같습니다!

Facade객체에서 다양한 Service에 대한 의존을 통해 로직 처리

)

hyunsb · 2023-09-17T16:36:41Z

src/main/java/com/livable/server/visitation/service/InvitationService.java

+        return VisitationResponse.InvitationTimeDto
+                .builder()
+                .startTime(invitation.getStartTime())
+                .endTime(invitation.getEndTime())
+                .startDate(invitation.getStartDate())
+                .endDate(invitation.getEndDate())
+                .build();
+    }


요거 InvitationTimeDTO 안에 정적 팩토리 메서드로 처리하면 더 깔끔할 거 같아요

public static InvitationTimeDTO from(Invitation invitation) { return InvitationTimeDTO.builder() ... ; }

hyunsb · 2023-09-17T16:38:29Z

src/main/java/com/livable/server/visitation/domain/VisitationErrorCode.java

+@Getter
+@AllArgsConstructor
+public enum VisitationErrorCode implements ErrorCode {
+
+    OBJECTMAPPER(HttpStatus.INTERNAL_SERVER_ERROR, "직렬화 과정에서 알 수 없는 에러가 발생했습니다."),
+    QR_ENCODE(HttpStatus.INTERNAL_SERVER_ERROR, "QR코드 생성 중 알 수 없는 에러가 발생했습니다."),
+    QR_DECODE(HttpStatus.INTERNAL_SERVER_ERROR, "QR코드를 푸는 과정에서 알 수 없는 에러가 발생했습니다."),
+    IO(HttpStatus.INTERNAL_SERVER_ERROR, "I/O를 진행하는 과정에서 알 수 없는 에러가 발생했습니다."),
+    INVALID_PERIOD(HttpStatus.BAD_REQUEST, "QR 기간이 유효하지 않습니다."),
+    NOT_FOUND(HttpStatus.BAD_REQUEST, "존재하지 않는 정보입니다.");
+
+
+    private final HttpStatus httpStatus;
+    private final String message;
+}


이거 설계가 참 좋은 거 같습니다 👍

hyunsb · 2023-10-06T08:03:18Z

src/main/java/com/livable/server/visitation/domain/QrCodeManager.java

+
+            Map<EncodeHintType, Object> encodeHints = getEncodeHints();
+
+            QRCodeWriter qrCodeWriter = new QRCodeWriter();


해당 메서드는 호출될 때마다 QRCodeWriter 객체가 생성될 거 같아요
메서드 내에서 특정 객체를 new 해버리면 테스트하기 어려울 거 같습니다!

cxxxtxxyxx added 9 commits September 18, 2023 00:33

Feat: 필요한 Repository 생성 (livable-final#22)

6810b07

Invitation, Visitor Repository 생성

Chore: QR코드 라이브러리 의존성 추가 (livable-final#22)

af0f7b3

zxing 의존성 추가

Feat: QR코드 매니저 클래스 구현 (livable-final#22)

5e8c64f

QrCodeManager 클래스 생성 및 구현 QrPayload 클래스 생성

Feat: InvitationId를 가져오는 메서드 구현 (livable-final#22)

56241dc

VisitorId를 통해 해당 방문자의 초대장 Id를 조회

Feat: 초대장 시작 및 종료 시간을 가져오는 메서드 구현 (livable-final#22)

3613f6d

QR 생성 및 유효성 검사를 위해 초대장 시작 및 종료 시간을 조회

Feat: QR생성 및 validate 위임 메서드 구현 (livable-final#22)

4033083

VisitationService에서 QrCodeManager를 사용하여 QR 관리

Feat: VisitationFacadeService 구현 (livable-final#22)

4c5d73b

Service, Repository의 의존성을 1대1로 관리하기 위해 Facade 객체 구현

Feat: VisitationErrorCode 구현 (livable-final#22)

4a01342

HttpStatus 및 Message 관리 객체

Feat: VisitationController 구현 (livable-final#22)

a3cba67

cxxxtxxyxx added the develop 기능 개발 label Sep 17, 2023

cxxxtxxyxx requested a review from hyunsb September 17, 2023 15:45

cxxxtxxyxx self-assigned this Sep 17, 2023

cxxxtxxyxx added 18 commits September 18, 2023 00:47

Modify: InvitationRepository 메서드 제거 (livable-final#22)

bd19dac

사용하지 않는 불필요한 메서드 제거

Typo: 메서드 명 수정 (livable-final#22)

7524d7d

컨벤션에 맞도록 메서드 명 수정 get -> create

Typo: 줄바꿈 추가 (livable-final#22)

5a6e5a9

컨벤션에 맞도록 줄바꿈 추가

Test: QRCode 생성 요청 테스트 구현 (livable-final#22)

e0d0d36

VisitationController createQrCode에 대한 MVC 테스트 구현

Test: QRCode 생성 요청 실패 테스트 구현 (livable-final#22)

c2e1e50

VisitationController createQrCode에 대한 MVC 테스트 구현

Test: QRCode 생성 요청 실패(400) 테스트 구현 (livable-final#22)

845fef0

Test: QRCode 생성 요청 실패(500) 테스트 구현 (livable-final#22)

9eb6281

Refactor: 테스트 메서드 네이밍 컨트롤러와 통일 (livable-final#22)

e7373c2

Test: 테스트용 모킹 객체 생성 (livable-final#22)

d17d06b

RequestBodyDto 객체에 @builder 어노테이션을 붙이는 대신 상속 모킹 객체를 생성해서 대신 사용

Test: QRCode 인증 성공 테스트 구현 (livable-final#22)

abbadba

Test: QRCode 인증 실패(400) 테스트 구현 (livable-final#22)

ee2dd4a

Test: findInvitationTime 성공 테스트 구현 (livable-final#22)

af7cd09

Test: findInvitationTime 실패 테스트 구현 (livable-final#22)

7c853c6

Test: createQrCode 성공 테스트 구현 (livable-final#22)

fa2bc84

Test: validateQrCode 성공 테스트 구현 (livable-final#22)

0b8cb45

VisitationService 테스트

Test: VisitorService.findInvitationId 성공 테스트 구현 (livable-final#22)

8031ed0

Style: 불필요한 Import문 제거 (livable-final#22)

dc1567f

InvitationServiceTest 내부에 MockBean import문 제거

Test: VisitorService.findInvitationId 실패 테스트 구현 (livable-final#22)

089b5f3

cxxxtxxyxx added 5 commits September 18, 2023 16:34

Refactor: Qr생성 Validation 추가 및 수정 (livable-final#22)

6fd76d7

Fix: LocalDateTime 역직렬화를 위한 코드 추가 (livable-final#22)

eb93004

objectMapper.registerModule(new JavaTimeModule()).writeValueAsString(expirationPeriodMap)로 수정

Test: QrCodeManager.createQrCode 성공 테스트 구현 (livable-final#22)

145e7dc

Test: QrCodeManager.createQrCode 실패 테스트_1 구현 (livable-final#22)

f72d59e

Test: QrCodeManager.createQrCode 실패 테스트_2 구현 (livable-final#22)

ca0f442

cxxxtxxyxx commented Sep 18, 2023

View reviewed changes

cxxxtxxyxx added 5 commits September 18, 2023 17:06

Refactor: Controller 메서드에서는 Facade 객체로 위임만 하도록 리팩터링 (livable-final#22)

1f1c105

Facade객체에서 다양한 Service에 대한 의존을 통해 로직 처리

Refactor: 로직 수정에 따른 테스트코드 리팩터링 (livable-final#22)

6f08b71

Modify: 불필요한 예외 테스트 제거 (livable-final#22)

c3a75eb

Test: VisitationFacadeService.createQrCode 성공 테스트 구현 (livable-final#22)

12c0a32

Test: VisitationFacadeService.validateQrCode 성공 테스트 구현 (livable-final#22

be2d2b0

)

hyunsb reviewed Sep 18, 2023

View reviewed changes

cxxxtxxyxx added 2 commits September 18, 2023 19:56

Feat: 쿼리 줄이기 위해 JPQL 직접 작성 (livable-final#22)

7fde3a8

Fix: Repository 테스트 실패 제거 (livable-final#22)

a140c65

cxxxtxxyxx merged commit 22d8cb4 into livable-final:develop Sep 18, 2023

cxxxtxxyxx added the review 코드 리뷰 요청 label Oct 6, 2023

khsrla9806 requested a review from kledyu October 6, 2023 07:47

hyunsb reviewed Oct 6, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Comments

QR Code 발급 및 인증 기능 구현 완료#24

QR Code 발급 및 인증 기능 구현 완료#24
cxxxtxxyxx merged 39 commits intolivable-final:developfrom
cxxxtxxyxx:feature/#22-qrcode-api

cxxxtxxyxx commented Sep 17, 2023 •

edited

Loading

Uh oh!

cxxxtxxyxx Sep 18, 2023

Uh oh!

hyunsb Sep 17, 2023

Uh oh!

hyunsb Sep 17, 2023

Uh oh!

hyunsb Oct 6, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants


		Map<EncodeHintType, Object> encodeHints = getEncodeHints();

		QRCodeWriter qrCodeWriter = new QRCodeWriter();

Comments

Conversation

cxxxtxxyxx commented Sep 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

추가 구현 필요

Uh oh!

cxxxtxxyxx Sep 18, 2023

Choose a reason for hiding this comment

Uh oh!

hyunsb Sep 17, 2023

Choose a reason for hiding this comment

Uh oh!

hyunsb Sep 17, 2023

Choose a reason for hiding this comment

Uh oh!

hyunsb Oct 6, 2023

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

cxxxtxxyxx commented Sep 17, 2023 •

edited

Loading