🛟 상황

학원에 대해서 리뷰를 등록할 수 있는 기능이 있다.

학원을 조회할 때 등록된 리뷰 카운트를 빠르게 조회할 필요가 있었다.

그렇다면 리뷰 등록할 때 리뷰로 선택한 타입 카운트가 증가되어야 한다.

POST 메소드로 요청 처리하는데, 값 갱신 PATCH 메소드 동작이 포함되는 것이다.

서로 다른 도메인 간의 의존성을 줄일 방법이 필요했다.

이벤트 리스너

그게 답이라 생각했다.

🎨 ERD

오직 학원에 대한 리뷰 카운트 조회 성능 위해 반정규화 했다.

• academy 도메인
  • academies 테이블
    • Id : 식별자
    • academyName : 학원 이름
  • review_counts 테이블
    • kindnessCount : 친절함 리뷰 개수
    • goodFacilityCount : 좋은 시설 리뷰 개수
    • cheapFeeCount : 값싼 교육비 리뷰 개수
    • goodManagementCount : 좋은 관리 리뷰 개수
• reviews 도메인
  • reviews 테이블
    • kindness : 친절함 리뷰 개수
    • goodFacility : 좋은 시설 리뷰 개수
    • cheapFee : 값싼 교육비 리뷰 개수
    • goodManagement : 좋은 관리 리뷰 개수

네이버 리뷰처럼 리뷰 등록 시 특정 키워드를 선택해서 리뷰 카운트를 증가시키는 방식이다.

지도에서 학원을 검색하면, 여태까지 갱신된 리뷰 카운트를 조회해서 사용자에게 보여준다.

🤖 이벤트 리스너

스프링 이벤트

1. 이벤트 발생 시 EventDispatcher 에게 전달
2. EventDispatcher 가 매핑되는 EventListener 연결
3. EventListener 가 전달받은 데이터를 활용해 코드 실행

의존성

Spring Web 의존성이 필요하다.

근데 스프링 쓰면서 웹 의존성 안 필요할 때가 있나몰랑

implementation 'org.springframework.boot:spring-boot-starter-web'

구현

이벤트 리스너를 구현하는 방식은 간단하다.

1. 이벤트 클래스를 구현한다.
2. 리스너 클래스를 구현한다.
3. 이벤트 리스너를 호출해서 리스너에게 영향을 준다.

우리 효자 스프링이 EventDispatcher를 이미 구현해놓았기 때문에 우리는 편하게 이벤트와 리스너만 구현하고 등록해서 쓰면 된다.

스프링 4.2 이후 버전

2023년 기준 스프링을 4버전까지 낮춰서 사용하는 사람은 없을거라 생각해서 최신 기준으로 코드를 작성했다.

4.2 이전 코드와의 차이점은 ApplicationEventPublisher 클래스를 상속하는 코드 유무 정도다.

우리는 스프링의 호의를 감사히 받아들이면 된다.

이벤트 클래스

이벤트를 등록, 호출하는 책임을 갖는다.

이벤트로 호출하고픈 코드에 필요한 정보를 응집하는 필드를 넣어놨다.

public class NewReviewEvent {

    private final Review review;

    public NewReviewEvent(Review review) {
        this.review = review;
    }

    public long getAcademyId() {
        return review.getAcademyId();
    }

    public Map<String, Boolean> getReviews() {
        return Map.of(
                "kindness", review.isKindness(),
                "goodFacility", review.isGoodFacility(),
                "cheapFee", review.isCheapFee(),
                "goodManagement", review.isGoodManagement());
    }

}

리스너 클래스

이벤트 클래스에 의해 호출되는 클래스

• @Component 스프링 빈으로 만들어 사용해야 한다. 그래야 EventDispatcher가 런타임에 Event 클래스와 매핑해서 연결해줄 수 있다.
  
• @EventListener 리스너로 등록한다는 의미. 매개변수로 EventPublisher 를 받아서 사용하기 때문에 Event와 매핑되는 것. 한 리스너 클래스에 여러 이벤트 리스너를 등록해도 된다. 이때는 모든 이벤트 리스너가 호출된다. 바로 다음 컬럼에 설명 예정
  
• @TransactionalEventListener 리스너의 동작까지도 트랜잭션에 포함시키는 어노테이션이다. 나는 DB 갱신에 해당하는 코드가 리스너에서 필요한 내용이기 때문에 이 어노테이션을 썼다. 만약 리스너 메소드 프로시저에서 문제가 발생한다면, 해당 이벤트에 해당하는 트랜잭션 자체가 모두 롤백된다.

  옵션(phase)	설명
  TransactionPhase.AFTER_COMMIT	(기본값) 트랜잭션 커밋될 때 이벤트 실행
  TransactionPhase.ROLLBACK	트랜잭션 롤백될 때 이벤트 실행
  TransactionPhase.AFTER_COMPLETION	트랜잭션 커밋 혹은 롤백될 때 이벤트 실행
  TransactionPhase.BEFORE_COMMIT	트랜잭션 커밋 전에 이벤트 실행

@Component
public class NewReviewEventListener {

    private final AcademyService academyService;

    public NewReviewEventListener(AcademyService academyService) {
        this.academyService = academyService;
    }

    // @EventListener
		@TransactionalEventListener
    public void sendPush(NewReviewEvent event) {
        long academyId = event.getAcademyId();
        Map<String, Boolean> reviews = event.getReviews();

        academyService.updateReviewCount(academyId, reviews);
    }

}

이벤트 등록

리뷰 등록 메소드에서 이벤트를 활용했다.

이렇게 원하는 메소드에서 이벤트를 생성해서 등록해주면 된다.

publishEvent 메소드를 활용해서 이벤트를 발생시킨다.

@Service
@Transactional(readOnly = true)
public class ReviewService {

		// 이벤트 등록자 주입
    private final ApplicationEventPublisher eventPublisher;
    private final ReviewJpaRepository reviewJpaRepository;

    public ReviewService(
            ApplicationEventPublisher eventPublisher,
            ReviewJpaRepository reviewJpaRepository
    ) {
        this.eventPublisher = eventPublisher;
        this.reviewJpaRepository = reviewJpaRepository;
    }

    @Transactional
    public ReviewResult createReview(long academyId, ReviewParam param) {
        Review review = param.toEntity(academyId);
        Review save = reviewJpaRepository.save(review);

				// 등록할 이벤트 생성
        NewReviewEvent newReviewEvent = new NewReviewEvent(save);

				// 이벤트 등록
        eventPublisher.publishEvent(newReviewEvent);

        return ReviewResult.from(save);
    }

}

동기 vs 비동기

반가운 우리 동기 형제.

동기는 응답 기다리고 다음꺼 실행.

비동기는 응답 기다리지 않고 다음꺼 실행.

여기선 이정도로 정리 가능하다.

스프링 이벤트는 기본적으로 동기 처리를 지원한다.

쉽게 말해서 리스너의 모든 메소드가 각자 실행 → 응답 후에 다음 메소드가 실행된다는 것.

비동기는 응답 전에 다른 메소드도 실행한다.

딱 봐도 성능과 정합성 트레이드 오프라는 걸 알 수 있다.

그렇다면 궁금한 점이 생긴다.

동기 처리할 때 실행 순서는 어떻게 정해지나?

@Slf4j
@Component
public class NewReviewEventListener {

    @EventListener
    public void sendPush(NewReviewEvent event) {
        log.info("첫 번째 이벤트 리스너 메소드 실행");
    }

    @EventListener
    public void sendPush2(NewReviewEvent event) {
        log.info("두 번째 이벤트 리스너 메소드 실행");
    }

}

응답을 보면 알 수 있듯이 코드 순서 대로다.

그러면 비동기일 때는?

@Slf4j
@Component
public class NewReviewEventListener {

    @Async
    @EventListener
    public void sendPush(NewReviewEvent event) throws InterruptedException {
        log.info("첫 번째 이벤트 리스너 메소드 실행");

        Thread.sleep(1_000);

        log.info("첫 번째 이벤트 리스너 메소드 종료");
    }

    @Async
    @EventListener
    public void sendPush2(NewReviewEvent event) {
        log.info("두 번째 이벤트 리스너 메소드 실행");
        log.info("두 번째 이벤트 리스너 메소드 종료");
    }

}

@Async 어노테이션을 사용해서 비동기처리가 가능해진다.

🗂️ 패키지 구조

이벤트 리스너를 구현하면서 고민거리가 하나 있었다.

결론부터 말하자면, 생각의 오류 때문에 했던 고민이었고 쉽게 해결 가능했다.

그림이 상당히 추상화되어 있어서 알아보기 힘들 수 있다.

두 형태의 구조에서 각각 문제가 있어 고민 했다.

그림 아래 정리했다.

고민점

• 1번 구조 문제점
  • 이벤트 → 리스너 호출시 DTO 클래스는 어느 도메인에 있어야 할까?
• 2번 구조 문제점
  • 이벤트 등록마다 글로벌을 참조하는게 맞을까?

고민타파

• 이벤트는 애초에 도메인에 포함되야 함.
• DTO 쓰지 말고 Java 기본 클래스를 사용하면 됨

좀 더 설명하자면,

DTO 를 어디에 구현할지 고민할 필요가 없이, 모든 정보를 파해쳐서 기본 타입으로 넘기면 되는 문제였다.

위에 이벤트 클래스 코드를 보면 DTO 가 없다.

long 타입의 변수와 Map 자료구조를 활용해서 도메인에 의존하지 않고 데이터 전달이 가능하다.