17 min to read

OOP 기반 선착순 투표 시스템 아키텍처

Hits

thumbnail.png

안녕하세요. 저는 Trading Platform팀 Backend 엔지니어로 근무하고 있는 현건수(Pir)입니다. 이번에 투표시스템을 맡게 되어, 일반 투표와 선착순 투표시스템 그리고 앞으로 확장적으로 늘어날 투표 시스템 아키텍처에 대해 OOP 기반으로 구성한 것을 공유하려고 합니다.

목차

  1. 투표 시스템 요구사항
  2. 투표 시스템 아키텍처 요구사항
  3. 투표 시스템 아키텍처
    3-1. 확장적인 투표 아키텍처
    3-2. 선착순 투표 아키텍처
  4. 코드로 보는 투표 시스템
    Step 1. 투표 타입 선택
    Step 2. 투표 타입 구현체
    Step 3. 선착순 투표 동시성 제어
  5. 테스트
  6. 마치며

1. 투표 시스템 요구사항

투표 시스템 요구사항은 예약, 기간 설정, 단일투표, 복수 투표, 선착순 투표 등의 기능이 포함됐습니다. 해당 요구사항을 받은 저는 ‘어떤 성격을 지닌 투표를 객체로 활용하면 좋을까?’하는 고민이 시작됐습니다.

저의 선택은 일반 투표와 선착순 투표를 크게 나누고 더 확장될 투표를 생각해서 유연하게 설계하는 것이었습니다.

만약 예약 / 단일 / 복수 / 기간 투표를 다 객체로 승격해서 생각한다면, 위와 같이 비즈니스가 늘어날수록 해당 네이밍을 가진 객체들도 무수히 생성될 뿐만아니라 설정 ON/OFF에 따라 네이밍이 달라지며, 특히 예약 / 단일 / 복수 / 기간의 기능들은 어떤 투표든 공통적으로 지녀야할 기능이라고 판단했습니다.

하지만 선착순 투표는 성격이 조금 다르다고 생각합니다. 선착순 투표는 일반투표( 예약 / 단일 / 복수 / 기간)의 기능을 가지고 있으며 투표를 몇명 참여했는지? 동시에 투표를 참여하지 않게해야하는 등 특수한 기능들이 더 추가돼야하기 때문입니다.

2. 투표 시스템 아키텍처 요구사항

요구사항 1. 사용자가 투표를 하고, 서버는 투표 결과를 알려준다

oop_vote_architecture_01.png

요구사항 2. 비즈니스가 언제든지 바뀔 수 있기 때문에 항상 다른 투표가 추가적으로 생기거나 삭제될 경우를 대비해야한다.

기술블로그-선착순 투표 시스템-여러 투표 대비.drawio.png

요구사항 3. 여러명이 동시에 투표할 경우, Race Condition이 발생하기 때문에 이를 대비해야한다.

vote_architecture_with_oop_03.png

3. 투표 시스템 아키텍처

3-1. 확장적인 투표 아키텍처

기술블로그-선착순 투표 시스템-페이지-11.drawio (1).png

요구사항 1 에서 사용자는 투표를 하고, 서버는 투표 결과를 알려준다는 문구를 사용했습니다.

기술블로그-선착순 투표 시스템-layerd architecture.drawio.png

저희는 현재 Layered Architecture를 사용하고 있으며 Presentation Layer와 Service Layer 사이에 각 Service 간 의존하는 것을 막기 위해 Facade Layer를 추가적으로 사용하고 있습니다.

유저가 “투표합니다”라는 요청을 보낼 경우, Facade Layer에서도 하위 모듈(투표 구현체- 일반투표, 선착순투표, 주주 투표, 관심 종목 투표 등)을 직접적으로 의존하는 것이 아니라 상위 모듈인 투표 타입 인터페이스를 의존해야합니다. 이는 컴파일 레벨에서의 의존성을 고정시키지 않고 런타임 레벨에서의 의존성을 변경시킬 수 있으며 DIP를 지킬 수 있는 설계가 됩니다.

요구사항 2 에서 거론했던 것처럼, 비즈니스는 항상 변동되기 때문에 투표가 늘어나거나 삭제되도 클라이언트 코드에 영향을 주지 않아야합니다.

그렇기 때문에 투표타입이라는 인터페이스를 두고 일반투표(DefaultVote)라는 구현체를 베이스로 하나 두고, 추가적으로 확장되는 투표들을 Decorator 패턴을 사용해 OCP를 위배하지 않고 다양한 투표를 추가/삭제할 수 있습니다. Decorator 패턴을 선택한 이유는 선착순 투표든, 주주 투표든, 관심 종목 투표든 기본적인 투표시스템이 갖춘 기능들(예약 / 단일 / 복수 / 기간) 공통적으로 사용하면서 추가적인 기능을 사용하기 위함입니다.

3-2. 선착순 투표 아키텍처

기술블로그-선착순 투표 시스템-페이지-15.drawio.png

요구사항 3 에서 거론했던 것처럼 선착순 투표이기 때문에 동시성을 제어해야하는 방법이 필요합니다.

동시성을 제어하는 방법은 다양한 방법(Redis Distributed Lock, DB Optimistic Lock, Pessimistic Lock, Named Lock 등)이 존재합니다. 이번 포스팅은 동시성 제어에 초점이 맞춰진 포스팅이 아니기 때문에 각각의 특징을 설명하진 않겠습니다. 저는 이 중 저희 프로젝트 환경에서 가장 알맞은 Named Lock을 선택했습니다.

현재 프로젝트에서 Named Lock을 처음 도입한는 것이기 때문에 팀원들도 다음에 편하게 사용할 수 있도록 NamedLockTemplate을 구현했습니다. NamedLockStategy 구현체를 받아서 해당 구현체의 비즈니스 로직이 실행하기 전에 NamedLock를 잡고 비즈니스 로직이 끝난 후에 NamedLock을 해제하는 역할을 합니다.

추후에 투표라는 도메인이 아닌 다른 도메인에서도 다양하게 사용할 수 있게 NamedLock은 Strategy 패턴을 사용해서 다양한 도메인에서 구현체만 생성하면 NamedLockTemplate과 결합하여 사용할 수 있게 구성했습니다.

유저가 투표함에 따라, 각 투표 성격에 맞는 아키텍처를 설계하고 객체를 생성하는 것이 주목적입니다. 현재는 일반투표와 선착순 투표만 존재하기 때문에 선착순 투표의 핵심인 동시성을 제어해야하기 때문에 NamedLock Strategy 구현체를 생성하게 되었습니다.

4. 코드로 보는 투표 시스템

코드로만 보면 흐름을 따라가기 힘들기 때문에, 아키텍처를 각 스텝으로 나눠서 설명합니다. 유저가 “투표합니다”라는 요청을 서버로 보낸 상황을 가정하여 그 후의 Flow를 나타냅니다. 해당 코드들은 포스팅을 위해 조금씩 변경 및 축소된 부분이 있으니 감안해서 읽어주시면 감사하겠습니다. 🙏🙏

Step 1. 투표 타입 선택

기술블로그-선착순 투표 시스템-페이지-12.drawio.png

유저의 “투표합니다” 라는 요청을 받은 서버는 Presentation Layer를 거쳐 Facade Layer에 도착합니다. 이 요청을 투표 타입 인터페이스에게 “투표합니다”라는 메세지 전달하는 것을 소개합니다.

VoteFacade

public class VoteFacade {
    ...

    public void vote(final VoteRequest voteRequest){
        final VoteVO findVote = findVoteService.findById(voteRequest.getVoteIdx());
        final VoteService voteService = voteServiceFactory.create(findVote);
      
        voteService.vote(findVote, voteRequest);
    }
}

VoteService

@FunctionalInterface
public interface VoteService {
    void vote(VoteVO vote, VoteRequest voteRequest);
}

VoteServiceFactory

public class VoteServiceFactory {
    private final DefaultVoteService defaultVoteService;
    private final NamedLockVoteFirstComeStrategy namedLockVoteFirstComeStrategy;

    public VoteService create(final VoteVO vote){
        return vote.isFirstCome() // 선착순 투표 여부
                ? namedLockVoteFirstComeStrategy
                : defaultVoteService;
    }
}

Step 2. 투표 타입 구현체

기술블로그-선착순 투표 시스템-페이지-13.drawio.png

VoteService를 구현한 일반투표(DefaultVote)를 베이스로 구현체로 생성했습니다. 또한, 일반 투표를 공통적으로 사용하고 더 확장적으로 추가될 투표를 위한 투표 데코레이터(Decorator)를 생성하고 이를 상속받은 선착순 투표(FirstComeVote)를 소개합니다.

DefaultVoteService - 일반 투표

public class DefaultVoteService implements VoteService{
	...

	@Override
	public void vote(final VoteVO vote, final VoteRequest voteRequest) {
	  vote.validReserved();
	  vote.validClosed();
	  vote.validPeriod();
	  vote.validMultipleSelection();

	  incrementVoter()
	  saveVoteResult();
	}
	...
}

VoteServiceDecorator - 투표 데코레이터

public abstract class VoteServiceDecorator implements VoteService {
		private DefaultVoteService defaultVoteService;

    public VoteServiceDecorator(DefaultVoteService defaultVoteService) {
        this.defaultVoteService = defaultVoteService;
    }

    @Override
    public void vote(final VoteVO vote, final VoteRequest voteRequest) {
        before(vote);
        defaultVoteService.vote(vote, voteRequest);
        after(vote);
    }

    public abstract void before(VoteVO vote);

    public abstract void after(VoteVO vote);
}

FirstComeVoteService - 선착순 투표

public class FirstComeVoteService extends VoteServiceDecorator {
    ...

    public FirstComeVoteService(DefaultVoteService defaultVoteService, ...) {
        super(defaultVoteService);
        ...
    }

    @Override
    public void before(final VoteVO vote) {
        final Long currentVotedCount = voteMemberCountRepository.findCountByIdx(vote.getIdx());
        vote.validFirstCome(currentVotedCount);
    }

    @Override
    public void after(final VoteVO vote) {
        final Long countOfAfterVoted = voteMemberCountRepository.findCountByIdx(vote.getIdx());

        if(vote.isMaxOfVotersCount(countOfAfterVoted) && !vote.isClosed()){
            vote.closed(); // 투표 상태 "CLOSED"로 변경
            updateVoteStatus(vote);
            saveStatusHistory(vote);
        }
    }
    ...
}

before와 after 추상 메서드를 구현함으로써, 확장되는 투표의 성격을 커스텀마이징 할 수 있습니다. 선착순 투표는 before에 현재 투표자를 검증하고, after에 투표후 카운트를 확인해서 투표 상태를 바꾸는 것을 확인할 수 있습니다. Decorator를 상속받아서 주주만 투표할 수 있는 주주 투투와, 관심 종목을 설정한 사람만 투표할 수 있는 관심 종목 투표를 추가적으로 알아보겠습니다.

StockHolderVoteService - 주주 투표

public class StockHolderVoteService extends VoteServiceDecorator {
    ...

    public StockHolderVoteService(DefaultVoteService defaultVoteService, ...) {
        super(defaultVoteService);
        ...
    }

    @Override
    public void before(final VoteVO vote) {
        if(!hasStock()){
            ...  
        }
    }

    @Override
    public void after(final VoteVO vote) {
        save...();
        update...();
    }
    ...
}

FavoriteStockVoteService - 관심 종목 투표

public class FavoriteStockVoteService extends VoteServiceDecorator {
    ...

    public FavoriteStockVoteService(DefaultVoteService defaultVoteService, ...) {
        super(defaultVoteService);
        ...
    }

    @Override
    public void before(final VoteVO vote) {
        validFavoriteStock();
    }

    @Override
    public void after(final VoteVO vote) {
        save...();
        update...();
    }
    ...
}

Decorator를 사용함으로써 추가적인 투표나 기존 투표를 수정함에 있어서 클라이언트 투표를 수정하지 않고 전처리, 후처리를 구현할 수 있습니다. 주의할 점은, 상속을 사용하면 하위 객체들은 상위 객체에 영향을 받기 때문에 추후에 상위 객체가 변동하지 않는 비즈니스에 적합하다고 생각합니다. 이 때문에 Decorator 패턴 또한 신중히 사용해야합니다.

Step 3. 선착순 투표 동시성 제어

NamedLock이란?

기술블로그-선착순 투표 시스템-네임드락.drawio.png

이번 포스팅에서는 아키텍처링에 관한 주제에 포커스를 맞추기 때문에, Concerrency에 관한 내용과 Named Lock에 관한 개념은 추가적으로 다루지 않겠습니다. 추가적으로 궁금하신 내용은 [MySQL Locking Functions]에서 확인해주시면 감사하겠습니다.

기술블로그-선착순 투표 시스템-페이지-14.drawio.png

동시성을 제어하기 위한 NamedLockTemplate과 NamedLockStrategy, 선착순 투표를 위해 이를 구현한 NamedLockFirstComeVoteStrategy를 소개합니다.

NamedLockStrategy - 네임드락 전략

@FunctionalInterface
public interface NamedLockStrategy {
    void business(NamedLockDTO namedLockDTO);
}

NamedLockFirstComeVoteStrategy - 선착순 투표 네임드락 전략

public class NamedLockVoteFirstComeStrategy implements VoteService, NamedLockStrategy {
    private final FirstComeVoteService firstComeVoteService;
    private final NamedLockTemplate namedLockTemplate;
    ...
    
    @Override
    public void vote(final VoteVO vote, final VoteRequest voteRequest) {
        final NamedLockVoteFirstComeDTO namedLockVoteFirstComeDTO = new NamedLockVoteFirstComeDTO(vote, voteRequest);
        final String lockName = LOCK_NAME_PRE + "_" + vote.getIdx();

        namedLockTemplate.businessWithLock(this, namedLockVoteFirstComeDTO, lockName);
    }

    @Override
    public void business(final NamedLockDTO namedLockDTO) {
        final NamedLockVoteFirstComeDTO namedLockVoteFirstComeDTO = (NamedLockVoteFirstComeDTO) namedLockDTO;

        firstComeVoteService.vote(namedLockVoteFirstComeDTO.getVote(),namedLockVoteFirstComeDTO.getVoteRequest());
    }
    ...
}

NamedLockTemplate - 네임드락 템플릿

public class NamedLockTemplate {

    private final NamedLockRepository namedLockRepository;
    private final DataSource serviceDatasource;

    public void businessWithLock(final NamedLockStrategy namedLockStrategy, final NamedLockDTO namedLockDTO, final String lockName) {
        Connection connection = null;
        try {
            connection = DataSourceUtils.getConnection(serviceDatasource);
            connection.setAutoCommit(false);

            namedLockRepository.getLock(connection, lockName, 3);
            namedLockStrategy.business(namedLockDTO);

            connection.commit();
        } catch (Exception e) {
            if(connection != null) {
                try {
                    connection.rollback();
                    ...
                } catch (SQLException sqlException) {
                    ...			
                }
            }
        }
        finally {
            namedLockRepository.releaseLock(lockName);
        }
    }

vote_architecture_with_oop_09.png

NamedLockRepository

public class NamedLockRepository {

    private ThreadLocal<DSLContext> namedLockContext = new ThreadLocal<>();

    public void getLock(Connection connection, String lockName, int timeOutSeconds) {
        ...
        final DSLContext newNamedLockDSLContext = DSL.using(connection, dialect, settings);

        newNamedLockDSLContext.fetch("SELECT GET_LOCK(?,?)", lockName, timeOutSeconds);
        namedLockContext.set(newNamedLockDSLContext);
    }

    public void releaseLock(String lockName){
        try {
            namedLockContext.get().fetch("SELECT RELEASE_LOCK(?)",lockName);
        }finally {
            namedLockContext.remove(); 
        }
    }
}

5. 테스트

30명 제한 선착순 투표에 100명이 투표

Screenshot at Oct 29 23-31-22.png

✅ 테스트 통과

6. 마치며

선착순 투표 시스템을 설계하면서 많은 고민을 했던 것 같습니다. 저는 현재 계속 OOP에 대해 많이 배우는 시기이고, 생각을 실천으로 실행하면서 시행착오를 겪는 시기라고 생각합니다.

그렇기 때문에 저와 같은 비즈니스 요구사항에 제가 설계한 구조보다 조금 더 유연하고 확장적인 설계가 분명히 존재한다고 생각합니다.

그래도 조그마한 바람이 있다면, 제 작은 생각들이 누군가에게는 발상이 되어 조그마한 도움이 되면 정말 뿌듯할 것 같습니다. 긴 글 읽어주셔서 감사합니다 😁