Java 程序处理异地机房不同时区问题

背景

我司海外业务的程序部署在香港机房，某次新版本发布时，灰度测试发现个 bug：运营同学设置的精选视频，没有按时生效，相关的 SQL 代码如下

/* 查询出当前生效的视频精选 */
SELECT id FROM video_choice WHERE status=1 AND
effective_time<=NOW() AND expiration_time>=NOW()

review 代码没有找到头绪，后来好不容易发现是服务器时区设置问题

在服务器上执行 date 命令查看时间，香港机房服务器时间如下

Fri Aug 14 08:24:26 BST 2020

国内机房服务器时间是

Fri Aug 14 15:24:26 CST 2020

可以看到时间相差了 7 个小时，香港机房时区是 BST，国内是 CST

解决方案

虽然是海外业务，但是运营同学进行业务设置都是默认使用北京时间的，所以解决方案无非是两种

• 所有机房统一使用北京时间，无论是国内的还是海外的
• 各个区域的机房，服务器时间使用当地默认设置，由程序对不同时区的时间进行兼容处理，统一转换成北京时间

修改服务器时区设置

找到运维同学要求修改服务器时区为 CST 被拒绝了，还表示海外一律用 UTC 时间，不能随便改。

问题是 UTC 时间和北京时间是相差 8 小时，现在是 BST 时间只差了 7 个小时，还有一个小时是因为 BST 执行夏令时的缘故

实际上香港根本就不采用夏令时，我估计运维同学其实也没有对香港机房的时区进行特别处理，默认就是 BST

感慨下，香港其实和北京是同一时区，但是人家的机房就是要用 BST，有些痕迹很难消除的

程序兼容

既然机房时区不能改，那只好程序来兼容了

最初的设想，是直接把 BST 时间转换为北京时间，不过那个夏令时把我难倒了：他们的夏令时什么时候开始和结束呢？

另外，将来程序部署到其他国家/地区的机房，采用的时区是个未知的时区，是否采用夏令时也不知道，又该如何处理？

研究以后发现，想要一劳永逸的解决任何时区到北京时间的转换，还挺麻烦的，搞了半天，没有太好的解决办法

出乎意料的简单解决方案

网上查了一下，可以在程序启动时传一个时区参数，如下

java app_name -D user.timezone=Asia/Shanghai

不过，这要修改我们的 web 容器 jetty 的启动脚本，运维同学肯定不会同意的

但是这个方法给了我灵感，可以在 java 程序启动后第一时间设置 user.timezone 环境变量，如下

System.setProperty("user.timezone", "GMT+08:00");

使用 Spring 的注解自动装配的话，只要定义一个类，让 IOC 容器实例化即可，不用侵入任何代码

@Component
public class TimeZoneHelper {

    @Autowired
    public TimeZoneHelper() {
        System.setProperty("user.timezone", "Asia/Shanghai");
        // 必须执行，否则新的时区不生效
        TimeZone.setDefault(TimeZone.getTimeZone("Asia/Shanghai"));
    }
}

这样，无论你的机房在哪个大洲的哪个国家/地区，也无论其时区如何设置，是否采用夏令时，都可以用北京时间来处理时间了

freemarker 时区设置

我们的前端使用 freemarker 模板，在代码里强制修改时区后，发现用户界面上没有生效，时间还是香港机房的 BST 时间，经过研究，发现页面上展示时间是用的 freemarker 的时间格式化功能，代码如下

<tr>
    <td>失效时间</td>
    <td>
        <!-- et 是个 java.util.Date 对象 -->
        <input type="text" value="${(et?datetime)!}" name="endTime">
    </td>
</tr>

看来是 freemarker 使用的时区依然是香港机房本地设置，并没有被我们修改时区的代码影响到，那么我们可以通过设置 freemarker 的时区来解决这个问题，在 spring 配置文件里如下配置 freemarker 即可

<bean class="org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer">
  <property name="freemarkerSettings">
    <props>
      ......
      <prop key="time_zone">Asia/Shanghai</prop>
      <prop key="sql_date_and_time_time_zone">Asia/Shanghai</prop>
      ......
    </props>
  </property>