玩轉 SpringBoot 2 之整合 JWT 下篇

前言

在《玩轉 SpringBoot 2 之整合 JWT 上篇》中介紹了關于 JWT 相關概念和JWT 基本使用的操作方式。本文為 SpringBoot 整合 JWT 的下篇，通過解決 App 用戶登錄 Session 問題的實戰操作，帶你更深入理解 JWT。通過本文你還可以了解到如下內容：

SpringBoot 使用攔截器的實際應用
SpringBoot 統一異常處理
SpringBoot 快速搭建 RESTful Api

關于生成JWT 操作請參考《玩轉 SpringBoot 2 之整合 JWT 上篇》

實戰操作

登錄操作

登錄操作流程圖：

在這里插入圖片描述

登錄操作流程介紹：

App 根據用戶名和密碼訪問登錄接口。
如果用戶名和密碼錯誤則提示 App 用戶密碼輸入錯誤。
如果用戶名和密碼正確則獲取用戶信息（表示登錄成功）并根據用戶信息生成 Token 并將其存入ServletContext 中。
將生成的 Token 返回給 App。

登錄操作具體代碼：

@RestController
public class LoginController {Logger log = LoggerFactory.getLogger(LoginController.class);@Autowiredprivate JWTService jwtService;@RequestMapping("/login")public ReturnMessage<Object> login(String loginName,String password,HttpServletRequest request) {if(valid(loginName,password)) {ReturnMessageUtil.error(CodeEnum.LOGINNAMEANDPWDERROR);}Map<String,String> userInfo = createUserInfoMap(loginName,password);String token = jwtService.createToken(userInfo, 1);ServletContext context = request.getServletContext();context.setAttribute(token, token);log.info("token:"+token);return ReturnMessageUtil.sucess(token);}
} private Map<String,String> createUserInfoMap(String loginName, String password) {Map<String,String> userInfo = new HashMap<String,String>();userInfo.put("loginName", loginName);userInfo.put("password", password);return userInfo;}private boolean valid(String loginName, String password) {if(Objects.equal("ljk", loginName) && Objects.equal("123456", password) ) {return true;}return false;}

攔截操作

攔截操作流程圖：

在這里插入圖片描述

攔截操作流程介紹：

服務器獲取（App訪問具體的Api 時攜帶的 Token）Token，如果 Token 為空則提示 App Token不能為空。
如果 Token 不為空則從 ServletContext 中獲取 Token，如果不存在則提示 App 該Token為非法 Token ！
如果 Token 不為空并且 ServletContext 中存在該Token，需要判斷 Token 是否過期。如果未過期則放開攔截。
如果Token 已經過期則提示 App Token已經過期，需要重新登錄。

攔截操作具體代碼：

public class LoginInterceptor implements HandlerInterceptor{Logger log = LoggerFactory.getLogger(LoginInterceptor.class);private JWTService jwtService;public LoginInterceptor(JWTService jwtService) {this.jwtService = jwtService;}public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object o) throws Exception {log.info("Token Checkout processing");String token = request.getParameter("token");if (StringUtils.isEmpty(token)) {throw new JKException(CodeEnum.TOKENISEMPTY);}String tokenInServletContext = (String)request.getServletContext().getAttribute(token);if(StringUtils.isEmpty(tokenInServletContext)) {throw new JKException(CodeEnum.ILLEGALTOKEN);}try {jwtService.verifyToken(token);} catch (AlgorithmMismatchException  e) {log.error("Token Checkout processing AlgorithmMismatchException 異常！"+e.getLocalizedMessage());throw new JKException(CodeEnum.ILLEGALTOKEN);}catch (TokenExpiredException  e) {log.info("token已經過期");throw new JKException(CodeEnum.EXPIRETOKEN);}catch (SignatureVerificationException  e) {log.error("Token Checkout processing SignatureVerificationException 異常！"+e.getLocalizedMessage());throw new JKException(CodeEnum.ILLEGALTOKEN);}catch (Exception e) {log.error("Token Checkout processing 未知異常！"+e.getLocalizedMessage());throw e;}return true;}
}

退出操作

退出操作流程介紹：

訪問退出接口并傳遞登錄生成的 Token，然后將 ServletContext中的 Token 刪除。

退出操作具體代碼：

	@GetMapping("/logout")public ReturnMessage<?> logout(String token,String issuer,HttpServletRequest request) {ServletContext context = request.getServletContext();context.removeAttribute(token);return ReturnMessageUtil.sucess();}

公共代碼

IndexController App 訪問測試Api，具體代碼如下：

@RestController
public class IndexController {@GetMapping("index")public ReturnMessage index() {return ReturnMessageUtil.sucess();}
}

統一異常次處理的 Handle

@RestControllerAdvice
public class ExceptionHandle {private final static Logger logger = LoggerFactory.getLogger(ExceptionHandle.class);@ExceptionHandler(value = Exception.class)//@ResponseBodypublic ReturnMessage<Object> handle(HttpServletResponse response, Exception exception) {response.setCharacterEncoding("utf-8");if(exception instanceof JKException) {JKException sbexception = (JKException)exception;return ReturnMessageUtil.error(sbexception.getCode(), sbexception.getMessage());}else {logger.error("系統異常 {}",exception);return ReturnMessageUtil.error(-1, "未知異常"+exception.getMessage());}}
}

JWTService 工具類代碼可以在我的GitHub上進行查看，具體地址請查看下面代碼示例章節。

測試

這里使用PostMan 進行測試，當然你也可以選用你順手的工具進行測試哈！

訪問 http://localhost:8080/sbe/login?loginName=ljk&password=123456 進行登錄獲取Token，如下圖所示date字段的值就是登錄成功后生成的 Token。

在這里插入圖片描述

訪問 http://localhost:8080/sbe/index?token=具體token值，如下圖所示訪問成功！
在這里插入圖片描述

如果不攜帶 Token 會提示Token不能為空，如下圖所示：

在這里插入圖片描述

如果輸入不存在的 Token 則提示非法Token！，如下圖所示：

在這里插入圖片描述

http://localhost:8080/sbe/logout?token=具體token值進行退出，如下圖所示：

在這里插入圖片描述

退出后再次使用已經退出的Token 訪問，會提示非法Token 如下圖所示：

在這里插入圖片描述

小結

登錄操作通過 JWT 生成Token 返回給App，攔截操作（也可以理解成校驗操作）通過攔截器（HandlerInterceptor）來進行實現。最后退出操作是通過將Token 保存ServletContent 中，退出其實就是將 Token 從 ServletContent 中刪除。

本文主旨是通過簡單實現，帶你了解 App 認證過程處理方式，對于攔截部分你也可以通過 Filter 或 Aop 來進行實現。Token 存儲也可以考慮使用Redis來實現，還有一個問題就是：JWT 續期問題本文并沒有實現（JWT 過期時間延期問題）。這個部分就當成一個作業，歡迎大家在評論區說說你的解決方案？