Keycloak v23.0.7：能否通过自定义SPI更新Infinispan缓存中的会话？

核心结论 #

• 完全可以在自定义SPI中通过编程方式更新用户/客户端会话，官方推荐使用上层抽象API而非直接操作Infinispan缓存。
• 无论是内置Infinispan缓存还是外部Infinispan服务器，该操作都能正常生效，Keycloak的缓存抽象层会屏蔽底层实现差异。

具体实现方式 #

Keycloak提供了UserSessionProvider和ClientSessionProvider两个核心接口，封装了会话的CRUD操作，无需直接调用Infinispan的底层方法（避免耦合底层缓存实现，降低维护成本）。

示例代码（自定义SPI中更新用户会话） #

在SPI实现类中，通过KeycloakSession获取对应Provider，修改会话属性后调用更新方法：

// 从KeycloakSession中获取UserSessionProvider
UserSessionProvider userSessionProvider = session.getProvider(UserSessionProvider.class);
RealmModel realm = session.getContext().getRealm();
String targetSessionId = "要更新的会话ID"; // 可通过会话上下文或其他方式获取

// 获取目标会话
UserSessionModel userSession = userSessionProvider.getUserSession(realm, targetSessionId);
if (userSession != null) {
    // 更新会话自定义属性（比如添加/修改note）
    userSession.setNote("custom_session_attr", "updated_value");
    // 更新会话的lastAccessedTime（可选）
    userSession.setLastAccessedTime(System.currentTimeMillis());
    // 持久化更新到缓存
    userSessionProvider.updateUserSession(realm, userSession);
}

更新客户端会话的类似逻辑 #

ClientSessionProvider clientSessionProvider = session.getProvider(ClientSessionProvider.class);
ClientSessionModel clientSession = clientSessionProvider.getClientSession(realm, clientSessionId);
if (clientSession != null) {
    // 修改客户端会话属性，比如调整redirectUri
    clientSession.setRedirectUri("https://new-redirect.example.com");
    // 持久化更新
    clientSessionProvider.updateClientSession(realm, clientSession);
}

关于Infinispan的适配问题 #

• 不管使用内置还是外部Infinispan，只要通过上述UserSessionProvider/ClientSessionProvider操作，Keycloak会自动处理缓存的读写、集群同步（如果是集群部署），无需额外适配代码。
• 官方Javadoc中的Infinispan相关方法（比如直接操作Cache接口）虽然可以用，但不推荐：直接操作缓存会绕过Keycloak的会话状态校验和同步机制，可能导致集群环境下会话状态不一致，或触发未预期的认证逻辑异常。

v23.0.7版本的兼容性说明 #

你当前使用的v23.0.7版本中，上述UserSessionProvider和ClientSessionProvider的API是稳定可用的，与v24+版本的SPI体系兼容（主题重构不会影响这些核心API），后续升级到v24时无需大幅修改这部分代码。

内容的提问来源于stack exchange，提问作者Lúthien