如何在Hibernate慢查询日志中对特定查询配置白名单？

嗨，你提的这个需求很常见——毕竟有些查询确实是“合理的慢”，没必要触发告警。Hibernate本身并没有直接提供慢查询白名单的配置项，但我们可以通过几种方式来实现，我给你梳理一下最实用的方案：

方法一：查询提示+自定义慢查询日志处理器（推荐） #

这种方式可以精确控制哪些查询被白名单，不受SQL内容变化的影响，是最灵活的方案：

1. 给目标查询添加自定义提示
   对于需要白名单的查询，我们可以添加一个自定义的查询提示，标记它不需要被记录为慢查询：

   • 如果你用的是注解式JPQL查询：

     @Query("SELECT e FROM LargeTable e WHERE e.status = :status")
     @QueryHints(value = {
         @QueryHint(name = "hibernate.query.whitelist.slow", value = "true")
     })
     List<LargeTable> findSlowButExpectedQuery(@Param("status") String status);
     

   • 如果是原生SQL或者Criteria查询，可以通过setHint方法添加：

     session.createNativeQuery("SELECT * FROM large_table WHERE status = ?")
            .setParameter(1, "ACTIVE")
            .setHint("hibernate.query.whitelist.slow", "true")
            .list();
     

2. 扩展Hibernate的慢查询日志监听器
   Hibernate的慢查询日志是由SlowQueryLoggingEventListener类处理的，我们可以重写它的逻辑，跳过带有白名单提示的查询：

   public class WhitelistedSlowQueryLogger extends SlowQueryLoggingEventListener {
       @Override
       protected void onSlowQuery(SlowQueryEvent event) {
           // 获取当前查询的提示信息
           Object whitelistFlag = event.getQuery().getHint("hibernate.query.whitelist.slow");
           // 如果标记为白名单，就跳过日志记录
           if ("true".equals(whitelistFlag)) {
               return;
           }
           // 否则执行原有的慢查询日志逻辑
           super.onSlowQuery(event);
       }
   }
   

3. 注册自定义监听器
   最后需要把这个自定义监听器配置到Hibernate中：

   • 如果是用hibernate.cfg.xml配置：

     <property name="hibernate.session_factory.event_listener">
         <map>
             <entry key="slowQuery" value="com.yourpackage.WhitelistedSlowQueryLogger"/>
         </map>
     </property>
     

   • 如果是Spring Boot项目，可以通过配置类注册：

     @Bean
     public HibernatePropertiesCustomizer hibernatePropertiesCustomizer() {
         return properties -> {
             Map<String, Object> eventListeners = new HashMap<>();
             eventListeners.put("slowQuery", WhitelistedSlowQueryLogger.class.getName());
             properties.put("hibernate.session_factory.event_listener", eventListeners);
         };
     }
     

方法二：日志框架过滤（适合简单场景） #

如果你的慢查询有固定的特征（比如查询特定的大表、包含固定的SQL片段），可以直接在日志框架（比如Logback、Log4j2）中配置过滤规则，忽略这些日志：
比如用Logback的话，在logback.xml中添加过滤器：

<appender name="YOUR_APPENDER" class="ch.qos.logback.core.ConsoleAppender">
    <!-- 添加慢查询白名单过滤器 -->
    <filter class="ch.qos.logback.core.filter.EvaluatorFilter">
        <evaluator>
            <!-- 匹配你需要忽略的SQL特征，比如查询large_table -->
            <expression>message.contains("SELECT * FROM large_table")</expression>
        </evaluator>
        <onMatch>DENY</onMatch> <!-- 匹配到就拒绝输出 -->
        <onMismatch>NEUTRAL</onMatch> <!-- 不匹配就继续处理 -->
    </filter>
    <!-- 其他appender配置 -->
</appender>

这种方法的缺点是不够灵活，如果SQL有动态参数或者结构变化，过滤规则容易失效，适合简单固定的场景。

方法三：自定义Hibernate拦截器（复杂场景） #

你也可以通过自定义Interceptor来拦截查询执行，标记需要白名单的查询，但这种方式相对复杂，需要更多的代码逻辑，一般不推荐，除非你还有其他拦截需求。

总的来说，第一种方法是最推荐的，它能精准控制每个查询的日志行为，完全符合你的需求。

备注：内容来源于stack exchange，提问作者Amit Bera