[Redis] API 요청 마다 조회하는 User 데이터 레디스로 최적화

Cache란 자주 사용하는 데이터를 미리 저장해놓고 다시 이 데이터를 필요로 할 때마다 빠르게 참조하여 읽기 기능을 개선하는 기술이다.

 

현재 진행 중인 프로젝트에서 성능 개선을 위해 캐시를 도입하였고, Redis를 사용하기로 했다.

거의 모든 API 요청에서 회원을 조회하는 쿼리가 나갔고 이를 캐싱처리하기 위해 위와 같이 구상하였다.

최초 로그인 시 redis에 값을 넣어주고 추후에 loadByUsername 호출될 때 redis 에서 값을 먼저 찾을 수 있도록 코드를 수정하였다. 

 

 

Redis 설정

build.gradle

implementation 'org.springframework.boot:spring-boot-starter-data-redis'

 

RedisConfig 

@Configuration
@EnableRedisRepositories
@RequiredArgsConstructor
public class RedisConfiguration {
    /**
     * redis 커맨드들을 쉽게 사용할 수 있게 하기 위한 클래스
     */

    @Value("${spring.redis.host}")
    private String host;

    @Value("${spring.redis.port}")
    private int port;

    private final RedisProperties redisProperties;

    @Bean
    public RedisConnectionFactory redisConnectionFactory() {
        return new LettuceConnectionFactory(host, port);
    }
    @Bean
    public RedisTemplate<String, User> userRedisTemplate(RedisConnectionFactory redisConnectionFactory) {
        RedisTemplate<String, User> redisTemplate = new RedisTemplate<>();
        redisTemplate.setConnectionFactory(redisConnectionFactory); // redis 서버에 대한 정보를 갖고 있음
        redisTemplate.setKeySerializer(new StringRedisSerializer());
        redisTemplate.setValueSerializer(new Jackson2JsonRedisSerializer<User>(User.class));
        return redisTemplate;
    }
}

 

Redis Repository

• expired 타임을 걸어주는걸 권장

@Repository
@RequiredArgsConstructor
@Slf4j
public class UserCacheRepository {
    private final RedisTemplate<String, User> userRedisTemplate;
    private final static Duration USER_CACHE_TTL = Duration.ofDays(3); // 3일의 만료기간 세팅

    public void setUser(User user) {
        log.info("Set User to Redis {}:{}", getUser(user.getUsername()), user, USER_CACHE_TTL);
        userRedisTemplate.opsForValue().set(getKey(user.getUsername()), user, USER_CACHE_TTL);
    }

    public User getUser(String userName) {
        User user = userRedisTemplate.opsForValue().get(getKey(userName));
        log.info("Get User to Redis {}:{}", getUser(userName), user);
        return user;
    }

    //key 값에 프리픽스를 붙여줌
    private String getKey(String userName) {
        return "USER:" + userName;
    }
}

 

 

loadUserByUsername 및 login 로직 수정

@Override
    public User loadUserByUsername(String userName) throws UsernameNotFoundException {
        // redis 에 있는지 체크하고 없다면 orElseGet 을 사용하여 db 에서 조회
        User user = userCacheRepository.getUser(userName)
                .orElseGet(() -> userRepository.findByUserName(userName).map(User::fromEntity).orElseThrow(
                        () -> new SimpleSnsApplicationException(ErrorCode.USER_NOT_FOUND, String.format("userName is %s", userName))));
        return user;
    }

    public String login(String userName, String password) {
        User savedUser = loadUserByUsername(userName);
        System.out.println("===================");
        userCacheRepository.setUser(savedUser);

        //비밀번호 체크
        if (!encoder.matches(password, savedUser.getPassword())) {
            throw new SimpleSnsApplicationException(ErrorCode.INVALID_PASSWORD, String.format("userName is %s", userName));
        }
        return JwtTokenUtils.generateAccessToken(userName, secretKey, expiredTimeMs);
    }