yeskery

一次 JDBC 与 MySQL 因 “CST” 时区协商误解导致时间差了 14 或 13 小时的排错经历

摘要

名为 CST 的时区是一个很混乱的时区,在与 MySQL 协商会话时区时,Java 会误以为是 CST -0500,而非 CST +0800

CST 时区

名为 CST 的时区是一个很混乱的时区,有四种含义:

  • 美国中部时间 Central Standard Time (USA) UTC-06:00
  • 澳大利亚中部时间 Central Standard Time (Australia) UTC+09:30
  • 中国标准时 China Standard Time UTC+08:00
  • 古巴标准时 Cuba Standard Time UTC-04:00

今天是“4月28日”。为什么提到日期?因为美国从“3月11日”至“11月7日”实行夏令时,美国中部时间改为 UTC-05:00,与 UTC+08:00 相差 13 小时。

排错过程

在项目中,偶然发现数据库中存储的 Timestamp 字段的 unix_timestamp() 值比真实值少了 13 个小时。通过调试追踪,发现了 com.mysql.cj.jdbc 里的时区协商有问题。

当 JDBC 与 MySQL 开始建立连接时,会调用 com.mysql.cj.jdbc.ConnectionImpl.initializePropsFromServer() 获取服务器参数,其中我们看到调用 this.session.configureTimezone() 函数,它负责配置时区。

  1. public void configureTimezone() {
  2. String configuredTimeZoneOnServer = getServerVariable("time_zone");
  3. if ("SYSTEM".equalsIgnoreCase(configuredTimeZoneOnServer)) {
  4. configuredTimeZoneOnServer = getServerVariable("system_time_zone");
  5. }
  6. String canonicalTimezone = getPropertySet().getStringReadableProperty(PropertyDefinitions.PNAME_serverTimezone).getValue();
  7. if (configuredTimeZoneOnServer != null) {
  8. // user can override this with driver properties, so don't detect if that's the case
  9. if (canonicalTimezone == null || StringUtils.isEmptyOrWhitespaceOnly(canonicalTimezone)) {
  10. try {
  11. canonicalTimezone = TimeUtil.getCanonicalTimezone(configuredTimeZoneOnServer, getExceptionInterceptor());
  12. } catch (IllegalArgumentException iae) {
  13. throw ExceptionFactory.createException(WrongArgumentException.class, iae.getMessage(), getExceptionInterceptor());
  14. }
  15. }
  16. }
  17. if (canonicalTimezone != null && canonicalTimezone.length() > 0) {
  18. this.serverTimezoneTZ = TimeZone.getTimeZone(canonicalTimezone);
  19. // The Calendar class has the behavior of mapping unknown timezones to 'GMT' instead of throwing an exception, so we must check for this...
  20. if (!canonicalTimezone.equalsIgnoreCase("GMT")
  21. && this.serverTimezoneTZ.getID().equals("GMT")) {
  22. throw ...
  23. }
  24. }
  25. this.defaultTimeZone = this.serverTimezoneTZ;
  26. }

追踪代码可知,当 MySQL 的 time_zone 值为 SYSTEM 时,会取 system_time_zone 值作为协调时区。

让我们登录到 MySQL 服务器验证这两个值:

  1. mysql> show variables like '%time_zone%';
  2. +------------------+--------+
  3. | Variable_name | Value |
  4. +------------------+--------+
  5. | system_time_zone | CST |
  6. | time_zone | SYSTEM |
  7. +------------------+--------+
  8. 2 rows in set (0.00 sec)

重点在这里!若 String configuredTimeZoneOnServer 得到的是 CST 那么 Java 会误以为这是 CST -0500,因此 TimeZone.getTimeZone(canonicalTimezone) 会给出错误的时区信息。

mysql_jdbc_time_zone

如图所示,本机默认时区是 Asia/Shanghai +0800,误认为服务器时区为 CST -0500,实际上服务器是 CST +0800

我们会想到,即便时区有误解,如果 Timestamp 是以 long 表示的时间戳传输,也不会出现问题,下面让我们追踪到 com.mysql.cj.jdbc.PreparedStatement.setTimestamp()

  1. public void setTimestamp(int parameterIndex, Timestamp x) throws java.sql.SQLException {
  2. synchronized (checkClosed().getConnectionMutex()) {
  3. setTimestampInternal(parameterIndex, x, this.session.getDefaultTimeZone());
  4. }
  5. }

注意到这里 this.session.getDefaultTimeZone() 得到的是刚才那个 CST -0500

  1. private void setTimestampInternal(int parameterIndex, Timestamp x, TimeZone tz) throws SQLException {
  2. if (x == null) {
  3. setNull(parameterIndex, MysqlType.TIMESTAMP);
  4. } else {
  5. if (!this.sendFractionalSeconds.getValue()) {
  6. x = TimeUtil.truncateFractionalSeconds(x);
  7. }
  8. this.parameterTypes[parameterIndex - 1 + getParameterIndexOffset()] = MysqlType.TIMESTAMP;
  9. if (this.tsdf == null) {
  10. this.tsdf = new SimpleDateFormat("''yyyy-MM-dd HH:mm:ss", Locale.US);
  11. }
  12. this.tsdf.setTimeZone(tz);
  13. StringBuffer buf = new StringBuffer();
  14. buf.append(this.tsdf.format(x));
  15. if (this.session.serverSupportsFracSecs()) {
  16. buf.append('.');
  17. buf.append(TimeUtil.formatNanos(x.getNanos(), true));
  18. }
  19. buf.append('\'');
  20. setInternal(parameterIndex, buf.toString());
  21. }
  22. }

原来 Timestamp 被转换为会话时区的时间字符串了。问题到此已然明晰:

  1. JDBC 误认为会话时区在 CST-5
  2. JBDC 把 Timestamp+0 转为 CST-5 的 String-5
  3. MySQL 认为会话时区在 CST+8,将 String-5 转为 Timestamp-13

最终结果相差 13 个小时!如果处在冬令时还会相差 14 个小时!

解决方案

解决办法也很简单,明确指定 MySQL 数据库的时区,不使用引发误解的 CST

  1. mysql> set global time_zone = '+08:00';
  2. Query OK, 0 rows affected (0.00 sec)
  3. mysql> set time_zone = '+08:00';
  4. Query OK, 0 rows affected (0.00 sec)

或者修改 my.cnf 文件,在 [mysqld] 节下增加 default-time-zone = '+08:00'

修改时区操作影响深远,需要重启 MySQL 服务器,建议在维护时间进行。

本文转载自:https://juejin.im/post/5902e087da2f60005df05c3d

评论

鲸落弟弟:

字体太小了,对笔记本用户太不友好了

2019-04-20 23:09[回复]

虎跃哥哥:

鲸落弟弟你够了,我是虎跃哥哥

2019-04-25 16:41[回复]

鲸落弟弟:

字体太小了,对笔记本用户太不友好了

2019-04-20 23:09[回复]
发表评论 点击刷新验证码

提示

该功能暂未开放