[Event] Spring Event란? 이벤트 발행과 구독 방법

 

1. 이벤트를 사용하는 이유

Spring Boot에서 이벤트를 적용하는 방법에 대해 들어가기 전에, 이벤트를 왜 써야하는지, 사용하면 좋은 상황에 대해 먼저 알아보자. 회원가입을 하고 나면 가입 축하 메세지를 전송하는 동시에 쿠폰을 전송하는 서비스가 있다고 가정해보았다.

 

@Service
@RequiredArgsConstructor
public class MemberService {

    private final AlarmService alarmService;
    private final AlimTalkService alimTalkService;

    public void register(String name) {
        // 회원가입 처리 로직
        System.out.println("회원 추가 완료");

        // 가입 축하 푸시 알림
        alarmService.send(name);

        // 카카오 알림톡 전송
        alimTalkService.send(name);
    }
}

 

코드로 간략하게 작성하면 위와 같이 작성할 수 있다. 하지만 이 코드엔 몇 가지 문제점이 있다.

 

1) 강한 결합

현재 회원가입 서비스에 회원 가입 로직뿐만 아니라 가입 축하 푸시 알림을 보내는 로직, 카카오 알림톡 전송하는 로직이 모두 섞여있다. 이렇게 서로 강한 결합으로 묶여있으면 후에 유지보수가 어렵고 코드의 구조가 복잡하다.

 

2) 성능

실제론 그런 경우는 없겠지만 가입 축하 푸시 알림을 보내는데 3분, 알림톡을 보내는데 3분이 걸린다고 하면 총 회원가입은 6분이 걸리게 된다. 메인 이벤트인 회원가입 처리 로직을 끝내면 서브 이벤트인 가입 축하 메세지 전송이나 가입 축하 쿠폰은 전송완료까지 기다릴 필요가 없다.

 

3) 트랜잭션

위 로직에서 만약 알림톡을 전송하다 오류가 나면 어떻게될까?? 한 트랜잭션으로 묶여있기 때문에 이전에 처리한 로직들까지 전부 롤백된다. 차라리 회원 가입 처리를 해주고, 푸시알림과 알림톡을 따로 관리하는게 옳은 방법이다.

바로 위와 같은 상황을 해결하는 방법 중에 이벤트를 적용해서 해결하는 방법이 있다. 이벤트는 생성 주체의 상태가 변경되면 이벤트를 발생시켜 원하는 기능을 실행해서 후처리를 도와준다.

 

 

 

2. 이벤트의 실행 단계

1. 생성 주체(주로 도메인 객체)에서 이벤트를 발생하면 이벤트 디스패처에게 전달한다.
2. 이벤트 디스패처가 이벤트 핸들러를 연결해준다.
3. 이벤트 핸들러에서 이벤트에 담긴 데이터를 통해 원하는 기능을 실행한다.

 

 

3.1 강한 결합 해결

이제 Spring Event를 이용해 문제점들을 하나하나 해결해나가 보자.

 

- 이벤트 클래스 생성

public class RegisteredEvent {

  private String name;

  public RegisteredEvent(String name) {
    this.name = name;
  }

  public String getName() {
    return name;
  }
}

 

이벤트는 상태가 바뀐 후에 발생하기 때문에 이벤트 클래스의 이름은 과거시제로 지어야한다. 또한, 이벤트 클래스는 이벤트를 처리하는 데이터를 포함한다.

예제에선 특정 회원에게 알림을 보내기 위해선 정보가 필요했기 때문에 name을 필드로 넣어주었다.

 

 

- 기존의 MemberService 수정

@Service
@RequiredArgsConstructor
public class MemberService {

//    private final AlarmService alarmService;
//    private final AlimTalkService alimTalkService;

    private final ApplicationEventPublisher publisher;

    public void register(String name) {
        // 회원가입 처리 로직
        System.out.println("회원 추가 완료");

        // 이벤트 등록
        publisher.publishEvent(new RegisteredEvent(name));

//        // 가입 축하 푸시 알림
//        alarmService.send(name);
//
//        // 카카오 알림톡 전송
//        alimTalkService.send(name);
    }
}

 

이벤트를 보내는 기능을 사용하기 위해 ApplicationEventPublisher를 주입해주었고,

회원가입 처리를 완료하면, publishEvent를 사용해 이벤트를 발행해준다.

기존에 있었던 알림 서비스와의 의존관계는 제거하였다.

 

 

- 이벤트 핸들러 등록

@Component
@RequiredArgsConstructor
public class SmsEventHandler {

    private final AlarmService alarmService;
    private final AlimTalkService alimTalkService;

    @EventListener
    public void sendFCM(RegisteredEvent event) {
        System.out.println("[SmsEventHandler - sendFCM]");
        alarmService.send(event.getName());
    }

    @EventListener
    public void sendAlimTalk(RegisteredEvent event) {
        System.out.println("[SmsEventHandler - sendAlimTalk]");
        alimTalkService.send(event.getName());
    }
}

 

@EventListener를 사용하면 이벤트 리스너로 등록이 되고, 매개변수에 이벤트 클래스를 정의하면 해당 이벤트가 발생했을 때 수신해서 처리를 할 수 있다.

 

 

- 테스트

@Test
@DisplayName("회원 가입 테스트")
void register() {
    String name = "dgjinsu";

    memberService.register(name);
}

 

간단하게 테스트코드를 작성하고 결과를 살펴보면 아래와 같이 로그가 찍히는걸 확인할 수 있다.

결과적으로 동일한 동작을 수행하지만 컴포넌트간 결합도는 낮출 수 있었다.

 

 

 

 

3.2 성능 문제 해결

알림을 보내는 각 service 로직에 임시로 쓰레드 슬립을 걸어주어 로직을 처리하는데 오래 걸리는 상황이라 가정해보았다.

 

@Service
public class AlarmService {
    public void send(String name) throws InterruptedException {
        Thread.sleep(3000); // 3초 sleep
        System.out.println(name + "에게 push 알림 발송");
    }
}

@Service
public class AlimTalkService {
    public void send(String name) throws InterruptedException {
        Thread.sleep(3000); // 3초 sleep
        System.out.println(name + "에게 알림톡 발송");
    }
}

 

 

client 입장에선 회원가입을 요청하고 약 6초 뒤 완료 화면을 볼 수 있다.

@EnableAsync 와 @Async 어노테이션을 사용하여 비동기로 처리해주면 해결 가능하다.

 

@SpringBootApplication
@EnableAsync // 추가
public class TestApplication {
    public static void main(String[] args) {
       SpringApplication.run(TestApplication.class, args);
    }
}


@Component
@RequiredArgsConstructor
public class SmsEventHandler {

    private final AlarmService alarmService;
    private final AlimTalkService alimTalkService;

    @Async // 추가
    @EventListener
    public void sendFCM(RegisteredEvent event) throws InterruptedException {
        System.out.println("[SmsEventHandler - sendFCM]");
        alarmService.send(event.getName());
    }

    @Async // 추가
    @EventListener
    public void sendAlimTalk(RegisteredEvent event) throws InterruptedException {
        System.out.println("[SmsEventHandler - sendAlimTalk]");
        alimTalkService.send(event.getName());
    }
}

 

결과는 2ms로 푸시 알림 로직과 알림톡 로직에 영향을 받지 않는 모습을 확인할 수 있다. 

 

 

 

3.3 트랜잭션 처리

트랜잭션을 분리해 독립적으로 실행하기에 앞서 트랜잭션에 대해 가볍게 살펴보자. 

A,B는 각각 트랜잭션 어노테이션이 붙어있다. A함수에서 B함수를 실행했고 B함수에서 예외가 발생한다면 A함수도 롤백이 될까?? 

@Service
@RequiredArgsConstructor
@Transactional
public class MemberService {

    private final PlatformTransactionManager transactionManager;
    private final TestService testService;

    public void register(String name) {
        DefaultTransactionDefinition def = new DefaultTransactionDefinition();
        TransactionStatus status = transactionManager.getTransaction(def);

        try {
            testService.a();

            // 트랜잭션 커밋
            transactionManager.commit(status);
        } catch (Exception e) {
            transactionManager.rollback(status);
            System.out.println("트랜잭션 롤백");
        }
    }
    
    
    
@Service
public class TestService {

    public void a() throws Exception {
        Thread.sleep(3000);
        throw new Exception("에러");
    }
}

 

a함수에서 별도로 propagation을 설정하지 않았기 때문에 A 함수의 트랜잭션과 B 함수의 트랜잭션은 동일한 컨텍스트를 공유하게 된다. 따라서 B 함수에서 예외가 발생하면 A 함수의 트랜잭션도 롤백된다.

 

히지만 a함수가 @Async로 실행된다면 상황이 달라진다. 

 

비동기 호출의 경우 기본적으로 메서드 호출이 비동기적으로 이루어지므로 트랜잭션 컨텍스트가 서로 다를 수 있다.

트랜잭션 매니저는 주로 현재 쓰레드에 대한 트랜잭션 컨텍스트를 관리하며, 비동기적인 호출은 다른 쓰레드에서 처리될 수 있다.

따라서 A 함수와 B 함수가 서로 다른 쓰레드에서 실행될 경우, 트랜잭션 컨텍스트가 공유되지 않아 B의 예외가 A의 트랜잭션 결과에 영향을 미치지 않는다.

 

결과적으로 @Async를 사용해 비동기적으로 알림 이벤트를 처리할 경우 별다른 설정을 하지 않아도 트랜잭션이 분리된다. 

 

하지만 트랜잭션 분리한다고 다 해결되는 것은 아니다. 

나의 코드를 살펴보았을 때 회원가입이 완료되야 알림 로직이 실행되야 하는데, 회원가입이 실패해도 비동기로 처리해뒀기 때문에 알림 로직이 실행될 수 있다.

 

이를 해결하기 위한 방법도 물론 있다. 

이부분은 글이 길어져 아래 포스팅에서 자세하게 다뤄봤음

 

https://dgjinsu.tistory.com/42

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