mall :sa-token項目源碼解析

来源:https://www.cnblogs.com/MrDevil-k/archive/2023/08/22/17648880.html
-Advertisement-
Play Games

[TOC] ## 一、mall開源項目 ### 1.1 來源 **mall學習教程**,架構、業務、技術要點全方位解析。mall項目(**50k+star**)是一套電商系統,使用現階段主流技術實現。涵蓋了SpringBoot 2.3.0、MyBatis 3.4.6、Elasticsearch 7. ...


目錄

一、mall開源項目

1.1 來源

mall學習教程,架構、業務、技術要點全方位解析。mall項目(50k+star)是一套電商系統,使用現階段主流技術實現。涵蓋了SpringBoot 2.3.0、MyBatis 3.4.6、Elasticsearch 7.6.2、RabbitMQ 3.7.15、Redis 5.0、MongoDB 4.2.5、Mysql5.7等技術,採用Docker容器化部署。

項目github地址: mall開源項目

1.2 項目轉移

可以把github上的項目轉移到gitee上,方便克隆到idea。

具體步驟如下:

1.3 項目克隆

由於github部署在國外,雖然idea也支持從github上拉取,但是克隆速度太慢,所以才推薦上述導入gitee後在克隆項目到idea。

具體的克隆步驟過於簡單和常規化,讀者可自行完成,或百度一下~

二、Sa-Toekn框架

2.1 Sa-Token 簡介

Sa-Token 是一個輕量級 Java 許可權認證框架,主要解決:登錄認證許可權認證單點登錄OAuth2.0分散式Session會話微服務網關鑒權 等一系列許可權相關問題。

Sa-Token 目前主要五大功能模塊:登錄認證、許可權認證、單點登錄、OAuth2.0、微服務鑒權。

功能概覽圖如下:

sa-token開發文檔地址: 框架介紹 (sa-token.cc)

2.2 分散式後端項目的使用流程

下圖是結合項目經歷,外加百度查找資料,自行總結的基本使用流程。

sa-token的使用流程圖如下:

2.3 分散式後端項目的使用場景

下圖是結合項目經歷,外加百度查找資料,自行總結的基本使用場景。

sa-token的使用場景圖如下:

三、源碼解析

看源碼自我總結出來的看新項目時的基本步驟,首先先看集成和配置,在從業務的角度來分析,結合集成的框架和組件,來依次剝削系統的架構。

解析內容:下方的解析內容大部分在圖中解釋,外面就不做過多的闡述。

3.1 集成與配置

直接拿源碼分析,只分析與sa-token有關的部分,其它部分讀者請,自行看源碼分析。

項目啟動:只需要啟動mall-tiny-sa-token模塊的部分即可。

啟動所需:啟動mysql5的服務,創建資料庫,並導入表(sql文件位置在,項目同級目錄的document文件夾里)。

ps:記得修改資料庫連接的配置信息。

3.1.1 導入依賴

pom文件中導入sa-token的相關依賴。

3.1.2 添加配置

application.yml中添加sa-token的相關配置,項目支持前後端分離項目,關閉從 cookie 中讀取 token,改為從 head 中讀取 token的配置。

3.1.3 異常處理

對於處理未登錄的、沒有許可權的、沒有角色的異常,需要全局處理一下。

拿登錄來做個小例子:由於未登錄狀態下訪問介面,Sa-Token 會拋出NotLoginException異常,此時會根據自定義的返回信息,返回狀態碼401和響應信息未提供token(異常處理的結果信息)。

3.1.4 存儲用戶信息

有兩個用戶,admin用戶具有ROLE_ADMIN角色,macro用戶具有ROLE_USER角色。

ps:模擬資料庫兩張表的關聯信息是根據id來關聯的,也就是給用戶分配角色。

3.2 登錄認證

3.2.1 配置黑白名單

在管理系統中,除了登錄介面,基本上都需要登錄認證,在 sa-token中使用路由攔截鑒權是最方便的,也就是說給sa-token配置攔截器,實現WebMvcConfigurer介面,配置黑白名單。

ps:自定義的白名單是從application.yml文件中獲取到的信息。

3.2.2 登錄業務代碼解讀

1.首先是控制層, 在UmsAdminController中添加一個登錄介面login

2.接著業務層, 在UmsAdminServiceImpl添加登錄的具體邏輯,先驗證密碼,然後調用StpUtil.login(adminUser.getId())即可實現登錄。

3.2.3 測試登錄

方式一:使用Postman測試

方式二:使用swagger介面文檔測試(建議使用,以及編寫好,直接訪問即可測試,訪問地址為: Swagger UI ),由於已經拿到token,就不做重覆測試了,直接測另一個介面,查詢當前登錄狀態的介面。

3.3 角色認證

緊接上文,我來實現一下吧!對於角色認證也就是定義好一套訪問介面的規則,比如ROLE-ADMIN角色可以訪問/brand下的所有資源,而ROLE_USER角色只能訪問/brand/listAll下的資源。

配置全局異常:見副標題3.1.3有所描述,不做過多陳訴。

當用戶不是被允許的角色訪問時,Sa-Token會拋出NotRoleException異常。

3.3.1 許可權驗證介面擴展

擴展 sa-token的StpInterface介面,重寫方法來返回用戶的角色名稱和角色許可權列表。

由於StpInterfaceImpl實現了StpInterface介面,重寫了裡面的方法。所以在SaTokenConfig的配置文件中的StpUtil.checkRole("ROLE_ADMIN")才能匹配到模擬的資料庫的角色信息。許可權信息也是同理,不一一列舉了。

3.3.2 配置攔截器

在攔截器中配置路由規則,ROLE_ADMIN角色可以訪問所有路徑,而ROLE_USER只能訪問/brand/listAll路徑。

3.3.3 測試角色

對於 admin用戶具有ROLE_ADMIN角色,macro用戶具有ROLE_USER角色 。

  • 使用admin賬號訪問/brand/{id}介面可以正常訪問
  • 使用macro賬號訪問/brand/{id}介面無法正常訪問,返回code403

這裡就不對admin進行測試展示了,下方是對macro用戶進行測試,查看沒有許可權的效果。

3.4 許可權認證

當給角色分配好許可權,然後給用戶分配好角色後,用戶就擁有了這些許可權。

對於許可權認證,也可以為每個介面分配不同的許可權,擁有該許可權的用戶就可以訪問該介面。

配置全局異常:見副標題3.1.3有所描述,不做過多陳訴。

用戶無許可權訪問時,Sa-Token 會拋出NotPermissionException異常。

3.4.1 配置攔截器

給攔截器配置路由規則admin用戶可以訪問所有路徑,而macro用戶只有讀取的許可權,沒有寫、改、刪的許可權。

3.4.2 測試許可權

對於 admin用戶可以訪問所有路徑,而macro用戶只有讀取的許可權,沒有寫、改、刪的許可權。

  • 使用admin賬號訪問/brand/delete介面可以正常訪問
  • 使用macro賬號訪問/brand/delete無法正常訪問,返回code403

這裡就不對admin進行測試展示了,下方是對macro用戶進行測試,查看沒有許可權的效果。

四、總結

本文是有我先從實際項目中獲取需求,從而對SpringSecurityOath2的學習,結合源碼來學習,到另一個項目由於鑒權已經部署在不同的ip,項目使用調用即可,項目中使用了 Sa-Token 是一個輕量級 Java 許可權認證框架 ,看官網是看的明白,但是不懂如何入手,就有了此文,從mall開源項目中學習sa-token,感覺收穫頗深,希望這篇文章對你們也會有所幫助。

後續我也會結合該框架學習一下其他的技術棧。

七夕~盈若安好,便是晴天


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

-Advertisement-
Play Games
更多相關文章
  • 在當今的數字時代,大規模數據處理和分析已經成為了企業和組織中不可或缺的一部分。為了有效地處理和分析海量的數據,Hadoop生態系統應運而生。本文將深入探討Hadoop生態系統的工作原理,介紹其關鍵組件以及如何使用它來處理和分析大規模數據。 ## 什麼是Hadoop? Hadoop是一個開源的分散式計 ...
  • Infinispan 是一個基於分散式系統的記憶體數據存儲和緩存平臺,它的集群實現原理涉及到節點的發現和通信。在 Infinispan 中,集群是由多個節點組成的,每個節點都存儲著數據的一部分,並且通過通信來保持數據的一致性和可用性。 Infinispan 集群的實現原理主要包括以下幾個關鍵點: 1. ...
  • # 簡介 Spring Boot Admin(SBA)是一個針對spring-boot的actuator介面進行UI美化封裝的監控工具。它可以:在列表中瀏覽所有被監控spring-boot項目的基本信息,詳細的Health信息、記憶體信息、JVM信息、垃圾回收信息,還可以直接修改logger日誌的le ...
  • # 應用場景 * 用戶下單5分鐘後,給他發簡訊 * 用戶下單30分鐘後,如果用戶不付款就自動取消訂單 # kafka無死信隊列 kafka本身沒有這種延時隊列的機制,像rabbitmq有自己的死信隊列,當一些消息在一定時間不消費時會發到死信隊列,由死信隊列來處理它們,上面的兩個需求如果是rabbit ...
  • 本文翻譯自國外論壇 medium,原文地址:https://levelup.gitconnected.com/how-i-deleted-more-than-1000-lines-of-code-using-spring-retry-9118de29060 > 使用 Spring Retry 重構代 ...
  • 通過一張圖描述清楚TuGraph Analytics的整體架構和關鍵設計,幫助大家快速瞭解TuGraph Analytics項目輪廓。 ...
  • ![](https://img2023.cnblogs.com/other/1218593/202308/1218593-20230822164212978-1679813836.png) ### 背景 有時候我們需要進行遠程的debug,本文研究如何進行遠程debug,以及使用 IDEA 遠程de ...
  • ## 1 概要 通過引入結構化併發編程的API,簡化併發編程。結構化併發將在不同線程中運行的相關任務組視為單個工作單元,從而簡化錯誤處理和取消操作,提高可靠性,並增強可觀察性。這是一個預覽版的API。 ## 2 歷史 結構化併發是由JEP 428提出的,併在JDK 19中作為孵化API發佈。它在JD ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 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 ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...