第十三章 Redis短信登录实战（基于Redis）

于 2024-10-06 13:51:08 发布
阅读量601 收藏 12
点赞数 14
分类专栏： Redis 文章标签： redis 数据库 缓存
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qushaming/article/details/142725721
版权

目录

一、概述

1.1. Session复制

1.2. 使用Redis

二、基于Redis实现共享Session登录 

2.1. 实现思路

2.2. 功能实现的主要代码

2.2.1. 用户业务接口

2.2.2. 用户业务接口实现类 

2.2.3. 用户控制层 

 2.2.4. 登录拦截器

2.2.5. 拦截器配置类 

2.3. 优化登录拦截器

 

完整的项目资源共享地址，当中包含了代码、资源文件以及Nginx（Windows版）和完整的配置：

链接：https://pan.quark.cn/s/5c28484d7882
提取码：cJxQ

一、概述

分布式集群的Session共享问题是多台Tomcat并不共享session存储空间，当请求切换到不同tomcat的服务时会导致数据丢失问题。

1.1. Session复制

在早期比较普遍的解决方案是通过Session复制，该方案的主要问题体现在以下几方面：

  1. 性能瓶颈：通过减少Session复制的频率来提高性能，例如使用基于时间的Session失效策略来复制，而不是在每次Session更新时复制。

  2. 数据一致性问题：使用更强一致性的机制来保证数据的一致性，例如使用分布式事务管理，或者通过合理的操作顺序来保证数据的一致性。

  3. 内存占用：通过使用更高效的序列化机制来减少Session数据占用的内存大小。

  4. 配置管理复杂度高：通过集中式Session存储来简化配置，例如使用分布式缓存（如Redis、Memcached）或者数据库来存储Session信息。

    具体实现代码取决于所使用的技术栈和架构。在Java环境中，可以使用Tomcat提供的Session管理器，或者集成Redis这样的第三方缓存服务来解决Session复制的问题。

1.2. 使用Redis

使用Redis作为Session共享，是比较成熟和理想的方案，能够满足Session数据的共享、且通过内存以及键值对的形式进行存储，更高效且便捷。

二、基于Redis实现共享Session登录 

2.1. 实现思路

1. 通过Redis实现共享Session登录的关键点是将手机号和验证码作为键值对存入Redis，并将登录的令牌token和用户信息作为键值对存入Redis：

 2. 存储用户信息更推荐使用Hash ：

2.2. 功能实现的主要代码

2.2.1. 用户业务接口

package com.hmdp.service;

import com.baomidou.mybatisplus.extension.service.IService;
import com.hmdp.dto.LoginFormDTO;
import com.hmdp.dto.Result;
import com.hmdp.entity.User;
import javax.servlet.http.HttpSession;

public interface IUserService extends IService<User> {

    Result sendCode(String phone, HttpSession session);

    Result login(LoginFormDTO loginForm, HttpSession session);

}

2.2.2. 用户业务接口实现类 

package com.hmdp.service.impl;

import cn.hutool.core.bean.BeanUtil;
import cn.hutool.core.bean.copier.CopyOptions;
import cn.hutool.core.lang.UUID;
import cn.hutool.core.util.RandomUtil;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.hmdp.dto.LoginFormDTO;
import com.hmdp.dto.Result;
import com.hmdp.dto.UserDTO;
import com.hmdp.entity.User;
import com.hmdp.mapper.UserMapper;
import com.hmdp.service.IUserService;
import com.hmdp.utils.RegexUtils;
import lombok.extern.slf4j.Slf4j;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.stereotype.Service;
import javax.annotation.Resource;
import javax.servlet.http.HttpSession;
import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.TimeUnit;
import static com.hmdp.utils.RedisConstants.*;
import static com.hmdp.utils.SystemConstants.USER_NICK_NAME_PREFIX;

@Slf4j
@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements IUserService {

    @Resource
    private StringRedisTemplate stringRedisTemplate;

    @Override
    public Result sendCode(String phone, HttpSession session) {
        // 1.校验手机号
        if (RegexUtils.isPhoneInvalid(phone)) {
            // 2.如果不符合，返回错误信息
            return Result.fail("手机号格式错误！");
        }
        // 3.符合，生成验证码
        String code = RandomUtil.randomNumbers(6);

        // 4.保存验证码到 session
        stringRedisTemplate.opsForValue().set(LOGIN_CODE_KEY + phone, code, LOGIN_CODE_TTL, TimeUnit.MINUTES);

        // 5.发送验证码
        log.debug("发送短信验证码成功，验证码：{}", code);
        // 返回ok
        return Result.ok();
    }

    @Override
    public Result login(LoginFormDTO loginForm, HttpSession session) {
        // 1.校验手机号
        String phone = loginForm.getPhone();
        if (RegexUtils.isPhoneInvalid(phone)) {
            // 2.如果不符合，返回错误信息
            return Result.fail("手机号格式错误！");
        }
        // 3.从redis获取验证码并校验
        String cacheCode = stringRedisTemplate.opsForValue().get(LOGIN_CODE_KEY + phone);
        String code = loginForm.getCode();
        if (cacheCode == null || !cacheCode.equals(code)) {
            // 不一致，报错
            return Result.fail("验证码错误");
        }

        // 4.一致，根据手机号查询用户 select * from tb_user where phone = ?
        User user = query().eq("phone", phone).one();

        // 5.判断用户是否存在
        if (user == null) {
            // 6.不存在，创建新用户并保存
            user = createUserWithPhone(phone);
        }

        // 7.保存用户信息到 redis中
        // 7.1.随机生成token，作为登录令牌
        String token = UUID.randomUUID().toString(true);
        // 7.2.将User对象转为HashMap存储
        UserDTO userDTO = BeanUtil.copyProperties(user, UserDTO.class);
        // StringRedisTemplate的key value必须是String型，因此需要做自定义类型转换
        Map<String, Object> userMap = BeanUtil.beanToMap(userDTO, new HashMap<>(),
                CopyOptions.create()
                        // true 忽略空的值
                        .setIgnoreNullValue(true)
                        // 字段值修改器，对字段值进行修改
                        .setFieldValueEditor((fieldName, fieldValue) -> fieldValue.toString()));
        // 7.3.存储
        String tokenKey = LOGIN_USER_KEY + token;
        stringRedisTemplate.opsForHash().putAll(tokenKey, userMap);
        // 7.4.设置token有效期
        stringRedisTemplate.expire(tokenKey, LOGIN_USER_TTL, TimeUnit.MINUTES);

        // 8.返回token
        return Result.ok(token);
    }

    private User createUserWithPhone(String phone) {
        // 1.创建用户
        User user = new User();
        user.setPhone(phone);
        user.setNickName(USER_NICK_NAME_PREFIX + RandomUtil.randomString(10));
        // 2.保存用户
        save(user);
        return user;
    }
}

2.2.3. 用户控制层 

package com.hmdp.controller;


import com.hmdp.dto.LoginFormDTO;
import com.hmdp.dto.Result;
import com.hmdp.dto.UserDTO;
import com.hmdp.service.IUserService;
import com.hmdp.utils.UserHolder;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.*;
import javax.annotation.Resource;
import javax.servlet.http.HttpSession;

@Slf4j
@RestController
@RequestMapping("/user")
public class UserController {

    @Resource
    private IUserService userService;

    /**
     * 发送手机验证码
     */
    @PostMapping("code")
    public Result sendCode(@RequestParam("phone") String phone, HttpSession session) {
        // 发送短信验证码并保存验证码
        return userService.sendCode(phone, session);
    }

    /**
     * 登录功能
     * @param loginForm 登录参数，包含手机号、验证码；或者手机号、密码
     */
    @PostMapping("/login")
    public Result login(@RequestBody LoginFormDTO loginForm, HttpSession session){
        // 实现登录功能
        return userService.login(loginForm, session);
    }

    @GetMapping("/me")
    public Result me(){
        // 获取当前登录的用户并返回
        UserDTO user = UserHolder.getUser();
        return Result.ok(user);
    }
}

 2.2.4. 登录拦截器

通过拦截器实现登录用户每次访问都会触发刷新 token有效期的操作：

package com.hmdp.utils;

import cn.hutool.core.bean.BeanUtil;
import cn.hutool.core.util.StrUtil;
import com.hmdp.dto.UserDTO;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.web.servlet.HandlerInterceptor;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.Map;
import java.util.concurrent.TimeUnit;
import static com.hmdp.utils.RedisConstants.LOGIN_USER_KEY;
import static com.hmdp.utils.RedisConstants.LOGIN_USER_TTL;

public class LoginInterceptor implements HandlerInterceptor {
    
    private StringRedisTemplate stringRedisTemplate;

    public LoginInterceptor(StringRedisTemplate stringRedisTemplate) {
        this.stringRedisTemplate = stringRedisTemplate;
    }

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 1.获取请求头中的token
        String token = request.getHeader("authorization");
        if (StrUtil.isBlank(token)) {
            // 不存在 拦截 返回401状态码
            response.setStatus(401);
            return false;
        }
        // 2.基于TOKEN获取redis中的用户
        String key  = LOGIN_USER_KEY + token;
        Map<Object, Object> userMap = stringRedisTemplate.opsForHash().entries(key);
        // 3.判断用户是否存在
        if (userMap.isEmpty()) {
            // 不存在 拦截 返回401状态码
            response.setStatus(401);
            return false;
        }
        // 5.将查询到的hash数据转为UserDTO
        UserDTO userDTO = BeanUtil.fillBeanWithMap(userMap, new UserDTO(), false);
        // 6.存在，保存用户信息到 ThreadLocal
        UserHolder.saveUser(userDTO);
        // 7.刷新token有效期
        stringRedisTemplate.expire(key, LOGIN_USER_TTL, TimeUnit.MINUTES);
        // 8.放行
        return true;
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // 移除用户
        UserHolder.removeUser();
    }
}

2.2.5. 拦截器配置类 

package com.hmdp.config;

import com.hmdp.utils.LoginInterceptor;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import javax.annotation.Resource;

@Configuration
public class MvcConfig implements WebMvcConfigurer {

    @Resource
    private StringRedisTemplate stringRedisTemplate;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 登录拦截器
        registry.addInterceptor(new LoginInterceptor(stringRedisTemplate))
                .excludePathPatterns(
                        "/shop/**",
                        "/voucher/**",
                        "/shop-type/**",
                        "/upload/**",
                        "/blog/hot",
                        "/user/code",
                        "/user/login"
                ).order(1);
    }
}

2.3. 优化登录拦截器

上面的拦截器代码逻辑有个问题是，登录用户如果一直访问一些不需要登录的页面，token依然不会刷新。对此，我们需要做如下的代码优化：

package com.hmdp.utils;

import org.springframework.web.servlet.HandlerInterceptor;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class LoginInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 1.判断是否需要拦截（ThreadLocal中是否有用户）
        if (UserHolder.getUser() == null) {
            // 没有，需要拦截，设置状态码
            response.setStatus(401);
            // 拦截
            return false;
        }
        // 有用户，则放行
        return true;
    }
}

package com.hmdp.utils;

import cn.hutool.core.bean.BeanUtil;
import cn.hutool.core.util.StrUtil;
import com.hmdp.dto.UserDTO;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.web.servlet.HandlerInterceptor;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.Map;
import java.util.concurrent.TimeUnit;

import static com.hmdp.utils.RedisConstants.LOGIN_USER_KEY;
import static com.hmdp.utils.RedisConstants.LOGIN_USER_TTL;

public class RefreshTokenInterceptor implements HandlerInterceptor {

    private StringRedisTemplate stringRedisTemplate;

    public RefreshTokenInterceptor(StringRedisTemplate stringRedisTemplate) {
        this.stringRedisTemplate = stringRedisTemplate;
    }

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 1.获取请求头中的token
        String token = request.getHeader("authorization");
        if (StrUtil.isBlank(token)) {
            return true;
        }
        // 2.基于TOKEN获取redis中的用户
        String key  = LOGIN_USER_KEY + token;
        Map<Object, Object> userMap = stringRedisTemplate.opsForHash().entries(key);
        // 3.判断用户是否存在
        if (userMap.isEmpty()) {
            return true;
        }
        // 5.将查询到的hash数据转为UserDTO
        UserDTO userDTO = BeanUtil.fillBeanWithMap(userMap, new UserDTO(), false);
        // 6.存在，保存用户信息到 ThreadLocal
        UserHolder.saveUser(userDTO);
        // 7.刷新token有效期
        stringRedisTemplate.expire(key, LOGIN_USER_TTL, TimeUnit.MINUTES);
        // 8.放行
        return true;
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // 移除用户
        UserHolder.removeUser();
    }
}

package com.hmdp.config;

import com.hmdp.utils.LoginInterceptor;
import com.hmdp.utils.RefreshTokenInterceptor;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import javax.annotation.Resource;

@Configuration
public class MvcConfig implements WebMvcConfigurer {

    @Resource
    private StringRedisTemplate stringRedisTemplate;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 登录拦截器
        registry.addInterceptor(new LoginInterceptor())
                .excludePathPatterns(
                        "/shop/**",
                        "/voucher/**",
                        "/shop-type/**",
                        "/upload/**",
                        "/blog/hot",
                        "/user/code",
                        "/user/login"
                ).order(1);
        // token刷新的拦截器
        registry.addInterceptor(new RefreshTokenInterceptor(stringRedisTemplate)).addPathPatterns("/**").order(0);
    }
}

详细代码请参看文章开头共享的代码资源，当中包含了后续章节要讲解的有关Redis所有内容，我会持续更新…… 

王哲晓 tiger
关注
专栏目录
第二十讲redis实用命令实战.pptx
08-23
### 第二十讲 Redis 实用命令实战 #### 一、Redis 数据类型概述 Redis 是一种高性能的键值存储系统，提供了多种内置的数据结构，包括字符串(Strings)、哈希(Hashes)、列表(Lists)、集合(Sets)、有序集合(Sorted ...
第十八讲redis安装实战.pptx
08-23
### 第十八讲Redis安装实战知识点总结 #### 一、Redis简介 Redis是一种开源的高性能键值存储系统，作为数据结构服务器被广泛应用于缓存、消息队列等多种场景中。相较于Memcached，Redis提供了更为丰富的数据类型...
第2章 Redis快速入门 试看.zip
05-11
十、实战应用 1. 缓存：利用Redis的高速读取能力，缓存热点数据，提高系统性能。 2. 排行榜：利用有序集合进行实时更新和查询。 3. 计数器：通过 incr/decr 操作，统计网站访问量等。 通过以上介绍，你已经对Redis...
第二十一讲redis实战案例及总回顾.pptx
08-23
### 第二十一讲Redis实战案例及总回顾 #### 一、Redis基础知识回顾 Redis是一种开源的、高性能的键值存储系统，它支持多种数据结构，如字符串（Strings）、散列（Hashes）、列表（Lists）、集合（Sets）以及有序...
redis实战 完整版
10-28
### Redis实战完整版知识点概述 #### 一、Key-Value存储系统简介 ##### 1.1.1 Voldemort - **特点**: Voldemort是一款分布式键值存储系统，特别适用于大规模读写密集型的应用场景。 - **应用场景**: 常用于缓存、...
Redis: 持久化之RDB和AOF
Wang的专栏
09-29 1093
Redis 有一个高质量的课题：数据安全性与数据可靠性Redis 是一个内存型数据库，数据大部分都是存在内存里面当信息在内存中流通时，Redis 节点突然就故障挂掉当重新启动的时候，内存中的数据肯定是全部丢失了如果在这种情况下，Redis 提供了对应的持久化方案，它有两种持久化方案RDB和AOF可以把内存中的数据保存到磁盘，避免数据的流失关于RDB，我们需要了解到什么是持久化什么是快照RDB的工作原理，包括它的优点和缺点关于AOF，需要知道为什么需要有AOF。
Redis-常见数据类型(修改ing)
qq_74812898的博客
09-29 1039
redis常用数据类型
Redis-持久化
qq_74812898的博客
09-28 1032
redis持久化
如何使用Redisson的布隆过滤器？
付聪
10-02 361
【代码】如何使用Redisson的布隆过滤器？
尚硅谷redis147答疑 redis源码redisObject dict
2401_86733530的博客
09-28 644
总结：虽然在`redisObject`的结构定义中没有直接看到`dict`，但在实际使用中，对于哈希类型的对象，`redisObject`的`ptr`字段会指向一个`dict`结构。- 当Redis创建一个哈希对象时，它会创建一个`redisObject`，将其`type`设置为哈希类型，然后`ptr`指向一个新创建的`dict`结构。- Redis使用了一种灵活的设计，`redisObject`的`ptr`字段可以指向不同类型的数据结构，包括但不限于`dict`。
Redission · 可重入锁（Reentrant Lock）
不惑
09-29 1101
下面的代码是单节点 Redis 的配置。/*** 对 Redisson 的使用都是通过 RedissonClient 对象* @return*/@Bean(destroyMethod="shutdown") // 服务停止后调用 shutdown 方法。// 创建配置// 集群模式。
Redis-持久化机制
qq_39007838的博客
10-01 1047
配置文件redis 6.0.16 及其以下补充一张来自于的图片写回策略，对应图中的 3 也即上面个图的 fsync 策略。
分布式锁--redission 最佳实践！
最新发布
weixin_61558375的博客
10-05 887
分布式锁在项目中的实战
【分布式微服务云原生】掌握分布式缓存：Redis与Memcached的深入解析与实战指南
Dylaniou的博客
10-03 1377
Redis和Memcached都是强大的分布式缓存解决方案，但它们在功能、持久化、数据结构支持等方面有所不同。Redis提供了更丰富的数据结构和持久化机制，而Memcached则以其简单性和高性能著称。在选择分布式缓存时，需要根据具体的业务需求和场景进行选择。
SpringBoot+Redis+RabbitMQ完成增删改查
Hello的博客
10-04 540
以上代码实现的功能就是全部数据查询还是走的数据库（数据量不多），但是单个查询，比如查询详情，先查缓存，缓存没有再查数据库，然后再添加到缓存中，下次查询就不走数据库了添加修改删除统一发送给RabbitMQ消息队列，由消息队列异步完成后续的任务，并更新或者删除对应的缓存。
Redis：hash类型
盒马的博客
10-03 1208
讲解Redis的hash类型，常用命令以及内部编码
Redis篇（Redis原理 - 数据结构）（持续更新迭代）
wlcass zhengge blog
10-02 1060
我们知道 Redis 是一个键值型（ Key-Value Pair ）的数据库，我们可以根据键实现快速的增删改查。而键与值的映射关系正是通过 Dict 来实现的。Dict 由三部分组成，分别是：哈希表（ DictHashTable ）、哈希节点（ DictEntry ）、字典（ Dict ）当我们向 Dict 添加键值对时，Redis 首先根据 key 计算出 hash 值（ h ），然后利用 h & sizemask 来计算元素应该存储到数组中的哪个索引位置。
令牌主动失效机制范例（利用redis）注释分析
qq_55018264的博客
10-05 431
令牌生成在需要限流的场景中，系统会根据一定的速率生成令牌，存储在 Redis 中。可以设定每秒生成的令牌数量。令牌获取当用户请求时，系统会从 Redis 中获取令牌。可以使用原子性操作（如 DECR）来确保令牌的正确获取和减少。令牌失效令牌的主动失效可以通过设定过期时间（TTL）来实现。当生成的令牌在一定时间内未被消费，Redis 会自动删除这些令牌。也可以通过在逻辑上判断令牌的使用情况，主动将过期的令牌从队列中剔除。监控与调整。
1、深入理解Redis线程模型
业精于勤荒于嬉，行成于思毁于随
09-30 1498
以上介绍的各种机制，其实都是Redis改变指令执行顺序的方式。在这几种工具中，Lua脚本通常会是项目中用得最多的方式。在很多追求极致性能的高并发场景，Lua脚本都会担任很重要的角色。但是其他的各种方式你也需要有了解，这样面临真实业务场景，你才有更多的方案可以选择。Redis的线程模型整体还是多线程的，只是后台执行指令的核心线程是单线程的。整个线程模型可以理解为还是以单线程为主。基于这种单线程为主的线程模型，不同客户端的各种指令都需要依次排队执行。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值