对于最新的稳定版本,请使用 Spring Security 6.4.1spring-doc.cadn.net.cn

身份验证事件

对于每个成功或失败的身份验证,一个AuthenticationSuccessEventAuthenticationFailureEvent,分别触发。spring-doc.cadn.net.cn

要侦听这些事件,您必须首先发布AuthenticationEventPublisher. Spring Security 的DefaultAuthenticationEventPublisher适用于此目的:spring-doc.cadn.net.cn

@Bean
public AuthenticationEventPublisher authenticationEventPublisher
        (ApplicationEventPublisher applicationEventPublisher) {
    return new DefaultAuthenticationEventPublisher(applicationEventPublisher);
}
@Bean
fun authenticationEventPublisher
        (applicationEventPublisher: ApplicationEventPublisher?): AuthenticationEventPublisher {
    return DefaultAuthenticationEventPublisher(applicationEventPublisher)
}

然后你可以使用 Spring 的@EventListener支持:spring-doc.cadn.net.cn

@Component
public class AuthenticationEvents {
	@EventListener
    public void onSuccess(AuthenticationSuccessEvent success) {
		// ...
    }

    @EventListener
    public void onFailure(AbstractAuthenticationFailureEvent failures) {
		// ...
    }
}
@Component
class AuthenticationEvents {
    @EventListener
    fun onSuccess(success: AuthenticationSuccessEvent?) {
        // ...
    }

    @EventListener
    fun onFailure(failures: AbstractAuthenticationFailureEvent?) {
        // ...
    }
}

虽然与AuthenticationSuccessHandlerAuthenticationFailureHandler,这些都很好,因为它们可以独立于 servlet API 使用。spring-doc.cadn.net.cn

添加异常映射

默认情况下,DefaultAuthenticationEventPublisher发布AuthenticationFailureEvent对于以下事件:spring-doc.cadn.net.cn

例外spring-doc.cadn.net.cn

事件spring-doc.cadn.net.cn

BadCredentialsExceptionspring-doc.cadn.net.cn

AuthenticationFailureBadCredentialsEventspring-doc.cadn.net.cn

UsernameNotFoundExceptionspring-doc.cadn.net.cn

AuthenticationFailureBadCredentialsEventspring-doc.cadn.net.cn

AccountExpiredExceptionspring-doc.cadn.net.cn

AuthenticationFailureExpiredEventspring-doc.cadn.net.cn

ProviderNotFoundExceptionspring-doc.cadn.net.cn

AuthenticationFailureProviderNotFoundEventspring-doc.cadn.net.cn

DisabledExceptionspring-doc.cadn.net.cn

AuthenticationFailureDisabledEventspring-doc.cadn.net.cn

LockedExceptionspring-doc.cadn.net.cn

AuthenticationFailureLockedEventspring-doc.cadn.net.cn

AuthenticationServiceExceptionspring-doc.cadn.net.cn

AuthenticationFailureServiceExceptionEventspring-doc.cadn.net.cn

CredentialsExpiredExceptionspring-doc.cadn.net.cn

AuthenticationFailureCredentialsExpiredEventspring-doc.cadn.net.cn

InvalidBearerTokenExceptionspring-doc.cadn.net.cn

AuthenticationFailureBadCredentialsEventspring-doc.cadn.net.cn

发布者会执行精确的Exceptionmatch,这意味着这些异常的子类不会同时生成事件。spring-doc.cadn.net.cn

为此,您可能希望通过setAdditionalExceptionMappings方法:spring-doc.cadn.net.cn

@Bean
public AuthenticationEventPublisher authenticationEventPublisher
        (ApplicationEventPublisher applicationEventPublisher) {
    Map<Class<? extends AuthenticationException>,
        Class<? extends AbstractAuthenticationFailureEvent>> mapping =
            Collections.singletonMap(FooException.class, FooEvent.class);
    AuthenticationEventPublisher authenticationEventPublisher =
        new DefaultAuthenticationEventPublisher(applicationEventPublisher);
    authenticationEventPublisher.setAdditionalExceptionMappings(mapping);
    return authenticationEventPublisher;
}
@Bean
fun authenticationEventPublisher
        (applicationEventPublisher: ApplicationEventPublisher?): AuthenticationEventPublisher {
    val mapping: Map<Class<out AuthenticationException>, Class<out AbstractAuthenticationFailureEvent>> =
            mapOf(Pair(FooException::class.java, FooEvent::class.java))
    val authenticationEventPublisher = DefaultAuthenticationEventPublisher(applicationEventPublisher)
    authenticationEventPublisher.setAdditionalExceptionMappings(mapping)
    return authenticationEventPublisher
}

默认事件

您还可以提供一个 catch-all 事件,以便在出现任何AuthenticationException:spring-doc.cadn.net.cn

@Bean
public AuthenticationEventPublisher authenticationEventPublisher
        (ApplicationEventPublisher applicationEventPublisher) {
    AuthenticationEventPublisher authenticationEventPublisher =
        new DefaultAuthenticationEventPublisher(applicationEventPublisher);
    authenticationEventPublisher.setDefaultAuthenticationFailureEvent
        (GenericAuthenticationFailureEvent.class);
    return authenticationEventPublisher;
}
@Bean
fun authenticationEventPublisher
        (applicationEventPublisher: ApplicationEventPublisher?): AuthenticationEventPublisher {
    val authenticationEventPublisher = DefaultAuthenticationEventPublisher(applicationEventPublisher)
    authenticationEventPublisher.setDefaultAuthenticationFailureEvent(GenericAuthenticationFailureEvent::class.java)
    return authenticationEventPublisher
}