如何通过KeycloakDeployment及keycloak.json获取RealmResource

我来帮你搞定这个问题——既然你已经有了正常运行的Tomcat Keycloak适配器，那复用现有keycloak.json的配置来构建Keycloak实例、获取RealmResource其实非常顺畅，下面是具体的实现步骤和代码示例：

1. 从KeycloakDeployment提取配置参数 #

你已经提到能获取到KeycloakDeployment实例，那首先从里面提取我们需要的所有核心参数：

• 认证服务器地址：deployment.getAuthServerBaseUrl()
• Realm名称：deployment.getRealm()
• 客户端ID（resource字段）：deployment.getResourceName()
• 客户端密钥：deployment.getResourceCredentials().get("secret").toString()（如果用的是secret认证）
• Keystore/Truststore路径和密码：deployment.getKeystore()、deployment.getKeystorePassword()、deployment.getTruststore()、deployment.getTruststorePassword()（如果用的是证书认证）

如果还没获取到KeycloakDeployment实例，也可以直接从classpath加载keycloak.json文件构建：

KeycloakDeployment deployment = KeycloakDeploymentBuilder.build(
    getClass().getResourceAsStream("/WEB-INF/keycloak.json")
);

2. 构建Keycloak实例 #

根据你用的客户端认证方式（secret或keystore），选择对应的构建方式：

方式一：客户端Secret认证 #

这是最常用的场景，适合大部分服务端调用Keycloak Admin API的情况：

// 提取配置
String authServerUrl = deployment.getAuthServerBaseUrl();
String realmName = deployment.getRealm();
String clientId = deployment.getResourceName();
String clientSecret = deployment.getResourceCredentials().get("secret").toString();

// 构建Keycloak客户端实例
Keycloak keycloak = KeycloakBuilder.builder()
    .serverUrl(authServerUrl)
    .realm(realmName)
    .clientId(clientId)
    .clientSecret(clientSecret)
    .grantType(OAuth2Constants.CLIENT_CREDENTIALS) // 服务端调用推荐用客户端凭证模式
    .build();

方式二：Keystore/Truststore证书认证 #

如果你的客户端是用证书和Keycloak交互的，就用这种方式：

// 提取证书相关配置
String keyStorePath = deployment.getKeystore();
String keyStorePassword = deployment.getKeystorePassword();
String trustStorePath = deployment.getTruststore();
String trustStorePassword = deployment.getTruststorePassword();

// 加载Keystore
KeyStore keyStore = KeyStore.getInstance(KeyStore.getDefaultType());
try (InputStream keyStoreStream = new FileInputStream(keyStorePath)) {
    keyStore.load(keyStoreStream, keyStorePassword.toCharArray());
}

// 加载Truststore
KeyStore trustStore = KeyStore.getInstance(KeyStore.getDefaultType());
try (InputStream trustStoreStream = new FileInputStream(trustStorePath)) {
    trustStore.load(trustStoreStream, trustStorePassword.toCharArray());
}

// 构建Keycloak实例
Keycloak keycloak = KeycloakBuilder.builder()
    .serverUrl(deployment.getAuthServerBaseUrl())
    .realm(deployment.getRealm())
    .clientId(deployment.getResourceName())
    .keyStore(keyStore, keyStorePassword.toCharArray())
    .trustStore(trustStore)
    .grantType(OAuth2Constants.CLIENT_CREDENTIALS)
    .build();

3. 获取RealmResource并执行操作 #

拿到Keycloak实例后，就可以轻松获取RealmResource，然后调用Keycloak Admin API做各种操作了：

// 获取目标Realm的资源对象
RealmResource realmResource = keycloak.realm(realmName);

// 示例操作1：获取当前客户端的详细信息
ClientRepresentation client = realmResource.clients()
    .findByClientId(clientId)
    .stream()
    .findFirst()
    .orElseThrow(() -> new RuntimeException("未找到客户端: " + clientId));
System.out.println("客户端显示名称: " + client.getName());

// 示例操作2：获取Realm下的所有用户
List<UserRepresentation> users = realmResource.users().list();
users.forEach(user -> System.out.println("用户ID: " + user.getId() + ", 用户名: " + user.getUsername()));

// 重要：用完记得关闭Keycloak实例，释放资源
keycloak.close();

注意事项 #

• 确保你的项目依赖了正确的Keycloak客户端库，比如keycloak-admin-client和keycloak-core，版本要和Tomcat适配器的版本保持一致，避免兼容性问题。
• 如果是Spring环境，你可以把Keycloak实例封装成Spring Bean，方便在各个组件中注入使用，记得加上合适的作用域注解。

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