Spring Events를 활용한 이벤트 기반 애플리케이션 개발
5분 소요
SpringBoot : 2.7.5 Java : 11
개요
이 글에서는 Spring 이벤트를 사용해 의존성을 제거하는 방법을 설명합니다. 애플리케이션을 개발하다 보면 서로 다른 서비스 사이에 의존성이 생길 수 있습니다.

사용자 등록
사용자를 등록할 때 위 그림처럼 EmailService와 PostService에 대한 의존성이 생깁니다.
이러한 의존성은 여러 문제를 일으킬 수 있으며, 그중 몇 가지는 다음과 같습니다.
- 강한 결합 사용자 등록 서비스에 등록 로직 외의 여러 로직이 섞여 있어 유지보수가 어려울 수 있습니다.
- 트랜잭션 이메일 전송에 실패했다는 이유만으로 회원 등록 결과를 롤백하는 것은 좋지 않습니다.
저라면 위 그림의 구조를 Spring 이벤트를 사용해 다음과 같이 바꾸겠습니다.

UserService가 이벤트를 생성해 ApplicationEventPublisher에 전달하고, 이벤트가 발행되면 ApplicationContext가 ApplicationListener를 구현한 빈들에게 알려 주는 형태가 됩니다.
서비스 간의 의존성이 사라진 것을 확인할 수 있습니다.
기본 예제를 설명한 뒤에, 더 확장 가능한 코드로 리팩터링해 보겠습니다.
서비스 간단 설명
사용자가 회원 가입을 완료하면 환영 이메일을 보내고 기본 게시글을 생성합니다.
사용자 정보 저장 → 이메일 전송 → 기본 게시글 생성
GitHub - Seonggil-Jeong/SpringBoot-Sample
이벤트 클래스 생성
@Getter
public class CreatedAccountEvent {
private String userId;
private String userName;
@Builder
public CreatedAccountEvent(String userId, String userName) {
this.userId = userId;
this.userName = userName;
}
}
필요한 데이터를 담고 있습니다. 이벤트 클래스는 과거형으로 이름을 짓습니다.
EventsPublisher
@Slf4j
@Component
@RequiredArgsConstructor
public class EventsPublisher {
private final ApplicationEventPublisher applicationEventPublisher;
public void pushCreateUserEvent(final String userId, final String userName) {
log.info(this.getClass().getName() + ".push create user event start!");
log.info("userId : " + userId);
log.info("userName : " + userName);
applicationEventPublisher.publishEvent(CreatedAccountEvent.builder()
.userName(userName)
.userId(userId).build());
}
}
생성한 이벤트를 전송할 Publisher를 구현합니다. publishEvent 메서드를 사용해 이벤트를 보낼 수 있습니다.
EventsListener
@Slf4j
@Component
@RequiredArgsConstructor
public class EventsListener {
private final PostRepository postRepository;
private final AccountRepository accountRepository;
@EventListener
public void pushEmailListener(CreateAccountEvent event) {
log.info(this.getClass().getName() + ".pushEmailListener Start");
log.info("userId : " + event.getUserId());
log.info("userName : " + event.getUserName());
System.out.println("push Email To " + event.getUserName() + " Hello!");
}
@EventListener
@Transactional(rollbackFor = Exception.class)
public void createDefaultPost(CreateAccountEvent event) {
final AccountEntity account = accountRepository.findById(event.getUserId()).orElseThrow(()
-> new NoSuchElementException("cannot found account with id : " + event.getUserId()));
postRepository.save(PostEntity.builder()
.createDate(new Date())
.postContent("default Post")
.postTitle("Default Post from Listener")
.createUserId(account).build());
}
}
@EventListener 어노테이션을 사용하면 파라미터가 일치하는 Listener가 실행됩니다.
서비스
@Override
public void registerAccount(final RegisterAccountRequest request) throws Exception {
validateService.canRegister(request); // userId, nickname are duplicated
final AccountEntity result = accountRepository.save(AccountEntity.builder()
.userId(request.getUserId())
.password(passwordEncoder.encode(request.getPassword()))
.nickname(request.getNickname())
.userName(request.getUserName())
.createDate(new Date())
.role(RoleType.USER)
.state(1).build());
// remove send email
// remove create default post
eventPublisher.pushCreateUserEvent(result.getUserId(), result.getUserName());
}
이제 기존 서비스 로직을 바꿔 회원 가입이 끝난 뒤 이벤트를 보내도록 할 수 있습니다.

pushEmailListener 메서드 실행 결과

createDefaultPost 메서드 실행 결과
두 Listener가 요청을 받아 정상적으로 처리한 것을 확인할 수 있습니다.
상속으로 한 단계 더 나아가기
기본적인 사용법을 익혔으니, 상속(extends)을 통해 더 유연한 이벤트를 구현해 보겠습니다.
이벤트를 그룹으로 묶는 것과 비슷합니다.
예를 들어 앞서와 같이 사용자가 회원 가입할 때 이벤트가 발행되고, 사용자가 로그인에 성공했을 때에도 이벤트가 발행된다고 해 보겠습니다.
이 상황에서 사용자와 관련된 이벤트가 발생할 때 실행되는 Listener를 추가하려면 어떻게 해야 할까요? → 단순한 방법으로는 로그인 메서드와 회원 가입 메서드에서 이벤트를 추가로 발행하면 됩니다.
// register
public void registerAccount(final RegisterAccountRequest request) throws Exception {
...
eventPublisher.pushCreateUserEvent(result.getUserId(), result.getUserName());
// add eventPublisher.pushUserAction( ~~~ )
}
// login
public void userLogin() {
...
eventPublisher.pushLoginUserEvent(result.getUserId(), result.getUserName());
// add eventPublisher.pushUserAction( ~~~ )
}
하지만 이 방법을 쓰면 서비스가 커질수록 유지보수에서 많은 어려움이 생깁니다. 그래서 상속으로 이 문제를 해결할 수 있습니다.
클래스 구조

클래스 구조
위와 같이 로그인이 완료되면 accountLoginListener가, 회원 가입이 완료되면 pushEmailListener와 createDefaultPostListener가 실행됩니다. 여기서 중요한 점은 파라미터의 타입에 따라 Listener가 실행된다는 것입니다.
따라서 AccountEvent를 상속한 이벤트가 실행되면, AccountEvent를 파라미터로 받는 Listener도 실행될 수 있습니다.
이를 바탕으로 계정(사용자) 관련 이벤트가 발생할 때 로그를 저장하도록 바꿔 보겠습니다.
abstract class Event
@Getter
@ToString
public abstract class Event {
private final UUID eventId;
private final LocalDate createAt;
public Event(LocalDate createAt) {
this.eventId = UUID.randomUUID();
this.createAt = createAt;
}
}
abstract class AccountEvent extends Event
@Getter
public abstract class AccountEvent extends Event {
private final EventType eventType;
public AccountEvent(LocalDate createAt, EventType eventType) {
super(createAt);
this.eventType = eventType;
}
}
final class CreateAccountEvent extends AccountEvent
@Getter
public final class CreateAccountEvent extends AccountEvent {
private final String userId;
private final String userName;
@Builder
public CreateAccountEvent(LocalDate createAt, EventType eventType, String userId, String userName) {
super(createAt, eventType);
this.userId = userId;
this.userName = userName;
}
}
final class LoginAccountEvent extends AccountEvent
@Getter
public final class LoginAccountEvent extends AccountEvent {
private final String userId;
private final String userRole;
@Builder
public LoginAccountEvent(LocalDate createAt, EventType eventType, String userId, String userRole) {
super(createAt, eventType);
this.userId = userId;
this.userRole = userRole;
}
}
class AccountEventPublisher
Publisher는 이전과 달라진 것이 없습니다.
@Slf4j
@RequiredArgsConstructor
@Component
public class AccountEventPublisher {
private final ApplicationEventPublisher publisher;
public void pushCreateUserEvent(final String userId, final String userName) {
log.info(this.getClass().getName() + ".push create user event start!");
log.info("userId : " + userId);
log.info("userName : " + userName);
publisher.publishEvent(CreateAccountEvent.builder()
.userName(userName)
.userId(userId)
.createAt(LocalDate.now())
.eventType(EventType.CREATE).build());
}
public void pushLoginUserEvent(final String userId, final String userRole) {
log.info(this.getClass().getName() + ".push login user event Start!");
log.info("userId : " + userId);
log.info("userRole : " + userRole);
publisher.publishEvent(LoginAccountEvent.builder()
.userId(userId)
.createAt(LocalDate.now())
.eventType(EventType.USER_LOGIN)
.userRole(userRole).build());
}
}
class AccountEventListener
@Slf4j
@Component
@RequiredArgsConstructor
public class AccountEventListener {
private final AccountRepository accountRepository;
private final PostRepository postRepository;
private final EventRepository eventRepository;
@EventListener // when createAccount
public void pushEmailListener(CreateAccountEvent event) {
log.info(this.getClass().getName() + ".pushEmailListener Start");
log.info("userId : " + event.getUserId());
log.info("userName : " + event.getUserName());
System.out.println("push Email To " + event.getUserName() + " Hello!");
}
@EventListener // when createAccount
@Transactional(rollbackFor = Exception.class)
public void createDefaultPost(CreateAccountEvent event) {
final AccountEntity account = accountRepository.findById(event.getUserId()).orElseThrow(()
-> new NoSuchElementException("cannot found account with id : " + event.getUserId()));
postRepository.save(PostEntity.builder()
.createDate(new Date())
.postContent("default Post")
.postTitle("Default Post from Listener")
.createUserId(account).build());
}
@EventListener // when login success
public void checkAccountLogin(LoginAccountEvent event) {
log.info(this.getClass().getName() + ".user Login Completed");
log.info("userId : " + event.getUserId());
log.info("userRole : " + event.getUserRole());
}
}
CreateAccountEvent가 발생했을 때 실행되는 메서드와 LoginAccountEvent가 발생했을 때 실행되는 메서드를 구현했습니다.
마지막으로 부모 클래스인 AccountEvent를 파라미터로 받는 메서드를 구현합니다. 이 메서드는 이벤트 내용을 DB에 저장합니다.
class AccountEventLoggingListener
@Slf4j
@Component
@RequiredArgsConstructor
public class AccountEventLoggingListener {
private final EventRepository eventRepository;
@EventListener
public void loggingAccountEvent(AccountEvent event) {
log.info(this.getClass().getName() + ".account event logging Start!");
eventRepository.save(EventEntity.builder()
.eventId(event.getEventId())
.eventType(event.getEventType())
.eventEntity("ACCOUNT_EVENT").build());
}
}
이제 결과를 확인해 보면 로그인과 회원 가입 시 각 이벤트에 맞는 메서드가 실행되고, 로깅 메서드는 항상 실행되는 것을 볼 수 있습니다.
회원 가입 결과

Account 테이블

Post 테이블

Event_Log 테이블
로그인 결과

checkAccountLogin 메서드

Event_Log 테이블
물론 이 작업은 AOP로도 구현할 수 있습니다.