Один Решение кеширования на основе SpringCache
1.1 Введение в SpringCache
springcache появился в версии spring3.1. Он инкапсулирует и абстрагирует работу с кешем: для получения кешированного результата достаточно использовать аннотацию на методе. Именно благодаря аннотациям он решает проблему связанности бизнес-кода и кода кеширования, позволяя существующему коду сразу поддерживать кеширование без вмешательства в бизнес-логику. Разработчики могут пользоваться кешем прозрачно для себя.
1.2 Обзор SpringCache
Существует множество решений для кеширования, и у каждого есть свои преимущества: например, Redis, Memcached, Guava, Caffeine и другие.
Если наша программа хочет использовать кэш, ей приходится связываться с этими фреймворками. Предусмотрительные архитекторы уже используют интерфейсы для уменьшения связанности: благодаря абстракции и полиморфизму объектно-ориентированного подхода они отделяют бизнес-код от конкретных фреймворков.
Но нам по-прежнему нужно явно вызывать в коде интерфейсы и методы, связанные с кешем: в нужный момент помещать данные в кеш и в нужный момент читать их оттуда. Подумайте о 「AOP」 — разве такие сценарии применения не предназначены для AOP по самой своей природе?
Начиная со Spring
3.1 доступна поддержка Cache через аннотации, аналогичная управлению транзакциями через аннотацию [@Transactional](/Transactional ), а также абстракция Cache; до этого обычно использовался AOP.
Преимущества использования Spring Cache:
-
Предоставляет базовую абстракцию Cache, упрощающую переключение между различными реализациями кеша；
-
Аннотация Cache позволяет прозрачно применять логику кэширования к нашему бизнес-коду, подобно транзакциям, причём для этого требуется меньше кода;
-
Обеспечивает автоматический откат кэша при откате транзакции；
-
Поддерживает довольно сложную логику кеширования；
1.3 Основные принципы устройства Spring Cache
Начиная со Spring 3.1 появился Spring Cache — абстракция кеширования Spring. Определяя org.springframework.cache.Cache и org.springframework.cache.CacheManager интерфейс для унификации различных технологий кеширования, а также поддерживает аннотации JCache, упрощающие разработку.
Интерфейс Cache задаёт спецификацию компонента кэша и включает набор различных операций с кэшем。В Spring для интерфейса Cache предусмотрены различные xxxCache реализация： RedisCache ， EhCacheCache ， ConcurrentMapCache и другие.
Рассмотрим интерфейс Cache и на примере части исходного кода CacheManager интерфейс.
Интерфейс Cache
public interface Cache { //Cache名称 String getName(); //Cache负责缓存的对象 Object getNativeCache(); /** * 获取key对应的ValueWrapper * 没有对应的key，则返回null * key对应的value是null，则返回null对应的ValueWrapper */ @Nullable Cache.ValueWrapper get(Object key); //返回key对应type类型的value @Nullable <T> T get(Object key, @Nullable Class<T> type); //返回key对应的value，没有则缓存Callable::call，并返回 @Nullable <T> T get(Object key, Callable<T> valueLoader); //缓存目标key-value（替换旧值），不保证实时性 void put(Object key, @Nullable Object value); //插入缓存，并返回该key对应的value；先调用get，不存在则用put实现 @Nullable default Cache.ValueWrapper putIfAbsent(Object key, @Nullable Object value) { Cache.ValueWrapper existingValue = this.get(key); if (existingValue == null) { this.put(key, value); } return existingValue; } //删除缓存，不保证实时性 void evict(Object key); //立即删除缓存：返回false表示剔除前不存在制定key活不确定是否存在；返回true，表示该key之前存在 default boolean evictIfPresent(Object key) { this.evict(key); return false; } //清除所有缓存，不保证实时性 void clear(); //立即清楚所有缓存，返回false表示清除前没有缓存或不能确定是否有；返回true表示清除前有缓存 default boolean invalidate() { this.clear(); return false; } public static class ValueRetrievalException extends RuntimeException { @Nullable private final Object key; public ValueRetrievalException(@Nullable Object key, Callable<?> loader, Throwable ex) { super(String.format("Value for key '%s' could not be loaded using '%s'", key, loader), ex); this.key = key; } @Nullable public Object getKey() { return this.key; } } //缓存值的一个包装器接口，实现类为SimpleValueWrapper @FunctionalInterface public interface ValueWrapper { @Nullable Object get(); } }
Как видно, интерфейс Cache абстрагирует такие операции с кешем, как get put evict.
Абстрактный класс AbstractValueAdaptingCache
public abstract class AbstractValueAdaptingCache implements Cache { //是否允许Null值 private final boolean allowNullValues; protected AbstractValueAdaptingCache(boolean allowNullValues) { this.allowNullValues = allowNullValues; } public final boolean isAllowNullValues() { return this.allowNullValues; } @Nullable public ValueWrapper get(Object key) { return this.toValueWrapper(this.lookup(key)); } @Nullable public <T> T get(Object key, @Nullable Class<T> type) { //查询到的缓存值做fromStoreValue转换 Object value = this.fromStoreValue(this.lookup(key)); //转换后非null值且无法转换为type类型则抛出异常 if (value != null && type != null && !type.isInstance(value)) { throw new IllegalStateException("Cached value is not of required type [" + type.getName() + "]: " + value); } else { return value; } } //从缓存中获取key对应的value，子类实现 @Nullable protected abstract Object lookup(Object key); //对于从缓存中获取的值，允许为空且值为NullValue时，处理为null @Nullable protected Object fromStoreValue(@Nullable Object storeValue) { return this.allowNullValues && storeValue == NullValue.INSTANCE ? null : storeValue; } //对于要插入缓存的null值，在允许null值的情况下处理为NullValue；否则抛出异常IllegalArgumentException protected Object toStoreValue(@Nullable Object userValue) { if (userValue == null) { if (this.allowNullValues) { return NullValue.INSTANCE; } else { throw new IllegalArgumentException("Cache '" + this.getName() + "' is configured to not allow null values but null was provided"); } } else { return userValue; } } //get操作依据，查询到缓存值非null，则fromStoreValue转换后包装成SimpleValueWrapper返回 @Nullable protected ValueWrapper toValueWrapper(@Nullable Object storeValue) { return storeValue != null ? new SimpleValueWrapper(this.fromStoreValue(storeValue)) : null; } }
Абстрактный класс AbstractValueAdaptingCache Реализует интерфейс Cache, в основном абстрагируя логику обработки значений NULL.
-
allowNullValuesСвойство указывает, разрешено ли кэширование значений NULL -
fromStoreValueметода для обработки значений NULLgetоперация, в свойствеallowNullValuesпри значении true обрабатывать NullValue как NULL -
toStoreValueметод обработки значений NULLputоперация, в свойствеallowNullValuesесли значение равно true, обрабатывать NULL как NullValue, иначе выбрасывать исключение -
toValueWrapperметод предоставляетCacheв интерфейсеgetреализация метода по умолчанию считывает значение из кэша, затем с помощьюfromStoreValueпреобразуется, затем оборачивается вSimpleValueWrapperВозвращает -
ValueWrapper get(Object key)иT get(Object key, @Nullable Classtype)Метод реализован на основе вышеописанного метода -
ValueWrapper get(Object key)и@Nullable Classtype)Метод реализован на основе вышеописанного метода -
lookupАбстрактный метод, позволяющий подклассам получать фактическое значение из кэша
ConcurrentMapCache
public class ConcurrentMapCache extends AbstractValueAdaptingCache { private final String name; //定义ConcurrentMap缓存 private final ConcurrentMap<Object, Object> store; //如果要缓存的是值对象的copy，则由此序列化代理类处理 @Nullable private final SerializationDelegate serialization; public ConcurrentMapCache(String name) { this(name, new ConcurrentHashMap(256), true); } //默认允许处理null public ConcurrentMapCache(String name, boolean allowNullValues) { this(name, new ConcurrentHashMap(256), allowNullValues); } //默认serialization = null public ConcurrentMapCache(String name, ConcurrentMap<Object, Object> store, boolean allowNullValues) { this(name, store, allowNullValues, (SerializationDelegate)null); } protected ConcurrentMapCache(String name, ConcurrentMap<Object, Object> store, boolean allowNullValues, @Nullable SerializationDelegate serialization) { super(allowNullValues); Assert.notNull(name, "Name must not be null"); Assert.notNull(store, "Store must not be null"); this.name = name; this.store = store; this.serialization = serialization; } //serialization不为空，缓存值对象的copy public final boolean isStoreByValue() { return this.serialization != null; } public final String getName() { return this.name; } public final ConcurrentMap<Object, Object> getNativeCache() { return this.store; } //实现lookup：store#get @Nullable protected Object lookup(Object key) { return this.store.get(key); } //基于ConcurrentMap::computeIfAbsent方法实现；get和put的值由fromStoreValue和toStoreValue处理Null @Nullable public <T> T get(Object key, Callable<T> valueLoader) { return this.fromStoreValue(this.store.computeIfAbsent(key, (k) -> { try { return this.toStoreValue(valueLoader.call()); } catch (Throwable var5) { throw new ValueRetrievalException(key, valueLoader, var5); } })); } public void put(Object key, @Nullable Object value) { this.store.put(key, this.toStoreValue(value)); } @Nullable public ValueWrapper putIfAbsent(Object key, @Nullable Object value) { Object existing = this.store.putIfAbsent(key, this.toStoreValue(value)); return this.toValueWrapper(existing); } public void evict(Object key) { this.store.remove(key); } public boolean evictIfPresent(Object key) { return this.store.remove(key) != null; } public void clear() { this.store.clear(); } public boolean invalidate() { boolean notEmpty = !this.store.isEmpty(); this.store.clear(); return notEmpty; } protected Object toStoreValue(@Nullable Object userValue) { Object storeValue = super.toStoreValue(userValue); if (this.serialization != null) { try { return this.serialization.serializeToByteArray(storeValue); } catch (Throwable var4) { throw new IllegalArgumentException("Failed to serialize cache value '" + userValue + "'. Does it implement Serializable?", var4); } } else { return storeValue; } } protected Object fromStoreValue(@Nullable Object storeValue) { if (storeValue != null && this.serialization != null) { try { return super.fromStoreValue(this.serialization.deserializeFromByteArray((byte[])((byte[])storeValue))); } catch (Throwable var3) { throw new IllegalArgumentException("Failed to deserialize cache value '" + storeValue + "'", var3); } } else { return super.fromStoreValue(storeValue); } } }
ConcurrentMapCache наследует абстрактный класс AbstractValueAdaptingCache , является стандартной реализацией кеша в Spring. Поддерживает кеширование с копированием объектов; сериализацией занимается SerializationDelegate
serialization, по умолчанию значение равно null, то есть кеш хранит ссылки. Операции с кешем основаны на базовом классе AbstractValueAdaptingCache — обработка
значений null, по умолчанию null допускается.
CacheManager
public interface CacheManager { @Nullable //获取指定name的Cache，可能延迟创建 Cache getCache(String name); //获取当前CacheManager下的Cache name集合 Collection<String> getCacheNames(); }
CacheManager На основе
name управляется группа Cache. Разумеется， CacheManager также имеет множество классов реализации, например ConcurrentMapCacheManager 、 AbstractCacheManager и SimpleCacheManager ，эти xxxCacheManager классы предназначены для определения правил управления Cache; здесь мы не будем рассматривать их подробнее.
II Использование SpringCache
2.1 Как использовать
Spring Cache — именно такой фреймворк. Он использует AOP для реализации кеширования на основе аннотаций и предоставляет продуманную абстракцию: бизнес-коду не нужно учитывать, какой фреймворк кеширования используется на нижнем уровне. Для реализации кеширования достаточно добавить одну аннотацию.
Добавление зависимости
<!--springboot的cache支持--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-cache</artifactId> </dependency> <!--配置拓展还需添加的依赖--> <dependency> <groupId>com.github.ben-manes.caffeine</groupId> <artifactId>caffeine</artifactId> <version>2.9.2</version> </dependency>
Настройка Cache
Добавьте аннотацию @EnableCaching в стартовый класс Application
@SpringBootApplication @MapperScan("com.xxxx.dao") @EnableCaching public class AxxxxApplication { public static void main(String[] args) { SpringApplication.run(AxxxxApplication.class, args); } }
Настройка типа кэша cache；здесь основное внимание уделяется локальному кэшу
//方式一：ConcurrentMapCache （不好设置过期时间） @Configuration public class SpringCachingConfig { @Bean public CacheManager cacheManager() { SimpleCacheManager cacheManager = new SimpleCacheManager(); Set<ConcurrentMapCache> mapCaches=new HashSet<>(); //配置cache类型与目录 mapCaches.add(new ConcurrentMapCache("cacheNames1")); mapCaches.add(new ConcurrentMapCache("cacheNames2")); mapCaches.add(new ConcurrentMapCache("cacheNames3")); mapCaches.add(new ConcurrentMapCache("cacheNames4")); cacheManager.setCaches(mapCaches); cacheManager.afterPropertiesSet(); return cacheManager; } } //方式二：CaffeineCache （可设置过期时间） @Configuration public class SpringCachingConfig { @Bean public CacheManager cacheManager() { SimpleCacheManager cacheManager = new SimpleCacheManager(); List<CaffeineCache> caffeineCaches = new ArrayList<>(); //SysConstants.CACHE_NAMES=new ArrayList( //Arrays.asList("cacheNames1","cacheNames2","cacheNames3","cacheNames4") //); for (String cacheName: SysConstants.CACHE_NAMES) { caffeineCaches.add(new CaffeineCache(cacheName, Caffeine.newBuilder() .initialCapacity(50) .maximumSize(30000)//最大存储数量 .expireAfterWrite(2, TimeUnit.HOURS)//过期时间2 小时 .build())); } cacheManager.setCaches(caffeineCaches); return cacheManager; } } //方式三。。。。还可以配置redis以及其他的方式，这里主要介绍以上两种方式
Реализация кеширования интерфейса
//控制器1 @RestController @RequestMapping("/path1") @Cacheable(cacheNames = "cacheNames1" ,key="#root.methodName+#a0" ) public class Controller1 { } //控制器2 @RestController @RequestMapping("/path2") @Cacheable(cacheNames = "cacheNames2" ,key="#root.methodName+#a0" ) public class Controller2 { } //控制器3 @RestController @RequestMapping("/path3") @Cacheable(cacheNames = "cacheNames3" ,key="#root.methodName+#a0" ) public class Controller3 { } //控制器4 @RestController @RequestMapping("/path4") @Cacheable(cacheNames = "cacheNames4" ,key="#root.methodName+#a0" ) public class Controller4 { }
2.2 Подробное описание аннотаций SpringCache
Аннотация @Cacheable
Если данных нет в кеше: запросить базу данных, сохранить данные в кеше, вернуть результат，
Если данные есть в кеше：сразу вернуть результат
| Параметры | Объяснение | пример |
| значение | Имена кешей, определённые в конфигурационном файле spring , необходимо указать хотя бы одно |
Например: @Cacheable(value=”mycache”) @Cacheable(value={”cache1”,”cache2”} |
| ключ | Ключ кеша; может быть пустым. Если он указан, его нужно записать в виде выражения SpEL; если не указан, по умолчанию он формируется из всех параметров метода | @Cacheable(value=”testcache”,key=”#userName”) |
| условие | Условие кеширования; может быть пустым, записывается на SpEL и возвращает true или false; кеширование выполняется только при true | @Cacheable(value=”testcache”,condition=”#userName.length()>2”) |
Назначение: позволяет записывать результаты в кеш, чтобы при последующих вызовах возвращать значение непосредственно из кеша без повторного выполнения самого метода. Самый простой способ использования,имя аннотации=имя кеша,пример использования приведён ниже:
@Cacheable(value="accountCache")// 使用了一个缓存名叫 accountCache public Account getAccountByName(String userName) { // 方法内部实现不考虑缓存逻辑，直接实现业务 System.out.println("real query account."+userName); return getFromDB(userName); }
Аннотация @CacheEvict
@CacheEvict: аннотация для удаления кеша, очень полезная для удаления старых и ненужных данных. Здесь также есть дополнительный параметр (allEntries): при allEntries=true можно массово удалить все записи
| Параметры | Объяснение | пример |
| значение | Имена кешей, определённые в конфигурационном файле spring , необходимо указать хотя бы одно | @CacheEvict(value=”my cache”) |
| ключ | Ключ кеша; может быть пустым. Если он указан, его нужно записать в виде выражения SpEL; если не указан, по умолчанию он формируется из всех параметров метода | @CacheEvict(value=”testcache”,key=”#userName”) |
| условие | Условие кеширования; может быть пустым, записывается на SpEL и возвращает true или false; кеширование выполняется только при true | @CacheEvict(value=”testcache”,condition=”#userName.length()>2”) |
| allEntries | Очищать ли всё содержимое кеша; по умолчанию false, если указать true, сразу после вызова метода весь кеш будет очищен | @CachEvict(value=”testcache”,allEntries=true) |
| beforeInvocation | Определяет, очищать ли кеш до выполнения метода; по умолчанию false. Если указать true, кеш будет очищен ещё до выполнения метода. По умолчанию, если при выполнении метода возникает исключение, кеш не очищается | @CachEvict(value=”testcache”，beforeInvocation=true) |
@CacheEvict(value="accountCache",key="#account.getName()")// 清空accountCache 缓存 public void updateAccount(Account account) { updateDB(account); } @CacheEvict(value="accountCache",allEntries=true)// 清空accountCache 缓存 public void reload() { reloadAll() } @Cacheable(value="accountCache",condition="#userName.length() <=4")// 缓存名叫 accountCache public Account getAccountByName(String userName) { // 方法内部实现不考虑缓存逻辑，直接实现业务 return getFromDB(userName); }
Аннотация @CachePut
@CachePut：эту аннотацию можно использовать, когда нужно обновить кеш, не вмешиваясь в выполнение метода. Иными словами, метод выполняется всегда, а его результат помещается в кеш；
| Параметры | Объяснение | пример |
| значение | Имена кешей, определённые в конфигурационном файле spring , необходимо указать хотя бы одно | @CachePut(value=”my cache”) |
| ключ | Ключ кеша; может быть пустым. Если он указан, его нужно записать в виде выражения SpEL; если не указан, по умолчанию он формируется из всех параметров метода | @CachePut(value=”testcache”,key=”#userName”) |
| условие | Условие кеширования; может быть пустым, записывается на SpEL и возвращает true или false; кеширование выполняется только при true | @CachePut(value=”testcache”,condition=”#userName.length()>2”) |
Аннотация @CachePut обеспечивает выполнение метода и одновременно запись возвращаемого им значения в кеш, реализуя синхронное обновление кеша и базы данных.
@CachePut(value="accountCache",key="#account.getName()")// 更新accountCache 缓存 public Account updateAccount(Account account) { return updateDB(account); }
Аннотация @Caching
При использовании кеша могут одновременно выполняться обновление и удаление, из-за чего возникает необходимость применить несколько аннотаций одновременно.А @Caching позволяет реализовать
//添加user缓存的同时，移除userPage的缓存 @Caching( put =@CachePut(value = "user",key ="#userVo.id"), evict = @CacheEvict(value = "userPage",allEntries = true) )
@Caching(put = { @CachePut(value = "user", key = "#user.id"), @CachePut(value = "user", key = "#user.username"), @CachePut(value = "user", key = "#user.email") }) public User save(User user) {
@CacheConfig
В каждой аннотации @Cacheable（） есть атрибут value＝“xxx”; очевидно, при большом количестве методов прописывать его утомительно. Если бы всё можно было объявить один раз, это упростило бы работу. Для этого и существует @CacheConfig: @CacheConfig — это аннотация уровня класса, позволяющая совместно использовать имена кешей; если в методе указать другое имя, приоритет по-прежнему будет у имени, заданного в методе.
@CacheConfig("books") public class BookRepositoryImpl implements BookRepository { @Cacheable public Book findBook(ISBN isbn) {...} }
Условное кэширование
Ниже приведены некоторые распространённые варианты условного кэширования
//@Cacheable将在执行方法之前( #result还拿不到返回值)判断condition，如果返回true，则查缓存； @Cacheable(value = "user", key = "#id", condition = "#id lt 10") public User conditionFindById(final Long id) //@CachePut将在执行完方法后（#result就能拿到返回值了）判断condition，如果返回true，则放入缓存； @CachePut(value = "user", key = "#id", condition = "#result.username ne 'zhang'") public User conditionSave(final User user) //@CachePut将在执行完方法后（#result就能拿到返回值了）判断unless，如果返回false，则放入缓存；（即跟condition相反） @CachePut(value = "user", key = "#user.id", unless = "#result.username eq 'zhang'") public User conditionSave2(final User user) //@CacheEvict， beforeInvocation=false表示在方法执行之后调用（#result能拿到返回值了）；且判断condition，如果返回true，则移除缓存； @CacheEvict(value = "user", key = "#user.id", beforeInvocation = false, condition = "#result.username ne 'zhang'") public User conditionDelete(final User user)
Пользовательские аннотации кеширования
Например, упомянутая ранее комбинация @Caching делает код с аннотациями над методом довольно громоздким. В таком случае можно использовать собственную аннотацию, объединив в ней все эти аннотации, например：
@Caching(put = { @CachePut(value = "user", key = "#user.id"), @CachePut(value = "user", key = "#user.username"), @CachePut(value = "user", key = "#user.email") }) @Target({ElementType.METHOD, ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) @Inherited public @interface UserSaveCache { }
Теперь достаточно использовать для метода следующий код，и весь код выглядит довольно аккуратно。
@UserSaveCache public User save(User user)
Расширение
Например, при вызове findByUsername следует помещать в кэш не только username–>user, но и id—>user и email—>user；тогда при следующем поиске по id нужные данные сразу найдутся в кэше
@Caching( cacheable = { @Cacheable(value = "user", key = "#username") }, put = { @CachePut(value = "user", key = "#result.id", condition = "#result != null"), @CachePut(value = "user", key = "#result.email", condition = "#result != null") } ) public User findByUsername(final String username) { System.out.println("cache miss, invoke find by username, username:" + username); for (User user : users) { if (user.getUsername().equals(username)) { return user; } } return null; }
На самом деле для схемы: id—>user；username—->user；email—>user；возможно, лучше использовать: id—>user；username—>id；email—>id；чтобы user хранился в единственном экземпляре；например:
@CachePut(value="cacheName", key="#user.username", cacheValue="#user.username") public void save(User user) @Cacheable(value="cacheName", key="#user.username", cacheValue="#caches[0].get(#caches[0].get(#username).get())") public User findByUsername(String username)
Данные контекста SpEL
Spring Cache предоставляет ряд данных контекста SpEL, которые мы можем использовать. Следующая таблица взята непосредственно из официальной документации Spring：
| Название | Расположение | Описание | Пример |
| methodName | Объект root | Имя текущего вызываемого метода | root.methodName |
| method | Объект root | Метод, вызываемый в данный момент | root.method.name |
| target | Объект root | Целевой объект, вызываемый в данный момент | root.target |
| targetClass | Объект root | Класс целевого объекта, вызываемого в данный момент | root.targetClass |
| args | Объект root | Список параметров текущего вызываемого метода | root.args[0] |
| caches | Объект root | Список кешей, используемых при текущем вызове метода（например, @Cacheable(value={“cache1”, “cache2”})），в этом случае кешей два | root.caches[0].name |
| имя аргумента | Контекст выполнения | Параметры текущего вызываемого метода: например, для findById(Long id) получить параметр можно через #id | user.id |
| result | Контекст выполнения | Возвращаемое значение после выполнения метода（доступно только для условий, проверяемых после выполнения метода, например ‘unless', а также 'cache evict' при beforeInvocation=false） | result |
@CacheEvict(value = "user", key = "#user.id", condition = "#root.target.canCache() and #root.caches[0].get(#user.id).get().username ne #user.username", beforeInvocation = true) public void conditionUpdate(User user)
Итоги
Для декларативного кэширования Spring предоставляет набор аннотаций Java:
· @Cacheable
o
Назначение：инициировать запись в кеш. Если данных в кеше нет, выполнить запрос к базе данных, сохранить данные в кеше и вернуть результат; если данные в кеше есть, сразу вернуть результат
o Применение:Запрос к базе данных Метод
· @CacheEvict
o
Функция：запускает очистку кеша
o Применение:Удаление или изменение базы данных Метод
· @CachePut
o
Функция: запись в кэш（не влияет на выполнение метода）.
o Применение:Добавить в базу данных Метод
· @Кэширование
o
Назначение: объединение нескольких операций с кешем, применяемых к методу
o Применение：совместное использование перечисленных выше аннотаций
