📄 [문서] Redis Lock 사용방법

[Chuseok22]

🗒️ 설명

• RedisConfig 클래스에서 redissonClient Bean을 생성합니다

  @Bean
  public RedissonClient redissonClient() {
    // Redisson의 Config 객체 생성
    Config config = new Config();
    String address = "redis://" + redisHost + ":" + redisPort;

    // Redis 단일 서버 설정
    config.useSingleServer()
        .setAddress(address) // Redis 서버 주소
        .setConnectionPoolSize(connectionPoolSize) // 연결 풀 크기
        .setConnectionMinimumIdleSize(connectionMinimumSize) // 최소 연결 수
        .setPassword(redisPassword); // 비밀번호 설정

    // RedissonClient 객체를 반환
    return Redisson.create(config);
  }

connectionPoolSize, connectionMinimumSize는 현재 각각 10, 5로 할당되어있습니다.
추후 application-prod.yml파일에서 알맞는 값으로 수정 예정입니다.

• 매번 로직에서 try-catch-finally 문을 사용하는 것을 중앙에서 관리하고자 RedisLockManager 클래스는 작성했습니다.

@Component
@Slf4j
@RequiredArgsConstructor
public class RedisLockManager {

  @Value("${spring.data.redis.wait-time}")
  private Long waitTime;

  @Value("${spring.data.redis.lease-time}")
  private Long leaseTime;

  private final RedissonClient redissonClient;

  /**
   * 락을 실행하며, 작업이 완료되면 락을 자동으로 해제합니다.
   *
   * @param lockKey 키값
   * @param task 실행할 작업
   * @param <T> 작업 실행 결과 타입
   * @return 작업 실행 결과
   */
  public <T> T executeLock(String lockKey, LockTask<T> task) {
    RLock lock = redissonClient.getLock(lockKey);
    // 락 획득 시도
    try {
      // 최대 waitTime초간 대기, 락 획득 후 leaseTime 뒤 자동 만료 설정
      if (!lock.tryLock(waitTime, leaseTime, TimeUnit.SECONDS)) { // 락 획득 실패시
        log.error("락 획득 실패 - 다른 요청 처리 중. lockKey: {}", lockKey);
        throw new IllegalStateException("락 획득 실패");
      }

      try {
        // 락 획득 성공 시 작업 진행
        return task.run();
      } catch (Exception e) {
        log.error("작업 실행 중 예외 발생", e);
        throw new RuntimeException("작업 실행 중 예외 발생", e);
      }

    } catch (InterruptedException e) {
      Thread.currentThread().interrupt();
      log.error("락 획득 대기 중 인터럽트 발생", e);
      throw new IllegalStateException("락 대기 중 인터럽트 발생", e);
    } finally { // 현재 스레드가 락을 가지고 있는 경우
      if (lock.isHeldByCurrentThread()) {
        log.info("현재 스레드가 락을 가지고 있어 해제합니다.");
        lock.unlock();
      }
    }
  }

  @FunctionalInterface
  public interface LockTask<T> {
    T run() throws Exception;
  }

}

코드는 위와 같으며 Lock을 사용하고자 하는 로직에서 redisLockManager.executeLock(lockKey, task)을 사용하면 됩니다.
LockTast<T> task는 함수형 인터페이스로 작성했으며 람다식으로 사용하시면 됩니다.

사용예시 (private final RedisLockManager redisLockManager 의존성 주입 되어있습니다)

    // 조회수 증가 (Redis 락을 사용하여 보호)
    String lockKey = "lock:questionPost" + command.getPostId();
    redisLockManager.executeLock(lockKey, () -> {
      questionPost.increaseViewCount();
      log.info("제목: {}, 조회수: {}", questionPost.getTitle(), questionPost.getViewCount());

      // 변경사항 저장
      questionPostRepository.save(questionPost);

      return null;
    });

해당 예시에서는 return null 처럼 반환값이 null 이지만 필요에 따라 원하는 반환값을 반환하시면 됩니다.

연결된 pr 참고하시면 됩니다 #660

<참고>
Redis Lock 에서 waitTime은 Lock을 얻기위해서 기다리는 시간이고 leaseTime은 Lock을 자동으로 해제하는 시간입니다.
이때 leaseTime을 충분히 큰 수로 설정하고 finally부분을 주석처리한 뒤 실행해보면 Lock을 얻은 뒤에 leaseTime동안 해제하지않고 기다리는 것을 볼 수 있습니다.
application-dev.yml

redis:
  lease-time: 60

RedisLockManager -> finally 부분 주석처리 후 진행 (주석처리하지 않으면 자동으로 해제 됨)

public <T> T executeLock(String lockKey, LockTask<T> task) {
    RLock lock = redissonClient.getLock(lockKey);
    // 락 획득 시도
    try {
      // 최대 waitTime초간 대기, 락 획득 후 leaseTime 뒤 자동 만료 설정
      if (!lock.tryLock(waitTime, leaseTime, TimeUnit.SECONDS)) { // 락 획득 실패시
        log.error("락 획득 실패 - 다른 요청 처리 중. lockKey: {}", lockKey);
        throw new IllegalStateException("락 획득 실패");
      }

      try {
        // 락 획득 성공 시 작업 진행
        return task.run();
      } catch (Exception e) {
        log.error("작업 실행 중 예외 발생", e);
        throw new RuntimeException("작업 실행 중 예외 발생", e);
      }

    } catch (InterruptedException e) {
      Thread.currentThread().interrupt();
      log.error("락 획득 대기 중 인터럽트 발생", e);
      throw new IllegalStateException("락 대기 중 인터럽트 발생", e);
    } finally { // 현재 스레드가 락을 가지고 있는 경우
//      if (lock.isHeldByCurrentThread()) {
//        log.info("현재 스레드가 락을 가지고 있어 해제합니다.");
//        lock.unlock();
//      }
    }
  }

현재 로컬에서는 docker를 통해서 Redis를 사용중이기에 docker를 기준으로 설명하겠습니다
(로컬에 Redis를 설치하면 더 쉬움^^)

1. sudo docker ps (실행중인 컨테이너 확인)

dojes@Chuseok22-ui-MacBookAir ~ % sudo docker ps
CONTAINER ID   IMAGE          COMMAND                  CREATED       STATUS       PORTS                    NAMES
3128f83730b6   redis:latest   "docker-entrypoint.s…"   12 days ago   Up 6 hours   0.0.0.0:6379->6379/tcp   redis

2. docker exec -it redis redis-cli (redis 컨테이너 접속)
3. AUTH myPassword (password 설정한 경우 입력)
4. TTL {lockKey} (lockKey에 해당하는 Lock의 남은 시간 확인)

127.0.0.1:6379> TTL lock:questionPost:6d4997ec-760a-49ed-a92d-e77754ba1d1d
(integer) 40

🙋‍♂️ 담당자

• 백엔드: @Cassiiopeia @minhong620 @Chuseok22
• 프론트엔드:
• 디자인: