Spring Boot整合HikariCP连接DB2时如何动态更新数据源密码

问题背景 #

• 基于Spring Boot开发对接DB2的RESTful应用，选用HikariCP作为连接池组件实现高效连接管理
• 数据库账号密码存储在安全凭证系统中，密码每周会在未知时间点自动轮换，要求每次获取数据库连接前，先从安全系统拉取最新密码，替换原有配置后再建立连接
• 现存异常：即使手动排空连接池，调用setPassword()传入新密码后，HikariCP仍然保留旧密码配置，无法使用新密码建立连接

现有配置与代码片段 #

Hikari配置文件 #

# 客户端获取连接的最大等待时长（毫秒）
spring.datasource.connectionTimeout=20000
# 连接池维护的最小空闲连接数
spring.datasource.minimumIdle=0
# 连接池最大连接数
spring.datasource.maximumPoolSize=100 
# 连接最大空闲时长（毫秒）
spring.datasource.idleTimeout=30000
# 池中连接的最大生命周期（毫秒），当前配置为0表示无生命周期限制
spring.datasource.maxLifetime=0 
# 连接默认自动提交行为
spring.datasource.autocommit=true 
spring.datasource.poolName=db2Pool

数据源初始化代码 #

@Bean("dataSourceMF")
@Order(PriorityOrdered.HIGHEST_PRECEDENCE)
public DataSource dataSourceMF() {
    PasswordsMessage passwordsMessage = passwordApi.getPassword("username");
    String userPassword = passwordsMessage.getPassword();

    Properties configProps = new Properties();
    configProps.put("poolName", poolName);
    configProps.put("jdbcUrl", db2Url);
    configProps.put("driverClassName", db2Driver);
    configProps.put("username", db2User);
    configProps.put("catalog", db2Catalog);
    configProps.put("maximumPoolSize", maximumPoolSize);
    configProps.put("minimumIdle", minimumIdle);
    configProps.put("connectionTimeout", connectionTimeout);
    configProps.put("idleTimeout", idleTimeout);
    configProps.put("autoCommit", autoCommit);
    configProps.put("dataSource.prepStmtCacheSize", 250);
    configProps.put("dataSource.prepStmtCacheSqlLimit", 2048);
    configProps.put("dataSource.cachePrepStmts", Boolean.TRUE);
    configProps.put("dataSource.useServerPrepStmts", Boolean.TRUE);
    configProps.put("password", userPassword);

    HikariConfig hc = new HikariConfig(configProps);
    dataSource = new HikariDataSource(hc);

    return dataSource;
}

获取连接逻辑代码 #

public Connection getConnection() throws SQLException, Exception {
    PasswordsMessage passwordsMessage = passwordApi.getPassword("username");
    String userPassword = passwordsMessage.getPassword();

    try {
        dataSource.setPassword(userPassword);
        return dataSource.getConnection();
    } catch (SQLException e) {
        e.printStackTrace();
    }
}

pom.xml依赖配置 #

<dependency>
    <groupId>com.zaxxer</groupId>
    <artifactId>HikariCP</artifactId>
    <version>2.4.7</version>
</dependency>

问题截图 #

问题根因 #

1. 当前使用的HikariCP 2.4.7版本过旧，该版本中HikariDataSource对外暴露的setPassword()等配置修改方法，在数据源初始化完成后不会同步更新底层创建物理连接的连接工厂配置。数据源启动时连接工厂已经固化了初始传入的密码，后续直接调用set方法修改属性，不会触发连接工厂重建，新建连接时仍然读取旧密码。
2. 配置中maxLifetime=0表示连接永久存活，旧密码创建的长连接不会被主动淘汰，密码轮换后旧连接失效，新连接又使用旧密码创建，会持续抛出认证错误。

可行解决方案 #

方案1：自定义动态密码数据源（推荐，性能最优） #

通过Hikari提供的JMX配置接口动态更新密码，配合异常重试逻辑实现无感知密码切换，不需要重建整个数据源：

1. 先升级HikariCP版本到3.2.0以上，修复旧版本配置同步的已知bug，同时保持对Spring Boot 1.x/2.x版本的兼容性。
2. 自定义继承HikariDataSource的动态数据源类，重写连接获取逻辑：

public class DynamicPasswordHikariDataSource extends HikariDataSource {
    private final PasswordApi passwordApi;
    private final String dbUsername;

    public DynamicPasswordHikariDataSource(HikariConfig config, PasswordApi passwordApi, String dbUsername) {
        super(config);
        this.passwordApi = passwordApi;
        this.dbUsername = dbUsername;
    }

    @Override
    public Connection getConnection() throws SQLException {
        // 每次获取连接前拉取最新密码，通过JMX配置接口同步更新到连接工厂
        String latestPassword = passwordApi.getPassword(dbUsername).getPassword();
        getHikariConfigMXBean().setPassword(latestPassword);
        
        try {
            return super.getConnection();
        } catch (SQLInvalidAuthorizationSpecException e) {
            // 捕获密码认证错误时，软驱逐池内所有空闲连接，强制使用新密码创建新连接后重试
            softEvictConnections();
            return super.getConnection();
        }
    }
}

3. 修改数据源初始化Bean，返回自定义动态数据源实例，同时修正不合理的配置项：

@Bean("dataSourceMF")
@Order(PriorityOrdered.HIGHEST_PRECEDENCE)
public DataSource dataSourceMF(PasswordApi passwordApi) {
    Properties configProps = new Properties();
    // 初始密码仅用于服务启动时的首次连接校验，后续会动态拉取更新
    PasswordsMessage initialPwd = passwordApi.getPassword(db2User);
    configProps.put("poolName", poolName);
    configProps.put("jdbcUrl", db2Url);
    configProps.put("driverClassName", db2Driver);
    configProps.put("username", db2User);
    configProps.put("catalog", db2Catalog);
    configProps.put("maximumPoolSize", maximumPoolSize);
    configProps.put("minimumIdle", minimumIdle);
    configProps.put("connectionTimeout", connectionTimeout);
    configProps.put("idleTimeout", idleTimeout);
    configProps.put("autoCommit", autoCommit);
    configProps.put("dataSource.prepStmtCacheSize", 250);
    configProps.put("dataSource.prepStmtCacheSqlLimit", 2048);
    configProps.put("dataSource.cachePrepStmts", Boolean.TRUE);
    configProps.put("dataSource.useServerPrepStmts", Boolean.TRUE);
    configProps.put("password", initialPwd.getPassword());
    // 连接最大生命周期设置为12小时，远短于7天的密码轮换周期，主动淘汰旧连接
    configProps.put("maxLifetime", 43200000);

    HikariConfig hc = new HikariConfig(configProps);
    return new DynamicPasswordHikariDataSource(hc, passwordApi, db2User);
}

方案2：密码轮换时重建数据源（适合低并发场景） #

如果不想自定义数据源实现，可以在业务代码捕获到数据库认证异常时，加本地锁关闭旧的HikariDataSource实例，用最新拉取的密码重新初始化新的数据源替换旧实例。

• 优点：实现逻辑简单，不需要修改Hikari数据源的内部逻辑
• 缺点：数据源重建瞬间会有短暂的连接等待，高并发场景下可能出现少量请求波动

配置注意事项 #

• 不要在每次调用getConnection()时都强制清空连接池，会大幅降低连接池性能，仅在捕获到认证异常时再驱逐连接重试即可
• 生产环境禁止将maxLifetime设置为0，必须设置比数据库侧密码、连接超时时间更短的生命周期值，避免僵死连接占用资源

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