Springboot實現(xiàn)Shiro整合JWT的示例代碼
寫在前面
之前想嘗試把JWT和Shiro結(jié)合到一起，但是在網(wǎng)上查了些博客，也沒太有看懂，所以就自己重新研究了一下Shiro的工作機制，然后自己想了個（傻逼）辦法把JWT和Shiro整合到一起了
另外接下來還會涉及到JWT相關的內(nèi)容，我之前寫過一篇博客，可以看這里：Springboot實現(xiàn)JWT認證
Shiro的Session機制
由于我的方法是改變了Shiro的默認的Session機制，所以這里先簡單講一下Shiro的機制，簡單了解Shiro是怎么確定每次訪問的是哪個用戶的
Servlet的Session機制
Shiro在JavaWeb中使用到的就是默認的Servlet的Session機制，大致流程如下：
1.用戶首次發(fā)請求
2.服務器接收到請求之后，無論你有沒有權限訪問到資源，在返回響應的時候，服務器都會生成一個Session用來儲存該用戶的信息，然后生成SessionId作為對應的Key
3.服務器會在響應中，用jsessionId這個名字，把這個SessionId以Cookie的方式發(fā)給客戶（就是Set-Cookie響應頭）
4.由于已經(jīng)設置了Cookie，下次訪問的時候，服務器會自動識別到這個SessionId然后找到你上次對應的Session
Shiro帶來的變化
而結(jié)合Shiro之后，上面的第二步和第三步會發(fā)生小變化：
2.—>服務器不但會創(chuàng)建Session，還會創(chuàng)建一個Subject對象（就是Shiro中用來代表當前用戶的類），也用這個SessionId作為Key綁定
3.—>第二次接受到請求的時候，Shiro會從請求頭中找到SessionId，然后去尋找對應的Subject然后綁定到當前上下文，這時候Shiro就能知道來訪的是誰了
我的思路
由于這個是我自己想出來的，所以可能會存在一定的問題，還請大佬指點
主要思想是：用JWT Token來代替Shiro原本返回的Session
工作流程：
- 用戶登錄
- 若成功則shiro會默認生成一個SessionId用來匹配當前Subject對象，則我們將這個SessionId放入JWT中
- 返回JWT
- 用戶第二次攜帶JWT來訪問接口
- 服務器解析JWT，獲得SessionId
- 服務器把SessionId交給Shiro執(zhí)行相關認證
代碼實現(xiàn)
導入JWT相關包
導入java-jwt包：
這個包里實現(xiàn)了一系列jwt操作的api（包括上面講到的怎么校驗，怎么生成jwt等等）
如果你是Maven玩家：
pom.xml里寫入
<!-- https://mvnrepository.com/artifact/com.auth0/java-jwt --> <dependency> <groupId>com.auth0</groupId> <artifactId>java-jwt</artifactId> <version>3.8.3</version> </dependency>
如果你是Gradle玩家：
build.gradle里寫入
compile group: 'com.auth0', name: 'java-jwt', version: '3.8.3'
如果你是其他玩家：
maven中央倉庫地址點這里
JWT工具類
JwtUtils，代碼如下：
import com.auth0.jwt.JWT;
import com.auth0.jwt.JWTVerifier;
import com.auth0.jwt.algorithms.Algorithm;
import com.auth0.jwt.exceptions.JWTDecodeException;
import com.auth0.jwt.interfaces.Claim;
import com.auth0.jwt.interfaces.DecodedJWT;
import java.io.Serializable;
import java.util.Calendar;
import java.util.Date;
/**
* @author Lehr
* @create: 2020-02-04
*/
public class JwtUtils {
/**
簽發(fā)對象：這個用戶的id
簽發(fā)時間：現(xiàn)在
有效時間：30分鐘
載荷內(nèi)容：暫時設計為：這個人的名字，這個人的昵稱
加密密鑰：這個人的id加上一串字符串
*/
public static String createToken(String userId,String realName, String userName) {
Calendar nowTime = Calendar.getInstance();
nowTime.add(Calendar.MINUTE,30);
Date expiresDate = nowTime.getTime();
return JWT.create().withAudience(userId) //簽發(fā)對象
.withIssuedAt(new Date()) //發(fā)行時間
.withExpiresAt(expiresDate) //有效時間
.withClaim("userName", userName) //載荷，隨便寫幾個都可以
.withClaim("realName", realName)
.sign(Algorithm.HMAC256(userId+"HelloLehr")); //加密
}
/**
* 檢驗合法性，其中secret參數(shù)就應該傳入的是用戶的id
* @param token
* @throws TokenUnavailable
*/
public static void verifyToken(String token, String secret) throws TokenUnavailable {
DecodedJWT jwt = null;
try {
JWTVerifier verifier = JWT.require(Algorithm.HMAC256(secret+"HelloLehr")).build();
jwt = verifier.verify(token);
} catch (Exception e) {
//效驗失敗
//這里拋出的異常是我自定義的一個異常，你也可以寫成別的
throw new TokenUnavailable();
}
}
/**
* 獲取簽發(fā)對象
*/
public static String getAudience(String token) throws TokenUnavailable {
String audience = null;
try {
audience = JWT.decode(token).getAudience().get(0);
} catch (JWTDecodeException j) {
//這里是token解析失敗
throw new TokenUnavailable();
}
return audience;
}
/**
* 通過載荷名字獲取載荷的值
*/
public static Claim getClaimByName(String token, String name){
return JWT.decode(token).getClaim(name);
}
}
一點小說明：
關于jwt生成時的加密和驗證方法：
jwt的驗證其實就是驗證jwt最后那一部分（簽名部分）。這里在指定簽名的加密方式的時候，還傳入了一個字符串來加密，所以驗證的時候不但需要知道加密算法，還需要獲得這個字符串才能成功解密，提高了安全性。我這里用的是id來，比較簡單，如果你想更安全一點，可以把用戶密碼作為這個加密字符串，這樣就算是這段業(yè)務代碼泄露了，也不會引發(fā)太大的安全問題（畢竟我的id是誰都知道的，這樣令牌就可以被偽造，但是如果換成密碼，只要數(shù)據(jù)庫沒事那就沒人知道）
關于獲得載荷的方法：
可能有人會覺得奇怪，為什么不需要解密不需要verify就能夠獲取到載荷里的內(nèi)容呢？原因是，本來載荷就只是用Base64處理了，就沒有加密性，所以能直接獲取到它的值，但是至于可不可以相信這個值的真實性，就是要看能不能通過驗證了，因為最后的簽名部分是和前面頭部和載荷的內(nèi)容有關聯(lián)的，所以一旦簽名驗證過了，那就說明前面的載荷是沒有被改過的。
Controller層
登錄邏輯
/**
* 用戶登錄
* @param userName
* @param password
* @param req
* @return
* @throws Exception
*/
@SneakyThrows
@PostMapping(value = "/login")
public AccountVO login(String userName, String password, HttpServletRequest req){
//嘗試登錄
Subject subject = SecurityUtils.getSubject();
try {
subject.login(new UsernamePasswordToken(userName, password));
} catch (Exception e) {
throw new LoginFailed();
}
AccountVO account = accountService.getAccountByUserName(userName);
String id = account.getId();
//生成jwtToken
String jwtToken = JwtUtils.createToken(id, account.getRealName(),account.getUserName(), subject.getSession().getId().toString());
//設置好token，后來會在全局處理的時候放入響應里
req.setAttribute("token", jwtToken);
return account;
}
主要是：在登錄成功之后把這個Subject的SessionId放入JWT然后生成token：
String jwtToken = JwtUtils.createToken(id,account.getRealName(),account.getUserName(),subject.getSession().getId().toString());
以后我們就可以通過解析JWT來獲取SessionId了，而不是每次把SessionId作為Cookie返回
退出邏輯
首先，由于JWT令牌本身就會失效，所以如果JWT令牌失效，也就相當與退出了
然后我們還可以同樣實現(xiàn)Shiro中傳統(tǒng)的手動登出：
public String logout(HttpServletRequest req) {
SecurityUtils.getSubject().logout();
return "用戶已經(jīng)安全登出";
}
這樣的話Realm中的用戶狀態(tài)就變成未認證了，就算JWT沒過期也需要重新登錄了
自定義SessionManager
先上代碼：
package com.imlehr.internship.shiroJwt;
import com.imlehr.internship.exception.TokenUnavailable;
import lombok.SneakyThrows;
import org.apache.shiro.session.mgt.SessionKey;
import org.apache.shiro.web.servlet.ShiroHttpServletRequest;
import org.apache.shiro.web.session.mgt.DefaultWebSessionManager;
import org.apache.shiro.web.util.WebUtils;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.Serializable;
import java.util.UUID;
/**
* @author Lehr
* @create: 2020-02-10
*/
public class CustomSessionManager extends DefaultWebSessionManager {
//這里我為了省事用了lombok的標簽
@SneakyThrows
@Override
protected Serializable getSessionId(ServletRequest request, ServletResponse response) {
String token = WebUtils.toHttp(request).getHeader("token");
System.out.println("會話管理器得到的token是：" + token);
if (token == null || token.length()<1) {
return UUID.randomUUID().toString();
}
//在這里驗證一下jwt了，雖然我知道這樣不好
String userId = JwtUtils.getAudience(token);
JwtUtils.verifyToken(token, userId);
String sessionId = JwtUtils.getClaimByName(token, "sessionId").asString();
if (sessionId == null) {
return new TokenUnavailable();
}
request.setAttribute(ShiroHttpServletRequest.REFERENCED_SESSION_ID_SOURCE, "header");
request.setAttribute(ShiroHttpServletRequest.REFERENCED_SESSION_ID, token);
request.setAttribute(ShiroHttpServletRequest.REFERENCED_SESSION_ID_IS_VALID, Boolean.TRUE);
request.setAttribute(ShiroHttpServletRequest.SESSION_ID_URL_REWRITING_ENABLED, isSessionIdUrlRewritingEnabled());
return sessionId;
}
}
之前的Session的獲取，就是在DefaultWebSessionManager里實現(xiàn)的，所以我們現(xiàn)在只需要重寫這個類，把我們?nèi)绾潍@取Session的邏輯寫進去就好了
這里說兩個方法：
getSessionId(SessionKey key)
這個方法是在DefaultWebSessionManager的，這里并沒有重寫，我們上面重寫的是后面第二個同名方法，只是想在這里談談，讀者可以直接跳過這段也不影響
源碼邏輯
在Shiro想要獲取SessionId的時候，首先會調(diào)用的就是這個方法，而不是那個傳入httpRequest的方法
在DefaultWebSessionManager中，他是這樣做的
@Override
public Serializable getSessionId(SessionKey key) {
Serializable id = super.getSessionId(key);
if (id == null && WebUtils.isWeb(key)) {
ServletRequest request = WebUtils.getRequest(key);
ServletResponse response = WebUtils.getResponse(key);
//調(diào)用第二個同名方法
id = getSessionId(request, response);
}
return id;
}
- 如果沒能找到id，就調(diào)用第二個同名方法
- 如果有，就返回
這里需要注意的是，這個方法會在整個驗證過程中多次被反復調(diào)用，而在服務器接受到用戶請求的時候，只會調(diào)用一次的方法是下面這個，也就是我們重寫的這個
getSessionId(ServletRequest request, ServletResponse response)
這個才是真正涉及到服務器接受到請求的時候獲取Session邏輯，從用戶的請求報文中獲取SessionId
所以我們要重寫的就是這一步
原版中的邏輯是：從Cookie里找到sessionId的值
我們只需要把邏輯該為：從Header中找出JWT（也就是從請求頭的'token'頭中找），然后解析JWT，獲取到我們存放在其中的SessionId屬性即可
ShiroConfiguration
我們只需要把自己寫的SessionManager配置進去就好了
首先配好：
public DefaultWebSessionManager sessionManager()
{
CustomSessionManager customSessionManager = new CustomSessionManager();
return customSessionManager;
}
然后放入SecurityManager
public SecurityManager securityManager(MyRealm myRealm) {
DefaultWebSecurityManager securityManager = new DefaultWebSecurityManager();
securityManager.setRealm(myRealm);
return securityManager;
}
完成🎉
測試
登錄
我們獲取到了JWT，JWT里面就帶有SessionId
后續(xù)請求不帶token
顯然，沒過認證，我們看下后臺：
因為不能獲得token所以無法得到該用戶對應的sessionId，所以被授權攔截了
后面那個JSESSIONID是因為沒得到sessionId新生成的，所以對應了一個沒有登錄的用戶，自然就會被拒絕
只有帶上之前的token，shiro才會認為我們是之前那個已經(jīng)登錄過的用戶
后續(xù)請求帶token
后臺：
成功！
另外，因為JWT本身就適合RESTful API服務，所以，如果把Shiro和Redis整合起來做成分布式的，那么效果會更好
到此這篇關于Springboot實現(xiàn)Shiro整合JWT的示例代碼的文章就介紹到這了,更多相關Springboot Shiro整合JWT內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
這篇文章主要介紹了Java 正則表達式詳細使用，非常不錯，具有參考借鑒價值，需要的朋友參考下吧2017-10-10
SpringBoot登錄驗證token攔截器的實現(xiàn)
本文主要介紹了SpringBoot登錄驗證token攔截器的實現(xiàn)，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2022-07-07
今天小編就為大家分享一篇java獲取用戶輸入的字符串方法，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2018-07-07
這篇文章主要介紹了JPA多條件復雜SQL動態(tài)分頁查詢功能，本文通過實例代碼給大家介紹的非常詳細，具有一定的參考借鑒價值,需要的朋友可以參考下2019-09-09
基于Properties實現(xiàn)配置數(shù)據(jù)庫驅(qū)動
這篇文章主要介紹了基于Properties實現(xiàn)配置數(shù)據(jù)庫驅(qū)動,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2020-05-05
SpringBoot 設置傳入?yún)?shù)非必要的操作
這篇文章主要介紹了SpringBoot 設置傳入?yún)?shù)非必要的操作，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2021-02-02
詳解使用Spring?Data?repository進行數(shù)據(jù)層的訪問問題
這篇文章主要介紹了使用Spring?Data?repository進行數(shù)據(jù)層的訪問,抽象出Spring Data repository是因為在開發(fā)過程中，常常會為了實現(xiàn)不同持久化存儲的數(shù)據(jù)訪問層而寫大量的大同小異的代碼，本文給大家介紹的非常詳細，需要的朋友參考下吧2022-06-06
這篇文章主要介紹了java算法之余弦相似度計算字符串相似率，對算法感興趣的同學，可以參考下2021-05-05
這篇文章主要介紹了重寫hashCode()和equals()方法詳細介紹，涉及重寫equals()方法，重寫hashCode()方法，重寫equals()而不重寫hashCode()的風險等相關內(nèi)容的介紹，具有一定借鑒價值,需要的朋友可以參考下2018-01-01
這篇文章主要介紹了java 使用異常的好處總結(jié)的相關資料,需要的朋友可以參考下2017-03-03