Spring Boot项目中ThreadLocal存储的MetadataImplementor取到null如何解决

问题根因 #

• 你对ThreadLocal的使用场景完全错误：ThreadLocal是线程绑定的存储组件，只会在执行set操作的线程中能获取到对应值。Hibernate初始化阶段执行set操作的是Spring Boot启动线程，而你后续调用introspect方法的是业务请求线程、异步初始化线程、定时任务线程等其他线程，自然拿不到值。
• MetadataImplementor本身是SessionFactory级别的全局不可变单例对象，不存在线程安全问题，完全不需要用ThreadLocal存储。

解决方案 #

直接替换掉ThreadLocal，用普通静态变量存储即可，修改后代码如下：

public class HibernateMetadata implements SessionFactoryBuilderFactory {
    // 用volatile修饰保证多线程环境下的可见性
    private static volatile MetadataImplementor metadataImplementor;

    @Override
    public SessionFactoryBuilder getSessionFactoryBuilder(MetadataImplementor metadataImplementor,
                                                          SessionFactoryBuilderImplementor defaultBuilder) {
        HibernateMetadata.metadataImplementor = metadataImplementor;
        return defaultBuilder;
    }

    public static MetadataImplementor getMetadataImplementor() {
        return metadataImplementor;
    }
}

其他排查点 #

如果修改后还是存在获取为空的情况，可以检查以下配置：

• 确认SPI注册配置正确：在resources/META-INF/services目录下存在名为org.hibernate.boot.spi.SessionFactoryBuilderFactory的文件，文件内容为HibernateMetadata类的全限定名。
• 如果你开启了Spring Boot的延迟Bean初始化、或者Hibernate的懒初始化，需要确认触发SessionFactory初始化的时机早于你第一次调用getMetadataImplementor的时机。
• 如果使用了Spring Boot DevTools热部署工具，存在类加载器隔离导致静态变量无法跨类加载器获取的问题，可以临时禁用DevTools验证问题。

内容的提问来源于stack exchange，提问作者Hamza