[Spring] Spring Cache을 적용한 조회 성능 개선 (with. Redis)

 
 
 
프로젝트를 리팩터링 하면서 조회하는 부분에 캐싱을 적용하려고 한다! 
 
왜 캐싱을 적용하려고 하냐? ! 
해당 서비스는 홈 화면에서 지도위에 내가 작성한 모든 게시글 위치를 표현해 준다. 
실질적으로 게시글 등록, 삭제보다 조회수가 훨씬 많을 것이라고 생각했고, 가장 많이 노출되는 홈 화면에서 계속 위치 정보를 불러온다면 성능적으로 좋지 않을 것이라고 생각했다.! 
 
 
스프링 캐시가 무엇인지는 아래 글에 정리해놓았다😊

[Spring] Spring Cache(스프링 캐시)란?

 
 

🔎 캐싱 전략에 대해서

로컬 캐싱

서버 내부 저장소에 캐시 데이터를 저장하는 것이다. 
속도는 빠르지만 서버 간 데이터 공유가 안된다는 단점이 있다. 

 

글로벌 캐싱

서버 내부 저장소가 아닌 별도의 캐시 서버를 두어 각 서버에서 캐시 서버를 참조하는 것이다. 
캐시 데이터를 얻으려고 할 때마다 캐시 서버로의 네트워크 트래픽이 발생하기 때문에 로컬 캐싱보다 속도는 느리다. 
하지만, 서버 간 캐시 데이터를 쉽게 공유할 수 있기 때문에 로컬 캐싱의 문제점을 해결할 수 있다.

 
나는 혼자 리팩토링 중이라서 굳이 글로벌 캐싱이 필요하지 않지만, 추후 확장성을 고려했을 때 글로벌 캐싱을 적용하는 게 좋겠다고 생각해서 Redis를 이용해서 구현했다.!
 
 

⚙️ 코드

 

build.gradle

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

  
spring cache와 redis를 의존성에 추가한다.
 
 

application

@EnableCaching
@EnableJpaAuditing
@SpringBootApplication
public class FootprintApplication {
    public static void main(String[] args) {
        SpringApplication.run(FootprintApplication.class, args);
    }

}

애플리케이션 클래스 위에 @EnableCaching을 추가한다. 
캐싱을 사용한다는 의미이다.
 
 

RedisConfig

import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.cache.RedisCacheConfiguration;
import org.springframework.data.redis.cache.RedisCacheManager;
import org.springframework.data.redis.connection.RedisConnectionFactory;
import org.springframework.data.redis.connection.lettuce.LettuceConnectionFactory;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.serializer.GenericJackson2JsonRedisSerializer;
import org.springframework.data.redis.serializer.RedisSerializationContext;
import org.springframework.data.redis.serializer.StringRedisSerializer;

import java.time.Duration;
import java.util.HashMap;
import java.util.Map;

@Configuration
public class RedisConfig {

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

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

    @Bean
    public RedisConnectionFactory redisConnectionFactory() {
        return new LettuceConnectionFactory(host, port);
    }

    @Bean
    public RedisTemplate<String, String> redisTemplate() {
        // redisTemplate를 받아와서 set, get, delete를 사용
        RedisTemplate<String, String> redisTemplate = new RedisTemplate<>();
        // setKeySerializer, setValueSerializer 설정
        // redis-cli을 통해 직접 데이터를 조회 시 알아볼 수 없는 형태로 출력되는 것을 방지
        redisTemplate.setKeySerializer(new StringRedisSerializer());
        redisTemplate.setValueSerializer(new StringRedisSerializer());
        redisTemplate.setConnectionFactory(redisConnectionFactory());

        return redisTemplate;
    }

    @Bean
    public RedisCacheManager cacheManager(RedisConnectionFactory connectionFactory) {

        RedisCacheConfiguration redisCacheConfiguration = RedisCacheConfiguration.defaultCacheConfig()
                .serializeKeysWith(RedisSerializationContext.SerializationPair.fromSerializer(new StringRedisSerializer()))
                .serializeValuesWith(RedisSerializationContext.SerializationPair.fromSerializer(new GenericJackson2JsonRedisSerializer()));

        Map<String, RedisCacheConfiguration> redisCacheConfigurationMap = new HashMap<>();
        redisCacheConfigurationMap.put("all_place", redisCacheConfiguration.entryTtl(Duration.ofHours(1)));

        return RedisCacheManager.RedisCacheManagerBuilder
                .fromConnectionFactory(connectionFactory)
                .cacheDefaults(redisCacheConfiguration)
                .withInitialCacheConfigurations(redisCacheConfigurationMap)
                .build();
    }

}

host와 port는 yml 파일에 정의해놓으면 된다.

 

• redisConnectionFactory()
  • redis 서버와 연결할 수 있는 CommectionFactory를 생성한다.
  • redis 클라이언트는 Jedis와 Lettuce가 있는데 스프링에는 기본적으로 Lettuce가 설정돼 있다.
    • Jedis : 멀티쓰레드 환경에서 unsafe 하다. Connection pool을 이용해 멀티스레드 환경을 구성해야 하고, Jedis인스턴스랑 연결할 때마다 Connection pool을 불러와 물리적인 비용이 증가한다.
    • Lettuce : 멀티쓰레드 환경에서 safe 하다. netty라이브러리 위에 구축된다. 비동기 방식으로 요청하며 TPS/CPU/Connection 개수와 응답 속도 등 jedis보다 뛰어나다.
• RedisTemplate()
  • Spring Data Redis는 RedisTemplate, RedisRepository 두 가지 방식으로 접근한다. 
    • RedisTemplate
      • Redis 데이터 베이스와 상호작용하는데 필요한 설정을 구성한다.
      • Redis에 문자열 키와 JSON 형식의 값으로 데이터를 저장하고 검색할 수 있다. 
      • 일반적으로 Redis의 다양한 데이터 유형인 문자열, 해시, 목록, 집합, 정렬된 집합 등을 처리하는 데 사용된다. 
      • 객체들을 자동적으로 직렬화/역직렬화 하며 바이너리 데이터를 Redis에 저장한다. 
      • 각 데이터 유형에 대해 기본적인 CRUD 작업이 가능하다. 
      • 저수준의 API로 직접적인 Redis 데이터베이스 작업을 수행하는 데 사용된다.
    • RedisRepository
      • 더 추상화된 레벨의 컴포넌트로, Redis 데이터베이스에 대한 공통 작업을 더 편리하게 처리할 수 있는 고수준의 메서드를 제공한다. 
      • Spring Data JPA의 JpaRepository와 유사한 형태로 작성되며, 엔티티 CRUD와 같은 고수준의 작업을 지원한다. 
      • 개발자가 인터페이스를 정의하고 해당 인터페이스를 구현하는 Redis 저장소 클래스를 생성하여, 직접 Redis 작업을 구현할 필요 없이 Spring Data Redis의 기능을 활용할 수 있다.
  • redisCacheManager
    • Redis Cache 적용을 위해 RedisCacheManager를 설정한다. 기본 RedisCacheConfiguration을 가져온 후, key와 value의 직렬화 방식을 설정한다.
    • 해당 코드에서는 StringRedisSerializer를 사용하여 문자열로 된 키를 직렬화 하고, GenericJackson2 JsonRedisSerializer를 사용하여 일반적인 객체를 JSON 형식으로 직렬화한다.
    • Redis 캐시 이름과 RedisCacheConfiguration을 매핑하는 맵을 생성 한다. 나는 위치 정보를 저장하기 위해서 "all_place"라는 이름으로 캐시를 생성했다. 
    • entryTtl(Duration.ofHours())에 원하는 시간을 넣으면 된다.

 
 

Service

    @Cacheable(cacheNames = "all_place", key = "#memberId")
    public ListResult<GetAllPlaceResDto> getAllPlacesV2(Long memberId) {

		//... 위치 정보를 불러오는 코드

        return responseService.getListResult(new ArrayList<>(getAllPlaceResDtoList));

    }

 
@Cacheable 어노테이션을 사용해서 캐싱을 구현하면 된다.
나는 key값을 memberId로 설정했다.!! 유저마다 홈에서 보이는 화면이 다를 것이기 때문이다.
redis에서는 key값이 all_place::{memberId} 형식으로 저장된다.
 
 
캐시 적용 전

 
캐시 적용 후

 
캐싱을 적용하기 전과 후를 비교했을 때 조회 시간이 493ms -> 8ms로 변했다
약 61배 빨라진 결과이다!!  이렇게 차이나도 되는건가...?
 
 
redis에도 잘 저장되었다.

 
근데 이 과정에서 고민이 생겼다. 캐시 유효시간을 설정하니까 데이터가 업데이트되더라도 조회할 때 설정 시간이 지나기 전까지 데이터가 업데이트되지 않는 다는 것이다.
 
그래서 나는 CachePut을 사용하면 되려나 생각했다.
 

    @CachePut(cacheNames = "all_place", key = "#memberId")
    public ListResult<GetAllPlaceResDto> getAllPlacesV2(Long memberId) {

		// ... 위치 정보 불러오는 코드

        return responseService.getListResult(new ArrayList<>(getAllPlaceResDtoList));

    }

 
이 어노테이션을 사용하니까 매번 업데이트가 잘 되는 것을 확인했다. 속도도 @Cacheable만큼은 아니지만 충분히 빨랐다! 하지만 업데이트 되지 않은 정보인데도 쿼리가 나가는 것을 확인했다. 
당연히 CachePut 어노테이션을 반환값이 캐싱되어 있는 유무와 상관없이 메서드를 무조건 실행한다!! 
 
그래서 나는 그대로 @Cacheable을 사용하고, 게시글을 등록, 수정, 삭제될 때 캐시 정보를 삭제하기로 했다 ㅎㅎ
 

    @Transactional
    @CacheEvict(cacheNames = "all_place", key = "#memberId")
    public SingleResult<UploadPostingResDto> uploadPostingV3(UploadPostingReqDto uploadPostingReqDto, String imageUrl, Long memberId) {
    
    	// ... 게시글 등록 로직
        return responseService.getSingleResult(uploadPostingResDto);

    }

 
이렇게 하니까 정상적으로 캐시가 삭제되고, 조회할 때 다시 등록되는 걸 확인했다 ㅎㅎ