如何将Hibernate默认会话事件监听器替换为自定义监听器输出SQL执行耗时
自定义Hibernate会话监听器替换内置默认监听器的实现方案
核心问题定位
- 当前自定义监听器未被运行时调用的本质原因:
- 配置中开启的
spring.jpa.properties.hibernate.generate_statistics=true,会触发Hibernate自动注册内置的StatisticalLoggingSessionEventListener,该监听器优先级远高于未完成注册的自定义实现,会直接接管所有会话事件的处理流程。 - 你将
spring.jpa开头的批量处理配置写在了log4j.properties文件中,log4j作为日志框架不会解析Spring专属配置项,这部分配置从项目启动开始就没有实际生效过。 - 编写的自定义监听器没有被挂载到Hibernate的会话事件链上,自然不会被上下文触发调用。
- 配置中开启的
具体调整步骤(全量基于Hibernate原生能力,无第三方依赖)
1. 修正配置位置并关闭默认监听器
把原先是错放在log4j.properties里的Hibernate配置全部迁移回application.properties,同时增加关闭默认统计监听器的配置,最终application.properties关键配置如下:
# 原有保留配置 spring.profiles.active=@spring.profiles.active@ server.port=5050 spring.datasource.url=jdbc:postgresql://localhost:5432/baida spring.datasource.driver-class-name=org.postgresql.Driver spring.datasource.username=postgres spring.datasource.password=root logging.config = src/main/resources/log4j.properties logging.level.net.proselyte.springbootdemo.MyLogger=debug # 替换/新增配置 # 关闭内置统计日志输出开关,避免触发默认监听器 spring.jpa.properties.hibernate.generate_statistics=false # 显式排除默认的统计会话监听器 spring.jpa.properties.hibernate.session.events.listener.exclude=org.hibernate.engine.internal.StatisticalLoggingSessionEventListener # 迁移原log4j文件中无效的批量处理配置 spring.jpa.properties.hibernate.jdbc.batch_size=10 spring.jpa.properties.hibernate.order_inserts=true spring.jpa.properties.hibernate.order_updates=true spring.jpa.properties.hibernate.jdbc.batch_versioned_data=true
同时调整log4j.properties配置,彻底屏蔽默认监听器的日志输出(直接打开你之前注释掉的配置行即可):
# 其他原有log4j配置保留 # 增加默认监听器的日志屏蔽配置 logger.statistical.name = org.hibernate.engine.internal.StatisticalLoggingSessionEventListener logger.statistical.level = OFF
2. 实现符合需求的自定义会话监听器
直接实现Hibernate原生的SessionEventListener接口,重点拦截SQL预编译、执行的开始/结束事件,实现SQL耗时、起止时间的日志输出,核心实现代码:
import org.hibernate.SessionEventListener; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import java.time.LocalTime; public class CustomSqlTimeSessionEventListener implements SessionEventListener { private static final Logger log = LoggerFactory.getLogger(CustomSqlTimeSessionEventListener.class); // 用ThreadLocal隔离不同线程的SQL执行时间,避免线程安全问题 private static final ThreadLocal<Long> SQL_START_NANO = new ThreadLocal<>(); @Override public void jdbcPrepareStatementStart() { SQL_START_NANO.set(System.nanoTime()); } @Override public void jdbcPrepareStatementEnd() { long startNano = SQL_START_NANO.get(); long endNano = System.nanoTime(); log.info("SQL预编译 | 开始时间:{} | 结束时间:{} | 耗时:{}ms", LocalTime.ofNanoOfDay(startNano), LocalTime.ofNanoOfDay(endNano), (endNano - startNano) / 1_000_000 ); SQL_START_NANO.remove(); } @Override public void jdbcExecuteStatementStart() { SQL_START_NANO.set(System.nanoTime()); } @Override public void jdbcExecuteStatementEnd() { long startNano = SQL_START_NANO.get(); long endNano = System.nanoTime(); log.info("SQL执行 | 开始时间:{} | 结束时间:{} | 耗时:{}ms", LocalTime.ofNanoOfDay(startNano), LocalTime.ofNanoOfDay(endNano), (endNano - startNano) / 1_000_000 ); SQL_START_NANO.remove(); } // 接口要求实现的其余空方法,无特殊需求无需加逻辑 @Override public void jdbcConnectionAcquisitionStart() {} @Override public void jdbcConnectionAcquisitionEnd() {} @Override public void jdbcConnectionReleaseStart() {} @Override public void jdbcConnectionReleaseEnd() {} @Override public void jdbcExecuteBatchStart() {} @Override public void jdbcExecuteBatchEnd() {} @Override public void cachePutStart() {} @Override public void cachePutEnd() {} @Override public void cacheGetStart() {} @Override public void cacheGetEnd(boolean hit) {} @Override public void flushStart() {} @Override public void flushEnd(int entityCount, int collectionCount) {} @Override public void partialFlushStart() {} @Override public void partialFlushEnd(int entityCount, int collectionCount) {} @Override public void transactionCompletion(boolean successful) {} }
3. 将自定义监听器挂载到Hibernate事件链
借助Spring Boot提供的HibernatePropertiesCustomizer扩展点,直接把自定义监听器注册到Hibernate的会话事件机制中,不需要额外写SPI文件,新增配置类如下:
import org.springframework.boot.autoconfigure.orm.jpa.HibernatePropertiesCustomizer; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import java.util.List; @Configuration public class HibernateCustomListenerConfig { @Bean public HibernatePropertiesCustomizer registerCustomSessionListener() { return hibernateProps -> hibernateProps.put( "hibernate.session.events.listeners", List.of(new CustomSqlTimeSessionEventListener()) ); } }
效果说明
调整完成后,默认的会话统计日志不会再输出,所有SQL执行的起止时间、耗时会按照自定义监听器的配置打印到控制台,全程没有引入任何第三方组件,全部基于Hibernate原生的事件监听能力实现。
内容的提问来源于stack exchange,提问作者TeamPlayer123
相关产品推荐
相关产品推荐

