如何在Keycloak运行时动态配置自定义数据源的JDBC参数？

可以实现运行时动态创建数据源，核心思路是放弃Quarkus构建时的数据源配置，改为在用户存储Provider的初始化阶段，从Keycloak管理控制台传入的配置参数中获取数据库连接信息，手动构建数据源实例。具体实现步骤如下：

1. 移除构建时数据源配置 #

删除quarkus.properties中custom-user-store和keycloak-user-store相关的所有配置项，避免Quarkus在构建阶段初始化固定数据源。

2. 在Provider初始化阶段动态构建数据源 #

在你的UserStorageProvider实现类的init方法中，从Keycloak的ComponentModel里读取控制台输入的连接参数，然后用JDBC连接池（如Quarkus默认的HikariCP）创建数据源实例。

示例代码：

import com.zaxxer.hikari.HikariDataSource;
import org.keycloak.component.ComponentModel;
import org.keycloak.storage.UserStorageProvider;

public class CustomUserStorageProvider implements UserStorageProvider {
    private HikariDataSource customDs;
    private HikariDataSource keycloakDs;

    @Override
    public void init(ComponentModel model) {
        // 从管理控制台配置中读取参数
        String customJdbcUrl = model.getConfig().getFirst("custom-jdbc-url").getValue();
        String customUsername = model.getConfig().getFirst("custom-username").getValue();
        String customPassword = model.getConfig().getFirst("custom-password").getValue();

        String keycloakJdbcUrl = model.getConfig().getFirst("keycloak-jdbc-url").getValue();
        String keycloakUsername = model.getConfig().getFirst("keycloak-username").getValue();
        String keycloakPassword = model.getConfig().getFirst("keycloak-password").getValue();

        // 构建第一个数据源（自定义用户存储）
        customDs = new HikariDataSource();
        customDs.setJdbcUrl(customJdbcUrl);
        customDs.setUsername(customUsername);
        customDs.setPassword(customPassword);
        customDs.setDriverClassName("com.mysql.cj.jdbc.Driver");
        // 配置XA事务（匹配原配置的XA要求）
        customDs.setXaDataSourceClassName("com.mysql.cj.jdbc.MysqlXADataSource");
        // 可添加其他连接池配置（如最大连接数、超时时间等）
        customDs.setMaximumPoolSize(10);
        customDs.setConnectionTimeout(30000);

        // 构建第二个数据源（Keycloak用户存储）
        keycloakDs = new HikariDataSource();
        keycloakDs.setJdbcUrl(keycloakJdbcUrl);
        keycloakDs.setUsername(keycloakUsername);
        keycloakDs.setPassword(keycloakPassword);
        keycloakDs.setDriverClassName("com.mysql.cj.jdbc.Driver");
        keycloakDs.setXaDataSourceClassName("com.mysql.cj.jdbc.MysqlXADataSource");
        keycloakDs.setMaximumPoolSize(10);
        keycloakDs.setConnectionTimeout(30000);
    }

    // ... 其他Provider方法实现
}

3. 动态配置JPA（如果使用JPA） #

如果你的扩展依赖JPA操作数据库，需要基于动态创建的数据源构建EntityManagerFactory，而不是依赖persistence.xml中的固定配置：

import jakarta.persistence.EntityManager;
import jakarta.persistence.EntityManagerFactory;
import jakarta.persistence.Persistence;
import java.util.HashMap;
import java.util.Map;

// 在init方法中添加EntityManagerFactory构建逻辑
Map<String, Object> customJpaProps = new HashMap<>();
customJpaProps.put("javax.persistence.jdbc.url", customJdbcUrl);
customJpaProps.put("javax.persistence.jdbc.user", customUsername);
customJpaProps.put("javax.persistence.jdbc.password", customPassword);
customJpaProps.put("javax.persistence.jdbc.driver", "com.mysql.cj.jdbc.Driver");
// 配置JTA事务适配Keycloak环境
customJpaProps.put("hibernate.transaction.jta.platform", "org.hibernate.service.jta.platform.internal.JBossStandAloneJtaPlatform");
customJpaProps.put("javax.persistence.transactionType", "JTA");

EntityManagerFactory customEmf = Persistence.createEntityManagerFactory("custom-user-pu", customJpaProps);
EntityManager customEntityManager = customEmf.createEntityManager();

// 同理构建keycloak-user-store对应的EntityManagerFactory和EntityManager

4. 资源清理 #

在Provider的close方法中关闭数据源和EntityManagerFactory，避免资源泄漏：

@Override
public void close() {
    // 关闭自定义数据源
    if (customDs != null) {
        customDs.close();
    }
    // 关闭Keycloak数据源
    if (keycloakDs != null) {
        keycloakDs.close();
    }
    // 关闭EntityManagerFactory和EntityManager
    if (customEntityManager != null && customEntityManager.isOpen()) {
        customEntityManager.close();
    }
    // ... 同理处理keycloak相关的EntityManager
}

额外配置 #

• 在Keycloak管理控制台的用户联邦Provider配置页面，添加对应的参数输入字段（如custom-jdbc-url、custom-username等），确保用户可以输入动态配置信息。
• 处理异常场景：在数据源创建过程中捕获SQLException等异常，抛出KeycloakException提示配置错误。

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