摘要：第一種辦法是每個中都使用不同的緩存名字。第二是給加上類的名字。設(shè)置的參數(shù)查看中的由緩存名類名方法名和參數(shù)構(gòu)成，這樣足夠保險了。在實際開發(fā)中可以根據(jù)實際情況構(gòu)造滿足需求。

在數(shù)據(jù)庫查詢中我們往往會使用增加緩存來提高程序的性能，@Cacheable 可以方便的對數(shù)據(jù)庫查詢方法加緩存。本文主要來探究一下緩存使用的key。

數(shù)據(jù)庫

mysql> select * from t_student;
+----+--------+-------------+
| id | name   | grade_class |
+----+--------+-------------+
|  1 | Simone | 3-2         |
+----+--------+-------------+
1 row in set (0.01 sec)

spring boot 配置

#jpa
spring.jpa.hibernate.ddl-auto=none
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/pratice
spring.datasource.username=root
spring.datasource.password=123456
#redis
spring.redis.host=localhost
spring.redis.lettuce.pool.maxActive=5
spring.redis.lettuce.pool.maxIdle=5
#cache
spring.cache.cache-names=Cache
spring.cache.redis.time-to-live=300000

數(shù)據(jù)訪問層

public interface StudentDao extends CrudRepository {

    @Cacheable(value = "Cache")
    @Override
    Optional findById(Long aLong);

    @Cacheable(value = "Cache")
    Optional findByName(String name);
}

啟動調(diào)用數(shù)據(jù)訪問層方法觀察

@Override
public void run(ApplicationArguments args) throws Exception {
  Optional optional = studentDao.findById(1L);
  System.out.println(optional);
}

當(dāng)默認使用 @Cacheable(value = "Cache") 的時候查看 redis 中緩存的 key

127.0.0.1:6379> keys *
1) "Cache::1"

可以知道 key是由緩存的名字和參數(shù)值生成的，key 的生成和方法的名字無關(guān)，如果兩個方法的參數(shù)相同了，就會命中同一個緩存，這樣顯然是不行的。使用相同的參數(shù)調(diào)用 findById 和 findByName 觀察查詢結(jié)果

@Override
public void run(ApplicationArguments args) throws Exception {
  Optional optional = studentDao.findById(1L);
  System.out.println(optional);

  Optional optionalByName = studentDao.findByName("1");
  System.out.println(optionalByName);
}
//輸出結(jié)果
//Optional[Student(id=1, name=Simone, gradeClass=3-2)]
//Optional[Student(id=1, name=Simone, gradeClass=3-2)]

從數(shù)據(jù)庫的數(shù)據(jù)看 studentDao.findByName("1") 應(yīng)該是查詢出空的，但是取命中了緩存，所以我們需要給緩存的 key 加上方法的名字。

@Cacheable(value = "Cache", key = "{#root.methodName, #aLong}")
@Override
Optional findById(Long aLong);

@Cacheable(value = "Cache", key = "{#root.methodName, #name}")
Optional findByName(String name);

//Optional[Student(id=1, name=Simone, gradeClass=3-2)] 
//Optional.empty

Redis 中的 Key 也有了方法的名字

127.0.0.1:6379> keys *
1) "Cache::findById,1"
2) "Cache::findByName,1"

在實際項目中我們肯定不是只有一張表，如果其他表使用緩存的名字也是 Cache，很有可能產(chǎn)生相同的 key，比如我還有一個如下的 dao

public interface TeacherDao extends CrudRepository {

    @Cacheable(value = "Cache", key = "{#root.methodName, #aLong}")
    @Override
    Optional findById(Long aLong);

    @Cacheable(value = "Cache", key = "{#root.methodName, #name}")
    Optional findByName(String name);
}

如果在調(diào)用 TeacherDao 中的方法命中了 StudentDao 中的方法會產(chǎn)生 ClassCastException ，這里就兩種方式來解決這個問題。第一種辦法是每個 dao 中都使用不同的緩存名字。第二是給 key 加上類的名字。

我 google 了一下，沒有找到使用 Spel 獲取到類名的方法(或許有)，所以這里通過配置 @Cacheable 的 key參數(shù)就不行了。那就只能實現(xiàn)自定義的生成器。

@Bean("customKeyGenerator")
public KeyGenerator keyGenerator() {
  return new KeyGenerator() {
    @Override
    public Object generate(Object o, Method method, Object... objects) {
      return method.getDeclaringClass().getName() + "_"
        + method.getName() + "_"
        + StringUtils.arrayToDelimitedString(objects, "_");
    }
  };
}

設(shè)置 @Cacheable 的 keyGenerator 參數(shù)

@Cacheable(value = "Cache", keyGenerator = "customKeyGenerator")
@Override
Optional findById(Long aLong);

@Cacheable(value = "Cache", keyGenerator = "customKeyGenerator")
Optional findByName(String name);

查看 Redis 中的 key

127.0.0.1:6379> keys *
1) "Cache::me.action.dao.StudentDao_findById_1"
2) "Cache::me.action.dao.StudentDao_findByName_1"

Key 由緩存名、類名、方法名和參數(shù)構(gòu)成，這樣足夠保險了。在實際開發(fā)中可以根據(jù)實際情況構(gòu)造 key 滿足需求。