表单登录

Spring Security 提供了通过 HTML 表单提供用户名和密码的支持。本节详细介绍了基于表单的身份验证在 Spring Security 中的工作原理。

本节探讨了基于表单的登录在 Spring Security 中的工作原理。首先，我们了解用户如何被重定向到登录表单。

图 1. 重定向到登录页面

上图基于我们 SecurityFilterChain 图表。

number 1 首先，用户向其未经授权的资源（/private）发出未经身份验证的请求。

number 2 Spring Security 的 AuthorizationFilter 通过抛出 AccessDeniedException 指示未经身份验证的请求被拒绝。

number 3 由于用户未经身份验证，ExceptionTranslationFilter 启动开始身份验证，并使用配置的 AuthenticationEntryPoint 发送重定向到登录页面。在大多数情况下，AuthenticationEntryPoint 是 LoginUrlAuthenticationEntryPoint 的实例。

number 4 浏览器请求它被重定向到的登录页面。

number 5 应用程序内部必须渲染登录页面。

当用户名和密码提交后，UsernamePasswordAuthenticationFilter会验证用户名和密码。UsernamePasswordAuthenticationFilter继承了AbstractAuthenticationProcessingFilter，因此下面的图表看起来应该很相似。

图 2. 验证用户名和密码

此图基于我们SecurityFilterChain 图表。

number 1 当用户提交用户名和密码时，UsernamePasswordAuthenticationFilter会从HttpServletRequest实例中提取用户名和密码，并创建一个UsernamePasswordAuthenticationToken，它是一种Authentication类型。

number 2 接下来，UsernamePasswordAuthenticationToken被传递到AuthenticationManager实例中进行验证。AuthenticationManager的具体实现取决于用户信息存储方式。

number 3 如果验证失败，则失败。

SecurityContextHolder被清空。
RememberMeServices.loginFail被调用。如果未配置记住我功能，则此操作为空操作。请参阅Javadoc中的RememberMeServices接口。
AuthenticationFailureHandler被调用。请参阅Javadoc中的AuthenticationFailureHandler类。

number 4 如果验证成功，则成功。

SessionAuthenticationStrategy被通知新的登录。请参阅Javadoc中的SessionAuthenticationStrategy接口。
Authentication被设置到SecurityContextHolder上。请参阅Javadoc中的SecurityContextPersistenceFilter类。
RememberMeServices.loginSuccess 方法被调用。如果未配置“记住我”功能，则此方法不会执行任何操作。有关详细信息，请参阅 Javadoc 中的 RememberMeServices 接口。
ApplicationEventPublisher 发布一个 InteractiveAuthenticationSuccessEvent 事件。
AuthenticationSuccessHandler 被调用。通常，这是一个 SimpleUrlAuthenticationSuccessHandler，它会重定向到由 ExceptionTranslationFilter 在我们重定向到登录页面时保存的请求。

默认情况下，Spring Security 启用表单登录。但是，一旦提供任何基于 Servlet 的配置，就必须显式提供基于表单的登录。以下示例展示了一个最小的显式 Java 配置

表单登录

Java
XML
Kotlin

public SecurityFilterChain filterChain(HttpSecurity http) {
	http
		.formLogin(withDefaults());
	// ...
}

<http>
	<!-- ... -->
	<form-login />
</http>

open fun filterChain(http: HttpSecurity): SecurityFilterChain {
	http {
		formLogin { }
	}
	// ...
}

在上述配置中，Spring Security 会渲染一个默认的登录页面。大多数生产应用程序都需要自定义登录表单。

以下配置演示了如何提供自定义登录表单。

自定义登录表单配置

Java
XML
Kotlin

public SecurityFilterChain filterChain(HttpSecurity http) {
	http
		.formLogin(form -> form
			.loginPage("/login")
			.permitAll()
		);
	// ...
}

<http>
	<!-- ... -->
	<intercept-url pattern="/login" access="permitAll" />
	<form-login login-page="/login" />
</http>

open fun filterChain(http: HttpSecurity): SecurityFilterChain {
	http {
		formLogin {
			loginPage = "/login"
			permitAll()
		}
	}
	// ...
}

当在 Spring Security 配置中指定登录页面时，您需要负责渲染该页面。以下 Thymeleaf 模板会生成一个符合 /login 登录页面的 HTML 登录表单。

登录表单 - src/main/resources/templates/login.html

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:th="https://www.thymeleaf.org">
	<head>
		<title>Please Log In</title>
	</head>
	<body>
		<h1>Please Log In</h1>
		<div th:if="${param.error}">
			Invalid username and password.</div>
		<div th:if="${param.logout}">
			You have been logged out.</div>
		<form th:action="@{/login}" method="post">
			<div>
			<input type="text" name="username" placeholder="Username"/>
			</div>
			<div>
			<input type="password" name="password" placeholder="Password"/>
			</div>
			<input type="submit" value="Log in" />
		</form>
	</body>
</html>

关于默认 HTML 表单，有几个关键点需要注意

表单应该执行一个 post 请求到 /login。
表单需要包含一个 CSRF 令牌，该令牌由 Thymeleaf 自动包含。
表单应该在名为 username 的参数中指定用户名。
表单应该在名为 password 的参数中指定密码。
如果找到名为 error 的 HTTP 参数，则表示用户未能提供有效的用户名或密码。
如果找到名为 logout 的 HTTP 参数，则表示用户已成功注销。

许多用户只需要自定义登录页面。但是，如果需要，您可以使用其他配置自定义前面显示的所有内容。

如果您使用 Spring MVC，则需要一个将 GET /login 映射到我们创建的登录模板的控制器。以下示例展示了一个最小的 LoginController

登录控制器

Java
Kotlin

@Controller
class LoginController {
	@GetMapping("/login")
	String login() {
		return "login";
	}
}

@Controller
class LoginController {
    @GetMapping("/login")
    fun login(): String {
        return "login"
    }
}