SpringBoot集成JWT實現token驗證

来源:https://www.cnblogs.com/jichuang/archive/2020/01/17/12205918.html
-Advertisement-
Play Games

原文：https://www.jianshu.com/p/e88d3f8151db JWT官網： https://jwt.io/ JWT(Java版)的github地址:https://github.com/jwtk/jjwt 什麼是JWT Json web token (JWT), 是為了在網路應 ...


原文：https://www.jianshu.com/p/e88d3f8151db

JWT官網： https://jwt.io/
JWT(Java版)的github地址:https://github.com/jwtk/jjwt

什麼是JWT

Json web token (JWT), 是為了在網路應用環境間傳遞聲明而執行的一種基於JSON的開放標準（(RFC 7519).定義了一種簡潔的，自包含的方法用於通信雙方之間以JSON對象的形式安全的傳遞信息。因為數字簽名的存在，這些信息是可信的，JWT可以使用HMAC演算法或者是RSA的公私秘鑰對進行簽名。

JWT請求流程

 

 

1. 用戶使用賬號和麵發出post請求；
2. 伺服器使用私鑰創建一個jwt；
3. 伺服器返回這個jwt給瀏覽器；
4. 瀏覽器將該jwt串在請求頭中像伺服器發送請求；
5. 伺服器驗證該jwt；
6. 返迴響應的資源給瀏覽器。

JWT的主要應用場景

身份認證在這種場景下，一旦用戶完成了登陸，在接下來的每個請求中包含JWT，可以用來驗證用戶身份以及對路由，服務和資源的訪問許可權進行驗證。由於它的開銷非常小，可以輕鬆的在不同功能變數名稱的系統中傳遞，所有目前在單點登錄（SSO）中比較廣泛的使用了該技術。 信息交換在通信的雙方之間使用JWT對數據進行編碼是一種非常安全的方式，由於它的信息是經過簽名的，可以確保發送者發送的信息是沒有經過偽造的。

優點

1.簡潔(Compact): 可以通過URL，POST參數或者在HTTP header發送，因為數據量小，傳輸速度也很快
2.自包含(Self-contained)：負載中包含了所有用戶所需要的信息，避免了多次查詢資料庫
3.因為Token是以JSON加密的形式保存在客戶端的，所以JWT是跨語言的，原則上任何web形式都支持。
4.不需要在服務端保存會話信息，特別適用於分散式微服務。

`

JWT的結構

JWT是由三段信息構成的，將這三段信息文本用.連接一起就構成了JWT字元串。
就像這樣:

1 eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ

JWT包含了三部分：
Header 頭部(標題包含了令牌的元數據，並且包含簽名和/或加密演算法的類型)
Payload 負載 (類似於飛機上承載的物品)
Signature 簽名/簽證

Header

JWT的頭部承載兩部分信息：token類型和採用的加密演算法。

1 { 
2   "alg": "HS256",
3    "typ": "JWT"
4 }

聲明類型:這裡是jwt
聲明加密的演算法:通常直接使用 HMAC SHA256

加密演算法是單向函數散列演算法，常見的有MD5、SHA、HAMC。
MD5(message-digest algorithm 5) （信息-摘要演算法）縮寫，廣泛用於加密和解密技術，常用於文件校驗。校驗？不管文件多大，經過MD5後都能生成唯一的MD5值
SHA (Secure Hash Algorithm，安全散列演算法），數字簽名等密碼學應用中重要的工具，安全性高於MD5
HMAC (Hash Message Authentication Code)，散列消息鑒別碼，基於密鑰的Hash演算法的認證協議。用公開函數和密鑰產生一個固定長度的值作為認證標識，用這個標識鑒別消息的完整性。常用於介面簽名驗證

Payload

載荷就是存放有效信息的地方。
有效信息包含三個部分
1.標準中註冊的聲明
2.公共的聲明
3.私有的聲明

標準中註冊的聲明 (建議但不強制使用) ：

iss: jwt簽發者
sub: 面向的用戶(jwt所面向的用戶)
aud: 接收jwt的一方
exp: 過期時間戳(jwt的過期時間，這個過期時間必須要大於簽發時間)
nbf: 定義在什麼時間之前，該jwt都是不可用的.
iat: jwt的簽發時間
jti: jwt的唯一身份標識，主要用來作為一次性token,從而迴避重放攻擊。

公共的聲明 ：

公共的聲明可以添加任何的信息，一般添加用戶的相關信息或其他業務需要的必要信息.但不建議添加敏感信息，因為該部分在客戶端可解密.

私有的聲明 ：

私有聲明是提供者和消費者所共同定義的聲明，一般不建議存放敏感信息，因為base64是對稱解密的，意味著該部分信息可以歸類為明文信息。

Signature

jwt的第三部分是一個簽證信息
這個部分需要base64加密後的header和base64加密後的payload使用.連接組成的字元串，然後通過header中聲明的加密方式進行加鹽secret組合加密，然後就構成了jwt的第三部分。
密鑰secret是保存在服務端的，服務端會根據這個密鑰進行生成token和進行驗證，所以需要保護好。

下麵來進行SpringBoot和JWT的集成

引入JWT依賴,由於是基於Java，所以需要的是java-jwt

1 <dependency>
2       <groupId>com.auth0</groupId>
3       <artifactId>java-jwt</artifactId>
4       <version>3.4.0</version>
5 </dependency>

需要自定義兩個註解

用來跳過驗證的 PassToken

1 @Target({ElementType.METHOD, ElementType.TYPE})
2 @Retention(RetentionPolicy.RUNTIME)
3 public @interface PassToken {
4     boolean required() default true;
5 }

需要登錄才能進行操作的註解 UserLoginToken

1 @Target({ElementType.METHOD, ElementType.TYPE})
2 @Retention(RetentionPolicy.RUNTIME)
3 public @interface UserLoginToken {
4     boolean required() default true;
5 }
@Target:註解的作用目標

@Target(ElementType.TYPE)——介面、類、枚舉、註解
@Target(ElementType.FIELD)——欄位、枚舉的常量
@Target(ElementType.METHOD)——方法
@Target(ElementType.PARAMETER)——方法參數
@Target(ElementType.CONSTRUCTOR) ——構造函數
@Target(ElementType.LOCAL_VARIABLE)——局部變數
@Target(ElementType.ANNOTATION_TYPE)——註解
@Target(ElementType.PACKAGE)——包

@Retention：註解的保留位置

RetentionPolicy.SOURCE:這種類型的Annotations只在源代碼級別保留,編譯時就會被忽略,在class位元組碼文件中不包含。
RetentionPolicy.CLASS:這種類型的Annotations編譯時被保留,預設的保留策略,在class文件中存在,但JVM將會忽略,運行時無法獲得。
RetentionPolicy.RUNTIME:這種類型的Annotations將被JVM保留,所以他們能在運行時被JVM或其他使用反射機制的代碼所讀取和使用。
@Document：說明該註解將被包含在javadoc中
@Inherited：說明子類可以繼承父類中的該註解

簡單自定義一個實體類User,使用lombok簡化實體類的編寫

1 @Data
2 @AllArgsConstructor
3 @NoArgsConstructor
4 public class User {
5     String Id;
6     String username;
7     String password;
8 }

需要寫token的生成方法

1 public String getToken(User user) {
2         String token="";
3         token= JWT.create().withAudience(user.getId())
4                 .sign(Algorithm.HMAC256(user.getPassword()));
5         return token;
6     }

Algorithm.HMAC256():使用HS256生成token,密鑰則是用戶的密碼，唯一密鑰的話可以保存在服務端。
withAudience()存入需要保存在token的信息，這裡我把用戶ID存入token中

接下來需要寫一個攔截器去獲取token並驗證token

 1 public class AuthenticationInterceptor implements HandlerInterceptor {
 2     @Autowired
 3     UserService userService;
 4     @Override
 5     public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object object) throws Exception {
 6         String token = httpServletRequest.getHeader("token");// 從 http 請求頭中取出 token
 7         // 如果不是映射到方法直接通過
 8         if(!(object instanceof HandlerMethod)){
 9             return true;
10         }
11         HandlerMethod handlerMethod=(HandlerMethod)object;
12         Method method=handlerMethod.getMethod();
13         //檢查是否有passtoken註釋，有則跳過認證
14         if (method.isAnnotationPresent(PassToken.class)) {
15             PassToken passToken = method.getAnnotation(PassToken.class);
16             if (passToken.required()) {
17                 return true;
18             }
19         }
20         //檢查有沒有需要用戶許可權的註解
21         if (method.isAnnotationPresent(UserLoginToken.class)) {
22             UserLoginToken userLoginToken = method.getAnnotation(UserLoginToken.class);
23             if (userLoginToken.required()) {
24                 // 執行認證
25                 if (token == null) {
26                     throw new RuntimeException("無token，請重新登錄");
27                 }
28                 // 獲取 token 中的 user id
29                 String userId;
30                 try {
31                     userId = JWT.decode(token).getAudience().get(0);
32                 } catch (JWTDecodeException j) {
33                     throw new RuntimeException("401");
34                 }
35                 User user = userService.findUserById(userId);
36                 if (user == null) {
37                     throw new RuntimeException("用戶不存在，請重新登錄");
38                 }
39                 // 驗證 token
40                 JWTVerifier jwtVerifier = JWT.require(Algorithm.HMAC256(user.getPassword())).build();
41                 try {
42                     jwtVerifier.verify(token);
43                 } catch (JWTVerificationException e) {
44                     throw new RuntimeException("401");
45                 }
46                 return true;
47             }
48         }
49         return true;
50     }
51 
52     @Override
53     public void postHandle(HttpServletRequest httpServletRequest, 
54                                   HttpServletResponse httpServletResponse, 
55                             Object o, ModelAndView modelAndView) throws Exception {
56 
57     }
58     @Override
59     public void afterCompletion(HttpServletRequest httpServletRequest, 
60                                           HttpServletResponse httpServletResponse, 
61                                           Object o, Exception e) throws Exception {
62     }

實現一個攔截器就需要實現HandlerInterceptor介面

HandlerInterceptor介面主要定義了三個方法
1.boolean preHandle ()：
預處理回調方法,實現處理器的預處理，第三個參數為響應的處理器,自定義Controller,返回值為true表示繼續流程（如調用下一個攔截器或處理器）或者接著執行
postHandle()和afterCompletion()；false表示流程中斷，不會繼續調用其他的攔截器或處理器，中斷執行。

2.void postHandle()：
後處理回調方法，實現處理器的後處理（DispatcherServlet進行視圖返回渲染之前進行調用），此時我們可以通過modelAndView（模型和視圖對象）對模型數據進行處理或對視圖進行處理，modelAndView也可能為null。

3.void afterCompletion():
整個請求處理完畢回調方法,該方法也是需要當前對應的Interceptor的preHandle()的返回值為true時才會執行，也就是在DispatcherServlet渲染了對應的視圖之後執行。用於進行資源清理。整個請求處理完畢回調方法。如性能監控中我們可以在此記錄結束時間並輸出消耗時間，還可以進行一些資源清理，類似於try-catch-finally中的finally，但僅調用處理器執行鏈中

主要流程:

1.從 http 請求頭中取出 token，
2.判斷是否映射到方法
3.檢查是否有passtoken註釋，有則跳過認證
4.檢查有沒有需要用戶登錄的註解，有則需要取出並驗證
5.認證通過則可以訪問，不通過會報相關錯誤信息

配置攔截器

在配置類上添加了註解@Configuration，標明瞭該類是一個配置類並且會將該類作為一個SpringBean添加到IOC容器內

 1 @Configuration
 2 public class InterceptorConfig extends WebMvcConfigurerAdapter {
 3     @Override
 4     public void addInterceptors(InterceptorRegistry registry) {
 5         registry.addInterceptor(authenticationInterceptor())
 6                 .addPathPatterns("/**");    // 攔截所有請求，通過判斷是否有 @LoginRequired 註解 決定是否需要登錄
 7     }
 8     @Bean
 9     public AuthenticationInterceptor authenticationInterceptor() {
10         return new AuthenticationInterceptor();
11     }
12 }

WebMvcConfigurerAdapter該抽象類其實裡面沒有任何的方法實現，只是空實現了介面
WebMvcConfigurer內的全部方法，並沒有給出任何的業務邏輯處理，這一點設計恰到好處的讓我們不必去實現那些我們不用的方法，都交由WebMvcConfigurerAdapter抽象類空實現,如果我們需要針對具體的某一個方法做出邏輯處理,僅僅需要在
WebMvcConfigurerAdapter子類中@Override對應方法就可以了。

註：
在SpringBoot2.0及Spring 5.0中WebMvcConfigurerAdapter已被廢棄
網上有說改為繼承WebMvcConfigurationSupport，不過試了下，還是過期的

解決方法:

直接實現WebMvcConfigurer （官方推薦）

 1 @Configuration
 2 public class InterceptorConfig implements WebMvcConfigurer {
 3     @Override
 4     public void addInterceptors(InterceptorRegistry registry) {
 5         registry.addInterceptor(authenticationInterceptor())
 6                 .addPathPatterns("/**");   
 7     }
 8     @Bean
 9     public AuthenticationInterceptor authenticationInterceptor() {
10         return new AuthenticationInterceptor();
11     }
12 }

InterceptorRegistry內的addInterceptor需要一個實現HandlerInterceptor介面的攔截器實例，addPathPatterns方法用於設置攔截器的過濾路徑規則。
這裡我攔截所有請求，通過判斷是否有@LoginRequired註解 決定是否需要登錄

在數據訪問介面中加入登錄操作註解

 1 @RestController
 2 @RequestMapping("api")
 3 public class UserApi {
 4     @Autowired
 5     UserService userService;
 6     @Autowired
 7     TokenService tokenService;
 8     //登錄
 9     @PostMapping("/login")
10     public Object login(@RequestBody User user){
11         JSONObject jsonObject=new JSONObject();
12         User userForBase=userService.findByUsername(user);
13         if(userForBase==null){
14             jsonObject.put("message","登錄失敗,用戶不存在");
15             return jsonObject;
16         }else {
17             if (!userForBase.getPassword().equals(user.getPassword())){
18                 jsonObject.put("message","登錄失敗,密碼錯誤");
19                 return jsonObject;
20             }else {
21                 String token = tokenService.getToken(userForBase);
22                 jsonObject.put("token", token);
23                 jsonObject.put("user", userForBase);
24                 return jsonObject;
25             }
26         }
27     }
28     @UserLoginToken
29     @GetMapping("/getMessage")
30     public String getMessage(){
31         return "你已通過驗證";
32     }
33 }

不加註解的話預設不驗證，登錄介面一般是不驗證的。在getMessage()中我加上了登錄註解，說明該介面必須登錄獲取token後，在請求頭中加上token並通過驗證才可以訪問

下麵進行測試，啟動項目，使用postman測試介面

在沒token的情況下訪問api/getMessage介面

  　　　　　　　　　　　　　　image.png
我這裡使用了統一異常處理，所以只看到錯誤message

 

下麵進行登錄，從而獲取token

  image.png
登錄操作我沒加驗證註解，所以可以直接訪問

 

把token加在請求頭中，再次訪問api/getMessage介面

  image.png
註意:這裡的key一定不能錯，因為在攔截器中是取關鍵字token的值
String token = httpServletRequest.getHeader("token");
加上token之後就可以順利通過驗證和進行介面訪問了

 

github項目源碼地址：https://github.com/JinBinPeng/springboot-jwt










您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • Android中常用ADB命令集錦
    收集的Android測試或者開發中常用的aadb命令，可以使用Ctrl+F快速搜索### ADB命令集錦： adb --help //adb幫助 adb start-server //啟動adb server adb kill-server //關閉adb server adb devices // ...
  • Python 3.8 已發佈，現在是切換至新版本的好時機嗎？
    Python 3.8 已於前兩周正式發佈，不過目前大多數開發者主要使用的仍是 Python 3.7.x 或更舊的版本。 ！ 事實上，立刻切換到使用 Python 3.8 可能會引發一些問題。想知道何時切換至 Python 3.8？下文將簡要概述切換主要的 Python 版本以及進行切換時可能會遇到的 ...
  • 深入delphi編程理解之消息（一）WINDOWS原生視窗編寫及消息處理過程
    通過以sdk方式編製windows視窗程式，對理解windows消息驅動機制和delphi消息編程有很大的幫助。 sdk編製windows視窗程式的步驟： 1、對TWndClass對象進行賦值; 2、向系統註冊wndclass對象(RegisterClass)； 3、CreateWindow創建視窗 ...
  • java提取字元串數字，Java獲取字元串中的數字
    ©Copyright 蕃薯耀 2020-01-17 https://www.cnblogs.com/fanshuyao/ 具體的方法如下： /** * 把字元串數字類型的數字取出來（只取遇到非數字字元前，包括空格） * @param str * <li>"1-0我5013我24a5c6" 》 1</ ...
  • 樂優商城1 —— 工程搭建
    你可以訪問 "碼雲 樂優商城" 來獲取關於樂優商城的工程代碼。 你可以訪問 "百度雲 樂優優商城" 密碼：ppzy 來獲取關於樂優商城的資料。 一、創建父工程 Maven Project 用來管理依賴 GroupId：項目中唯一標識符，對應的是java中的包結構，在這裡表示項目中的結構 Artifa ...
  • SpringBoot啟動後自動打開瀏覽器訪問項目
    之前我們用SSM或者SSH進行JAVA WEB開發的時候,IDEA 需要配置Tomcat然後把項目放到tomcat運行，tomcat啟動的時候會自動打開瀏覽器去訪問項目，但是SpringBoot是內嵌tomcat的，項目啟動成功後無法自主訪問，需要我們手動打開瀏覽器輸入url訪問，我覺得這樣很不習慣... ...
  • [Golang] 劍走偏鋒 -- IoComplete ports
    前言 Golang 目前的主要應用領域還是後臺微服務，雖然在業務領域也有所應用但仍然是比較小衆的選擇。大多數的服務運行環境都是linux，而在windows中golang應用更少，而作者因爲特殊情況，不得已要在widows環境中用golang去寫本地代理服務。在我的使用場景中實時性要求非常高（視頻通 ...
  • 模擬copy
    import java.io.*; public class test13_6 { public static void main(String []args) throws Exception { FileOutputStream output=null; FileInputStream inpu ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類