Feature/287 봉사 기록 엔티티와 이벤트 기반 생성 방식 구현 #293

7zrv · 2025-01-10T08:05:56Z

[FEATURE]봉사 기록 도메인의 추가 생성, 조회 기능 개발 #287

📌 과제 설명

봉사 기록 테이블이 추가됨에 따라 해당 데이터에 대한 엔티티와
봉사 시간 정산시 발행하는 이벤트 기반 생성 기능의 구현입니다.

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

봉사 기록 엔티티 생성
봉사 기록 영속성 레이어 구현
봉사 기록 생성 유스케이스와 구현체 구현
DomainEvent에 봉사 기록 생성 이벤트 추가
생성 이벤트에 대한 이벤트 퍼블리셔 구현
이벤트 구독을 위한 RedisSubScriber 클래스 구현
봉사 기록 생성 이벤트 메세지에 대한 컨버터 구현
봉사 기록 생성 핸들러 구현
봉사 정산 메서드에 봉사 기록 생성 이벤트 등록 -> 추후 다른 이벤트와 통합 예정
봉사 시간 정산 테스트에 봉사 기록 테스트 임시 작성 -> 추후 분리 예정

✅ PR 포인트 & 궁금한 점

이벤트 기반 방식이 처음이라 어색한 부분이 있을수도 있을거 같습니다
제가 작성한 코드가 이벤트 발행 ~ 봉사 기록 생성까지의 논리가 정확한지 봐주시면 감사하겠습니다.

1

.

m-a-king

수고하셨습니다~

m-a-king · 2025-01-10T10:00:10Z

.../com/somemore/domains/interestcenter/event/converter/CreateRecruitBoardMessageConverter.java


            return switch (DomainEventSubType.from(eventType)) {
                case CREATE_RECRUIT_BOARD -> parseCreateRecruitBoardEvent(message);
+                case VOLUNTEER_HOURS_SETTLE -> null;


조치해주셔서 감사합니다

여기 null인 이유는 추후 구현인건가요?
로직을 몰라서 여쭤봅니다

네 구조 자체가 조금 잘못돼서 추후에 수정해야하는 부분입니다.

m-a-king · 2025-01-10T10:02:20Z

...main/java/com/somemore/domains/volunteerapply/service/SettleVolunteerApplyFacadeService.java

            apply.changeAttended(true);
            updateVolunteerUseCase.updateVolunteerStats(apply.getVolunteerId(), hours);
            publishVolunteerReviewRequestEvent(apply, recruitBoard);
+            volunteerRecordEventPublisher.publishVolunteerRecordCreateEvent(apply, recruitBoard);


serverEventPublisher를 활용해서 추상화하는 것이 좋을 것 같습니다.

혹시 봉사 기록 이벤트만을 위한 퍼블리셔를 만들고 의존하신 특별한 이유가 있나요?

혹은 봉사 기록 이벤트 내부에서 정적 팩토리 메서드를 활용할 수 있을 것 같습니다.

처음에 이벤트에 대한 개념이 확실히 잡히지 않아서
봉사 시간 정산시 봉사 기록 생성 이벤트를 발행한다 라는 의미로 생각하고 메서드를 만들었습니다

현재는 봉사 시간 정산 이벤트가 발생하고 이를 구독하는 클래스에서 자신들이 필요한 로직을 수행하도록
이벤트 발행과 구독을 완전히 분리하는 방향을 생각하고 있는데요

봉사 시간 정산 이벤트가 발생하면 RedisSettleVolunteerHoursSubscriber 에서 이를 구독하여
그 안에서 메세지를 핸들링 하는것을 구상중인데 혹시 이 부분에 대해서는 어떻게 생각하시나요

publishVolunteerReviewRequestEvent(apply, recruitBoard);
volunteerRecordEventPublisher.publishVolunteerRecordCreateEvent(apply, recruitBoard);

이거 방식이 달라서 상의해서 한가지로 통합하는게 좋아보입니다.

@7zrv 좋습니다. 봉사 시간 정산 이벤트가 발생하면 그것을 봉사 시간 정산 이벤트 구독자가 받고 그제야 봉사 시간 정산 이벤트로부터 발생해야 하는 리뷰 요청 알림 이벤트와 봉사 기록 생성 이벤트로 나누어져서 두 번의 이벤트를 발생시키면 좋을 것 같습니다.

두 번의 이벤트가 발생하는 시점에서 범수 님이 말해주신 것 중에서 골라야 하는데, 제 생각에는 이벤트를 발생시킨다는 개념은 serverEventPublisher에게 맡기고 이벤트는 이벤트 클래스의 정적 메서드를 활용해서 생성하는 게 좋을 것 같다고 생각했습니다.
@leebs0521

-> publishVolunteerReviewRequestEvent(apply, recruitBoard) 메서드를 사용하자. 하지만 빌더 패턴을 드러내지 말자 (이벤트 클래스의 정적 팩토리 메서드를 활용하자)
-> 별도의 클래스(volunteerRecordEventPublisher)에서 이벤트를 생성하고 그것을 의존하는 현재 구조는 과하지 않을까?

라고 생각했습니다!

m-a-king · 2025-01-10T10:05:08Z

...java/com/somemore/domains/volunteerrecord/event/convert/VolunteerRecordMessageConverter.java

+@Component
+public class VolunteerRecordMessageConverter {
+
+    private static final String SUB_TYPE = "subType";


m-a-king · 2025-01-10T10:07:32Z

...java/com/somemore/domains/volunteerrecord/event/convert/VolunteerRecordMessageConverter.java

+    private VolunteerRecord buildVolunteerRecordCreate(String message) throws JsonProcessingException {
+
+        VolunteerRecordCreateEvent volunteerRecordCreateEvent = objectMapper.readValue(message, VolunteerRecordCreateEvent.class);
+
+        return VolunteerRecord.create(
+                volunteerRecordCreateEvent.getVolunteerId(),
+                volunteerRecordCreateEvent.getTitle(),
+                volunteerRecordCreateEvent.getVolunteerDate(),
+                volunteerRecordCreateEvent.getVolunteerHours()
+        );


빌더를 드러내지 않고 create 하는 것 확인했습니다~

메서드 명도 create~~~로 바꿔도 될 것 같은데 create~~~create라서 어색해서 build라고 하셨나요?

넵 문맥상 어색해보여서 크리에이트를 빌드한다 라는 문장으로 적은건데
이제 보니 CreateVolunteerRecord라고 해도될 거 같네요 어떻게 생각하시나요?

저도 재중님 의견이 괜찮아보이네요

저도 좋습니다~

m-a-king · 2025-01-10T10:08:07Z

...m/somemore/domains/volunteerrecord/event/subscriber/RedisSettleVolunteerHoursSubscriber.java

+
+        settleVolunteerHoursHandler.handle(volunteerRecord);
+    }
+}


개행이 필요하대요!

ayoung-dev

수고하셨습니다!

leebs0521

고생하셨씁니다.

leebs0521 · 2025-01-11T09:52:55Z

src/test/java/com/somemore/domains/volunteerrecord/domain/VolunteerRecordTest.java

+class VolunteerRecordTest {
+
+    @Test
+    void createVolunteerRecord_success() {


@display가 있으면 좋을것 같습니다.

leebs0521 · 2025-01-11T09:54:30Z

src/main/java/com/somemore/domains/volunteerrecord/service/VolunteerRecordCreateService.java

+@Service
+@Transactional
+public class VolunteerRecordCreateService implements VolunteerRecordCreateUseCase {
+


다른 서비스 클래스들은 CreateDomainService 이런식으로 지었는데 여기만 DomainCreateService로 지은 이유가 있으신가요?

leebs0521 · 2025-01-11T09:55:42Z

...java/com/somemore/domains/volunteerrecord/event/convert/VolunteerRecordMessageConverter.java

+    private VolunteerRecord buildVolunteerRecordCreate(String message) throws JsonProcessingException {
+
+        VolunteerRecordCreateEvent volunteerRecordCreateEvent = objectMapper.readValue(message, VolunteerRecordCreateEvent.class);
+
+        return VolunteerRecord.create(
+                volunteerRecordCreateEvent.getVolunteerId(),
+                volunteerRecordCreateEvent.getTitle(),
+                volunteerRecordCreateEvent.getVolunteerDate(),
+                volunteerRecordCreateEvent.getVolunteerHours()
+        );


저도 재중님 의견이 괜찮아보이네요

leebs0521 · 2025-01-11T09:57:00Z

.../com/somemore/domains/interestcenter/event/converter/CreateRecruitBoardMessageConverter.java


            return switch (DomainEventSubType.from(eventType)) {
                case CREATE_RECRUIT_BOARD -> parseCreateRecruitBoardEvent(message);
+                case VOLUNTEER_HOURS_SETTLE -> null;


여기 null인 이유는 추후 구현인건가요?
로직을 몰라서 여쭤봅니다

leebs0521 · 2025-01-11T09:59:59Z

...main/java/com/somemore/domains/volunteerapply/service/SettleVolunteerApplyFacadeService.java

            apply.changeAttended(true);
            updateVolunteerUseCase.updateVolunteerStats(apply.getVolunteerId(), hours);
            publishVolunteerReviewRequestEvent(apply, recruitBoard);
+            volunteerRecordEventPublisher.publishVolunteerRecordCreateEvent(apply, recruitBoard);


publishVolunteerReviewRequestEvent(apply, recruitBoard);
volunteerRecordEventPublisher.publishVolunteerRecordCreateEvent(apply, recruitBoard);

이거 방식이 달라서 상의해서 한가지로 통합하는게 좋아보입니다.

- 봉사 기록 엔티티 추가 - 엔티티 생성 메서드 구현

- 레포지토리 인터페이스 생성 - Jpa 레포지토리 생성 - 레포지토리 구현체 생성

- 엔티티 생성 메서드 테스트및 검증 완료

- 봉사 기록 등록 유스케이스 생성 - 봉사 기록 등록 구현체 생성 - 테스트 코드 작성및 검증 완

- 도메인 이벤트 타입에 봉사 시간 정산 이벤트 등록 - 발행될 봉사 시간 정산 이벤트 클래스 생성 - 봉사 시간 정산 이벤트 퍼블리셔 생성 - 구독을 위한 봉사 시간 정산 이벤트 RedisSubscriber 생성 - RedisListenerRegistrar애 구독 클래스 추가 - 봉사 시간 정산 이벤트 메세지 컨버터 생성 - 봉사 기록 생성 이벤트 핸들러 인터페이스 생성 - 봉사 기록 생성 이벤트 핸들러 구현체 생성 - 봉사 시간 정산 메서드에 봉사 기록 생성 이벤트 의존성 주입 - 테스트 코드 작성및 검증 완료

- 추가된 도메인 이벤트 타입으로 인해 발생한 에러 해결을 위해 case추가

- 이벤트 발행 테스트의 분리

- RedisSettleVolunteerHoursSubscriber 클래스에 마지막 라인 개행추가 - VolunteerRecordMessageConverter의 봉사 기록 객체 생성 메서드 이름 변경

sonarqubecloud · 2025-01-14T02:53:02Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

7zrv added Feature 서진 labels Jan 10, 2025

7zrv requested review from ayoung-dev, leebs0521 and m-a-king January 10, 2025 08:05

7zrv self-assigned this Jan 10, 2025

7zrv linked an issue Jan 10, 2025 that may be closed by this pull request

[FEATURE]봉사 기록 도메인의 추가 생성, 조회 기능 개발 #287

Closed

3 tasks

This comment was marked as off-topic.

Sign in to view

github-actions bot changed the title ~~Feature/287 봉사 기록 엔티티와 이벤트 기반 생성 방식 구현~~ [BUILD FAIL] Feature/287 봉사 기록 엔티티와 이벤트 기반 생성 방식 구현 Jan 10, 2025

github-actions bot closed this Jan 10, 2025

This comment was marked as off-topic.

Sign in to view

7zrv reopened this Jan 10, 2025

This comment was marked as off-topic.

Sign in to view

github-actions bot changed the title ~~[BUILD FAIL] Feature/287 봉사 기록 엔티티와 이벤트 기반 생성 방식 구현~~ [BUILD FAIL] [BUILD FAIL] Feature/287 봉사 기록 엔티티와 이벤트 기반 생성 방식 구현 Jan 10, 2025

github-actions bot closed this Jan 10, 2025

This comment was marked as off-topic.

Sign in to view

7zrv reopened this Jan 10, 2025

7zrv changed the title ~~[BUILD FAIL] [BUILD FAIL] Feature/287 봉사 기록 엔티티와 이벤트 기반 생성 방식 구현~~ Feature/287 봉사 기록 엔티티와 이벤트 기반 생성 방식 구현 Jan 10, 2025

m-a-king approved these changes Jan 10, 2025

View reviewed changes

ayoung-dev approved these changes Jan 11, 2025

View reviewed changes

leebs0521 approved these changes Jan 11, 2025

View reviewed changes

7zrv added 7 commits January 14, 2025 11:28

feat: 봉사 기록 엔티티 추가

fbcd8ac

- 봉사 기록 엔티티 추가 - 엔티티 생성 메서드 구현

feat: 봉사 기록 도메인 레포지토리 추가

18a9cef

- 레포지토리 인터페이스 생성 - Jpa 레포지토리 생성 - 레포지토리 구현체 생성

feat: 봉사 기록 엔티티 테스트 코드 추가

2c28207

- 엔티티 생성 메서드 테스트및 검증 완료

feat: 봉사 기록 등록 유스케이스및 구현체 생성

fce9791

- 봉사 기록 등록 유스케이스 생성 - 봉사 기록 등록 구현체 생성 - 테스트 코드 작성및 검증 완

fix(RecruitBoardMessageConverter): switch문에서 발생하는 에러 해결

e022479

- 추가된 도메인 이벤트 타입으로 인해 발생한 에러 해결을 위해 case추가

fix: 봉사 기록 이벤트 발행 테스트 분리

2c6d162

- 이벤트 발행 테스트의 분리

chore: 코드리뷰 사항 반영

7ff6c7e

- RedisSettleVolunteerHoursSubscriber 클래스에 마지막 라인 개행추가 - VolunteerRecordMessageConverter의 봉사 기록 객체 생성 메서드 이름 변경

7zrv force-pushed the feature/287-add-volunteer-record branch from 468c35b to 7ff6c7e Compare January 14, 2025 02:49

7zrv merged commit 6738940 into main Jan 14, 2025
3 checks passed

7zrv deleted the feature/287-add-volunteer-record branch January 14, 2025 02:53

Feature/287 봉사 기록 엔티티와 이벤트 기반 생성 방식 구현 #293

Feature/287 봉사 기록 엔티티와 이벤트 기반 생성 방식 구현 #293

Uh oh!

Conversation

7zrv commented Jan 10, 2025

📌 과제 설명

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

✅ PR 포인트 & 궁금한 점

Uh oh!

This comment was marked as off-topic.

Uh oh!

This comment was marked as off-topic.

Uh oh!

This comment was marked as off-topic.

Uh oh!

This comment was marked as off-topic.

Uh oh!

m-a-king 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!

7zrv Jan 10, 2025 • 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!

m-a-king Jan 11, 2025 • 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ayoung-dev left a comment

Choose a reason for hiding this comment

Uh oh!

leebs0521 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!

sonarqubecloud bot commented Jan 14, 2025

Quality Gate passed

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

7zrv Jan 10, 2025 •

edited

Loading

m-a-king Jan 11, 2025 •

edited

Loading