[Event] 실제 프로젝트에서 Spring Event를 적용해 복잡한 의존 관계 해소하기

Spring Event를 처음 들어본다면 아래 글을 먼저 보고 오는 것을 추천한다.

https://dgjinsu.tistory.com/41

[Event] Spring Event 왜 사용할까??

1. 이벤트를 사용하는 이유 Spring Boot에서 이벤트를 적용하는 방법에 대해 들어가기 전에, 이벤트를 왜 써야하는지, 사용하면 좋은 상황에 대해 먼저 알아보자. 회원가입을 하고 나면 가입 축하

dgjinsu.tistory.com

https://dgjinsu.tistory.com/42

[Event] Spring Event 도입 시 트랜잭션 처리에 대한 고민

1. 서론 전 게시글에서 Spring Event로 의존성을 개선하는 법을 다뤄보았다. 하지만 한 트랜잭션 안에서 처리하던 것들이 흩어지면서 문제되는 부분도 있다. 이번엔 그 부분을 깊게 다뤄볼 생각이다

dgjinsu.tistory.com

예전에 Spring Event에 대해 우연히 알게 되었고, 개발하던 중 여기 도입하면 좋겠다 라는 생각이 들어 학습 후 도입하게 되었다. 우선적으로 적용하려는 부분은 아래 내용이다.

현재 개발중인 프로젝트에서 기업이 노동자에게 일자리를 제안하는 기능을 만들게되었다.

제안을 하게되면 알림 정보를 저장하고 FCM을 사용한 PUSH알림 및 카카오 알림톡을 보내주는 프로세스로 동작한다.

1.1 적용 전 - 아키텍처

동작하는 프로세스를 그림으로 간단하게 나타내보았다.

1.2 적용 전 - 코드

- HeadHuntingService

@Service
@RequiredArgsConstructor
@Transactional
@Slf4j
public class HeadHuntingCompanyService {
    private final MemberRepository memberRepository;
    private final HeadHuntingRepository headHuntingRepository;
    private final NotificationService notificationService;
    private final JobPostRepository jobPostRepository;

    public void offerJobPost(Long companyId, OfferRequest request) {
        Member company = memberRepository.findById(companyId)
                .orElseThrow(() -> new CustomException(ErrorCode.MEMBER_NOT_FOUND));
        HeadHunting headHunting = headHuntingRepository.findByIdWithMember(request.getHeadHuntingId())
            	.orElseThrow(() -> new CustomException(ErrorCode.HEAD_HUNTING_NOT_FOUND));
        // 요청한 jobPostId 가 유효한지 체크
        List<Long> jobPostIdList = request.getOfferJobPostRequest().stream()
                .map(OfferJobPostRequest::getJobPostId)
                .collect(Collectors.toList());
        Long findJobPostCount = jobPostRepository.findByIdList(jobPostIdList);
        if (jobPostIdList.size() != findJobPostCount) {
            throw new CustomException(ErrorCode.JOB_POST_NOT_FOUND);
        }

        List<OfferJobPostRequest> offerJobPostRequestList = request.getOfferJobPostRequest();
        for (OfferJobPostRequest offerJobPostRequest : offerJobPostRequestList) {
            String dateList = offerJobPostRequest.getWorkDateList().stream()
                    .map(date -> date.toString().substring(5, 10))
                    .collect(Collectors.joining(", "));

            String content = "[" + company.getCompanyInfo().getCompanyName() + "] 에서 " + dateList + "에 일자리를 제안했습니다.";
            String url = "/api/worker/job-post/" + jobPost.getId();

            notificationService.saveNotification(request.getMemberId(), NotificationType.OFFER, content, url);
        }
    }

- NotificationService

@Service
@RequiredArgsConstructor
@Transactional
@Slf4j
public class NotificationService {
    private final NotificationRepository notificationRepository;
    private final FCMNotificationService fcmNotificationService;
    private final MemberRepository memberRepository;

    public void saveNotification(Long receiverId, NotificationType type, String content, String url) {
        Member worker = memberRepository.findById(receiverId)
                .orElseThrow(() -> new CustomException(ErrorCode.MEMBER_NOT_FOUND));

        Notification notification = Notification.builder()
                .content(content)
                .url(url)
                .notificationType(type)
                .receiver(worker)
                .build();

        notificationRepository.save(notification);

        // push 알림 수락 시
        if (worker.getIsNotification()) {
            // fcm 알림 발송
            FCMNotificationRequestDto request = FCMNotificationRequestDto.builder()
                    .targetMemberId(worker.getId())
                    .title(content)
                    .body(content)
                    .build();
            fcmNotificationService.sendNotificationByToken(request);
        }
        
        // 알림톡 발송
        ...
    }
}

의존성 관계가 연쇄적으로 연결되어있고 이는 코드의 가독성 및 유지보수 등 여러 측면에서 안 좋은 예라고 볼 수 있다.

이를 다음과 같이 리펙토링 하면서 강한 의존성을 갖고 있던 기존의 문제점을 해결할 수 있었다.

2.1 적용 후 - 아키텍처

이벤트를 적용함으로써 조금은 더 복잡하지만 HeadHuntingService, NotificationService, FCMService, AliTalkService는 서로 어떠한 의존도 하지 않음을 볼 수 있다.

2.2 적용 후 - 코드

우선 HeadHuntingService => NotificationService 의존성 부터 끊어주었다.

- Event 클래스 생성 (1)

@AllArgsConstructor
@Getter
public class NotificationEvent {
    // content & url 에 사용
    private String companyName;
    private List<LocalDate> workDateList;
    private Long jobPostId;

    private NotificationType notificationType;
    private Long receiverId;
}

- EventHandler 생성 (1)

@Component
@RequiredArgsConstructor
public class NotificationHandler {
    private final NotificationService notificationService;

    @Async
    @TransactionalEventListener(phase = TransactionPhase.AFTER_COMMIT)
    public void saveNotification(NotificationEvent event) {
        String dateList = event.getWorkDateList().stream()
                .map(date -> date.toString().substring(5, 10))
                .collect(Collectors.joining(", "));

        String content = "[" + event.getCompanyName() + "] 에서 " + dateList + "에 일자리를 제안했습니다.";
        String url = "/api/worker/job-post/" + event.getJobPostId();
        notificationService.saveNotification(event.getReceiverId(), event.getNotificationType(), content, url);
    }
}

- HeadHuntingService 수정

@Service
@RequiredArgsConstructor
@Transactional
@Slf4j
public class HeadHuntingCompanyService {
    private final MemberRepository memberRepository;
    private final ProjectRepository projectRepository;
    private final HeadHuntingRepository headHuntingRepository;
    private final ApplicationEventPublisher publisher;

    public void offerJobPost(Long companyId, OfferRequest request) {
        Member company = memberRepository.findById(companyId)
                .orElseThrow(() -> new CustomException(ErrorCode.MEMBER_NOT_FOUND));
        HeadHunting headHunting = headHuntingRepository.findByIdWithMember(request.getHeadHuntingId())
                .orElseThrow(() -> new CustomException(ErrorCode.HEAD_HUNTING_NOT_FOUND));

        // 요청한 jobPostId 가 유효한지 체크
        List<Long> jobPostIdList = request.getOfferJobPostRequest().stream()
                .map(OfferJobPostRequest::getJobPostId)
                .collect(Collectors.toList());
        Long findJobPostCount = jobPostRepository.findByIdList(jobPostIdList);
        if (jobPostIdList.size() != findJobPostCount) {
            throw new CustomException(ErrorCode.JOB_POST_NOT_FOUND);
        }

        for (OfferJobPostRequest offerJobPostRequest : request.getOfferJobPostRequest()) {
            publisher.publishEvent(new NotificationEvent(company.getCompanyInfo().getCompanyName(), offerJobPostRequest.getWorkDateList(), offerJobPostRequest.getJobPostId(), NotificationType.OFFER, headHunting.getMember().getId()));
        }
    }
}

이젠 NotificationService => FCMService, AlimTalkService 의존성을 끊어주자.

- Event 클래스 생성 (2)

@AllArgsConstructor
@Getter
public class AlarmEvent {
    private String content;
    private Long receiverId;
    private String phone;
    private String templateCode;
}

- EventHandler 생성 (2)

@Component
@RequiredArgsConstructor
public class AlarmHandler {
    private final FCMNotificationService fcmNotificationService;
    private final AlimTalkService alimTalkService;

    @Async
    @TransactionalEventListener(phase = TransactionPhase.AFTER_COMMIT)
    public void sendFCM(AlarmEvent event) {
        // fcm 알림 발송
        FCMNotificationRequestDto request = FCMNotificationRequestDto.builder()
                .targetMemberId(event.getReceiverId())
                .title(event.getContent())
                .body(event.getContent())
                .build();
        fcmNotificationService.sendNotificationByToken(request);
    }

    @Async
    @TransactionalEventListener(phase = TransactionPhase.AFTER_COMMIT)
    public void sendAlimTalk(AlarmEvent event) {
        alimTalkService.sendAlimTalk(event.getPhone(), event.getTemplateCode(), event.getContent());
    }
}

- NotificationService 수정

@Service
@RequiredArgsConstructor
@Transactional
@Slf4j
public class NotificationService {
    private final NotificationRepository notificationRepository;
    private final MemberRepository memberRepository;
    private final ApplicationEventPublisher publisher;

    public void saveNotification(Long receiverId, NotificationType type, String content, String url) {
        Member worker = memberRepository.findById(receiverId)
                .orElseThrow(() -> new CustomException(ErrorCode.MEMBER_NOT_FOUND));

        Notification notification = Notification.builder()
                .content(content)
                .url(url)
                .notificationType(type)
                .receiver(worker)
                .build();

        notificationRepository.save(notification);

        publisher.publishEvent(new FCMEvent(content, worker.getId()));
    }
}

3. 결론

결합도를 낮추고 응집도를 높이다!

개발을 하다 보면 "코드를 작성할 때 결합도가 낮고 응집도가 높아야 좋은 코드다" 라는 말을 들어봤을 것이다. 무엇보다 동작하는 코드가 중요하지만 유지보수성을 고려했을 때 무엇보다 중요하게 생각해야한다.

이번에 스프링 이벤트에 대해 학습하고 이를 도입해 빈(Bean) 간 데이터를 주고받을 때 이벤트를 발행(Publish)하고 이벤트를 수신 또는 구독하여 소비(Listen /Subscribe)할 수 있도록 하였다.

늘어난 코드량과 줄어든 직관력

장점만 있는 것은 아니었다. 스프링 이벤트를 사용하다보니 리스너에게 전달할 때 필요한 Event 객체, 각 핸들러 등 코드량과 애플리케이션 복잡도는 높아졌다. 또한 코드가 직관적이지 않다보니 다른 사람이 코드를 볼 때 힘들수도 있겠다는 생각이 들었다.

Spring Event의 역할을 Apache Kafka, RabbitMQ와 같은 메시징 브로커도 수행할 수 있는데 이는 추후에 학습 후 고민해봐야겠다.

참고

https://mangkyu.tistory.com/292

'Spring Boot, JAVA 🌱' 카테고리의 다른 글

[Spring Batch] ItemReader cursor vs paging (0)	2024.03.11
JPA 1차 캐싱을 이용한 성능 튜닝, 그리고 1차 캐싱이 되지 않는 경우와 우회법 (2)	2024.02.29
[Event] Spring Event 도입 시 트랜잭션 처리에 대한 고민 (1)	2024.02.22
[Event] Spring Event란? 이벤트 발행과 구독 방법 (0)	2024.02.21
[Redis] Redis로 최근 검색 기록 관리하기 (0)	2024.02.02