表单登录 - 表单登录配置 - 配置表单登录页面

Java - Web - Spring 《表单登录 - 表单登录配置 - 配置表单登录页面》

一、引言

在 Web 应用开发中，用户登录是一个非常常见且重要的功能。Spring 框架为我们提供了强大的安全支持，使得实现表单登录变得相对简单。本文将详细介绍如何在 Spring 项目中配置表单登录页面，包括必要的依赖、配置步骤以及示例代码。

二、项目准备

2.1 添加依赖

首先，我们需要在 pom.xml 中添加 Spring Security 的依赖。以下是一个基本的 Maven 依赖示例：

<dependencies>
    <!-- Spring Web -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <!-- Spring Security -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-security</artifactId>
    </dependency>
</dependencies>

2.2 创建 Spring Boot 项目

可以使用 Spring Initializr（https://start.spring.io/）快速创建一个 Spring Boot 项目，选择上述依赖后下载并导入到 IDE 中。

三、配置表单登录

3.1 创建自定义登录页面

在 src/main/resources/templates 目录下创建一个名为 login.html 的文件，内容如下：

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <title>Login Page</title>
</head>
<body>
    <h1>Login</h1>
    <form action="#" th:action="@{/login}" th:method="post">
        <label for="username">Username:</label>
        <input type="text" id="username" name="username" required><br><br>
        <label for="password">Password:</label>
        <input type="password" id="password" name="password" required><br><br>
        <input type="submit" value="Login">
    </form>
    <p th:if="${param.error}" style="color: red;">Invalid username or password.</p>
    <p th:if="${param.logout}" style="color: green;">You have been logged out successfully.</p>
</body>
</html>

这个页面包含一个简单的表单，用于输入用户名和密码，并提交到 /login 路径。同时，它还处理了登录失败和登出成功的提示信息。

3.2 配置 Spring Security

创建一个配置类来配置 Spring Security，以下是示例代码：

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
import org.springframework.security.web.SecurityFilterChain;
@Configuration
@EnableWebSecurity
public class SecurityConfig {
    @Bean
    public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception {
        http
          .authorizeRequests()
              .antMatchers("/login").permitAll()
              .anyRequest().authenticated()
              .and()
          .formLogin()
              .loginPage("/login")
              .defaultSuccessUrl("/home")
              .permitAll()
              .and()
          .logout()
              .permitAll();
        return http.build();
    }
}

在这个配置类中，我们做了以下几件事情：

允许所有用户访问 /login 页面。
要求所有其他请求都需要进行身份验证。
指定自定义的登录页面为 /login。
登录成功后默认重定向到 /home 页面。
允许所有用户进行登出操作。

3.3 创建主页和控制器

在 src/main/resources/templates 目录下创建一个名为 home.html 的文件，内容如下：

<!DOCTYPE html>
<html>
<head>
    <title>Home Page</title>
</head>
<body>
    <h1>Welcome to the Home Page!</h1>
    <a href="/logout">Logout</a>
</body>
</html>

创建一个控制器来处理 /home 请求：

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
@Controller
public class HomeController {
    @GetMapping("/home")
    public String home() {
        return "home";
    }
}

四、运行项目

启动 Spring Boot 应用程序，访问 http://localhost:8080/login，你将看到自定义的登录页面。输入用户名和密码进行登录，如果登录成功，将重定向到主页；如果登录失败，将显示错误信息。

五、总结

步骤	操作	说明
1	添加依赖	在 `pom.xml` 中添加 Spring Web 和 Spring Security 依赖
2	创建自定义登录页面	在 `templates` 目录下创建 `login.html` 文件
3	配置 Spring Security	创建 `SecurityConfig` 类，指定登录页面和访问规则
4	创建主页和控制器	在 `templates` 目录下创建 `home.html` 文件，并创建 `HomeController` 处理 `/home` 请求

通过以上步骤，我们成功地在 Spring 项目中配置了自定义的表单登录页面。Spring Security 为我们提供了便捷的方式来实现用户认证和授权，让我们能够专注于业务逻辑的开发。希望本文对你有所帮助！