前言
在《玩轉(zhuǎn) SpringBoot 2 之整合 JWT 上篇》 中介紹了關(guān)于 JWT 相關(guān)概念和JWT 基本使用的操作方式。本文為 SpringBoot 整合 JWT 的下篇，通過(guò)解決 App 用戶(hù)登錄 Session 問(wèn)題的實(shí)戰(zhàn)操作，帶你更深入理解 JWT。通過(guò)本文你還可以了解到如下內(nèi)容：
- SpringBoot 使用攔截器的實(shí)際應(yīng)用
- SpringBoot 統(tǒng)一異常處理
- SpringBoot 快速搭建 RESTful Api
關(guān)于生成JWT 操作請(qǐng)參考 《玩轉(zhuǎn) SpringBoot 2 之整合 JWT 上篇》
實(shí)戰(zhàn)操作
登錄操作
登錄操作流程圖：
登錄操作流程介紹：
- App 根據(jù)用戶(hù)名和密碼訪(fǎng)問(wèn)登錄接口。
- 如果用戶(hù)名和密碼錯(cuò)誤則提示 App 用戶(hù)密碼輸入錯(cuò)誤。
- 如果用戶(hù)名和密碼正確則獲取用戶(hù)信息（表示登錄成功）并根據(jù)用戶(hù)信息生成 Token 并將其存入ServletContext 中。
- 將生成的 Token 返回給 App。
登錄操作具體代碼：
@RestController
public class LoginController {
Logger log = LoggerFactory.getLogger(LoginController.class);
@Autowired
private 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;
}
攔截操作
攔截操作流程圖：
攔截操作流程介紹：
服務(wù)器獲取 （App訪(fǎng)問(wèn)具體的Api 時(shí)攜帶的 Token）Token，如果 Token 為空則提示 App Token不能為空。
如果 Token 不為空則從 ServletContext 中獲取 Token，如果不存在則提示 App 該Token為非法 Token ！
如果 Token 不為空并且 ServletContext 中存在該Token，需要判斷 Token 是否過(guò)期。如果未過(guò)期則放開(kāi)攔截。
如果Token 已經(jīng)過(guò)期則提示 App Token已經(jīng)過(guò)期，需要重新登錄。
攔截操作具體代碼：
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已經(jīng)過(guò)期");
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;
}
}
退出操作
退出操作流程介紹：
訪(fǎng)問(wèn)退出接口并傳遞登錄生成的 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 訪(fǎng)問(wèn)測(cè)試Api，具體代碼如下：
@RestController
public class IndexController {
@GetMapping("index")
public ReturnMessage index() {
return ReturnMessageUtil.sucess();
}
}
統(tǒng)一異常次處理的 Handle
@RestControllerAdvice
public class ExceptionHandle {
private final static Logger logger = LoggerFactory.getLogger(ExceptionHandle.class);
@ExceptionHandler(value = Exception.class)
//@ResponseBody
public 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("系統(tǒng)異常 {}",exception);
return ReturnMessageUtil.error(-1, "未知異常"+exception.getMessage());
}
}
}
JWTService 工具類(lèi) 代碼可以在我的GitHub上進(jìn)行查看，具體地址請(qǐng)查看下面代碼示例章節(jié)。
測(cè)試
這里使用PostMan 進(jìn)行測(cè)試，當(dāng)然你也可以選用你順手的工具進(jìn)行測(cè)試哈！
訪(fǎng)問(wèn) http://localhost:8080/sbe/login?loginName=ljk&password=123456 進(jìn)行登錄獲取Token，如下圖所示date字段的值就是登錄成功后生成的 Token。
訪(fǎng)問(wèn) http://localhost:8080/sbe/index?token=具體token值，如下圖所示訪(fǎng)問(wèn)成功！
如果不攜帶 Token 會(huì)提示Token不能為空，如下圖所示：
如果輸入不存在的 Token 則提示 非法Token！，如下圖所示：
http://localhost:8080/sbe/logout?token=具體token值 進(jìn)行退出，如下圖所示：
退出后再次使用已經(jīng)退出的Token 訪(fǎng)問(wèn)，會(huì)提示非法Token 如下圖所示：
小結(jié)
登錄操作通過(guò) JWT 生成Token 返回給App，攔截操作（也可以理解成校驗(yàn)操作）通過(guò)攔截器（HandlerInterceptor）來(lái)進(jìn)行實(shí)現(xiàn)。最后退出操作是通過(guò)將Token 保存ServletContent 中，退出其實(shí)就是將 Token 從 ServletContent 中刪除。
本文主旨是通過(guò)簡(jiǎn)單實(shí)現(xiàn)，帶你了解 App 認(rèn)證過(guò)程處理方式，對(duì)于攔截部分你也可以通過(guò) Filter 或 Aop 來(lái)進(jìn)行實(shí)現(xiàn)。Token 存儲(chǔ)也可以考慮使用Redis來(lái)實(shí)現(xiàn)，還有一個(gè)問(wèn)題就是：JWT 續(xù)期問(wèn)題本文并沒(méi)有實(shí)現(xiàn)（JWT 過(guò)期時(shí)間延期問(wèn)題）。這個(gè)部分就當(dāng)成一個(gè)作業(yè)，歡迎大家在評(píng)論區(qū)說(shuō)說(shuō)你的解決方案？
代碼示例
本文并沒(méi)有對(duì) JWTService 工具類(lèi)、統(tǒng)一異常處理、攔截器使用搭建進(jìn)行詳細(xì)介紹，如果你想直接查看本文全部源碼，請(qǐng)?jiān)谖业腉itHub 倉(cāng)庫(kù) SpringbootExamples 中的 spring-boot-2.x-jwt 模塊進(jìn)行查看。
GitHub：https://github.com/zhuoqianmingyue/springbootexamples
同時(shí)你也可以通過(guò)查看我關(guān)于攔截器、統(tǒng)一異常處理、搭建 RESTful Api 詳細(xì)教程總結(jié)自己完成相關(guān)的實(shí)現(xiàn)：
