跳到主要内容

基于Session的登录流程实现

在项目实战中，登录功能是许多应用程序的核心组成部分。本文将深入探讨黑马点评项目中基于 Session 实现的登录流程、登录拦截以及 Session 共享等关键功能，

基于Session实现登录流程​

短信登录流程：

1.发送验证码​

  • 用户提交手机号后，首先校验手机号的合法性。若手机号不合法，要求用户重新输入。
  • 若手机号合法，后台生成对应的验证码，并将其保存到 Session 中。同时，通过短信方式将验证码发送给用户。
@Override
public Result sendCode(String phone, HttpSession session) {
    //校验 手机号
    if (RegexUtils.isPhoneInvalid(phone)) {
        //不符合
        return Result.fail("手机号格式不正确");
    }
    //生成验证码
    String code = RandomUtil.randomNumbers(6);
    //保存到session
    session.setAttribute("code", code);
    //发送验证码
    log.debug("手机号：{}，验证码：{}", phone, code);
    return Result.ok();
}

2.短信验证码登录、注册​

  • 用户输入验证码和手机号后，后台从 Session 中获取当前验证码，并与用户输入的验证码进行校验。若不一致，则无法通过校验。
  • 若校验一致，后台根据手机号查询用户。若用户不存在，则为用户创建账号信息并保存到数据库。无论用户是否存在，都会将用户信息保存到 Session 中，以便后续获取当前登录信息。
@Override
public Result login(LoginFormDTO loginForm, HttpSession session) {
    //校验手机号
    String phone = loginForm.getPhone();
    if (RegexUtils.isPhoneInvalid(phone)) {
        //不符合
        return Result.fail("手机号格式不正确");
    }
    //校验验证码
    Object hasSendCode = session.getAttribute("code");
    String code = loginForm.getCode();
    if (hasSendCode == null || !hasSendCode.toString().equals(code)) {
        return Result.fail("验证码不正确");
    }
    //校验通过，查询用户
    User user = this.query().eq("phone", phone).one();
    if (user == null) {
        user = createUserWithPhone(phone);
    }
    //保存用户信息到session
    session.setAttribute("user", user);
    return Result.ok();
}

private User createUserWithPhone(String phone) {
    User user = new User();
    user.setPhone(phone);
    user.setNickName(USER_NICK_NAME_PREFIX + RandomUtil.randomString(10));
    this.save(user);
    return user;
}

3.校验登录状态​

用户在请求接口时，系统会从客户端的Cookie中获取JSessionId，通过该JSessionId在Session中寻找用户信息。为了提升安全性，可以定期检查Session的有效性，避免用户长期不操作导致Session过期。

可以在拦截器中完成这一操作：

登录拦截器LoginInterceptor用于在用户请求时检查登录状态。

public class LoginInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        //获取Session
        HttpSession session = request.getSession();
        //获取用户信息
        Object user = session.getAttribute("user");
        if (user == null) {
            //不存在，拦截，返回401状态码
            response.setStatus(401);
            return false;
        }
        //存在，保存到ThreadLocal中
        UserHolder.saveUser((UserDTO) user);
        return true;
    }
}

配置拦截器生效：在配置类MvcConfig中，将登录拦截器添加到拦截器注册表中，并指定排除的路径模式，即不需要拦截的路径。

@Configuration
public class MvcConfig implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LoginInterceptor())
                .excludePathPatterns("/shop/**",
                        "/shop/**",
                        "/voucher/**",
                        "/shop-type/**",
                        "/upload/**",
                        "/blog/hot",
                        "/user/code",
                        "/user/login"
                );
    }
}

具体的UserHolder:

public class UserHolder {
    private static final ThreadLocal<UserDTO> tl = new ThreadLocal<>();

    public static void saveUser(UserDTO user){
        tl.set(user);
    }

    public static UserDTO getUser(){
        return tl.get();
    }

    public static void removeUser(){
        tl.remove();
    }
}

完整的流程：

1653066208144.png

分布式Session​

Session 通常存储在 Tomcat 服务器中，但当后端有多个 Tomcat 服务器时，实现数据共享会变得困难。早期的解决方法是将 Session 拷贝到不同的 Tomcat 服务器上，但这种方式效率较低且复杂。现在，借助 Redis 可以更优雅地解决 Session 共享问题，有两种存储方式：使用 String 存储和使用哈希存储。这里选择哈希存储

1653319261433.png

  1. 设计思路：选择使用哈希存储时，设计 key 的时候可以随机生成一个 token 给前端，让前端带着 token 来访问后端。
  2. 整体流程：
  • 用户发送请求，后端根据 token 从 Redis 中获取用户信息，
  • 如果用户信息存在，则进行后续处理，否则拦截请求。

1653319474181.png

修改后的代码如下：

    // 修改发送验证码逻辑，保存到redis
    @Override
    public Result sendCode(String phone, HttpSession session) {
        // 校验手机号
        if (RegexUtils.isPhoneInvalid(phone)) {
            // 不符合
            return Result.fail("手机号格式不正确");
        }
        // 生成验证码
        String code = RandomUtil.randomNumbers(6);
        // 保存到redis
        stringRedisTemplate.opsForValue().set(LOGIN_CODE_KEY + phone, code, LOGIN_CODE_TTL, TimeUnit.MINUTES);
        // 发送验证码
        log.debug("手机号：{}，验证码：{}", phone, code);
        return Result.ok();
    }

    // 修改登录逻辑，从redis读数据
    @Override
    public Result login(LoginFormDTO loginForm, HttpSession session) {
        // 校验手机号
        String phone = loginForm.getPhone();
        if (RegexUtils.isPhoneInvalid(phone)) {
            // 不符合
            return Result.fail("手机号格式不正确");
        }
        // 从redis中获取验证码
        String hasSendCode = stringRedisTemplate.opsForValue().get(LOGIN_CODE_KEY + phone);
        String code = loginForm.getCode();
        if (hasSendCode == null ||!hasSendCode.toString().equals(code)) {
            return Result.fail("验证码不正确");
        }
        // 校验通过，查询用户
        User user = this.query().eq("phone", phone).one();
        if (user == null) {
            user = createUserWithPhone(phone);
        }
        // 保存用户信息到redis中
        // 生成token
        String token = UUID.randomUUID().toString();
        // 将User对象转为HashMap存储
        UserDTO userDTO = BeanUtil.copyProperties(user, UserDTO.class);
        Map<String, Object> userMap = BeanUtil.beanToMap(userDTO, new HashMap<>(),
                CopyOptions.create()
                      .setIgnoreNullValue(true)
                      .setFieldValueEditor((fieldName, fieldvalue) -> fieldvalue.toString())
        );
        // 存储
        String toKenKey = LOGIN_USER_KEY + token;
        stringRedisTemplate.opsForHash().putAll(toKenKey, userMap);
        // 设置有效期
        stringRedisTemplate.expire(toKenKey, LOGIN_USER_TTL, TimeUnit.MINUTES);
        return Result.ok(token);
    }

登录状态刷新问题​

当前的拦截机制存在一个问题：如果访问不需要拦截的路径，拦截器不会生效，此时不会刷新令牌，可能导致登录状态过期。

1653320822964.png

优化方案：再添加一个拦截器RefreshTokenInterceptor，拦截所有请求。

1653320764547.png

代码如下：

    public class RefreshTokenInterceptor implements HandlerInterceptor {
        private StringRedisTemplate stringRedisTemplate;
        // 这里的构造方法是为了注入StringRedisTemplate，
        // 因为 RefreshTokenInterceptor 是自己 new 出来的，不是 Spring 管理的
        public RefreshTokenInterceptor(StringRedisTemplate stringRedisTemplate) {
            this.stringRedisTemplate = stringRedisTemplate;
        }
        @Override
        public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
            // 获取请求头中的token
            String token = request.getHeader("authorization");
            if (StrUtil.isBlank(token)) {
                return true;
            }
            // 获取redis中的用户
            String key = LOGIN_USER_KEY + token;
            Map<Object, Object> userMap = stringRedisTemplate.opsForHash().entries(key);
            if (userMap.isEmpty()) {
                // 用户不存在
                return true;
            }
            // 将hash数据转为UserDTO
            UserDTO userDTO = BeanUtil.fillBeanWithMap(userMap, new UserDTO(), false);
            // 保存到ThreadLocal中
            UserHolder.saveUser(userDTO);
            // 刷新token有效期
            stringRedisTemplate.expire(key, LOGIN_USER_TTL, java.util.concurrent.TimeUnit.DAYS);
            return true;
        }
        @Override
        public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
            // 清空ThreadLocal中的数据  防止内存泄漏
            UserHolder.removeUser();
        }

登录拦截器修改：修改登录拦截器LoginInterceptor，使其仅在UserHolder中没有用户时进行拦截。

    public class LoginInterceptor implements HandlerInterceptor {
        @Override
        public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
            if (UserHolder.getUser() == null) {
                // 不存在，拦截，返回401状态码
                response.setStatus(401);
                return false;
            }
            // 有用户
            return true;
        }

至此，黑马点评的登录逻辑完成。通过对登录流程的优化，包括使用 Redis 解决 Session 共享问题和添加拦截器解决登录状态刷新问题，提高了系统的稳定性和扩展性，使其能够更好地满足实际应用的需求。在实际工作中，我们需要不断深入理解业务需求，选择合适的技术方案，并对系统进行持续优化和改进，以确保系统的性能和用户体验。

0%