스프링 부트 로컬 캐시 적용하기

📌 들어가며

백엔드 개발을 할 때 가장 신경쓰게 되는 것은 아무래도 API의 성능일 것입니다. 많은 트래픽을 받아도 안정적인 속도로 동일한 결과를 사용자에게 제공해 주어야 하기 때문입니다. 이번 포스팅에서는 이러한 API의 성능을 높일 때 사용되는 방법중 하나인 캐시를 적용하는 방법을 알아보고자 합니다. 캐시를 적용하기 위해 Redis를 사용하기도 하는데요 해당 포스팅에서는 스프링부트의 자체 캐시(로컬 캐시)를 사용해 보도록 하겠습니다. 

 

📌 캐시란?

캐시는 자주 사용하는 데이터를 저장해두고 재활용하는 기술을 뜻합니다.

 

일반적으로 캐시는 일시적인 특징이 있는 데이터 집합을 고속 데이터 스토리지 저장합니다.

따라서 이후에 해당 데이터에 대한 동일한 요청이 있을 경우,

데이터의 원본 스토리지 위치로 액세스할 때보다 더 빠르게 요청을 처리할 수 있습니다.

이렇게 캐싱을 사용하면 이전에 검색했거나 계산한 데이터를 효율적으로 재사용할 수 있습니다.

 

부분적으로 설명하자면,

일반적으로 동일한 리소스 대해 빈번한 SELECT로 발생되는 DBMS 과부하를 줄이고자 사용합니다.

이런 식으로 과부하를 줄이면 높은 트래픽이 갑자기 몰리더라도 Web Application이 죽지 않고 버틸 수 있습니다.

 

 

📌 Cache Manager

캐시 추상화에서는 캐시 기술을 지원하는 캐시 매니저를 빈으로 등록해야 합니다.

아래 두 CacheManager 를 가장 많이 사용하며 이 중에서 CaffeineCacheManager 사용법에 대해 알아보겠습니다.

 

✔️ EhCacheCacheManager

자바에서 유명한 캐시 프레임워크 중 하나인 EhCache를 지원하는 캐시 매니저입니다.

 

✔️ CaffeineCacheManager

Java 8로 Guava 캐시를 재작성한 Caffeine 캐시를 사용하는 캐시 매니저입니다.

EhCache와 함께 인기 있는 캐시 매니저인데, EhCache보다 좋은 성능을 갖는다고 해서 최근 많이 사용합니다.

 

📌 CaffeineCacheManager

먼저 Ehcache는 multi-level 캐시, distributed 캐시, 캐시 리스너 등과 같은 많은 기능을 지원합니다.

Caffeine은 Ehcache보다 캐시의 성능이 높으며, 실제로 더 우수한 캐시 제거 전략을 사용합니다.

실제로 Window TinyLfu 퇴출 정책을 사용하는데, 거의 최적의 적중률을 제공합니다.

 

Caffeine에 대한 대부분의 기능은 Caffeine Wiki를 참조부탁드립니다.

 

그럼 본격적으로 캐시를 적용해보겠습니다.

 

의존성 추가 build.gradle

	//spring cache with caffeine
	implementation 'org.springframework.boot:spring-boot-starter-cache'
	implementation 'com.github.ben-manes.caffeine:caffeine'// caffeine

 

CacheConfig 추가

package kr.co.starbucks.config;

import com.github.benmanes.caffeine.cache.Caffeine;
import java.util.Arrays;
import java.util.List;
import java.util.concurrent.TimeUnit;
import java.util.stream.Collectors;
import kr.co.starbucks.constants.CacheType;
import org.springframework.cache.CacheManager;
import org.springframework.cache.annotation.EnableCaching;
import org.springframework.cache.caffeine.CaffeineCache;
import org.springframework.cache.support.SimpleCacheManager;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@EnableCaching
@Configuration
public class CacheConfig {
    @Bean
    public CacheManager cacheManager() {
        SimpleCacheManager cacheManager = new SimpleCacheManager();

        List<CaffeineCache> caches = Arrays.stream(CacheType.values())
            .map(cache -> new CaffeineCache(
                cache.getName(),
                Caffeine.newBuilder()
//                    .expireAfterWrite(cache.getExpireAfterWrite(), TimeUnit.SECONDS)
                    .expireAfterAccess(cache.getExpireAfterWrite(), TimeUnit.SECONDS)
                    .maximumSize(cache.getMaximumSize())
                    .recordStats()
                    .build()
            ))
            .collect(Collectors.toList());

        cacheManager.setCaches(caches);
        return cacheManager;
    }

}

 

📌  Creating Parameters

 

-  initialCapacity: 내부 해시 테이블의 최소한의 크기를 설정합니다.

-  maximumSize: 캐시에 포함할 수 있는 최대 엔트리 수를 지정합니다.

-  maximumWeight: 캐시에 포함할 수 있는 엔트리의 최대 무게를 지정합니다.

-  expireAfterAccess: 캐시가 생성된 후, 해당 값이 가장 최근에 대체되거나 마지막으로 읽은 후 특정 기간이 경과하면 캐시에서 자동으로 제거되도록 지정합니다.

-  expireAfterWrite: 항목이 생성된 후 또는 해당 값을 가장 최근에 바뀐 후 특정 기간이 지나면 각 항목이 캐시에서 자동으로 제거되도록 지정합니다.

-  refreshAfterWrite: 캐시가 생성되거나 마지막으로 업데이트된 후 지정된 시간 간격으로 캐시를 새로 고칩니다.

-  weakKeys: 키를 weak reference로 지정합니다. (GC에서 회수됨)

-  weakValues: Value를 weak reference로 지정합니다. (GC에서 회수됨)

-  softValues: Value를 soft reference로 지정합니다. (메모리가 가득 찼을 때 GC에서 회수됨)

-  recordStats: 캐시에 대한 Statics를 적용합니다.

 

⚠️ expireAfterWrite 와 expireAfterAccess 가 함께 지정된 경우, expireAfterWrite가 우선순위로 적용됩니다.

⚠️ maximumSize와 maximumWeight는 함께 지정될 수 없습니다.

 

CacheType 에 대한 관리

package kr.co.starbucks.constants;

import com.google.common.collect.ImmutableMap;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import lombok.Getter;

@Getter
public enum CacheType {

    TEST("test"),
    BASIC_POLICY("basic-policy"),
    GIFT_TERMS("gift-terms"),
    GOODS_INFO("goods-info"),
    PAYMENT_POLICY("payment-policy");
    
    private final String name;
    private final int expireAfterWrite;
    private final int maximumSize;

    CacheType(String name) {
        this.name = name;
        this.expireAfterWrite = ConstConfig.DEFAULT_TTL_SEC;
        this.maximumSize = ConstConfig.DEFAULT_MAX_SIZE;
    }

    private static final ImmutableMap<String, CacheType> codes = ImmutableMap.copyOf(
        Stream.of(values()).collect(Collectors.toMap(CacheType::getName, Function.identity())));

    static class ConstConfig {
        static final int DEFAULT_TTL_SEC = 60;
        static final int DEFAULT_MAX_SIZE = 10000;
    }

}

 

실제 cache를 적용하고 싶은 메서드에 @Cacheable 어노테이션을 추가하여 적용

    @Cacheable(value = "payment-policy", cacheManager = "cacheManager")
    public List<PaymentPolicy> getPaymentPolicyList() {
        return paymentPolicyRepository.findByUseYnAndAvailableGiftBuyYn("Y", "Y");
    }

 

이렇게 적용하고 실제 해당 메서드를 호출 해 보면 

한번만 JPA 관련 로깅(select 문)이 찍히고 그 이후에는 여러번 호출해도

캐시가 사라질 때까지는select 문이 실행되지 않는 것을 

확인할 수 있습니다.

 

 

참고:

https://gngsn.tistory.com/157