多Keycloak Provider注册Entity Listener的替代方案问询

方案1：使用Keycloak官方User事件监听SPI（推荐） #

Keycloak原生提供了UserEventListenerProvider SPI，这是监听用户生命周期事件的标准方式，完全规避ORM配置冲突，且支持即插即用。

实现步骤： #

1. 自定义事件监听器类，实现UserEventListenerProvider：

import org.keycloak.models.KeycloakSession;
import org.keycloak.models.UserModel;
import org.keycloak.events.UserEventListenerProvider;

public class CustomUserEventListener implements UserEventListenerProvider {
    private final KeycloakSession session;

    public CustomUserEventListener(KeycloakSession session) {
        this.session = session;
    }

    // 对应@PrePersist/@PostPersist：用户创建时触发
    @Override
    public void onUserCreated(UserModel user) {
        processUser(user);
    }

    // 对应@PreUpdate/@PostUpdate：用户更新时触发
    @Override
    public void onUserUpdated(UserModel user) {
        processUser(user);
    }

    // 对应@PostLoad：用户加载时触发
    @Override
    public void onUserLoaded(UserModel user) {
        processUser(user);
    }

    // 实现其他必要的空方法
    @Override
    public void close() {}

    @Override
    public void onUserDeleted(UserModel user) {}
    // 按需实现其他事件方法，如onUserEnabled、onUserDisabled等

    private void processUser(UserModel user) {
        // 这里编写你的数据处理逻辑
    }
}

2. 实现对应的Provider Factory：

import org.keycloak.Config;
import org.keycloak.models.KeycloakSession;
import org.keycloak.models.KeycloakSessionFactory;
import org.keycloak.events.UserEventListenerProviderFactory;

public class CustomUserEventListenerFactory implements UserEventListenerProviderFactory {
    @Override
    public UserEventListenerProvider create(KeycloakSession session) {
        return new CustomUserEventListener(session);
    }

    @Override
    public void init(Config.Scope config) {}

    @Override
    public void postInit(KeycloakSessionFactory factory) {}

    @Override
    public void close() {}

    // 每个Provider使用唯一ID，避免冲突
    @Override
    public String getId() {
        return "custom-user-listener-1";
    }
}

3. 注册SPI：
   在你的Provider JAR中创建META-INF/services/org.keycloak.events.UserEventListenerProviderFactory文件，内容为Factory类的全限定名：

com.your.package.CustomUserEventListenerFactory

每个Provider JAR独立完成上述步骤即可，Keycloak会自动加载所有注册的事件监听器，无配置冲突。

方案2：编程式注册JPA Entity Listener（保留原有JPA注解逻辑） #

通过Quarkus的CDI扩展机制，动态向EntityManagerFactory添加实体监听器，无需依赖META-INF/orm.xml。

实现步骤： #

1. 创建CDI扩展类，注册EntityManagerFactoryBuilderCustomizer：

import io.quarkus.hibernate.orm.runtime.entitymanagerfactory.EntityManagerFactoryBuilderCustomizer;
import jakarta.enterprise.inject.spi.Extension;
import jakarta.enterprise.inject.spi.ExtensionContext;

public class JpaListenerRegistrationExtension implements Extension {
    public void register(ExtensionContext context) {
        context.addBeanRegistrationContributor((phase, registrations) -> {
            registrations.addBean()
                .types(EntityManagerFactoryBuilderCustomizer.class)
                .classBean(ListenerCustomizer.class)
                .createWith(ListenerCustomizer::new);
        });
    }

    static class ListenerCustomizer implements EntityManagerFactoryBuilderCustomizer {
        @Override
        public void customize(org.hibernate.boot.spi.EntityManagerFactoryBuilder builder) {
            // 动态添加你的JPA监听器到UserEntity
            builder.addEntityListener(org.keycloak.models.jpa.entities.UserEntity.class, YourJpaEntityListener.class);
        }
    }
}

2. 注册CDI扩展：
   在JAR中创建META-INF/services/javax.enterprise.inject.spi.Extension文件，内容为扩展类的全限定名：

com.your.package.JpaListenerRegistrationExtension

3. 保留你的JPA监听器类（带@PrePersist等注解）：

import jakarta.persistence.PrePersist;
import jakarta.persistence.PreUpdate;
import jakarta.persistence.PostLoad;
import org.keycloak.models.jpa.entities.UserEntity;

public class YourJpaEntityListener {
    @PrePersist
    public void onPrePersist(UserEntity user) {
        // 原有处理逻辑
    }

    @PreUpdate
    public void onPreUpdate(UserEntity user) {
        // 原有处理逻辑
    }

    @PostLoad
    public void onPostLoad(UserEntity user) {
        // 原有处理逻辑
    }
}

每个Provider通过此方式独立注册监听器，无需orm.xml，自然不会出现文件冲突。

方案对比 #

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