[SpringBoot/Kotlin] Caffeine Cache 사용하기 (LocalCache)

Caffeine Cache 란?

로컬캐시는 해당 기기에서만 사용되는 캐시이다. 속도가 빠르지만 분산 시스템일 경우 데이터 정합성이 깨질 수 있다.

비즈니스 요구사항에 따라 어느정도까지 정합성을 맞춰야할지, 얼마나 속도가 중요할지에 따라 캐시를 선택한다.

 

Caffeine Cache는 java 캐싱 라이브러리 중 높은 성능을 가지고 있는 캐시이다.

Caffeine은 Window TinyLfu eviction 정책을 가지고 있는데, 이는 최적의 적중률을 제공한다.

---

Setting

build.gradle.kts

dependencies {
    implementation("org.springframework.boot:spring-boot-starter-cache")
    implementation("com.github.ben-manes.caffeine:caffeine")
}

Cache Config 작성

@Configuration
@EnableCaching
class CacheConfig { }

• CacheConfig 파일을 생성하고, 캐시로 사용할 Bean들을 정의해놓는다.

Cache Enum 정의

enum class CacheType (
    private val cacheName: String,
    private val expireAfterWrite: Long,
    private val timeUnit: TimeUnit
) {
    USER_INFO_CACHE(
        USER_INFO_CACHE_NAME,     // 캐시 이름: UserInfo
        10,
        TimeUnit.SECONDS,         // 만료 시간: 10s 
    );
    
    fun getCacheName() = cacheName
    fun getExpireAfterWrite() = expireAfterWrite 
    fun getTimeUnit() = timeUnit

    companion object {
        const val USER_INFO: String = "UserInfo"
    }
}

• Enum 클래스 및 각 필드에 대해 Getter 생성

Cache Manager Bean 등록

@Bean
fun cacheManager(): CacheManager {
    val cacheManager = SimpleCacheManager()
    val caches = CacheType.values().map {        
        CaffeineCache(
            it.getCacheName(),
            Caffeine.newBuilder()
                .recordStats()
                .expireAfterWrite(it.getExpireAfterWrite(), it.getTimeUnit())
                .build()
        )
    }

    cacheManager.setCaches(caches)
    return cacheManager
}

• CacheType에 정의된 캐시들을 CaffeineCache 객체로 생성하여, CacheManager에 등록

Cache KeyGenerator

별도의 keyGenerator를 사용하지 않을 경우, 기본적으로 제공되는 아래의 SimpleKeyGenerator 사용

public static Object generateKey(Object... params) {
    if (params.length == 0) {
        return SimpleKey.EMPTY;
    }
    if (params.length == 1) {
        Object param = params[0];
        if (param != null && !param.getClass().isArray()) {
            return param;
        }
    }
    return new SimpleKey(params);
}

• 파라미터가 없다면, SimpleKey.EMPTY가 key로 사용
• 파라미터가 1개라면, 파라미터를 key로 사용
• 파라미터가 2개 이상이라면, SimpleKey 객체로 사용

CustomKeyGenerator

@Bean("UserInfoCacheKeyGenerator")
fun userInfoCacheKeyGenerator(): KeyGenerator {
    return KeyGenerator { _, method, params ->
        if (params.size > 2) {
            "${method.name}:${params[2]}"
        } else {
            "${method.name}:${UUID.randomUUID()}"
        }
    }
}

• 메소드명과 특정 parameter를 사용하여 Key 생성

CacheConfig.kt 전체

@Configuration
@EnableCaching
class CacheConfig { 
    @Bean
    fun cacheManager(): CacheManager {
        val cacheManager = SimpleCacheManager()
        val caches = CacheType.values().map {        
            CaffeineCache(
                it.getCacheName(),
                Caffeine.newBuilder()
                    .recordStats()
                    .expireAfterWrite(it.getExpireAfterWrite(), it.getTimeUnit())
                    .build()
            )
        }
    
        cacheManager.setCaches(caches)
        return cacheManager
    }
    
    @Bean("UserInfoCacheKeyGenerator")
    fun userInfoCacheKeyGenerator(): KeyGenerator {
        return KeyGenerator { _, method, params ->
            if (params.size > 2) {
                "${method.name}:${params[2]}"
            } else {
                "${method.name}:${UUID.randomUUID()}"
            }
        }
    }
    
    enum class CacheType (
        private val cacheName: String,
        private val expireAfterWrite: Long,
        private val timeUnit: TimeUnit
    ) {
        USER_INFO_CACHE(
            USER_INFO_CACHE_NAME,     // 캐시 이름: UserInfo
            10,
            TimeUnit.SECONDS,         // 만료 시간: 10s 
        );
        
        fun getCacheName() = cacheName
        fun getExpireAfterWrite() = expireAfterWrite 
        fun getTimeUnit() = timeUnit
    
        companion object {
            const val USER_INFO: String = "UserInfo"
        }
    }
}

 

---

Cache 사용

@Cacheable(cacheNames = [CacheType.USER_INFO], keyGenerator = "UserInfoCacheKeyGenerator")
fun getUserInfo(userId: String) {...}

• defaultKeyGenerator 사용 시, 생략 가능

---

TestCode

class UserInfoCacheTests {
    @SpykBean
    lateinit var cacheManager: CacheManager
    lateinit var userInfoCache: Cache<Any, Any>

    @BeforeEach
    fun beforeEach() {
        userInfoCache = (cacheManager.getCache(CacheConfig.CacheType.USER_INFO) as CaffeineCache).nativeCache
    }

    @Test
    fun `USER_INFO 캐시가 동작한다`() {
        getUserInfo("requestId", "userId")
        getUserInfo("requestId", "userId")

        assertEquals(1, userInfoCache.asMap().keys.size)
        eventCache.asMap().map {
            assertEquals("getUserInfo|userId", it.key)
            assertNotNull(it.value)
        }

        assertEquals(1, userInfoCache.stats().hitCount())
        assertEquals(1, userInfoCache.stats().missCount())
    }
}

---

https://www.baeldung.com/java-caching-caffeine

https://wave1994.tistory.com/182