Spring Cache 알아보기 - 1

implementation 'org.springframework.boot:spring-boot-starter-cache:3.3.2'

@EnableCaching // 캐시를 사용하려면 추가하여야합니다.
@Configuration
class CacheConfig {
    @Bean(name = ["caffeineCacheManager"])
    fun cacheManager(): CacheManager =
        CaffeineCacheManager().apply {
            setCaffeine(
                Caffeine.newBuilder()
                    .initialCapacity(200)
                    .maximumSize(500)
                    .expireAfterWrite(JwtProvider.REFRESH_TOKEN_VALID_MILLISECONDS, TimeUnit.MILLISECONDS)
                    .weakKeys()
            )
        }
}
 

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Import({CachingConfigurationSelector.class})
public @interface EnableCaching {
    boolean proxyTargetClass() default false;
    //용도: 캐시 어드바이저가 CGLIB 프록시를 사용할지 여부를 결정합니다.
    //설명: false(기본값)으로 설정된 경우 JDK 동적 프록시를 사용하고, true로 설정된 경우 CGLIB를 사용하여 프록시를 생성합니다. CGLIB를 사용하면 클래스 전체를 프록시로 감쌀 수 있으며, 인터페이스가 없는 클래스에 대해 프록시를 생성할 수 있습니다.
 
    AdviceMode mode() default AdviceMode.PROXY;
    //용도: 캐싱 어드바이스의 모드를 설정합니다.
    //설명: AdviceMode.PROXY가 기본값으로, 프록시 기반의 어드바이저를 사용하여 캐싱 기능을 적용합니다. AdviceMode.ASPECTJ를 설정할 경우, AspectJ를 사용하여 어드바이스를 적용할 수 있습니다. AdviceMode.PROXY는 프록시 기반의 캐싱을 사용하는 기본적인 방식입니다.
 
    int order() default Integer.MAX_VALUE;
    //용도: 캐시 어드바이저의 실행 순서를 설정합니다.
    //설명: order 속성은 여러 어드바이저가 있을 때, 이들의 실행 순서를 정의합니다. 기본값인 Integer.MAX_VALUE는 가장 높은 우선순위를 가지며, 기본적으로 가장 마지막에 실행됩니다. 이를 통해 어드바이저의 우선순위를 조정할 수 있습니다.
}

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
@Reflective
public @interface Cacheable {
    @AliasFor("cacheNames")
    String[] value() default {};
    //용도: 캐시 이름을 지정합니다. cacheNames 속성과 동일하게 동작하며, 두 속성은 서로의 별칭(alias)입니다.
    //설명: 캐시 이름을 지정할 때 사용되며, 하나 이상의 캐시 이름을 배열 형태로 설정할 수 있습니다.
 
    @AliasFor("value")
    String[] cacheNames() default {};
    //용도: 캐시 이름을 지정합니다. value 속성과 동일하게 동작하며, 두 속성은 서로의 별칭입니다.
    //설명: 캐시 이름을 지정할 때 사용되며, 하나 이상의 캐시 이름을 배열 형태로 설정할 수 있습니다.
 
    String key() default "";
    //용도: 캐시 항목을 저장할 때 사용할 키를 SpEL(Spring Expression Language)로 지정합니다.
    //설명: 기본값은 빈 문자열이며, 메서드 파라미터를 기준으로 자동 생성됩니다. 특정 키를 명시적으로 지정하고 싶을 때 사용합니다.
 
    String keyGenerator() default "";
    //용도: 커스텀 키 생성기를 지정합니다.
    //설명: 기본적으로는 스프링이 제공하는 키 생성기를 사용하지만, keyGenerator 속성을 통해 커스텀 키 생성기를 명시할 수 있습니다.
 
    String cacheManager() default "";
    //용도: 사용할 캐시 매니저 빈의 이름을 지정합니다.
    //설명: 여러 캐시 매니저가 있는 경우, 특정 캐시 매니저를 명시적으로 지정할 때 사용합니다.
 
    String cacheResolver() default "";
    //용도: 캐시 리졸버를 지정합니다.
    //설명: 캐시 리졸버는 어떤 캐시를 사용할지 결정하는 역할을 합니다. cacheResolver를 통해 커스텀 캐시 리졸버를 지정할 수 있습니다.
 
    String condition() default "";
    //용도: 캐시 조건을 지정합니다.
    //설명: SpEL 표현식을 사용하여 조건을 지정할 수 있으며, 조건이 참일 경우에만 캐싱이 이루어집니다.
 
    String unless() default "";
    //용도: 캐시에서 제외할 조건을 지정합니다.
    //설명: SpEL 표현식을 사용하여 조건을 지정할 수 있으며, 조건이 참일 경우 캐싱되지 않습니다. condition과 반대로 동작합니다.
 
    boolean sync() default false;
    //용도: 캐시를 동기적으로 사용할지 여부를 지정합니다.
    //설명: true로 설정하면 캐시를 동기적으로 사용합니다. 이는 캐시가 아직 로드되지 않았을 때, 동일한 키에 대한 여러 호출이 블로킹되지 않도록 보장합니다.
}

@Cacheable(value = ["users"], key = "#username")
override fun loadUserByUsername(username: String): UserDetails {
    return userRepository.findByIdOrNull(username.toLong())?.run {
        CurrentUserInfo(
            userId = "userId",
            nickName = nickName,
            userNo = userNo!!,
            role = role,
        )
    } ?: throw UserNotFoundException()
}

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
@Reflective
public @interface CacheEvict {
    @AliasFor("cacheNames")
    String[] value() default {};
    //용도: 캐시 이름을 지정합니다. cacheNames 속성과 동일하게 동작하며, 두 속성은 서로의 별칭(alias)입니다.
    //설명: 캐시 이름을 지정할 때 사용되며, 하나 이상의 캐시 이름을 배열 형태로 설정할 수 있습니다.
 
    @AliasFor("value")
    String[] cacheNames() default {};
    //용도: 캐시 이름을 지정합니다. value 속성과 동일하게 동작하며, 두 속성은 서로의 별칭입니다.
    //설명: 캐시 이름을 지정할 때 사용되며, 하나 이상의 캐시 이름을 배열 형태로 설정할 수 있습니다.
 
    String key() default "";
    //용도: 캐시 항목을 저장할 때 사용할 키를 SpEL(Spring Expression Language)로 지정합니다.
    //설명: 기본값은 빈 문자열이며, 메서드 파라미터를 기준으로 자동 생성됩니다. 특정 키를 명시적으로 지정하고 싶을 때 사용합니다.
 
    String keyGenerator() default "";
    //용도: 커스텀 키 생성기를 지정합니다.
    //설명: 기본적으로는 스프링이 제공하는 키 생성기를 사용하지만, keyGenerator 속성을 통해 커스텀 키 생성기를 명시할 수 있습니다.
 
    String cacheManager() default "";
    //용도: 사용할 캐시 매니저 빈의 이름을 지정합니다.
    //설명: 여러 캐시 매니저가 있는 경우, 특정 캐시 매니저를 명시적으로 지정할 때 사용합니다.
 
    String cacheResolver() default "";
    //용도: 캐시 리졸버를 지정합니다.
    //설명: 캐시 리졸버는 어떤 캐시를 사용할지 결정하는 역할을 합니다. cacheResolver를 통해 커스텀 캐시 리졸버를 지정할 수 있습니다.
 
    String condition() default "";
    //용도: 캐시 조건을 지정합니다.
    //설명: SpEL 표현식을 사용하여 조건을 지정할 수 있으며, 조건이 참일 경우에만 캐싱이 이루어집니다.
 
    boolean allEntries() default false;
    //용도: 캐시 내의 모든 항목을 제거할지 여부를 지정합니다.
    //설명: true로 설정하면 지정된 캐시 이름의 모든 항목이 제거됩니다. key 속성보다 우선적으로 적용됩니다.
 
    boolean beforeInvocation() default false;
    //용도: 메서드 호출 전(before) 또는 후(after)에 캐시 항목을 제거할지 여부를 지정합니다.
    //설명: true로 설정하면 메서드가 호출되기 전에 캐시 항목을 제거합니다. 기본값은 false로, 메서드 호출 후에 캐시 항목을 제거합니다.
}
 

@CacheEvict(value = ["users"], key = "#username")
fun remove(username: String) {
    ....
}

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
@Reflective
public @interface CachePut {
    @AliasFor("cacheNames")
    String[] value() default {};
    //용도: 캐시 이름을 지정합니다. cacheNames 속성과 동일하게 동작하며, 두 속성은 서로의 별칭(alias)입니다.
    //설명: 캐시 이름을 지정할 때 사용되며, 하나 이상의 캐시 이름을 배열 형태로 설정할 수 있습니다.
 
    @AliasFor("value")
    String[] cacheNames() default {};
    //용도: 캐시 이름을 지정합니다. value 속성과 동일하게 동작하며, 두 속성은 서로의 별칭입니다.
    //설명: 캐시 이름을 지정할 때 사용되며, 하나 이상의 캐시 이름을 배열 형태로 설정할 수 있습니다.
 
    String key() default "";
    //용도: 캐시 항목을 저장할 때 사용할 키를 SpEL(Spring Expression Language)로 지정합니다.
    //설명: 기본값은 빈 문자열이며, 메서드 파라미터를 기준으로 자동 생성됩니다. 특정 키를 명시적으로 지정하고 싶을 때 사용합니다.
 
    String keyGenerator() default "";
    //용도: 커스텀 키 생성기를 지정합니다.
    //설명: 기본적으로는 스프링이 제공하는 키 생성기를 사용하지만, keyGenerator 속성을 통해 커스텀 키 생성기를 명시할 수 있습니다.
 
    String cacheManager() default "";
    //용도: 사용할 캐시 매니저 빈의 이름을 지정합니다.
    //설명: 여러 캐시 매니저가 있는 경우, 특정 캐시 매니저를 명시적으로 지정할 때 사용합니다.
 
    String cacheResolver() default "";
    //용도: 캐시 리졸버를 지정합니다.
    //설명: 캐시 리졸버는 어떤 캐시를 사용할지 결정하는 역할을 합니다. cacheResolver를 통해 커스텀 캐시 리졸버를 지정할 수 있습니다.
 
    String condition() default "";
    //용도: 캐시 조건을 지정합니다.
    //설명: SpEL 표현식을 사용하여 조건을 지정할 수 있으며, 조건이 참일 경우에만 캐싱이 이루어집니다.
 
    String unless() default "";
    //용도: 캐시에서 제외할 조건을 지정합니다.
    //설명: SpEL 표현식을 사용하여 조건을 지정할 수 있으며, 조건이 참일 경우 캐싱되지 않습니다. condition과 반대로 동작합니다.
}
 

@CachePut(value = ["users"], key = "#username")
override fun loadUserByUsername(username: String): UserDetails {
    return userRepository.findByIdOrNull(username.toLong())?.run {
        CurrentUserInfo(
            userId = "userId",
            nickName = nickName,
            userNo = userNo!!,
            role = role,
        )
    } ?: throw UserNotFoundException()
}

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
@Reflective
public @interface Caching {
    Cacheable[] cacheable() default {};
 
    CachePut[] put() default {};
 
    CacheEvict[] evict() default {};
}

@Caching(
    cacheable = [Cacheable(value = ["productCache"], key = "#product.id")],
    put = [CachePut(value = ["productCache"], key = "#product.id")],
    evict = [CacheEvict(value = ["productCache"], key = "#product.id")]
)
fun updateProduct(product: Product): Product {
    return product
}

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface CacheConfig {
    String[] cacheNames() default {};
    //용도: 캐시의 이름을 정의합니다.
    //설명: 캐시를 적용할 때 사용할 캐시 이름을 배열 형태로 지정할 수 있습니다. 여러 캐시 이름을 지정할 수 있으며,
    //     이 이름은 @Cacheable, @CachePut, @CacheEvict 애노테이션의 value 또는 cacheNames 속성에 사용될 수 있습니다.
    String keyGenerator() default "";
    //용도: 캐시 키를 생성할 때 사용할 커스텀 키 생성기의 이름을 지정합니다.
    //설명: 지정된 이름의 커스텀 KeyGenerator 빈을 사용하여 캐시 키를 생성합니다. 기본적으로는 스프링의 기본 키 생성기를 사용하지만, 이 속성을 통해 커스텀 키 생성기를 사용할 수 있습니다.
    String cacheManager() default "";
    //용도: 사용할 캐시 매니저 빈의 이름을 지정합니다.
    //설명: 여러 개의 캐시 매니저가 있을 때, 특정 캐시 매니저를 지정하여 캐시 작업을 수행합니다. 이 속성에 지정된 캐시 매니저가 캐시 작업에 사용됩니다.
 
    String cacheResolver() default "";
    //용도: 캐시 리졸버의 이름을 지정합니다.
    //설명: 캐시 리졸버는 캐시를 선택할 때 사용하는 빈입니다. 특정 캐시 리졸버를 지정하여 캐시를 동적으로 선택할 수 있습니다.
}

@Service
@CacheConfig(
    cacheNames = ["productCache"],
    keyGenerator = "keyGenerator",
    cacheManager = "cacheManager"
)
class ProductService {
 
    @Cacheable
    fun getProductById(productId: String): Product {
        // 제품 정보를 조회하고 반환
    }
 
    @CachePut
    fun updateProduct(product: Product): Product {
        // 제품 정보를 업데이트하고 반환
        return product
    }
}