Кэширование

Модуль для создания кешей на основе Caffeine или Redis с помощью аннотаций в декларативном стиле, так и использование их императивном стиле.

Caffeine

Реализация на основе библиотеки Caffeine для кэша внутри памяти приложения.

Подключение

Java Kotlin

Зависимость build.gradle:

implementation "ru.tinkoff.kora:cache-caffeine"

Модуль:

@KoraApp
public interface Application extends CaffeineCacheModule { }

Зависимость build.gradle.kts:

implementation("ru.tinkoff.kora:cache-caffeine")

Модуль:

@KoraApp
interface Application : CaffeineCacheModule

Конфигурация

Пример полной конфигурации для mycache.config кэша, параметры описаны в классе CaffeineCacheConfig (указаны примеры значений или значения по умолчанию):

Hocon YAML

mycache {
    config {
        expireAfterWrite = "10s" //(1)!
        expireAfterAccess = "10s" //(2)!
        initialSize = 10 //(3)!
        maximumSize = 100000 //(4)!
    }
}

1. Время по истечении которого значение для ключа будет удалено, отчитывается после добавления значения (по умолчанию отсутвует)
2. Время по истечении которого значение для ключа будет удалено, отчитывается после операции чтения (по умолчанию отсутвует)
3. Начальный размер кэша (помогает избежать расширения кэша в случае активного набухания) (по умолчанию отсутвует)
4. Максимальный размер кэша (При достижении границы или чуть ранее будет исключать из кэша наименее актуальные значения) (по умолчанию 100000)

mycache:
  config:
    expireAfterWrite: "10s" #(1)!
    expireAfterAccess: "10s" #(2)!
    initialSize: 10 #(3)!
    maximumSize: 100000 #(4)!

1. Время по истечении которого значение для ключа будет удалено, отчитывается после добавления значения (по умолчанию отсутвует)
2. Время по истечении которого значение для ключа будет удалено, отчитывается после операции чтения (по умолчанию отсутвует)
3. Начальный размер кэша (помогает избежать расширения кэша в случае активного набухания) (по умолчанию отсутвует)
4. Максимальный размер кэша (При достижении границы или чуть ранее будет исключать из кэша наименее актуальные значения) (по умолчанию 100000)

Redis

Реализация на основе базы данных в памяти Redis и драйвера подключения Lettuce.

Подключение

Java Kotlin

Зависимость build.gradle:

implementation "ru.tinkoff.kora:cache-redis"

Модуль:

@KoraApp
public interface Application extends RedisCacheModule { }

Зависимость build.gradle.kts:

implementation("ru.tinkoff.kora:cache-redis")

Модуль:

@KoraApp
interface Application : RedisCacheModule

Конфигурация

Требуется отдельно сконфигурировать Lettuce драйвер для подключения к Redis. Используется одно подключение для всех кешей.

Пример полной конфигурации для lettuce драйвера, параметры описаны в классе LettuceConfig (указаны примеры значений или значения по умолчанию):

Hocon YAML

lettuce {
    uri = "redis://locahost:6379" //(1)!
    user = "admin" //(2)!
    password = "12345" //(3)!
    database = 0 //(4)!
    protocol = "REP3" //(5)!
    socketTimeout = "10s" //(6)!
    commandTimeout = "60s" //(7)!
}

1. URI для подключения к Redis (обязательный)
2. Имя пользователя для подключения (по умолчанию отсутвует)
3. Пароль пользователя для подключения (по умолчанию отсутвует)
4. Номер базы для подключения (по умолчанию отсутвует)
5. Протокол для подключения
6. Таймаут времени подключения
7. Таймаут времени выполнения команды

lettuce:
  uri: "redis://locahost:6379" #(1)!
  user: "admin" #(2)!
  password: "12345" #(3)!
  database: 0 #(4)!
  protocol: "REP3" #(5)!
  socketTimeout: "10s" #(6)!
  commandTimeout: "60s" #(7)!

1. URI для подключения к Redis (обязательный)
2. Имя пользователя для подключения (по умолчанию отсутвует)
3. Пароль пользователя для подключения (по умолчанию отсутвует)
4. Номер базы для подключения (по умолчанию отсутвует)
5. Протокол для подключения
6. Таймаут времени подключения
7. Таймаут времени выполнения команды

Конфигурации Redis кэша настраивает именно поведение конкретного кэша.

Пример полной конфигурации для mycache.config кэша, параметры описаны в классе RedisCacheConfig (указаны примеры значений):

Hocon YAML

mycache {
    config {    
        expireAfterWrite = "10s" //(1)!
        expireAfterAccess = "10s" //(2)!
        keyPrefix = "mykey" //(3)!
    }
}

1. При записи устанавливает время expiration
2. При чтении устанавливает время expiration
3. Префикс ключа в определенном кеше для избежания коллизий ключе в рамках Redis базы данных, может быть пустой строкой тогда ключи будут без префикса (обязательный)

mycache:
  config:
    expireAfterWrite: "10s" #(1)!
    expireAfterAccess: "10s" #(2)!
    keyPrefix: "mykey" //(3)!

1. При записи устанавливает время expiration
2. При чтении устанавливает время expiration
3. Префикс ключа в определенном кеше для избежания коллизий ключе в рамках Redis базы данных, может быть пустой строкой тогда ключи будут без префикса (обязательный)

Использование

Для создания кеша потребуется зарегистрировать типизированный @Cache контракт. Интерфейс контракта должен наследоваться только от предоставляемых Kora'ой реализаций: CaffeineCache / RedisCache. Для такого @Cache будет создана и добавлена в граф реализация, ее можно будет использовать для внедрения зависимостей.

Для регистрации @Cache и указания конфига требуется проаннотировать аннотацией @Cache где аргумент value означает полный путь к конфига.

Java Kotlin

@Cache("mycache.config")
public interface MyCache extends CaffeineCache<String, String> { }

@Cache("mycache.config")
interface MyCache : CaffeineCache<String, String>

Императивный подход

Кеши доступны для внедрения как зависимости по интерфейсу и могут использовать вкупе с декларативными операциями.

Реализация CaffeineCache предоставляет базовые контракты интерфейса Cache для синхронных операций, а RedisCache предоставляет как Cache так и AsyncCache для асинхронных операций с CompletionStage сигнатурами.

Интерфейсы предоставляют операции получения, удаления, обновления, пакетных операций и тп. Также реализации кешей могут предоставлять специфичные для себя контракты.

Декларативный подход

Все примеры использования аспектов будут подразумевать реализацию кэша выше.

Получение

Для кэширования и получения значения из кэша для метода get() следует проаннотировать его аннотацией @Cacheable.

Ключ для кэша составляет из аргументов метода, порядок аргументов имеет значение, в данном случае он будет составляться из значения arg1.

Java Kotlin

@Component
public class SomeService {

    @Cacheable(MyCache.class)
    public String get(String arg1) {
        // do something
    }
}

@Component
class SomeService {

    @Cacheable(MyCache::class)
    fun get(arg1: String): String {
        // do something
    }
}

Сохранение

Для добавления значений в кэш через метод put() следует проаннотировать его аннотацией @CachePut. Метод проаннотированный @CachePut будет вызван и его значение положено в кэш определенный в value.

Ключ для кэша составляет из аргументов метода, порядок аргументов имеет значение, в данном случае он будет составляться из значения arg1.

Java Kotlin

@Component
public class SomeService {

    @CachePut(MyCache.class)
    public String put(String arg1) {
        // do something
    }
}

@Component
class SomeService {

    @CachePut(MyCache::class)
    fun put(arg1: String): String {
        // do something
    }
}

Удаление

Для удаления значения по ключу из кэша через метод evict() следует проаннотировать его аннотацией @CacheInvalidate. Метод проаннотированный @CacheInvalidate будет вызван и затем по ключу для кэша определенного в value будут удалены значения по ключу.

Ключ для кэша составляет из аргументов метода, порядок аргументов имеет значение, в данном случае он будет составляться из значения arg1.

Java Kotlin

@Component
public class SomeService {

    @CacheInvalidate(MyCache.class)
    public void evict(String arg1) {
        // do something
    }
}

@Component
class SomeService {

    @CacheInvalidate(MyCache::class)
    fun evict(arg1: String) {
        // do something
    }
}

Полное удаление

Для удаления всех значений из кэша через метод evictAll() следует проаннотировать его аннотацией @CacheInvalidate и указать параметр invalidateAll = true.

Метод проаннотированный @CacheInvalidate будет вызван и затем будут удалены все из кэша определенного в value.

Java Kotlin

@Component
public class SomeService {

    @CacheInvalidate(value = MyCache.class, invalidateAll = true)
    public void evictAll(String arg1) {
        // do something
    }
}

@Component
class SomeService {

    @CacheInvalidate(value = MyCache::class, invalidateAll = true)
    fun evict(arg1: String) {
        // do something
    }
}

Композитный кэш

В случае если у вас есть несколько кешей то требуется подключить оба модуля и указать соответствующее количество аннотаций над методом.

Java Kotlin

@KoraApp
public interface Application extends RedisCacheModule, CaffeineCacheModule {

    @Cache("mycache.caffeine.config")
    public interface MyCaffeineCache extends CaffeineCache<String, String> { }

    @Cache("mycache.redis.config")
    public interface MyRedisCache extends RedisCache<String, String> { }
}

@KoraApp
interface Application : RedisCacheModule, CaffeineCacheModule { 

    @Cache("mycache.caffeine.config")
    interface MyCaffeineCache : CaffeineCache<String, String> { }

    @Cache("mycache.redis.config")
    interface MyRedisCache : RedisCache<String, String> { }
}

А сам проаннотированный класс так:

Java Kotlin

@Component
public class SomeService {

    @Cacheable(MyCaffeineCache.class)
    @Cacheable(MyRedisCache.class)
    public String get(String arg1) {
        // do something
    }
}

@Component
class SomeService {

    @Cacheable(MyCaffeineCache::class)
    @Cacheable(MyRedisCache::class)
    fun get(arg1: String): String {
        // do something
    }
}

Порядок вызова аспектов соответствует порядку аннотаций над методом, сверху внизу.

Ключ

В случае если ключ кэша представляет собой 1 аргумент, то требуется зарегистрировать Cache с сигнатурой соответствующей типам ключа и значения.

Java Kotlin

@Cache("mycache.config")
public interface MyCache extends CaffeineCache<String, String> { }

@Cache("mycache.config")
interface MyCache : CaffeineCache<String, String>

Преобразование

В случае если аргумент не может быть преобразован в ключ кеша, то реализация кеша затребует соответствующий преобразователь с интерфейсом CacheKeyMapper, в случае если аргументов для ключа будет 2 то потребуется CacheKeyMapper2 и так далее.

Такой преобразователь можно также предоставить в ручную с помощью аннотации @Mapping, пример преобразования сложного объекта в простой ключ кеша:

Java Kotlin

@Component
public class SomeService {

    public record UserContext(String userId, String traceId) { }

    public static final class UserContextMapping implements CacheKeyMapper<String, UserContext> {

        @Nonnull
        @Override
        public String map(UserContext arg) {
            return arg.userId();
        }
    }

    @Mapping(UserContextMapping.class)
    @Cacheable(MyCache.class)
    public String get(UserContext context) {
        // do something
    }
}

@Component
class SomeService {

    @Cacheable(MyCache::class)
    fun get(arg1: String, arg2: BigDecimal): String {
        // do something
    }
}

Композитный ключ

В случае если ключ кэша представляет собой N аргументов, то требуется зарегистрировать Cache с использованием собственного класса который бы описывал такой ключ.

Пример для Cache где композитный ключ состоит из 2 элементов:

Java Kotlin

Предполагается создавать собственный record класс который бы описывал композитный ключ.

@Cache("mycache.config")
public interface MyCache extends CaffeineCache<MyCache.Key, String> {

    record Key(String k1, Long k2) { }
}

Предполагается создавать собственный data класс который бы описывал композитный ключ.

@Cache("mycache.config")
interface MyCache : CaffeineCache<MyCache.Key, String> {

    data class Key(val k1: String, val k2: Long)
}

Если используется RedisCache то подразумевается что по умолчанию все аргументы композитного ключа будут не null, либо потребуется использовать собственный преобразователь ключа.

Порядок аргументов

В случае если метод принимает аргументы которые хочется исключить из композитного ключа, либо же порядок аргументов не соответствует порядку аргументов конструктора композитного ключа, следует использовать атрибут аннотации parameters и определить какие именно аргументы метода использовать и в каком порядке.

Java Kotlin

@Component
public class SomeService {

    @Cacheable(value = MyCache.class, parameters = {"arg1", "arg2"})
    public String get(Long arg2, String arg3, String arg1) {
        // do something
    }
}

@Component
class SomeService {

    @Cacheable(value = MyCache::class, parameters = ["arg1", "arg2"])
    fun get(arg2: Long, arg3: String, arg1: String): String {
        // do something
    }
}

Подгружаемый кэш

Библиотека предоставляет компонент для построения сущности, которая объединяет операции GET и PUT, без использования аспектов - LoadableCache

Java Kotlin

@Cache("mycache.config")
public interface MyCache extends CaffeineCache<String, String> { }

@KoraApp
public interface Application : CaffeineCacheModule {

    default LoadableCache<String, String> loadableCache(MyCache cache, SomeService someService) {
        return cache.asLoadable(someService::loadEntity);
    }
}

@Cache("mycache.config")
interface MyCache : CaffeineCache<String, String>

@KoraApp
interface Application : CaffeineCacheModule {

    fun loadableCache(
        cache: MyCache,
        someService: SomeService,
    ): LoadableCache<String, String> {
        return cache.asLoadable(someService::loadEntity)
    }
}

Сигнатуры

Доступные сигнатуры для методов которые поддерживают аннотации из коробки:

Java Kotlin

Класс не должен быть final, чтобы аспекты работали.

Под T подразумевается тип возвращаемого значения.

• T myMethod()
• Optional<T> myMethod()
• CompletionStage<T> myMethod() CompletionStage
• Mono<T> myMethod() Project Reactor (надо подключить зависимость)

Класс должен быть open, чтобы аспекты работали.

Под T подразумевается тип возвращаемого значения, либо T?, либо Unit.

• myMethod(): T
• suspend myMethod(): T Kotlin Coroutine (надо подключить зависимость как implementation)