동시성 이슈 해결하기 : synchronized와 saveAndFlush

synchronized

- synchronized를 메소드에 명시해주면 하나의 스레드만 접근이 가능하다.

- 멀티스레드 환경에서 스레드간 데이터 동기화를 위해 자바에서 제공하는 키워드다.

- synchronized는 현재 데이터를 사용하고 있는 스레드를 제외하고 나머지 스레드들이 데이터에 접근할 수 없도록 막아 순차적으로 데이터에 접근할 수 있도록 한다.

 

 

본문

정원이 n명인 독서 모임이 있다. 현재 모임원은 n-1명으로, 한 명만 더 가입할 수 있다. 이때 두 명의 유저가 동시에 가입을 시도하면 둘 중 한 명만 가입이 되어야 한다. 가입 시, 모임 정원을 확인하여 남은 자리가 없다면 정원 초과 예외를 발생시킨다.

 

 

모임 가입 기능 전체 코드

- Club.java : 독서 모임 엔티티

- ClubService.java : 독서 모임의 비즈니스 로직 처리단

- ClubServiceTest.java : 독서 모임의 비즈니스 로직 테스트

Club.java

@Entity
public class Club {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Column(name = "book_club_id")
    private Long id;

    @ManyToOne(fetch = FetchType.LAZY)
    @JoinColumn(name = "leader_id")
    private User leader;

    @OneToMany(mappedBy = "club")
    private final List<MemberRegister> memberRegisters = new ArrayList<>();

    @NotNull
    private String clubName;

    @NotNull
    private int capacity;

    @NotNull
    private int memberCount = 0;
    
    public void addMemberRegister(MemberRegister memberRegister) {
        memberRegisters.add(memberRegister);
        ++memberCount;
    }

}​

 

 

[Entity] 모임 정원 체크 로직

public void checkCapacity() {
    if (memberCount + 1 > capacity) {
        throw new NotEnoughCapacityException("member count is over capacity");
    }
}

현재 멤버 수 + 1이 정원보다 크면, 정원 초과 예외가 발생한다.

 

 

[Test] 동시 가입 시, 정원 초과 예외 발생 테스트

@Test
void joinParallel() throws InterruptedException {

    //given
    User leader = newUser("leader");
    User member1 = newUser("member1");
    User member2 = newUser("member2");
    List<User> members = new ArrayList<>(List.of(member1, member2));

    Long clubId = newClub(leader, 2);  //정원이 2명인 모임 생성, 현재 멤버 수는 1

    //then
    ExecutorService executorService = Executors.newFixedThreadPool(2);
    CountDownLatch latch = new CountDownLatch(2);

    //when
    for (User member: members) {
        executorService.submit(() -> {
            try {
                clubService.join(new SessionUser(member), clubId);
            } catch (Exception e) {
                assertThat(e.getClass()).isEqualTo(NotEnoughCapacityException.class);
            } finally {
                latch.countDown();
            }
        });
    }

    latch.await();

    //then
    Club club = clubRepository.findById(clubId).get();
    assertThat(club.getMemberCount()).isEqualTo(2);
    List<MemberRegister> memberRegistersOfClub = memberRegisterRepository.findByClubId(club.getId());
    assertThat(memberRegistersOfClub.size()).isEqualTo();
}

두 명의 유저가 동시 가입 시, 정원 초과 예외(NotEnoughCapacityException)가 발생하는 테스트 코드를 작성하였다. 둘 중 한 명만 가입되어 모임의 멤버 수는 2명이길 기대했다.

 

 

[Service] 기존 join() 메서드

@Transactional
public Long join(SessionUser sessionUser, Long id) {
    Club club = clubRepository.findById(id)
            .orElseThrow(IllegalArgumentException::new);

    club.checkCapacity();
    User user = findUser(sessionUser);
    MemberRegister memberRegister = MemberRegister.register(club, user);

    return memberRegisterRepository.save(memberRegister).getId();
}

synchronized 키워드가 없는 일반 메서드다.

 

[Test] 발생한 문제

두 유저가 차례대로 모임의 멤버 수를 조회하지 않고 동시에 조회된다. 기존 멤버 수(memberCount)가 1, 2 순으로 조회되길 기대했으나 1, 1로 조회되며 Race Condition이 발생했다. 정원 초과 예외가 발생하지 않아 두 유저 모두 가입되며 모임의 총 멤버 수는 3명이 되어 테스트에 실패했다. 

 

 

[Service] 수정된 join() 메서드

@Service
public class ClubService {

    private final UserRepository userRepository;
    private final ClubRepository clubRepository;
    private final MemberRegisterRepository memberRegisterRepository;

    @Transactional
    public synchronized Long join(SessionUser sessionUser, Long id) {
        Club club = clubRepository.findById(id)
                .orElseThrow(IllegalArgumentException::new);

        club.checkCapacity();
        User user = findUser(sessionUser);
        MemberRegister memberRegister = MemberRegister.register(club, user);

        return memberRegisterRepository.saveAndFlush(memberRegister).getId();
    }
}

메서드에 synchronized 키워드를 붙여 스레드들이 순차적으로 join 메소드를 호출하게 되었다.

그리고 memberRegister를 레포지토리에 저장할 땐 save()가 아닌 saveAndFlush() 메서드를 사용한다.

 

save 메서드를 사용하면 데이터베이스에 바로 flush되지 않아 synchronized를 이용한 테스트를 통과하지 못한다. 이는 @Transactional의 동작 방식 때문인데 데이터베이스에 값이 입력되기 전 다른 스레드가 메소드에 접근할 수 있다. 따라서 saveAndFlush 메서드를 사용해 바로 flush되게 함으로서 테스트를 통과할 수 있다.

 

이처럼 커밋 전 같은 트랜잭션 안에서, 데이터베이스에 저장된 변경사항을 나중에 읽어야해서 즉각 반영이 되어야 하는 경우, saveAndFlush를 사용한다. (스레드 1에 의해 멤버 한 명이 가입하면 memberCount가 1 증가한다. 스레드 2는 증가된 memberCount를 읽어야 한다.)