如何在Quarkus DevServices中为Keycloak实现事件监听器

你当前的核心问题在于：Keycloak的自定义事件监听器属于Keycloak SPI扩展，并非Quarkus的CDI Bean，直接用@ApplicationScoped注解无法被Keycloak识别；再加上DevService每次启动全新容器，没法手动修改Keycloak配置，必须通过Quarkus自动完成扩展注入和配置。

第一步：将监听器改造为Keycloak SPI扩展 #

Keycloak通过工厂类加载SPI实现，你需要补充工厂类并完成SPI注册：

1. 实现EventListenerProviderFactory工厂类

package de.hsos.swa.pizza4me;

import org.keycloak.Config;
import org.keycloak.events.EventListenerProvider;
import org.keycloak.events.EventListenerProviderFactory;
import org.keycloak.models.KeycloakSession;
import org.keycloak.models.KeycloakSessionFactory;

public class MyKeycloakEventListenerFactory implements EventListenerProviderFactory {

    @Override
    public EventListenerProvider create(KeycloakSession session) {
        return new MyKeycloakEventListener();
    }

    @Override
    public void init(Config.Scope config) {
        // 可选：添加初始化逻辑
    }

    @Override
    public void postInit(KeycloakSessionFactory factory) {
        // 可选：添加后置初始化逻辑
    }

    @Override
    public void close() {
        // 可选：添加资源关闭逻辑
    }

    @Override
    public String getId() {
        // 这个ID是后续在Keycloak控制台选择监听器的标识
        return "my-custom-listener";
    }
}

2. 改造原监听器类，移除Quarkus CDI注解

package de.hsos.swa.pizza4me;

import org.keycloak.events.Event;
import org.keycloak.events.EventListenerProvider;
import org.keycloak.events.admin.AdminEvent;

public class MyKeycloakEventListener implements EventListenerProvider {
    
    @Override
    public void onEvent(Event event) {
        System.out.println("Event: " + event.getType());
    }

    @Override
    public void onEvent(AdminEvent event, boolean includeRepresentation) {
        System.out.println("Admin Event: " + event.getOperationType());
    }

    @Override
    public void close() {
        System.out.println("Listener closed");
    }
}

3. 添加SPI注册文件
   在src/main/resources/META-INF/services目录下创建文件org.keycloak.events.EventListenerProviderFactory，内容为工厂类的全限定名：

de.hsos.swa.pizza4me.MyKeycloakEventListenerFactory

第二步：配置Quarkus DevService挂载扩展 #

通过Quarkus配置，将打包好的扩展jar自动挂载到Keycloak容器的扩展扫描目录：

1. 先执行mvn package将项目打包为jar文件
2. 在application.properties中添加DevService配置：

# 启用Keycloak DevService
quarkus.keycloak.devservices.enabled=true
# 挂载本地扩展jar到容器的providers目录（替换为你的实际jar文件名）
quarkus.keycloak.devservices.extra-mounts=./target/pizza4me-1.0.0-SNAPSHOT.jar:/opt/keycloak/providers/my-custom-listener.jar
# 可选：自动导入预配置的Realm（包含监听器启用设置）
quarkus.keycloak.devservices.import-realm=./src/main/resources/realm-export.json

第三步：自动启用监听器（可选） #

如果不想每次启动后手动在Keycloak控制台配置监听器，可以预先导出包含监听器配置的Realm文件：

1. 启动Quarkus后，打开Keycloak控制台，进入目标Realm的Events -> Listeners，添加my-custom-listener（即工厂类getId()返回的标识）
2. 导出Realm配置（控制台左上角「Export」按钮），保存为src/main/resources/realm-export.json
3. 上述配置中的import-realm会自动导入该Realm，监听器将随容器启动自动启用

为什么之前的写法无效？ #

• Keycloak的事件监听器运行在Keycloak容器内部，不属于Quarkus应用的Bean，Quarkus的CDI注解对Keycloak无意义，必须打包为Keycloak SPI扩展
• DevService每次启动全新容器，无法手动修改容器内文件，必须通过Quarkus配置自动完成扩展挂载

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