redis实战——实现(类)短信登录

486过于烦躁

已于 2022-04-09 09:44:58 修改

阅读量1.3k

点赞数

文章标签： java redis

于 2022-04-08 23:24:58 首次发布

本文链接：https://blog.csdn.net/study_maker/article/details/124027795

版权

前言：

1.基于Session实现登录

实现流程图

2.基于Redis实现共享session登录

实现流程图

3.登录拦截器的优化：

前言：

该项目的前端代码已置于nginx服务器上，只需在启动服务即可

导入的依赖有 :

        <!--redis-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
        </dependency>
        <!--redis连接池-->
        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-pool2</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
            <version>5.1.47</version>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.4.3</version>
        </dependency>

        <!--hutool-->
        <dependency>
            <groupId>cn.hutool</groupId>
            <artifactId>hutool-all</artifactId>
            <version>5.7.17</version>
        </dependency>

需要补充的知识点：

1.hutool的介绍：是一个小而全的Java工具类库，通过静态方法封装，降低相关API的学习成本，提高工作效率

(1) hutool参考文档链接: Hutool参考文档. (其中需要重点了解javabean的用法)

(2) hutoolAPI文档链接: hutool-码云(gitee.com).

2.Threadlocal的介绍：

(1) Threadlocal详解：ThreadLocal详解

(2) Threadlocal小文章：拼多多面试官没想到ThreadLocal我用得这么溜

3.Session共享问题：Session+Redis实现Session共享 - 知乎 (zhihu.com)

4.编程习惯：对于一些常量我们都会将它单独置于一个类中，并用public static final修饰，例如：

public class RedisConstants {
    public static final String LOGIN_CODE_KEY = "login:code:";
    public static final Long LOGIN_CODE_TTL = 2L;
}

1.基于Session实现登录

实现流程图

可以通过正则表达式来判断手机号是否合法（项目源码内有提供，不仅如此，还有判断其它格式是否合法的接口，如下）

public abstract class RegexPatterns {
    /**
     * 手机号正则
     */
    public static final String PHONE_REGEX = "^1([38][0-9]|4[579]|5[0-3,5-9]|6[6]|7[0135678]|9[89])\\d{8}$";
    /**
     * 邮箱正则
     */
    public static final String EMAIL_REGEX = "^[a-zA-Z0-9_-]+@[a-zA-Z0-9_-]+(\\.[a-zA-Z0-9_-]+)+$";
    /**
     * 密码正则。4~32位的字母、数字、下划线
     */
    public static final String PASSWORD_REGEX = "^\\w{4,32}$";
    /**
     * 验证码正则, 6位数字或字母
     */
    public static final String VERIFY_CODE_REGEX = "^[a-zA-Z\\d]{6}$";

}

public class RegexUtils {
    /**
     * 是否是无效手机格式
     * @param phone 要校验的手机号
     * @return true:符合，false：不符合
     */
    public static boolean isPhoneInvalid(String phone){
        return mismatch(phone, RegexPatterns.PHONE_REGEX);
    }
    /**
     * 是否是无效邮箱格式
     * @param email 要校验的邮箱
     * @return true:符合，false：不符合
     */
    public static boolean isEmailInvalid(String email){
        return mismatch(email, RegexPatterns.EMAIL_REGEX);
    }

    /**
     * 是否是无效验证码格式
     * @param code 要校验的验证码
     * @return true:符合，false：不符合
     */
    public static boolean isCodeInvalid(String code){
        return mismatch(code, RegexPatterns.VERIFY_CODE_REGEX);
    }

    // 校验是否不符合正则格式
    private static boolean mismatch(String str, String regex){
        if (StrUtil.isBlank(str)) {
            return true;
        }
        return !str.matches(regex);
    }
}

2.基于Redis实现共享session登录

实现流程图

与之前的流程图对比，session登录校验是由tomcat自动地把sessionID写入cookie里，以后每次请求带着cookie就带了sessionID，根据sessionID找到session继而找到用户；

而现在是以token作为登录令牌，由于没有tomcat的帮助，我们需要手动地把token返回给前端，而后每次请求基于 token 再从 redis 中获取用户（以随机token为key来存储用户数据，而不是继续用手机号来作为key）

前端代码存储 token，如下（看看就好，后续后端可以通过请求头来获取 token）：

存在的问题：

因为 redis 中我们使用的 StringRedisTemplate 要求我们的 key 和 value 都要是String 类型，而我们 UserDTO (通过User对象转换而来，简化信息，保障用户安全)中的 Id 是 Long 类型的，需要我们自行进行定义，如下：//4.2将UserDTO转换为Hash存储

/*如下是
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements IUserService 下的接口和成员
*/
    @Resource
    private StringRedisTemplate stringRedisTemplate;

    @Override
    public Result login(LoginFormDTO loginForm, HttpSession session) {
        //1.校验手机号
        String phone = loginForm.getPhone();
        if(RegexUtils.isPhoneInvalid(phone)){
            return Result.fail("手机格式不正确");
        }
        //2.校验验证码
//        Object cacheCode = session.getAttribute("code");
        String cacheCode = stringRedisTemplate.opsForValue().get(LOGIN_CODE_KEY + phone);
        if(cacheCode == null||!cacheCode.equals(loginForm.getCode())){
            //不一致
            return Result.fail("验证码错误");
        }
        // 一致
        User user = query().eq("phone", phone).one();
        //3.判断用户是否存在
        if(user==null){
            //不存在,创建新用户并保存
            createUserWithPhone(phone);
        }
        //存在
        //4.保存到redis
//        session.setAttribute("user", BeanUtil.copyProperties(user, UserDTO.class));

        //4.1随机生成token，作为登录令牌
        String token = UUID.randomUUID().toString(true);

        //4.2将User对象转换为Hash存储
        UserDTO userDTO = BeanUtil.copyProperties(user, UserDTO.class);
        Map<String, Object> map = BeanUtil.beanToMap(userDTO,new HashMap<>(), CopyOptions.create()
                .setIgnoreNullValue(true)
                .setFieldValueEditor((fieldName,fieldValue)->fieldValue.toString()));

        //4.3存储
        String tokenKey=LOGIN_USER_KEY+token;
        stringRedisTemplate.opsForHash().putAll(tokenKey,map);
        stringRedisTemplate.expire(tokenKey,LOGIN_USER_TTL,TimeUnit.MINUTES);
        return Result.ok(token);
    }

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

User对象

@Data
@EqualsAndHashCode(callSuper = false)
@Accessors(chain = true)
@TableName("tb_user")
public class User implements Serializable {

    private static final long serialVersionUID = 1L;

    /**
     * 主键
     */
    @TableId(value = "id", type = IdType.AUTO)
    private Long id;

    /**
     * 手机号码
     */
    private String phone;

    /**
     * 密码，加密存储
     */
    private String password;

    /**
     * 昵称，默认是随机字符
     */
    private String nickName;

    /**
     * 用户头像
     */
    private String icon = "";

    /**
     * 创建时间
     */
    private LocalDateTime createTime;

    /**
     * 更新时间
     */
    private LocalDateTime updateTime;


}

UserDTO对象

@Data
public class UserDTO {
    private Long id;
    private String nickName;
    private String icon;
}

3.登录拦截器的优化：

先前的拦截器只拦截了需要登录校验的路径（登录，支付），token 仅在登录的时候刷新有效期，那么就存在问题：当用户登录完后访问的是不需要登录的其他页面（逛商品），并不能刷新 token 的有效期，这就导致了限定有效期内 token 过期自动退出

所以我们可以进行以下优化：

再添加一个拦截器拦截所有的路径，这样每次请求都可以刷新 token 的有效期，这个拦截器对所有请求都放行，而后到后一个拦截器只需通过对 Threadlocal 内是否存在用户做判断即可

拦截器的先后顺序：

可以通过设置order的值来确保拦截的顺序，越小优先级越高；也可以不设置，默认order的值都为0，通过调整拦截器的位置确定执行的顺序（需要注意的是：有@Configuration等注解，才可以对StringRedisTemplate 进行依赖注入，以下 RefreshIntercptor 是我们手动new出来的，只能进行有参构造器进行传入）

Myconfig

@Configuration
public class MyConfig implements WebMvcConfigurer {
    @Resource
    private StringRedisTemplate stringRedisTemplate;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new RefreshIntercptor(stringRedisTemplate)).excludePathPatterns("/**");

        registry.addInterceptor(new LoginInterceptor()).excludePathPatterns(
                "/user/code",
                "/user/login",
                "/shop/**",
                "/shop-type/**",
                "/upload/**",
                "/blog/hot",
                "/voucher/**"
        );
    }
}

RefreshInterceptor

public class RefreshIntercptor implements HandlerInterceptor {

    private StringRedisTemplate stringRedisTemplate;

    public RefreshIntercptor(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)){
            response.setStatus(401);
            return true;
        }
        //2.基于token获取redis中的用户
        String tokenkey = RedisConstants.LOGIN_USER_KEY+token;
        Map<Object, Object> userMap = stringRedisTemplate.opsForHash().entries(tokenkey);
        //3.判断用户是否存在
        if(userMap.isEmpty()){
            return true;
        }
        //存在，保存用户到ThreadLocal
        UserDTO userDTO = BeanUtil.fillBeanWithMap(userMap, new UserDTO(), false);
        UserHolder.saveUser(userDTO);

        //4.设置token 刷新有效期
        stringRedisTemplate.expire(tokenkey,RedisConstants.LOGIN_USER_TTL, TimeUnit.MINUTES);
        //放行
        return true;
    }

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

LoginInterceptor

public class LoginInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
       if(UserHolder.getUser()==null){
           response.setStatus(401);
           return false;
       }
        return true;
    }

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

486过于烦躁

关注

0
点赞
踩
5

收藏

觉得还不错? 一键收藏
2
评论
redis实战——实现(类)短信登录

目录前言：1.基于Session实现登录实现流程图2.基于Redis实现共享session登录实现流程图3.登录拦截器的优化：前言：该项目的前端代码已置于nginx服务器上，只需在启动服务即可导入的依赖有:  <dependency> <groupId>org.springframework.boot</groupId> ...
复制链接

扫一扫