KeyCloak集成Spring Boot时如何在认证成功跳转前添加自定义代码

失效原因 #

Keycloak 与 Spring Boot 集成时走的是 OIDC 授权码认证流程，认证成功后的处理逻辑由 Keycloak 内置的过滤器接管，和 Spring Security 原生的表单登录流程完全独立，因此配置 formLogin().successHandler() 不会生效。

实现方案 #

方案1：替换Keycloak默认认证成功处理器（支持自定义跳转逻辑） #

如果需要在跳转前执行逻辑甚至修改跳转地址，可直接替换Keycloak内置的成功处理器：

1. 自定义处理器继承KeycloakAuthenticationSuccessHandler

public class CustomKeycloakAuthSuccessHandler extends KeycloakAuthenticationSuccessHandler {

    public CustomKeycloakAuthSuccessHandler(RedirectStrategy redirectStrategy) {
        super(redirectStrategy);
    }

    @Override
    public void onAuthenticationSuccess(HttpServletRequest request, HttpServletResponse response, Authentication authentication) throws IOException, ServletException {
        // 此处写入自定义逻辑：比如记录登录日志、补充用户权限、写入session信息等
        System.out.println("认证成功，用户ID：" + authentication.getName());
        
        // 调用父类方法执行原有跳转逻辑，如需自定义跳转地址可自行实现重定向逻辑
        super.onAuthenticationSuccess(request, response, authentication);
    }
}

2. 在安全配置类中注册自定义处理器

@Configuration
public class KeycloakSecurityConfiguration extends KeycloakWebSecurityConfigurerAdapter {

    @Override
    protected void configure(HttpSecurity http) throws Exception {
        super.configure(http);
        http.authorizeRequests().antMatchers("/**").authenticated()
            .anyRequest().permitAll();
        // 注册自定义过滤器
        http.addFilterBefore(keycloakAuthenticationProcessingFilter(), UsernamePasswordAuthenticationFilter.class);
    }

    @Bean
    @Override
    protected KeycloakAuthenticationProcessingFilter keycloakAuthenticationProcessingFilter() throws Exception {
        KeycloakAuthenticationProcessingFilter filter = super.keycloakAuthenticationProcessingFilter();
        // 替换为自定义成功处理器
        filter.setAuthenticationSuccessHandler(new CustomKeycloakAuthSuccessHandler(new DefaultRedirectStrategy()));
        return filter;
    }
}

方案2：监听认证成功事件（适合无跳转修改的纯后置逻辑） #

如果不需要干预跳转流程，仅需执行认证成功后的后置操作，可以直接监听Spring Security的认证成功事件，实现更简洁：

@Component
public class KeycloakAuthSuccessListener implements ApplicationListener<AuthenticationSuccessEvent> {

    @Override
    public void onApplicationEvent(AuthenticationSuccessEvent event) {
        Authentication auth = event.getAuthentication();
        // 过滤非Keycloak的认证事件
        if (auth instanceof KeycloakAuthenticationToken) {
            // 执行自定义逻辑
            System.out.println("Keycloak用户认证成功：" + auth.getName());
        }
    }
}

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