记住我功能 - 记住我配置 - 实现记住登录状态

Java - Web - Spring 《记住我功能 - 记住我配置 - 实现记住登录状态》

在Web应用开发中，“记住我”功能是一个非常实用的特性，它允许用户在下次访问网站时无需再次输入用户名和密码即可自动登录。在Spring框架中，实现“记住我”功能相对简单，本文将详细介绍如何在Spring Security中配置并实现“记住我”功能。

1. 项目环境准备

首先，我们需要创建一个基于Spring Boot和Spring Security的Web项目。可以使用Spring Initializr（https://start.spring.io/）来快速创建项目，添加以下依赖：

Spring Web
Spring Security

2. 配置Spring Security实现“记住我”功能

2.1 配置SecurityConfig类

创建一个配置类 SecurityConfig，继承自 WebSecurityConfigurerAdapter，并在其中配置“记住我”功能。以下是示例代码：

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.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;
import org.springframework.security.crypto.password.PasswordEncoder;
@Configuration
@EnableWebSecurity
public class SecurityConfig extends WebSecurityConfigurerAdapter {
    @Bean
    public PasswordEncoder passwordEncoder() {
        return new BCryptPasswordEncoder();
    }
    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http
          .authorizeRequests()
              .antMatchers("/public/**").permitAll() // 允许访问公共资源
              .anyRequest().authenticated() // 其他请求需要认证
              .and()
          .formLogin()
              .loginPage("/login") // 自定义登录页面
              .permitAll()
              .and()
          .logout()
              .permitAll()
              .and()
          .rememberMe()
              .key("uniqueAndSecret") // 密钥，用于加密cookie
              .tokenValiditySeconds(86400); // 记住我功能的有效期，单位为秒，这里设置为1天
    }
}

代码解释：

passwordEncoder()：创建一个 BCryptPasswordEncoder 实例，用于对密码进行加密。
configure(HttpSecurity http)：配置Spring Security的安全规则。
- authorizeRequests()：定义请求的访问权限。
- formLogin()：启用表单登录，并指定自定义登录页面。
- logout()：启用注销功能。
- rememberMe()：启用“记住我”功能，设置密钥和有效期。

2.2 创建登录页面

在 src/main/resources/templates 目录下创建 login.html 文件，添加一个“记住我”的复选框。示例代码如下：

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Login Page</title>
</head>
<body>
    <h1>Login</h1>
    <form action="/login" method="post">
        <label for="username">Username:</label>
        <input type="text" id="username" name="username" required><br>
        <label for="password">Password:</label>
        <input type="password" id="password" name="password" required><br>
        <input type="checkbox" id="remember-me" name="remember-me">
        <label for="remember-me">Remember Me</label><br>
        <input type="submit" value="Login">
    </form>
</body>
</html>

代码解释：

form 表单的 action 属性指向 /login，这是Spring Security默认的登录处理URL。
remember-me 复选框用于让用户选择是否启用“记住我”功能。

2.3 创建控制器

创建一个控制器类 LoginController，用于处理登录页面的请求。示例代码如下：

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

代码解释：

@GetMapping("/login")：处理 /login 请求，返回 login.html 页面。

3. 测试“记住我”功能

启动Spring Boot应用程序，访问 http://localhost:8080/login，输入用户名和密码，并勾选“Remember Me”复选框，然后点击“Login”按钮进行登录。登录成功后，关闭浏览器，再次打开浏览器并访问受保护的页面，此时应该会自动登录。

4. 总结

步骤	描述
1	配置 `SecurityConfig` 类，启用“记住我”功能，设置密钥和有效期。
2	创建 `login.html` 页面，添加“记住我”复选框。
3	创建 `LoginController` 类，处理登录页面的请求。

通过以上步骤，我们成功在Spring Security中实现了“记住我”功能，让用户可以方便地保持登录状态。

希望本文对你理解和实现Spring Security的“记住我”功能有所帮助。如果你有任何问题或建议，欢迎留言讨论。