MVC拦截器、ThreadLocal来进行登录拦截

1. 对登录进行拦截

1.1 什么是ThreadLocal

ThreadLocal叫做线程变量，意思是ThreadLocal中填充的变量属于当前线程，该变量对其他线程而言是隔离的，也就是说该变量是当前线程独有的变量。ThreadLocal为变量在每个线程中都创建了一个副本，那么每个线程可以访问自己内部的副本变量。
详细可以看：https://blog.csdn.net/u010445301/article/details/111322569

1.2 定义UserHolder 类，来封装ThreadLocal方法

package com.hmdp.utils;

import com.hmdp.dto.UserDTO;

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();
    }
}

1.3 拦截器WebMvcConfigurer 的配置

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;
@Configuration
public class MvcConfig implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LoginInterceptor())//新增一个拦截器
                .excludePathPatterns(//放行的接口
                        "/blog/hot",
                        "/shop/**",
                        "/upload/**",
                        "/voucher/**",
                        "/shop-type/**",
                        "/user/code",
                        "/user/login"
                );
    }
}

1.4 登录的配置，当碰到拦截的方法的时候调用

package com.hmdp.utils;

import com.hmdp.dto.UserDTO;
import org.springframework.web.servlet.HandlerInterceptor;

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

public class LoginInterceptor implements HandlerInterceptor {
    @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();//移除用户
    }
}

1.5 UserServiceImpl

package com.hmdp.service.impl;

import cn.hutool.core.bean.BeanUtil;
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.stereotype.Service;

import javax.annotation.Resource;
import javax.servlet.http.HttpSession;

/**
 * <p>
 * 服务实现类
 * </p>
 *
 * @author 虎哥
 * @since 2021-12-22
 */
@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements IUserService {


    @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);
        //5.发送验证码，如果我们要发送短信的话，需要通过第三方平台，比如阿里云之类的，所以我们直接使用log日志输出
        log.debug("发送短信验证码成功，验证码："+ code);
        //返回ok
        return Result.ok();
    }

    @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;
    }
}

1.6 controller：

package com.hmdp.controller;


import com.hmdp.dto.LoginFormDTO;
import com.hmdp.dto.Result;
import com.hmdp.dto.UserDTO;
import com.hmdp.entity.UserInfo;
import com.hmdp.service.IUserInfoService;
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;

/**
 * <p>
 * 前端控制器
 * </p>
 *
 * @author 虎哥
 * @since 2021-12-22
 */
@Slf4j
@RestController
@RequestMapping("/user")
public class UserController {

    @Resource
    private IUserService userService;

    @Resource
    private IUserInfoService userInfoService;

    /**
     * 发送手机验证码
     */
    @PostMapping("code")
    public Result sendCode(@RequestParam("phone") String phone, HttpSession session) {
        // TODO 发送短信验证码并保存验证码
        return userService.sendCode(phone,session);//因为我们的短信验证码要保存在session当中
    }

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

    /**
     * 登出功能
     * @return 无
     */
    @PostMapping("/logout")
    public Result logout(){
        // TODO 实现登出功能
        return Result.fail("功能未完成");
    }

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

    @GetMapping("/info/{id}")
    public Result info(@PathVariable("id") Long userId){
        // 查询详情
        UserInfo info = userInfoService.getById(userId);
        if (info == null) {
            // 没有详情，应该是第一次查看详情
            return Result.ok();
        }
        info.setCreateTime(null);
        info.setUpdateTime(null);
        // 返回
        return Result.ok(info);
    }
}