使用redis进行短信登录验证（验证码打印在控制台）

使用redis进行短信登录验证

一、流程
- 1. 总体流程图
- 2. 流程文字讲解：
- 3.代码
- - 3.1 UserServiceImpl：（难点）
  - 3.2 拦截器LoginInterceptor：
  - 3.3 拦截器配置类：
- 4 功能实现，成功存入redis

（黑马点评）

一、流程

1. 总体流程图

在这里插入图片描述

2. 流程文字讲解：

通过前端提供的手机号，进行判断符不符合11位的格式，如果不符合，返回错误信息，并且提示手机格式错误；判断符合格式，则生成一个6位的随机验证码。然后存到redis中。这个时候，只是简单的key-value，所以我们使用string类型。
我们现在生成了验证码，在进行校验之前，还需要验证是否和之前的手机号一致。然后校验验证码和我们redis中的验证码是否一致。不一致，返回错误信息；一致，查询手机号是否已经存在，如果User为空，则创建用户。然后保存信息到redis，作为登录令牌通过拦截器拦截。
生成一个token作为登录令牌，因为我们现在是需要通过token来携带我们的用户信息，所以我们使用Hash类型。第一步，把我们的User对象转为UserDTO类型。我们要存Hash的数据类型，就需要使用HashMap对象，所以，还需要把UserDTO转为HashMap（比较麻烦，详细见代码），然后存入并设置有效期。
对于拦截器：我们要使用StringRedisTemplate对象，但拦截器是我们自己写的，不进入Spring容器里面，所以需要通过构造函数来拿到StringRedisTemplate对象。
然后从请求头中拿到token，如果没有token，拦截，返回错误。然后从token中拿到UserMap对象。然后判断是否存在，不存在拦截。然后将Hash对象转为UserDTO对象，存入ThreadLocal，然后刷新有效期。

3.代码

3.1 UserServiceImpl：（难点）

package com.hmdp.service.impl;

import cn.hutool.core.bean.BeanUtil;
import cn.hutool.core.bean.copier.CopyOptions;
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 org.springframework.data.redis.core.RedisTemplate;
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.UUID;
import java.util.concurrent.TimeUnit;

import static com.hmdp.utils.RedisConstants.LOGIN_CODE_KEY;
import static com.hmdp.utils.RedisConstants.LOGIN_CODE_TTL;


@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements IUserService {
    @Resource
    private StringRedisTemplate stringRedisTemplate;//在之前csdn我们配置过。

    @Override
    public Result sendCode(String phone, HttpSession session) {
        //1.校验手机号
        if (RegexUtils.isPhoneInvalid(phone)){//RegexUtils去校验手机号是否无效，再utils中
               //2.如果不符合，返回错误信息
            return Result.fail("手机号格式错误");
        }
        //3.符合，生成验证码
        String code = RandomUtil.randomNumbers(6);//生成一个6位的随机数字验证码
    /*    //4.保存验证码到session，
        session.setAttribute("code",code);*/
        //4.保存验证码到redis中  = set key value ex 120
        stringRedisTemplate.opsForValue().set("login:code:"+phone,code,2, TimeUnit.MINUTES);//这里就把验证码保存到了redis中，为了防止数据存储过多，设置存储时间
        stringRedisTemplate.opsForValue().set(LOGIN_CODE_KEY+phone,code,LOGIN_CODE_TTL, TimeUnit.MINUTES);//这里是把我们用到的常量定义到常量类里面。
        //5.发送验证码，如果我们要发送短信的话，需要通过第三方平台，比如阿里云之类的，所以我们直接使用log日志输出
        log.debug("发送短信验证码成功，验证码："+ code);
        //返回ok
        return Result.ok();
    }

    //使用redis的登录和注册
    @Override
    public Result login(LoginFormDTO loginForm, HttpSession session) {
        //1.校验手机号//因为我们需要确定，登录的时候，手机号还是不是一个
        String phone =loginForm.getPhone();
        if (RegexUtils.isPhoneInvalid(phone)){//RegexUtils去校验手机号是否无效，再utils中
            //2.如果不符合，返回错误信息
            return Result.fail("手机号格式错误");
        }
        //2.从redis过去验证码然后校验验证码
        String CacheCode = stringRedisTemplate.opsForValue().get(LOGIN_CODE_KEY+phone);//从redis中获取验证码
        String code = loginForm.getCode();
        if (CacheCode==null||!CacheCode.equals(code)){
            //3.不一致，报错
            return Result.fail("验证码错误");
        }

        //4.一致，根据手机号查询用户 select * from tb_user where phone = ?  =query,因为，我们在这个类上面extends ServiceImpl<UserMapper, User>，所以可以使用mybatisPlus
        User user = query().eq("phone", phone).one();//one()是查询一个，如果查询不到，返回null
        //5.判断用户是否存在
        if (user == null) {
            //6.不存在，创建新用户，保存
            user =  creteUserWithPhone(phone);
        }


        //7.保存用户信息到Redis
        //7.1 生成一个token，作为登录令牌
        String token = UUID.randomUUID().toString();//toString是转为String类型
        //7.2 将User对象转为hash存储
        UserDTO userDTO = BeanUtil.copyProperties(user, UserDTO.class);

        //7.3 存储 难点
        /**
         * 因为  Map<String, Object>是我们所有属性都是string的时候，才可以完全存进去，但我们的id是Long类型的
         * 所以我们使用工具类对其中的失败的值进行转化为string
         *   Map<String, Object>是可以自定义方法的，我们现在需要的是一个HashMap，所以userDTO,new HashMap<>(),
         *   然后使用  CopyOptions.create().setIgnoreNullValue(true).忽略空的值
         *    setFieldValueEditor((fieldName,fieldValue)->fieldValue.toString()));失败的name和value我们只把失败的
         *    value转化为string类型不改id
         */
        Map<String, Object> userMap = BeanUtil.beanToMap(userDTO,new HashMap<>(),
                CopyOptions.create().setIgnoreNullValue(true).
                        setFieldValueEditor((fieldName,fieldValue)->fieldValue.toString()));//把userDTO转为Map<>
        String tokenKey="login:token:"+token;
        stringRedisTemplate.opsForHash().putAll(tokenKey,userMap);//因为我们要往hash中存储对象，多个值，但putall存储的是Map<>
       //                              我们不要直接存这个名字，和前面phone一样，防止我们混淆
        //7.4 设置token的有效期
        stringRedisTemplate.expire(tokenKey,30,TimeUnit.MINUTES);//session是30min没有访问，才删除，如果要做到一样，可以使用拦截器
        return Result.ok(token);
    }//每一个session都有一个sessionid，当我们访问tomcat的时候，就已经自动带着了，所以，又sessionId就能知道是哪个用户

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

    /*传统session里面
    @Override
    public Result login(LoginFormDTO loginForm, HttpSession session) {
        //1.校验手机号//因为我们需要确定，登录的时候，手机号还是不是一个
        String phone =loginForm.getPhone();
        if (RegexUtils.isPhoneInvalid(phone)){//RegexUtils去校验手机号是否无效，再utils中
            //2.如果不符合，返回错误信息
            return Result.fail("手机号格式错误");
        }
        //2.校验验证码
        Object CacheCode = session.getAttribute("code");
        String code = loginForm.getCode();
        if (CacheCode==null||!CacheCode.toString().equals(code)){
            //3.不一致，报错
            return Result.fail("验证码错误");
        }

        //4.一致，根据手机号查询用户 select * from tb_user where phone = ?  =query,因为，我们在这个类上面extends ServiceImpl<UserMapper, User>，所以可以使用mybatisPlus
        User user = query().eq("phone", phone).one();//one()是查询一个，如果查询不到，返回null
        //5.判断用户是否存在
        if (user == null) {
            //6.不存在，创建新用户，保存
          user =  creteUserWithPhone(phone);
        }


        //7.保存用户信息到session
        session.setAttribute("User", BeanUtil.copyProperties(user, UserDTO.class));//将user对象转换成UserDTO对象，再保存到session中
        return Result.ok();
    }//每一个session都有一个sessionid，当我们访问tomcat的时候，就已经自动带着了，所以，又sessionId就能知道是哪个用户

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

3.2 拦截器LoginInterceptor：

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 javax.servlet.http.HttpSession;
import java.util.Map;
import java.util.concurrent.TimeUnit;

public class LoginInterceptor implements HandlerInterceptor {
    private StringRedisTemplate stringRedisTemplate;//这里是由下面这个构造函数，在MVC拦截器中传递进来的对象得到的
    public LoginInterceptor(StringRedisTemplate stringRedisTemplate) {
        this.stringRedisTemplate = stringRedisTemplate;
    }//这个类的对象不是由spring创建的，所以我们不能使用@Rouse，只能使用构造函数
    //redis的

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        //1.获取请求头中的token，
        String token = request.getHeader("authorization");
        if (StrUtil.isBlank(token)) {//使用工具类StrUtil中的方法isBlank
               //2.如果请求头中没有token，拦截  返回401状态码  未授权的意思
            response.setStatus(401);
            return false;
        }
        //2.基于token获取redis的用户
        Map<Object, Object> userMap = stringRedisTemplate.opsForHash()
                .entries(RedisConstants.LOGIN_USER_KEY + token);//这里使用的是redis的hash结构
/*session.setAttribute("sessionName",Object); //保存
	//用来设置session值的，sessionName是名称，object是你要保存的对象。
   	session.getAttribute("sessionName");  //取得
   	//用来得到对应名称的session值，即得到object对象，注意需要进行类型转换！
*/
        //3.判断用户是否存在
        if (userMap.isEmpty()) {//如果为空
            //4.不存在，拦截  返回401状态码  未授权的意思
            response.setStatus(401);
            return false;
        }

        //将查询到的Hash转为UserDTO对象
        UserDTO userDTO = BeanUtil.fillBeanWithMap(userMap, new UserDTO(), false);//将userMap转存为UserDTp，不忽略异常
//5.存在，保存到ThreadLocal  对ThreadLocal进行了规范和重写。
        UserHolder.saveUser(userDTO);//把user保存到ThreadLocal，对user进行强转
        //刷新token有效期
        stringRedisTemplate.expire(RedisConstants.LOGIN_USER_KEY + token, RedisConstants.LOGIN_USER_TTL, TimeUnit.MINUTES);
        //6.放行
        return true;
    }

/*    session的
@Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
       //1.获取session
        HttpSession session = request.getSession();
        //2.获取session的用户
        Object user = session.getAttribute("user");
        *//*session.setAttribute("sessionName",Object); //保存
	//用来设置session值的，sessionName是名称，object是你要保存的对象。
   	session.getAttribute("sessionName");  //取得
   	//用来得到对应名称的session值，即得到object对象，注意需要进行类型转换！
*//*
        //3.判断用户是否存在
        if (user == null) {
            //4.不存在，拦截  返回401状态码  未授权的意思
            response.setStatus(401);
            return false;
        }
        //5.存在，保存到ThreadLocal  对ThreadLocal进行了规范和重写。
        UserHolder.saveUser((UserDTO)user);//把user保存到ThreadLocal，对user进行强转
        //6.放行
        return true;
    }*/

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

3.3 拦截器配置类：

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;

    /**
     * 这个类上面有@Configuration，是由spring来创建的，所以我们可以使用  @Resource来引入对象，再放到下面这个
     * LoginInterceptor构造函数里面，传递给LoginInterceptor类
     * @param registry
     */

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LoginInterceptor(stringRedisTemplate))
                .excludePathPatterns(//放行的接口
                        "/blog/hot",
                        "/shop/**",
                        "/upload/**",
                        "/voucher/**",
                        "/shop-type/**",
                        "/user/code",
                        "/user/login"
                );
    }
}