如何配置Hibernate 5实现与Hibernate 4一致的java.util.Calendar存储行为？

问题描述 #

从Hibernate 4升级到Hibernate 5后，不同时区下的java.util.Calendar对象存入MySQL时的存储结果存在明显差异，核心疑问为：是否可以通过配置让Hibernate 5完全复刻Hibernate 4的原有存储行为？

复现场景 #

• 关联的MySQL字段数据类型为datetime
• 运行程序的服务器时区为US/Eastern
• 程序运行时的系统当前时间为2021-04-28 22:17:51
• 代码中创建的Calendar对象绑定的指定时区为Canada/Pacific
• Hibernate 4环境下，该Calendar值存入MySQL后的结果为2021-04-28 22:17:51
• Hibernate 5环境下，完全相同的Calendar值存入MySQL后的结果为2021-04-28 19:17:51（即Calendar对象绑定时区对应的本地时间值）

上述行为变更可追溯至Hibernate官方记录的HHH-7375需求，核心调整逻辑为：Hibernate 5重构了Calendar类型的持久化处理逻辑，写入数据库时会优先读取Calendar对象自身绑定的时区完成时间转换；而Hibernate 4的处理逻辑是完全忽略Calendar对象自带的时区设置，统一按JVM默认时区完成时间转换后再存储。该差异不受实体类Calendar字段是否添加@Temporal(TemporalType.TIMESTAMP)注解的影响。

复现代码示例 #

实体类定义 #

@Entity
public class TimeTestObj {

    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    Integer id;
    @Temporal(TemporalType.TIMESTAMP) // 无论是否添加该注解，时区转换的逻辑差异都会触发
    Calendar calendar;

    public TimeTestObj(Calendar calendar) {
        this.calendar = calendar;
    }
}

测试逻辑代码 #

public class TimeTest {
    public static void main(String[] args) {
        SessionFactory sessionFactory = buildSessionFactory();
        
        // 程序运行环境的默认时区为US/Eastern
        Calendar calendar = Calendar.getInstance(TimeZone.getTimeZone("Canada/Pacific"));
        TimeTestObj timeTestObject = new TimeTestObj(calendar);
        
        Session session = sessionFactory.getCurrentSession();
        Transaction trans = session.beginTransaction();
        session.saveOrUpdate(timeTestObject);
        trans.commit();
        
        sessionFactory.close();
    }
    
    private static SessionFactory buildSessionFactory() {
        Configuration configuration = new Configuration();
        configuration.addAnnotatedClass(TimeTestObj.class);
        configuration.configure();
            
        // Hibernate 4环境下的SessionFactory构建逻辑
        // ServiceRegistryBuilder srb = new ServiceRegistryBuilder().applySettings(configuration.getProperties());
        // ServiceRegistry serviceRegistry = srb.buildServiceRegistry();
            
        // Hibernate 5环境下的SessionFactory构建逻辑
        ServiceRegistry serviceRegistry = new StandardServiceRegistryBuilder()
            .applySettings(configuration.getProperties())
            .build();
        return configuration.buildSessionFactory(serviceRegistry);
    }
}

兼容Hibernate 4存储行为的实现方案 #

首先明确：Hibernate 5没有提供直接切回Hibernate 4旧版Calendar存储逻辑的内置全局开关，但可以通过自定义扩展或连接配置实现完全的行为对齐，具体方式如下：

• 自定义类型全局替换
  实现与Hibernate 4逻辑完全一致的Calendar类型处理器，全局覆盖Hibernate 5内置的默认Calendar类型绑定。核心处理逻辑为：向数据库写入时间值时，完全忽略Calendar对象自身绑定的时区，将其持有的时间戳按JVM默认时区格式化为yyyy-MM-dd HH:mm:ss格式后写入；从数据库读取时间值时，同样按JVM默认时区解析为Calendar对象。注册自定义类型的核心代码：

  ServiceRegistry serviceRegistry = new StandardServiceRegistryBuilder()
      .applySettings(configuration.getProperties())
      .build();
  MetadataSources metadataSources = new MetadataSources(serviceRegistry);
  // 注册兼容旧版的自定义Calendar类型，替换Hibernate 5原生实现
  metadataSources.registerTypeOverride(
      new LegacyCalendarCompatType(),
      new String[]{"calendar", "java.util.Calendar"}
  );
  SessionFactory sessionFactory = metadataSources.buildMetadata()
      .buildSessionFactory();
  

• 调整JDBC连接时区配置
  针对MySQL数据库场景，可在JDBC连接URL中添加connectionTimeZone=JVM&forceConnectionTimeZoneToServer=true参数，让JDBC层的时间转换逻辑完全跟随JVM默认时区处理。该方案可快速对齐大部分场景的存储表现，但会对所有时间类型的持久化逻辑生效，上线前需要充分评估对现有业务的影响。

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