基于session和redis两种方式的短信登录业务流程及代码实现

今天药忘吃喽~ 2024-03-24 00:06 50阅读 0赞

##  ##

**目录**

短信登录业务

短信登录的业务流程

基于session登录的代码实现

发送短信验证码

短信验证码登录、注册

检验登录注册

基于redis共享session登录的代码实现

发送短信验证码

短信验证码登录、注册

检验登录注册

--------------------

### 短信登录业务 ###

#### 短信登录的业务流程 ####

> 基于session实现短信登录的业务流程

![66ae19f08f56adb7027feb012987f26a.png][]

**流程说明**：

发送短信：从前端获取到手机号，校验手机号，生成验证码，**将验证码保存到session** ，并将验证码发送至手机

短信验证码登录、注册：从前端获取手机号和验证码，**将获取的验证码与session中的验证码进行比较**，如果一致的话则进行**登录或者新用户的注册**

检验登录状态：实际上是一个拦截器（Intercepter），**从session中获取用户信息判断用户信息是否存在**。如果存在，则保存到ThreadLocal中；否则对请求进行过滤

**注意**：

1、向前端返回用户信息时，需要将用户的信息封装至UserDto中（仅选择需要展示的数据），不能将用户的全部信息直接返回、暴露给前端。

2、拦截器从session中获取到用户信息后，需要保存至ThreadLocal中，方便其他操作直接获取用户的信息

3、session过期，设置session刷新时间后，在这个时间段内如果controller有用户操作则刷新session的过期时长

> 基于Redis实现共享session的业务流程

为什么需要共享session？

当用户请求量很大时，需要服务器搭建集群，不同服务器上的session无法同步、或者进行同步开销太大；可以直接利用redis实现session的共享

![cdf91a1e40cfc9ce0bed05fb1bb7b73f.png][]

**说明**：

发送短信验证码：在生成验证码后，将验证码保存至redis中。需要**重点关注redis的数据结构\{“phone”, code\}**。

短信验证登录、注册：此时需要前端获取验证码**和redis中存的验证码进行比较**。并且此时不再将用户信息保存至session中，而是**利用token将用户信息存至redis中，用户信息在不同服务器间的共享得以实现**。

**注意**：**token**在生成后保存在redis中的**同时也返回给前端**，即前端可以通过对应的token获取用户的信息（发送请求时携带token）

![6bfd5ba971ee0785209634ec9c90089e.png][]

**说明**：

校验登录状态：根据前端请求携带的token从redis中获取用户信息，如果有的话就将用户信息放至ThreadLocal中，否则的话对用户的请求进行拦截

**注意**：

1、在设置验证码、token时都需要设置过期时间，否则会长期占用内存

2、token设置过期时间后**不会在操作后和session一样自动刷新过期时长**，因此需要在拦截器（Intercepter）中**手动刷新token的有效期**

#### 基于session登录的代码实现 ####

##### 发送短信验证码 #####

UserServiceImpl.SendCode()

//UserController.java
    @PostMapping("/code")
    public Result sendCode(@RequestParam("phone") String phone, HttpSession session) {
        // 发送短信验证码并保存验证码
        return userService.SendCode(phone, session);
    }
    
    
    //UserServiceImpl.java
    @Override
    public Result SendCode(String phone, HttpSession session) {
        //1、判断手机号是否有效
        if(RegexUtils.isPhoneInvalid(phone)){
            return Result.fail("请输入正确的手机号");
        }
    
        //2、生成六位验证码
        String code = RandomUtil.randomNumbers(6);
    
        //3、将验证码放至session中
        session.setAttribute("code", code);
    
        //4、将验证码发送至手机,需要对接短信服务的api
        log.info("验证码为:{}", code);
    
        //5、返回ok
        return Result.ok("获取验证码成功");
    }

##### 短信验证码登录、注册 #####

UserServiceImpl.UserLogin()

//UserController.java
    @PostMapping("/login")
    public Result login(@RequestBody LoginFormDTO loginForm, HttpSession session){
        // 实现登录功能
        return userService.UserLogin(loginForm, session);
    }
    
    //UserServiceImpl.java
    @Override
    public Result UserLogin(LoginFormDTO loginForm, HttpSession session) {
        //1、从loginForm中获取手机号、验证码，校验手机号
        String phone = loginForm.getPhone();
        String code = loginForm.getCode();
    
        if(RegexUtils.isPhoneInvalid(phone)){
            return Result.fail("请输入正确的手机号");
        }
    
        //2、从session中获取验证码
        String cacheCode = session.getAttribute("code").toString();
    
        //3、进行比较，如不一样，返回验证码错误
        if(code == null || !cacheCode.equals(code)){
            return Result.fail("验证码错误");
        }
    
        //4、如果一样则在数据库中查找该用户
        User user = query().eq("phone", phone).one();
    
        //5、如果没有查找到则创建新用户，并保存到数据库中
        if(user == null){
            //创建新用户，并保存到数据库中
            user = createUserWithPhone(phone);
        }
    
        //6、如果查找到则进行登录，将用户信息放至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));  //user_xxx
        save(user);
        return user;
    }

##### 检验登录注册 #####

LoginIntercepter.java

package com.hmdp.utils;
    
    import com.hmdp.dto.Result;
    import com.hmdp.dto.UserDTO;
    import com.hmdp.entity.User;
    import org.springframework.beans.BeanUtils;
    import org.springframework.web.servlet.HandlerInterceptor;
    
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpServletResponse;
    import javax.servlet.http.HttpSession;
    
    /**
     * @Description TODO
     * @Author ygw
     * @Date 2022/10/15 15:37
     * @Version 1.0
     */
    public class LoginInterceptor implements HandlerInterceptor {
        @Override
        public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
            //1、从session获取用户信息
            HttpSession session = request.getSession();
            User user = (User)session.getAttribute("user");
    
            //2、判断用户是否存在，不存在时对请求进行拦截
            if(user == null){
                //不存在拦截，返回401代码
                response.setStatus(401);
                return true;
            }
    
            //3、用户存在时，将用户信息保存到ThreadLocal中，放行
            UserDTO userDTO = new UserDTO();
            userDTO.setId(user.getId());
            userDTO.setNickName(user.getNickName());
            userDTO.setIcon(user.getIcon());
            UserHolder.saveUser(userDTO);
    
            return true;
            
        }
    
        @Override
        public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
            //当前请求执行完毕后，需要移除用户信息，防止内存泄漏
            UserHolder.removeUser();
        }
    }

WebMvcConfig.java

package com.hmdp.config;
    
    import com.hmdp.utils.LoginInterceptor;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
    import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
    
    /**
     * @Description TODO
     * @Author ygw
     * @Date 2022/10/15 15:57
     * @Version 1.0
     */
    @Configuration
    public class WebMVCConfig implements WebMvcConfigurer {
        @Override
        public void addInterceptors(InterceptorRegistry registry) {
            registry.addInterceptor(new LoginInterceptor())
                    .excludePathPatterns(
                            "/shop/**",
                           "/shop-type/**",
                            "/upload/**",
                            "/voucher/**",
                            "/user/code",
                            "/user/login",
                            "/blog/hot");
        }
    }

#### 基于redis共享session登录的代码实现 ####

##### 发送短信验证码 #####

UserServiceImpl.SendCode()

@Service
    @Slf4j
    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)){
                return Result.fail("请输入正确的手机号");
            }
    
            //2、生成六位验证码
            String code = RandomUtil.randomNumbers(6);
    
            //3、将验证码放至redis中，并设置一个有效期
            stringRedisTemplate.opsForValue().set(LOGIN_CODE_KEY + phone, code, LOGIN_CODE_TTL, TimeUnit.MINUTES);
    //LOGIN_CODE_KEY -> login:code:   相当于加个前缀，更好的在redis中进行存储
    //LOGIN_CODE_TTL -> 2
    
            //4、将验证码发送至手机
            log.info("验证码为:{}", code);
    
            //5、返回ok
            return Result.ok("获取验证码成功");
        }
    }

##### 短信验证码登录、注册 #####

UserServiceImpl.UserLogin()

@Override
    public Result UserLogin(LoginFormDTO loginForm, HttpSession session) {
        //1、从loginForm中获取手机号、验证码，校验手机号
        String phone = loginForm.getPhone();
        String code = loginForm.getCode();
    
        if(RegexUtils.isPhoneInvalid(phone)){
            return Result.fail("请输入正确的手机号");
        }
    
        //2、从redis中获取验证码
        String cacheCode = stringRedisTemplate.opsForValue().get(LOGIN_CODE_KEY + phone);
    
        //3、进行比较，如不一样，返回验证码错误
        if(code == null || !cacheCode.equals(code)){
            return Result.fail("验证码错误");
        }
    
        //4、如果一样则在数据库中查找该用户
        User user = query().eq("phone", phone).one();
    
        //5、如果没有查找到则创建新用户，并保存到数据库中
        if(user == null){
            //创建新用户，并保存到数据库中
            user = createUserWithPhone(phone);
        }
    
        //6、如果查找到则进行登录，将用户信息放至redis中
        //6.1、随机生成token作为登录令牌
        String token = UUID.randomUUID().toString(true);
    
        //6.2、将User对象转为Hash存储
        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()));
    
        //6.3、存储
        stringRedisTemplate.opsForHash().putAll(LOGIN_USER_KEY + token, userMap);
        stringRedisTemplate.expire(LOGIN_USER_KEY + token, LOGIN_USER_TTL,TimeUnit.SECONDS);  //LOGIN_USER_KEY -> login:token:
     //LOGIN_USER_TTL -> 3600
        //7、返回token
        return Result.ok(token);
    }
    
    private User createUserWithPhone(String phone) {
        User user = new User();
        user.setPhone(phone);
        user.setNickName(USER_NICK_NAME_PREFIX + RandomUtil.randomString(10));  //user_xxx
        save(user);
        return user;
    }

##### 检验登录注册 #####

LoginIntercepter.java

package com.hmdp.utils;
    
    import cn.hutool.core.bean.BeanUtil;
    import cn.hutool.core.util.StrUtil;
    import com.hmdp.dto.Result;
    import com.hmdp.dto.UserDTO;
    import com.hmdp.entity.User;
    import org.springframework.beans.BeanUtils;
    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;
    
    import static com.hmdp.utils.RedisConstants.LOGIN_USER_KEY;
    import static com.hmdp.utils.RedisConstants.LOGIN_USER_TTL;
    
    /**
     * @Description TODO
     * @Author ygw
     * @Date 2022/10/15 15:37
     * @Version 1.0
     */
    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、从redis获取请求头中的token
            String token = request.getHeader("authorization");
    
            //2、根据token获取redis中的用户信息，
            if(StrUtil.isBlank(token)){
                //token为空，进行拦截
                response.setStatus(401);
                return false;
            }
    
            Map<Object, Object> userMap = stringRedisTemplate.opsForHash().entries(LOGIN_USER_KEY + token);   //LOGIN_USER_KEY -> login:token:
    
    
            //3、判断用户是否存在，不存在时对请求进行拦截
            if(userMap == null){
                //4、不存在拦截，返回401代码
                response.setStatus(401);
                return true;
            }
            //5、将查询到的Hash数据转成UserDTO对象
            UserDTO userDTO = BeanUtil.fillBeanWithMap(userMap, new UserDTO(), false);
    
            //6、用户存在时，将用户信息保存到ThreadLocal中
            UserHolder.saveUser(userDTO);
    
            //7、刷新token有效期
            stringRedisTemplate.expire(LOGIN_USER_KEY + token, LOGIN_USER_TTL, TimeUnit.SECONDS);
     //LOGIN_USER_KEY -> login:token:
     //LOGIN_USER_TTL -> 3600
            return true;
    
        }
    
        @Override
        public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
            //当前请求执行完毕后，需要移除用户信息，防止内存泄漏
            UserHolder.removeUser();
        }
    }

WebMvcConfig.java

package com.hmdp.config;
    
    import com.hmdp.utils.LoginInterceptor;
    import org.springframework.beans.factory.annotation.Autowired;
    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;
    
    /**
     * @Description TODO
     * @Author ygw
     * @Date 2022/10/15 15:57
     * @Version 1.0
     */
    @Configuration
    public class WebMVCConfig implements WebMvcConfigurer {
    
        @Resource
        private StringRedisTemplate stringRedisTemplate;
    
        @Override
        public void addInterceptors(InterceptorRegistry registry) {
            registry.addInterceptor(new LoginInterceptor(stringRedisTemplate))
                    .excludePathPatterns(
                            "/shop/**",
                           "/shop-type/**",
                            "/upload/**",
                            "/voucher/**",
                            "/user/code",
                            "/user/login",
                            "/blog/hot");
        }
    }

[66ae19f08f56adb7027feb012987f26a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/474b3527d1ca4499bbf49a4ee827ac9c.png
[cdf91a1e40cfc9ce0bed05fb1bb7b73f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/264a368b1f924efba6566558527a68c7.png
[6bfd5ba971ee0785209634ec9c90089e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/13/78c0c80ff321489290d72cc8fd4aebce.png