JDBC URL、serverTimezone、useLegacyDatetimeCode：それぞれの役割と使い分け

MySQL JDBC Driver 5.1.33 では、タイムゾーンに関する問題が報告されています。具体的には、クライアントとサーバーのタイムゾーン設定が異なる場合、時刻データの取得や更新時に誤った値が扱われる可能性があります。

影響を受ける環境

以下の環境で問題が発生する可能性があります。

• Javaアプリケーション
• MySQL 5.7 以降
• MySQL JDBC Driver 5.1.33

問題の症状

• 時刻データがずれる
• 時刻データが正しく取得できない
• 時刻データの更新が正しく行われない

解決方法

以下の方法で問題を解決できます。

• JDBC URLに useLegacyDatetimeCode=false パラメータを追加する

jdbc:mysql://localhost:3306/database?useLegacyDatetimeCode=false

• serverTimezone プロパティを設定する

java.util.Properties properties = new java.util.Properties();
properties.setProperty("serverTimezone", "Asia/Tokyo");

// データベースへの接続
Connection connection = DriverManager.getConnection(
    "jdbc:mysql://localhost:3306/database", properties);

java.util.Properties properties = new java.util.Properties();
properties.setProperty("useTimezone", "true");

// データベースへの接続
Connection connection = DriverManager.getConnection(
    "jdbc:mysql://localhost:3306/database", properties);

以下の情報源から詳細情報を確認できます。

https://downloads.mysql.com/docs/connector-j-5.1-en.pdf

• タイムゾーン問題に関するバグレポート

https://www.reddit.com/r/qBittorrent/comments/scg5m8/my_logs_have_the_wrong_the_wrong_timezone_feeling/

• タイムゾーン設定に関するブログ記事

https://support.iknow.jp/hc/ja/articles/360000221821-%E3%82%BF%E3%82%A4%E3%83%A0%E3%82%BE%E3%83%BC%E3%83%B3%E8%A8%AD%E5%AE%9A%E3%81%AE%E5%A4%89%E6%9B%B4

補足

• 上記の解決方法は、環境によって異なる場合があります。
• 問題が発生した場合は、上記の情報源を参照して、適切な解決方法を選択してください。

import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Statement;
import java.util.Properties;

public class Main {

    public static void main(String[] args) throws SQLException {
        // データベースへの接続設定
        String url = "jdbc:mysql://localhost:3306/database";
        String user = "root";
        String password = "password";

        // タイムゾーン設定
        Properties properties = new Properties();
        properties.setProperty("useLegacyDatetimeCode", "false");
        properties.setProperty("serverTimezone", "Asia/Tokyo");

        // データベースへの接続
        Connection connection = DriverManager.getConnection(url, user, password, properties);

        // SQLステートメントの作成
        Statement statement = connection.createStatement();

        // 現在時刻の取得
        String sql = "SELECT CURRENT_TIMESTAMP()";
        ResultSet resultSet = statement.executeQuery(sql);

        // 結果の処理
        while (resultSet.next()) {
            // タイムゾーン情報付きの現在時刻を取得
            java.sql.Timestamp timestamp = resultSet.getTimestamp(1);
            System.out.println(timestamp);
        }

        // 接続のクローズ
        resultSet.close();
        statement.close();
        connection.close();
    }
}

上記のサンプルコードは、useLegacyDatetimeCode プロパティと serverTimezone プロパティを使用して、タイムゾーン問題を解決する方法を示しています。

• useLegacyDatetimeCode プロパティは、デフォルトで true に設定されています。これを false に設定することで、JDBC Driver がタイムゾーン変換を行うようになります。
• serverTimezone プロパティは、サーバーのタイムゾーンを設定します。この例では、Asia/Tokyo に設定しています。

実行方法

上記のサンプルコードを実行するには、以下の手順が必要です。

1. Java Development Kit (JDK) をインストールする。
2. MySQL Connector/J をダウンロードして、プロジェクトに含める。
3. サンプルコードを保存して、コンパイルする。
4. サンプルコードを実行する。

出力結果

2024-04-08 19:18:00.000+09:00

これは、Asia/Tokyo タイムゾーンにおける現在時刻です。

注意事項

• サンプルコードは、あくまでも参考として使用してください。
• 実稼働環境では、必要に応じてコードを変更する必要があります。

タイムゾーン問題を解決するその他の方法

jdbc:mysql://localhost:3306/database?useTimezone=true

serverTimezone プロパティと useLegacyDatetimeCode プロパティを両方とも設定しない

// タイムゾーン設定は行わない

Connection connection = DriverManager.getConnection(url, user, password);

アプリケーションサーバーでタイムゾーン設定を行う

• Tomcat の場合、server.xml ファイルに以下の設定を追加する。

<Connector port="8080" protocol="HTTP/1.1"
           connectionTimeout="20000"
           redirectPort="8443"
           useBodyEncodingForURI="true"
           disableUploadTimeout="true">
    <Parameter name="useTimezone" value="true" />
</Connector>

<subsystem xmlns="urn:jboss:domain:undertow:1.5">
    <server name="default-server">
        <http-listener name="default" socket-binding="http" redirect-socket-binding="https">
            <filters>
                <response-header name="X-Powered-By" value="Undertow" />
            </filters>
        </http-listener>
        <https-listener name="https" socket-binding="https" security-realm="ApplicationRealm">
            <filters>
                <response-header name="X-Powered-By" value="Undertow" />
            </filters>
        </https-listener>
    </server>
    <servlet-container name="default-servlet-container">
        <jsp-config>
            <property name="defaultEncoding" value="UTF-8" />
        </jsp-config>
        <websockets>
            <socket-binding name="default" />
        </websockets>
    </servlet-container>
    <handlers>
        <file name="default-file-handler" path="/path/to/webapps" />
    </handlers>
    <host name="default-host" alias="localhost">
        <valve name="access-log">
            <pattern>%h %l %u %t "%r" %s %b "%{Referer}i" "%{User-Agent}i"</pattern>
            <valve-class name="org.jboss.undertow.server.handlers.accesslog.AccessLogValve" />
        </valve>
        <location name="/" handler="default-file-handler" />
    </host>
</subsystem>

データベース接続ライブラリの設定を変更する

• HikariCP の場合、以下の設定を追加する。

HikariDataSource dataSource = new HikariDataSource();
dataSource.setJdbcUrl("jdbc:mysql://localhost:3306/database");
dataSource.setUsername("root");
dataSource.setPassword("password");
dataSource.setTimeZone("Asia/Tokyo");