cacheable怎么获取缓存值_Spring Cache缓存注解

点击上方蓝色字体，选择“标星公众号”

优质文章，第一时间送达

  作者 |  成猿手册

来源 | cnblogs.com/WangJpBlog/p/13389932.html

Spring Cache缓存注解

本篇文章代码示例在Spring Cache简单实现上的代码示例加以修改。

只有使用public定义的方法才可以被缓存，而private方法、protected 方法或者使用default 修饰符的方法都不能被缓存。 当在一个类上使用注解时，该类中每个公共方法的返回值都将被缓存到指定的缓存项中或者从中移除。

@Cacheable

@Cacheable注解属性一览：

属性名	作用与描述
cacheNames/value	指定缓存的名字，缓存使用CacheManager管理多个缓存Cache，这些Cache就是根据该属性进行区分。对缓存的真正增删改查操作在Cache中定义，每个缓存Cache都有自己唯一的名字。
key	缓存数据时的key的值，默认是使用方法所有入参的值，可以使用SpEL表达式表示key的值。
keyGenerator	缓存的生成策略(键生成器)，和key二选一，作用是生成键值key，keyGenerator可自定义。
cacheManager	指定缓存管理器(例如ConcurrentHashMap、Redis等)。
cacheResolver	和cacheManager作用一样，使用时二选一。
condition	指定缓存的条件(对参数判断，满足什么条件时才缓存)，可用SpEL表达式，例如：方法入参为对象user则表达式可以写为condition = "#user.age>18"，表示当入参对象user的属性age大于18才进行缓存。
unless	否定缓存的条件(对结果判断，满足什么条件时不缓存)，即满足unless指定的条件时，对调用方法获取的结果不进行缓存，例如：unless = "result==null"，表示如果结果为null时不缓存。
sync	是否使用异步模式进行缓存，默认false。

@Cacheable指定了被注解方法的返回值是可被缓存的。其工作原理是Spring首先在缓存中查找数据，如果没有则执行方法并缓存结果，然后返回数据。

缓存名是必须提供的，可以使用引号、Value或者cacheNames属性来定义名称。下面的定义展示了users缓存的声明及其注解的使用:

@Cacheable("users")
//Spring 3.x
@Cacheable(value = "users")
//Spring 从4.0开始新增了value别名cacheNames比value更达意,推荐使用
@Cacheable(cacheNames = "users")

键生成器

缓存的本质就是键/值对集合。在默认情况下，缓存抽象使用(方法签名及参数值)作为一个键值，并将该键与方法调用的结果组成键/值对。 如果在Cache注解上没有指定key,
则Spring会使用KeyGenerator来生成一个key。

package org.springframework.cache.interceptor;
import java.lang.reflect.Method;

@FunctionalInterface
public interface KeyGenerator {
    
    Object generate(Object var1, Method var2, Object... var3);
}

Sping默认提供了SimpleKeyGenerator生成器。Spring 3.x之后废弃了3.x 的DefaultKey
Generator而用SimpleKeyGenerator取代，原因是DefaultKeyGenerator在有多个入参时只是简单地把所有入参放在一起使用hashCode()方法生成key值，这样很容易造成key冲突。SimpleKeyGenerator使用一个复合键SimpleKey来解决这个问题。通过其源码可得知Spring生成key的规则。

/**
 * SimpleKeyGenerator源码的类路径参见{
    @link org.springframework.cache.interceptor.SimpleKeyGenerator}
 */

从SimpleKeyGenerator的源码中可以发现其生成规则如下(附SimpleKey源码)：

• 如果方法没有入参，则使用SimpleKey.EMPTY作为key(key = new SimpleKey())。

• 如果只有一个入参，则使用该入参作为key(key = 入参的值)。

• 如果有多个入参，则返回包含所有入参的一个SimpleKey(key = new SimpleKey(params))。

package org.springframework.cache.interceptor;

import java.io.Serializable;
import java.util.Arrays;
import org.springframework.util.Assert;
import org.springframework.util.StringUtils;

public class SimpleKey implements Serializable {
    
    public static final SimpleKey EMPTY = new SimpleKey(new Object[0]);
    private final Object[] params;
    private final int hashCode;

    public SimpleKey(Object... elements) {
    
        Assert.notNull(elements, "Elements must not be null");
        this.params = new Object[elements.length];
        System.arraycopy(elements, 0, this.params, 0, elements.length);
        this.hashCode = Arrays.deepHashCode(this.params);
    }

    public boolean equals(Object other) {
    
        return this == other || other instanceof SimpleKey && Arrays.deepEquals(this.params, ((SimpleKey)other).params);
    }

    public final int hashCode() {
    
        return this.hashCode;
    }

    public String toString() {
    
        return this.getClass().getSimpleName() + " [" + StringUtils.arrayToCommaDelimitedString(this.params) + "]";
    }
}

如需自定义键生成策略，可以通过实现org.springframework.cache.interceptor.KeyGenerator接口来定义自己实际需要的键生成器。示例如下，自定义了一个MyKeyGenerator类并且实现(implements)了KeyGenerator以实现自定义的键值生成器：

package com.example.cache.springcache;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.cache.interceptor.KeyGenerator;
import org.springframework.cache.interceptor.SimpleKey;
import java.lang.reflect.Method;

/