【Java踩坑记】——SpringBoot中使用@Cacheable

• 问题描述：

项目中一个接口，服务器端不定期报错ClassCastExcepiton，具体的堆栈信息如下。

• 查找问题：

1、可以看到这个错误是由getConfigValue()导致的，由于报错信息是ClassCastExcepiton，所以主要从类型转换异常的方向去考虑问题。

    @Override
    @Cacheable(cacheNames = {"sysConfig"},key = "#sysConfigKeyString")
    public String getConfigValue(String sysConfigKeyString) {
        return Optional.ofNullable(sysConfigMapper.checkConfigKeyUnique(sysConfigKeyString)).map(SysConfig::getConfigValue).orElse(null);
    }

    /**
     * 根据key获取值
     * @param keys
     * @return
     */
    @Override
    @Cacheable(cacheNames = {"sysConfig"},key = "#sysConfigKeyMap")
    public Map<String,String> getConfigValues(String sysConfigKeyMap){
        List<SysConfig> list=  sysConfigMapper.selectListByKeys(Arrays.asList(sysConfigKeyMap.split(",")));
       return list.stream().collect(Collectors.toMap(SysConfig::getConfigKey,SysConfig::getConfigValue));

    }

2、以上是最初的业务代码，从具体的逻辑看，好像并没有什么异常，getConfigValue方法中也并没有存在类型转换的代码。然后就开始了百度之旅，在网上百度各种原因，有说是由于CGILB导致的，有说是DEVTOOLS导致的……无果

3、静下心，由于这个错误是不定期出现，开始分析业务代码，尝试着复现这个异常。在经过多种尝试后，发现这个问题是在某种特定的情况下调用了getConfigValues()方法之后（sysConfigKeyString和sysConfigKeyMap传入值相同时），会必现这个问题。

4、由此发现问题的突破口是在缓存上。由于我们使用了@Cacheable注解，会自动将查询过后的数据进行缓存，再次读取的时候会从缓存中取得相应的数据

5、由于getConfigValues缓存的是map格式的数据，getConfigValue缓存的String类型的数据，两个使用的是同一个cacheNames。由此，才查询相同key(sysConfigKeyString和sysConfigKeyMap相同)的时候，会优先读取缓存中的数据，因此可能会造成类型转换异常的问题。

• 问题解决：

找到问题之后，我们将map和string两种格式的key存储到不同的cacheNames中，可以解决上述问题。

    @Override
    @Cacheable(cacheNames = {"sysConfigString"},key = "#sysConfigKeyString")
    public String getConfigValue(String sysConfigKeyString) {
        return Optional.ofNullable(sysConfigMapper.checkConfigKeyUnique(sysConfigKeyString)).map(SysConfig::getConfigValue).orElse(null);
    }

    /**
     * 根据key获取值
     * @param keys
     * @return
     */
    @Override
    @Cacheable(cacheNames = {"sysConfigMap"},key = "#sysConfigKeyMap")
    public Map<String,String> getConfigValues(String sysConfigKeyMap){
        List<SysConfig> list=  sysConfigMapper.selectListByKeys(Arrays.asList(sysConfigKeyMap.split(",")));
       return list.stream().collect(Collectors.toMap(SysConfig::getConfigKey,SysConfig::getConfigValue));

    }

• 问题总结：

1、遇到代码问题优先静心排查业务代码问题

2、在Cacheable的使用过程中，一定要注意同个cacheName中key值相同的可能覆盖的问题。