Ehcache 缓存查看

参考:https://blog.youkuaiyun.com/EQuaker/article/details/90140137

参考:https://blog.youkuaiyun.com/xintingandzhouyang/article/details/81433235

环境

        <dependency>
            <groupId>net.sf.ehcache</groupId>
            <artifactId>ehcache</artifactId>
            <version>2.10.6</version>
        </dependency>

实现

查看上述参考后,本地自己写的一个Ehcache 缓存查询工具类

package xx.cache;

import net.sf.ehcache.*;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.stereotype.Component;

import java.util.Collections;
import java.util.List;

/**
 * @author zcm
 * @since 2020/9/28 10:24
 * <p>
 * Ehcache 工具类
 */
@Component
public class EhcacheUtil {

    private static Logger log = LoggerFactory.getLogger(EhcacheUtil.class);


    private static CacheManager cacheManager;


    /**
     * 引入其他方式创建的 Ehcache 缓存管理器,同时为静态变量赋值
     *
     * @param cacheManager
     */
    @Qualifier("ehcacheCacheManager")
    @Autowired
    public void setCacheManager(CacheManager cacheManager) {
        EhcacheUtil.cacheManager = cacheManager;
    }


    /**
     * 得到当前存在的缓存的cache对象
     *
     * @param cacheName
     * @return 如果缓存类型不存在, 或已清理, 则可能返回空类型
     */
    public static Cache getCache(String cacheName) {
        Cache cache = cacheManager.getCache(cacheName);
        return cache;
    }


    public static Ehcache getEhcache(String cacheName){
        return cacheManager.getEhcache(cacheName);
    }


    /**
     * 得到该缓存的所有key
     *
     * @param cacheName
     * @return
     */
    public static List getKeys(String cacheName) {
        Cache cache = getCache(cacheName);
        if (cache == null) {
            return Collections.emptyList();
        }
        List keys = cache.getKeys();
        return keys;
    }


    /**
     * 得到缓存值的本来形式
     *
     * @param cacheName
     * @param key
     * @return
     */
    public static Object getObjVal(String cacheName, Object key) {
        Cache cache = getCache(cacheName);
        if (cache == null) {
            return null;
        }
        Element element = cache.get(key);
        return null == element ? null : element.getObjectValue();
    }


    /**
     * 得到字符串形式的缓存值
     *
     * @param cacheName
     * @param key
     * @return
     */
    public static String getStrVal(String cacheName, Object key) {
        Object objVal = getObjVal(cacheName, key);
        return null == objVal ? "" : String.valueOf(objVal);
    }

    /**
     * 判断该缓存是否存在
     *
     * @param cacheName
     * @return
     */
    public static boolean cacheExist(String cacheName) {
        return cacheManager.cacheExists(cacheName);
    }

    /**
     * 得到当前该缓存管理器下的所有存在的缓存的名称数组
     *
     * @return
     */
    public static String[] getCacheNames() {
        return cacheManager.getCacheNames();
    }

    /**
     * TODO 慎用,如果删除该缓存后,在往该缓存添加值,如果直接添加会报错,提示 该缓存已关闭或状态不存在
     * 报错: The allMenus Cache is not alive (STATUS_SHUTDOWN)
     *
     * 清空所有缓存下的键值,所有缓存也会被释放
     */
    public static void removeAll() {
        cacheManager.removeAllCaches();
    }


    /**
     * TODO 慎用,如果删除该缓存后,在往该缓存添加值,如果直接添加会报错,提示 该缓存已关闭或状态不存在
     * 移除该缓存的所有键值,该缓存也会被释放
     * 从CacheManager中删除缓存。缓存被释放。
     *
     * @param cacheName
     */
    public static void removeCache(String cacheName) {
        cacheManager.removeCache(cacheName);
    }


    /**
     * 移除该缓存的所有键值,但缓存不释放
     *
     * @param cacheName
     */
    public static void clearCache(String cacheName) {
        Cache cache = getCache(cacheName);
        if(cache != null) {
            cache.removeAll();
        }
    }


    /**
     * 删除缓存下的所有键值,但不释放该缓存
     */
    public static void clearAll() {
        cacheManager.clearAll();
    }


    /**
     * 清除CacheManager中名称以前缀开头的所有缓存的内容，但不删除它们。
     *
     * @param prefix
     */
    public static void clearStartWith(String prefix) {
        cacheManager.clearAllStartingWith(prefix);
    }


    /**
     * 检查 缓存管理器的 状态
     *
     * @return
     */
    public static String getStatus() {
        return cacheManager.getStatus().toString();
    }

    /**
     * 安全的添加 以某个名称为命名的缓存,如果存在,则直接返回,否则添加后在返回
     * @param cacheName
     * @return
     */
    public static Ehcache addCacheIfAbsent(String cacheName){
        Ehcache ehcache = cacheManager.addCacheIfAbsent(cacheName);
        return ehcache;
    }

    /**
     * 为某个缓存添加键值,默认空闲时间0s,过期时间 300s
     * @param cacheName     缓存名称
     * @param key           key
     * @param value         value
     * @return
     */
    public static void setValue(String cacheName,String key,String value) {
//        // 设置空闲时间 0, 过期时间 300 ,单位都为秒
        setValue(cacheName,key,value,0,300);
    }


    /**
     * 为某个缓存添加键值,指定空闲时间和过期时间
     * @param cacheName
     * @param key
     * @param value
     * @param idleSeconds
     * @param liveSeconds
     */
    public static void setValue(String cacheName,String key,String value,int  idleSeconds,int liveSeconds) {
        Ehcache ehcache = addCacheIfAbsent(cacheName);
        // 设置空闲时间 0, 过期时间 300 ,单位都为秒
        ehcache.put(new Element(key,value,idleSeconds,liveSeconds));
    }

}

说明:

至于在其他参考文章中,描述的如果,如果缓存要被检索,需要 在 ehcache.xml 中的具体元素中加入  searchable 子标签和相关查询的key 值和其他设定,由于我的项目使用的 springboot 项目,使用相关缓存的操作注解来设置 缓存和key ,所有没有设置 searchable 子标签也可以查询到对应的缓存的相关值