Keycloak中通过EventListener SPI设置用户属性的持久化问题

方案一：修复EventListenerProvider的持久化问题 #

你的事件监听器代码中，设置用户属性后未触发持久化操作——因为REGISTER事件触发时，用户创建的事务已经提交，单独修改UserModel不会自动同步到数据库。需要手动调用UserProvider的更新方法确保属性被保存：

修改后的onEvent方法代码：

@Override
public void onEvent(Event event) {
    if (event.getType() != EventType.REGISTER)
        return;
    
    RealmModel realm = session.realms().getRealm(event.getRealmId());
    UserModel user = session.users().getUserById(realm, event.getUserId());
    
    user.setSingleAttribute("hello", "world");
    // 显式触发用户更新，将修改同步到数据库
    session.getProvider(UserProvider.class).updateUser(realm, user);
}

原理：通过UserProvider的updateUser方法，强制将用户的属性修改提交到数据库，解决事务已提交导致的修改丢失问题。

方案二：通过RegistrationUserCreation的success回调处理 #

如果不想依赖事件监听器，可以扩展RegistrationUserCreation，重写success方法——这个方法会在用户注册成功且事务未提交时触发，修改会自动被事务持久化，且仅执行一次：

1. 实现自定义的RegistrationUserCreation类：

public class CustomRegistrationUserCreation extends RegistrationUserCreation {

    public CustomRegistrationUserCreation(KeycloakSession session, FormContext formContext) {
        super(session, formContext);
    }

    @Override
    public void success() {
        // 先执行父类逻辑，确保用户已完成创建
        super.success();
        // 获取当前注册的用户实例
        UserModel user = getFormContext().getUser();
        // 设置自定义属性
        user.setSingleAttribute("hello", "world");
    }
}

2. 创建工厂类注册自定义实现：

@AutoService(RegistrationProviderFactory.class)
public class CustomRegistrationUserCreationFactory extends RegistrationUserCreationFactory {

    @Override
    public RegistrationProvider create(KeycloakSession session) {
        return new CustomRegistrationUserCreation(session, null);
    }

    @Override
    public String getId() {
        // 可自定义ID，或直接覆盖默认的"registration-user-creation"
        return "custom-registration-user-creation";
    }
}

3. 控制台配置：在Keycloak的认证流程中，将默认的「User Creation」执行器替换为你自定义的执行器，后续用户注册成功时会自动触发success方法，属性将被持久化。

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