Hibernate升级至5.4.18后无法清除queryCache问题求助

核心原因 #

Hibernate从5.2版本开始重构了SessionFactory的缓存相关API，原有SessionFactory.getQueryCache()方法被移除，查询缓存的操作统一收敛到CacheImplementor接口下。调用getDefaultQueryResultsCache()返回null的核心原因通常是未提前启用查询缓存配置，或API调用链路错误。

前置配置校验 #

必须在Hibernate配置中开启查询缓存开关，否则查询缓存实例不会初始化：

hibernate.cache.use_query_cache = true
# 需搭配二级缓存实现使用，示例为JCache标准实现配置
hibernate.cache.region.factory_class = org.hibernate.cache.jcache.JCacheRegionFactory

正确实现代码 #

import org.hibernate.SessionFactory;
import org.hibernate.engine.spi.CacheImplementor;
import org.hibernate.engine.spi.SessionFactoryImplementor;
import org.hibernate.cache.spi.QueryResultsCache;

public void clearQueryCache(SessionFactory sessionFactory) {
    // 1. 通过unwrap获取SessionFactoryImplementor实例，避免代理类强转失败
    SessionFactoryImplementor sfImplementor = sessionFactory.unwrap(SessionFactoryImplementor.class);
    CacheImplementor cacheImplementor = sfImplementor.getCache();

    // 2. 清除默认查询缓存
    QueryResultsCache defaultQueryCache = cacheImplementor.getDefaultQueryResultsCache();
    if (defaultQueryCache != null) {
        defaultQueryCache.clear();
    }

    // 可选：清除指定自定义区域的查询缓存
    // String customRegion = "your_custom_query_region";
    // QueryResultsCache customCache = cacheImplementor.getQueryResultsCache(customRegion);
    // if (customCache != null) {
    //     customCache.clear();
    // }

    // 可选：清除所有查询缓存区域
    cacheImplementor.getQueryResultsCacheRegions()
        .values()
        .forEach(region -> {
            if (region != null) {
                region.clear();
            }
        });
}

异常排查点 #

• 优先检查启动日志中是否有查询缓存初始化的相关日志，确认配置生效
• Spring集成场景下不要直接强转注入的SessionFactory，使用unwrap方法获取原生实现类更稳妥
• 若使用了自定义缓存区域，需指定对应区域名调用getQueryResultsCache获取对应实例，默认方法仅返回全局默认查询缓存

内容的提问来源于stack exchange，提问作者Soven K Rout