HikariCP 设置 JDBC 超时参数方法

本文介绍了如何通过 HikariCP 连接池配置 JDBC 连接的超时参数。重点讲解了如何使用 addDataSourceProperty() 方法设置 wait_timeout 和 interactive_timeout 等 MySQL 服务器变量，并提供了代码示例，帮助开发者正确配置数据库连接，避免因超时导致的连接中断问题。

在使用 JDBC 连接数据库时，设置合适的超时参数对于保证应用程序的稳定性和性能至关重要。HikariCP 是一个高性能的 JDBC 连接池，提供了多种配置选项来满足不同的需求。本文将重点介绍如何通过 HikariCP 配置连接超时相关的参数，特别是 MySQL 服务器的 wait_timeout 和 interactive_timeout 变量。

配置 MySQL 服务器变量

直接在 JDBC URL 中设置 wait_timeout 和 interactive_timeout 通常不会生效，因为 HikariCP 默认不会将这些参数直接传递给 MySQL 服务器。正确的方法是使用 addDataSourceProperty() 方法。

以下是一个示例代码，展示了如何通过 HikariCP 配置这些参数：

HikariConfig hikariConfig = new HikariConfig();
hikariConfig.setJdbcUrl("jdbc:mysql://your_host/your_database");
hikariConfig.setUsername("your_username");
hikariConfig.setPassword("your_password");

// 设置连接池的连接超时时间
hikariConfig.setConnectionTimeout(65 * 1000); // 65 秒

// 设置连接池的空闲超时时间
hikariConfig.setIdleTimeout(66 * 1000); // 66 秒

// 设置 MySQL 服务器的 wait_timeout 和 interactive_timeout
hikariConfig.addDataSourceProperty("cachePrepStmts", "true"); // 开启预编译语句缓存，提高性能
hikariConfig.addDataSourceProperty("prepStmtCacheSize", "250"); // 设置预编译语句缓存大小
hikariConfig.addDataSourceProperty("prepStmtCacheSqlLimit", "2048"); // 设置预编译语句缓存SQL长度限制
hikariConfig.addDataSourceProperty("wait_timeout", "77"); // 设置 wait_timeout
hikariConfig.addDataSourceProperty("interactive_timeout", "78"); // 设置 interactive_timeout

HikariDataSource hikariDataSource = new HikariDataSource(hikariConfig);

try (Connection connection = hikariDataSource.getConnection();
     Statement statement = connection.createStatement();
     ResultSet resultSet = statement.executeQuery("show variables like '%timeout%'")) {

    while (resultSet.next()) {
        System.out.println(resultSet.getString(1) + " " + resultSet.getString(2));
    }

} catch (SQLException e) {
    e.printStackTrace();
} finally {
    // 确保关闭连接池
    hikariDataSource.close();
}

代码解释：

1. HikariConfig 对象: 用于配置 HikariCP 连接池。
2. setJdbcUrl(), setUsername(), setPassword(): 设置数据库连接的基本信息。
3. setConnectionTimeout() 和 setIdleTimeout(): 设置连接池的连接超时时间和空闲超时时间，这两个参数是 HikariCP 自身的配置。
4. addDataSourceProperty(): 关键方法，用于设置底层数据源的属性。 这里我们设置了 wait_timeout 和 interactive_timeout，它们是 MySQL 服务器的变量。同时，为了提高性能，也设置了 cachePrepStmts, prepStmtCacheSize, prepStmtCacheSqlLimit 属性，用于开启和配置预编译语句缓存。
5. HikariDataSource 对象: 使用配置好的 HikariConfig 创建数据源。
6. Try-with-resources: 确保在使用完连接后能够正确关闭，避免资源泄漏。
7. 执行 show variables like '%timeout%' 查询: 验证 wait_timeout 和 interactive_timeout 是否已成功设置。

注意事项：

• wait_timeout 和 interactive_timeout 的区别: wait_timeout 影响非交互式连接的超时时间，而 interactive_timeout 影响交互式连接的超时时间。 根据你的应用程序的连接类型，选择合适的参数进行配置。
• MySQL 服务器配置: 即使在 JDBC 连接中设置了这些参数，MySQL 服务器本身也需要配置相应的超时时间。 确保 MySQL 服务器的 wait_timeout 和 interactive_timeout 设置与应用程序的需求一致。 可以使用 SET GLOBAL wait_timeout=xxx; 和 SET GLOBAL interactive_timeout=xxx; 命令在 MySQL 服务器上进行配置，但需要管理员权限。
• 连接池大小: 根据应用程序的并发量，合理配置 HikariCP 的连接池大小，避免连接不足或资源浪费。
• 异常处理: 在实际应用中，务必进行完善的异常处理，以便在连接失败或超时的情况下能够及时处理。

总结：

通过 addDataSourceProperty() 方法，可以灵活地配置 HikariCP 连接池，设置底层数据源的属性，包括 MySQL 服务器的超时变量。 正确配置这些参数，能够有效地避免因连接超时导致的各种问题，提高应用程序的稳定性和性能。 在实际应用中，需要结合应用程序的实际情况，合理配置各个参数，并进行充分的测试。