SpringBoot+JWT實現註冊、登入、狀態續簽流程分析

2022-06-09 14:00:15

一、實現流程

1.註冊

2.登入

3.登入保持【狀態續簽】

二、實現方法

專案結構

1.引入依賴

<!-- spring-web -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- mysql聯結器 -->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
</dependency>
<!-- Mybatis Plus -->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.4.3.4</version>
</dependency>
<!-- druid -->
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid-spring-boot-starter</artifactId>
    <version>1.2.8</version>
</dependency>
<!-- jwt -->
<dependency>
    <groupId>com.auth0</groupId>
    <artifactId>java-jwt</artifactId>
    <version>3.10.3</version>
</dependency>

2.application組態檔

spring:
  application:
    name: jwtLogin   # 應用名稱
  datasource:
    druid:
      url: jdbc:mysql://192.168.0.111:3306/login_test?useSSL=false&serverTimezone=UTC
      username: samon
      password: 123456
      driver-class-name: com.mysql.jdbc.Driver
server:
  port: 8848   # 應用服務 WEB 存取埠

3.mysql建表

使用者表

4.Bean

1.bean/user.java
使用者bean

package com.cxstar.bean;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import lombok.Data;
import java.util.Date;
@Data
public class User {
    // 自增長id
    @TableId(type = IdType.AUTO)
    private Integer id;
    private String userName;
    private String passWord;
    private Date createTime;
    private Date lastLogin;
    public  User() {}
    public User(Integer id, String userName) {
        this.id = id;
        this.userName = userName;
    }
}

2.bean/ServiceRes.java
統一Service返回類

package com.cxstar.bean;
import lombok.Data;
@Data
public class ServiceRes {
    private Integer code;
    private String msg;
    private String jwt;
    private ServiceRes() {}
    public ServiceRes(Integer code, String msg) {
        this.code = code;
        this.msg = msg;
    }
    public ServiceRes(Integer code, String msg, String jwt) {
        this.code = code;
        this.msg = msg;
        this.jwt = jwt;
    }
}

3.bean/ControllerRes.java
統一Controller返回類

package com.cxstar.bean;
import lombok.Data;
@Data
public class ControllerRes {
    private Integer code;
    private String msg;
    public ControllerRes(Integer code, String msg) {
        this.code = code;
        this.msg = msg;
    }
}

5.Mapper mapper/UserMapper.java
繼承MP

package com.cxstar.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.cxstar.bean.User;
import org.apache.ibatis.annotations.Mapper;
@Mapper
public interface UserMapper extends BaseMapper<User> {
}

6.service service.userService.interface
登入、註冊、改密業務【狀態續簽測試】

package com.cxstar.service;
import com.cxstar.bean.ServiceRes;
import com.cxstar.bean.User;
public interface userService {
    // 註冊
    ServiceRes register(User user);
    // 登入
    ServiceRes login(User user);
    // 改密【帶許可權業務，用於狀態續簽測試】
    ServiceRes changePassWord(User user);
}

service.impl.UserServiceImpl.java
登入、註冊、改密業務【狀態續簽測試】

package com.cxstar.service.impl;
import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
import com.cxstar.bean.ServiceRes;
import com.cxstar.bean.User;
import com.cxstar.mapper.UserMapper;
import com.cxstar.service.userService;
import com.cxstar.utils.JwtUtil;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.util.DigestUtils;
import java.nio.charset.StandardCharsets;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
@Slf4j
@Service
public class UserServiceImpl implements userService {
    @Autowired
    UserMapper userMapper;
    /**
     * 註冊
     * @param user 使用者類
     * @return ServiceRes
     */
    @Override
    public ServiceRes register(User user) {
        // 判斷使用者名稱是否唯一
        if(this.checkUserNameIsUnique(user)) {
            // 判斷使用者名稱密碼是否合法
            if(this.checkUserNameAndPassword(user)) {
                // 密碼MD5加密
                user.setPassWord(this.MD5Code(user.getPassWord()));
                // 加入建立時間
                user.setCreateTime(new Date());
                // 入庫
                userMapper.insert(user);
                return new ServiceRes(1, "註冊成功");
            } else return new ServiceRes(-1, "使用者名稱或密碼不合法");
        } else return new ServiceRes(-1, "使用者名稱已存在");
    }
    /**
     * 登入
     * @param user 使用者類
     * @return ServiceRes
     */
    @Override
    public ServiceRes login(User user) {
        // 判斷使用者名稱密碼是否合法
        if(this.checkUserNameAndPassword(user)) {
            // 密碼MD5加密
            user.setPassWord(this.MD5Code(user.getPassWord()));
            // 檢查使用者是否存在
            User curUser = this.checkUserIsExit(user);
            if(curUser!=null) {
                // 更新使用者最後登入時間
                curUser.setLastLogin(new Date());
                userMapper.updateById(curUser);
                // 生成jwt
                Map<String, String> payload = new HashMap<>();
                payload.put("userId", curUser.getId().toString()); // 加入一些非敏感的使用者資訊
                payload.put("userName", curUser.getUserName());    // 加入一些非敏感的使用者資訊
                String jwt = JwtUtil.generateToken(payload);
                return new ServiceRes(1, "登入成功", jwt);
            } else return new ServiceRes(-1, "使用者名稱或密碼錯誤");
        } else return new ServiceRes(-1, "使用者名稱或密碼不合法");
    }
    /**
     * 改密業務
     * @return ServiceRes
     */
    @Override
    public ServiceRes changePassWord(User user) {
        if(this.updatePassWord(user)) return new ServiceRes(1, "改密成功");
        else return new ServiceRes(-1, "改密失敗");
    }
    /**
     * 非對稱加密
     * @param text 明文
     * @return 密文
     */
    private String MD5Code(String text) {
        return DigestUtils.md5DigestAsHex(text.getBytes(StandardCharsets.UTF_8));
    }
    /**
     * 修改密碼方法
     * @param user 傳入使用者名稱和新密碼
     * @return 改密成功返回 true 失敗返回 false
     */
    private Boolean updatePassWord(User user) {
        // 密碼非對稱加密
        user.setPassWord(this.MD5Code(user.getPassWord()));
        // 更新密碼
        return userMapper.updateById(user)>0;
    }
    /**
     * 檢查使用者是否存在【使用者名稱密碼相同】
     * @param user 使用者類
     * @return 使用者存在返回 使用者物件 不存在返回 null
     */
    private User checkUserIsExit(User user) {
        LambdaQueryWrapper<User> lqw = new LambdaQueryWrapper<>();
        lqw.eq(User::getUserName, user.getUserName());
        lqw.eq(User::getPassWord, user.getPassWord());
        return userMapper.selectOne(lqw);
    }
    /**
     * 判斷使用者名稱是否唯一
     * @param user 使用者類
     * @return 唯一返回 true 不唯一返回 false
     */
    private Boolean checkUserNameIsUnique(User user) {
        LambdaQueryWrapper<User> lqw = new LambdaQueryWrapper<>();
        lqw.eq(User::getUserName, user.getUserName());
        List<User> userList = userMapper.selectList(lqw);
        return userList.size() == 0;
    }
    /**
     * 判斷使用者名稱密碼是否合法
     * @param user 使用者類
     * @return 滿足 【英文字母、數位、下劃線】 返回 true，否則返回 false
     */
    private Boolean checkUserNameAndPassword(User user) {
        String regex = "^[_a-z0-9A-Z]+$";
        return user.getUserName().matches(regex) && user.getPassWord().matches(regex);
    }

}

6.Controller controller/UserController.java
登入、註冊、改密業務【狀態續簽測試】

package com.cxstar.controller;
import com.cxstar.bean.ControllerRes;
import com.cxstar.bean.ServiceRes;
import com.cxstar.bean.User;
import com.cxstar.service.userService;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.PutMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
@Slf4j
@Controller
@ResponseBody
@RequestMapping("/user")
public class UserController {
    @Autowired
    userService userService;
    @PostMapping("/register")
    public ControllerRes register(User user) {
        // 註冊
        ServiceRes serviceRes = userService.register(user);
        return new ControllerRes(serviceRes.getCode(), serviceRes.getMsg());
    }
    @PostMapping("/login")
    public ControllerRes login(User user, HttpServletResponse response) {
        // 登入
        ServiceRes serviceRes = userService.login(user);
        // 登入成功後往響應頭插入jwt
        if(serviceRes.getJwt() != null) response.addHeader("access-token", serviceRes.getJwt());
        return new ControllerRes(serviceRes.getCode(), serviceRes.getMsg());
    }
    @PutMapping("/pwd")
    public ControllerRes changePassWord(User user, HttpServletRequest request) {
        // 取出jwt中的使用者
        User jwtUser = (User)request.getAttribute("jwt-user");
        // 合併jwt中使用者的使用者名稱與傳入使用者的新密碼
        // 此處不能直接使用傳入的使用者名稱，防止惡意修改其他使用者的密碼
        user.setId(jwtUser.getId());
        // 改密
        ServiceRes serviceRes = userService.changePassWord(user);
        return new ControllerRes(serviceRes.getCode(), serviceRes.getMsg());
    }
}

7.JWT工具類 utils/JwtUtil.java
生成和解析 token 的方法

package com.cxstar.utils;
import com.auth0.jwt.JWT;
import com.auth0.jwt.JWTCreator;
import com.auth0.jwt.algorithms.Algorithm;
import com.auth0.jwt.interfaces.DecodedJWT;
import com.auth0.jwt.interfaces.JWTVerifier;
import java.util.Calendar;
import java.util.Date;
import java.util.Map;
public class JwtUtil {
    // 簽名金鑰
    private static final String SECRET = "hello JWT *%$#$&";
    /**
     * 生成token
     * @param payload token攜帶的資訊
     * @return token字串
     */
    public static String generateToken(Map<String,String> payload){
        // 指定token過期時間
        Calendar calendar = Calendar.getInstance();
        calendar.add(Calendar.HOUR, 24);  // 24小時
        JWTCreator.Builder builder = JWT.create();
        // 構建payload
        payload.forEach(builder::withClaim);
        // 指定簽發時間、過期時間 和 簽名演演算法，並返回token
        String token = builder.withIssuedAt(new Date()).withExpiresAt(calendar.getTime()).sign(Algorithm.HMAC256(SECRET));
        return token;
    }

    /**
     * 解析token
     * @param token token字串
     * @return 解析後的token類
     */
    public static DecodedJWT decodeToken(String token){
        JWTVerifier jwtVerifier = JWT.require(Algorithm.HMAC256(SECRET)).build();
        DecodedJWT decodedJWT = jwtVerifier.verify(token);
        return decodedJWT;
    }
}

8.HandlerInterceptor攔截器 interceptor.java
攔截器業務實現

package com.cxstar.interceptor;

import com.alibaba.fastjson.JSONObject;
import com.auth0.jwt.exceptions.JWTDecodeException;
import com.auth0.jwt.exceptions.TokenExpiredException;
import com.auth0.jwt.interfaces.DecodedJWT;
import com.cxstar.bean.ControllerRes;
import com.cxstar.bean.User;
import com.cxstar.utils.JwtUtil;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.PrintWriter;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;

/**
 * 攔截需要授權的介面
 */
@Slf4j
public class PermisssionInterceptor implements HandlerInterceptor {

    // 目標方法執行前呼叫
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws IOException {

        // 檢查使用者JWT
        String jwt = request.getHeader("access-token");

        // 校驗並取出私有資訊
        try {

            // token 解碼
            DecodedJWT dj = JwtUtil.decodeToken(jwt);

            // 取出基本使用者資訊加入請求頭 --------------------------------------------------------------------------------
            String userId = dj.getClaim("userId").asString();
            String userName = dj.getClaim("userName").asString();
            // jwt校驗合格的，將 jwt 中存的使用者資訊加入請求頭，不合格的，請求頭存個空使用者
            request.setAttribute("jwt-user", userId!=null?new User(Integer.valueOf(userId), userName):new User());
            // -------------------------------------------------------------------------------------------------------

            // 計算當前時間是否超過過期時間的一半，如果是就幫使用者續簽 --------------------------
            // 此處並不是永久續簽，只是為 大於過期時間的一半 且 小於過期時間 的 token 續簽
            Long expTime = dj.getExpiresAt().getTime();
            Long iatTime = dj.getIssuedAt().getTime();
            Long nowTime = new Date().getTime();
            if((nowTime-iatTime) > (expTime-iatTime)/2) {
                // 生成新的jwt
                Map<String, String> payload = new HashMap<>();
                payload.put("userId", userId); // 加入一些非敏感的使用者資訊
                payload.put("userName", userName);    // 加入一些非敏感的使用者資訊
                String newJwt = JwtUtil.generateToken(payload);
                // 加入返回頭
                response.addHeader("access-token", newJwt);
            }
            // -----------------------------------------------------------------------

            return true;

        } catch (JWTDecodeException e) {
            log.error("令牌錯誤");
            addResBody(response, new ControllerRes(-1, "令牌錯誤"));  // 新增返回體
            return false;

        } catch (TokenExpiredException e) {
            log.error("令牌過期");
            addResBody(response, new ControllerRes(-1, "令牌過期"));  // 新增返回體
            return false;
        }

    }

    // 目標方法執行後呼叫
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        HandlerInterceptor.super.postHandle(request, response, handler, modelAndView);
    }

    // 頁面渲染前呼叫
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        HandlerInterceptor.super.afterCompletion(request, response, handler, ex);
    }

    private void addResBody(HttpServletResponse response, ControllerRes res) throws IOException {

        response.setStatus(HttpServletResponse.SC_FORBIDDEN);        // 設定狀態碼

        response.setCharacterEncoding("UTF-8");
        response.setContentType("application/json; charset=utf-8");
        PrintWriter out = response.getWriter();
        out.write(JSONObject.toJSONString(res));
        out.flush();
        out.close();

    }

}

config/PermissionWebConfig.java
攔截器攔截規則

package com.cxstar.config;
import com.cxstar.interceptor.PermisssionInterceptor;
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 PermissionWebConfig implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new PermisssionInterceptor())
                .addPathPatterns("/**")    // 攔截哪些頁面
                .excludePathPatterns("/user/login", "/user/register");   // 放行哪些頁面
    }
}