如何在Java代码中接收Keycloak的用户登录/登出事件？

当然可以，Keycloak提供了成熟的事件监听机制，能让你在Java代码中捕获并处理用户的登录、登出等事件。

具体实现步骤 #

1. 实现自定义事件监听器 #

Keycloak推荐通过继承AbstractEventListenerProvider来简化监听器开发，也可以直接实现核心接口EventListenerProvider。示例代码如下：

public class CustomUserEventListener extends AbstractEventListenerProvider {
    private final KeycloakSession session;

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

    @Override
    public void onEvent(Event event) {
        // 根据事件类型处理逻辑
        switch (event.getType()) {
            case LOGIN:
                processLogin(event);
                break;
            case LOGOUT:
                processLogout(event);
                break;
            // 可扩展处理其他事件类型，如REGISTER、PASSWORD_RESET等
            default:
                break;
        }
    }

    @Override
    public void onEvent(AdminEvent event, boolean includeRepresentation) {
        // 若无需处理管理端事件，可留空或简单实现
    }

    private void processLogin(Event event) {
        String userId = event.getUserId();
        String username = event.getUsername();
        String clientId = event.getClientId();
        // 这里添加你的业务逻辑，比如记录登录日志、触发业务流程
        System.out.printf("用户 %s（ID：%s）通过客户端 %s 完成登录%n", username, userId, clientId);
    }

    private void processLogout(Event event) {
        String userId = event.getUserId();
        String username = event.getUsername();
        // 处理登出逻辑，比如清理用户会话缓存
        System.out.printf("用户 %s（ID：%s）已登出%n", username, userId);
    }
}

2. 实现监听器工厂类 #

需要通过工厂类来实例化自定义监听器，Keycloak会通过SPI机制加载这个工厂：

public class CustomUserEventListenerFactory implements EventListenerProviderFactory {

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

    @Override
    public void init(Config.Scope config) {
        // 初始化配置，可读取自定义参数
    }

    @Override
    public void postInit(KeycloakSessionFactory factory) {
        // 后续初始化操作
    }

    @Override
    public void close() {
        // 资源清理
    }

    @Override
    public String getId() {
        // 返回监听器唯一标识，后续配置Keycloak时需要用到
        return "custom-user-event-listener";
    }
}

3. 打包部署 #

• 将代码打包成JAR包，注意Keycloak API依赖使用provided scope，避免与Keycloak内置依赖冲突。
• 将JAR包放入Keycloak独立模式的standalone/deployments目录下，Keycloak会自动部署。

4. 在Keycloak控制台启用监听器 #

• 登录Keycloak管理控制台，进入目标Realm。
• 点击左侧菜单Events -> Config。
• 在Event Listeners列表中添加工厂类定义的ID（如custom-user-event-listener），保存配置即可生效。

核心类/接口说明 #

• EventListenerProvider：所有事件监听器的核心接口，定义了处理用户事件和管理端事件的两个onEvent方法。
• AbstractEventListenerProvider：Keycloak提供的抽象类，默认实现了接口方法，只需重写需要的逻辑，简化开发。
• EventListenerProviderFactory：监听器实例的工厂接口，Keycloak通过SPI机制发现并加载该类，用于创建监听器实例。
• Event：封装用户事件的核心数据，包含事件类型（EventType枚举）、用户ID、用户名、客户端ID、时间戳等关键信息。

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