2. 程式人生 > 實用技巧 >穀粒商城XXL-SSO(三十六)

穀粒商城XXL-SSO(三十六)

阿新 • • 發佈：2020-07-21

231-232

一、簡介

1.1 概述

XXL-SSO 是一個分散式單點登入框架。只需要登入一次就可以訪問所有相互信任的應用系統。
擁有"輕量級、分散式、跨域、Cookie+Token均支援、Web+APP均支援"等特性。現已開放原始碼，開箱即用。

1.2 特性

  • 1、簡潔：API直觀簡潔，可快速上手
  • 2、輕量級：環境依賴小，部署與接入成本較低
  • 3、單點登入：只需要登入一次就可以訪問所有相互信任的應用系統
  • 4、分散式：接入SSO認證中心的應用，支援分散式部署
  • 5、HA：Server端與Client端，均支援叢集部署，提高系統可用性
  • 6、跨域：支援跨域應用接入SSO認證中心
  • 7、Cookie+Token均支援：支援基於Cookie和基於Token兩種接入方式，並均提供Sample專案
  • 8、Web+APP均支援：支援Web和APP接入
  • 9、實時性：系統登陸、登出狀態，全部Server與Client端實時共享
  • 10、CS結構：基於CS結構，包括Server"認證中心"與Client"受保護應用"
  • 11、記住密碼：未記住密碼時，關閉瀏覽器則登入態失效；記住密碼時，支援登入態自動延期，在自定義延期時間的基礎上，原則上可以無限延期
  • 12、路徑排除：支援自定義多個排除路徑，支援Ant表示式,用於排除SSO客戶端不需要過濾的路徑

1.3 下載

文件地址

原始碼倉庫地址

原始碼倉庫地址 Release Download
https://github.com/xuxueli/xxl-sso		 Download
https://gitee.com/xuxueli0323/xxl-sso Download

技術交流

1.4 環境

  • JDK：1.7+
  • Redis：4.0+

二、快速入門（基於Cookie）

基於Cookie，相關概念可參考 "章節 4.6"

2.1：原始碼編譯

- xxl-sso-server：中央認證服務，支援叢集
- xxl-sso-core：Client端依賴
- xxl-sso-samples：單點登陸Client端接入示例專案
    - xxl-sso-web-sample-springboot：基於Cookie接入方式，供使用者瀏覽器訪問，springboot版本
    - xxl-sso-token-sample-springboot：基於Token接入方式，常用於無法使用Cookie的場景使用，如APP、Cookie被禁用等，springboot版本

2.2 部署 "認證中心（SSO Server）"

專案名：xxl-sso-server

配置說明

配置檔案位置：application.properties

……

// redis 地址： 如 "{ip}"、"{ip}:{port}"、"{redis/rediss}://xxl-sso:{password}@{ip}:{port:6379}/{db}"；多地址逗號分隔
xxl.sso.redis.address=redis://127.0.0.1:6379

// 登入態有效期視窗，預設24H，當登入態有效期視窗過半時，自動順延一個週期
xxl.sso.redis.expire.minite=1440

2.3 部署 "單點登陸Client端接入示例專案"

專案名：xxl-sso-web-sample-springboot

maven依賴

<dependency>
    <groupId>com.xuxueli</groupId>
    <artifactId>xxl-sso-core</artifactId>
    <version>${最新穩定版}</version>
</dependency>

配置 XxlSsoFilter

參考程式碼：com.xxl.sso.sample.config.XxlSsoConfig

@Bean
public FilterRegistrationBean xxlSsoFilterRegistration() {

    // xxl-sso, redis init
    JedisUtil.init(xxlSsoRedisAddress);

    // xxl-sso, filter init
    FilterRegistrationBean registration = new FilterRegistrationBean();

    registration.setName("XxlSsoWebFilter");
    registration.setOrder(1);
    registration.addUrlPatterns("/*");
    registration.setFilter(new XxlSsoWebFilter());
    registration.addInitParameter(Conf.SSO_SERVER, xxlSsoServer);
    registration.addInitParameter(Conf.SSO_LOGOUT_PATH, xxlSsoLogoutPath);

    return registration;
}

配置說明

配置檔案位置：application.properties

……

### xxl-sso     (CLient端SSO配置)

##### SSO Server認證中心地址（推薦以域名方式配置認證中心，本機可參考章節"2.5"修改host檔案配置域名指向）
xxl.sso.server=http://xxlssoserver.com:8080/xxl-sso-server

##### 登出登陸path，值為Client端應用的相對路徑
xxl.sso.logout.path=/logout

##### 路徑排除Path，允許設定多個，且支援Ant表示式。用於排除SSO客戶端不需要過濾的路徑
xxl-sso.excluded.paths=

### redis   // redis address, like "{ip}"、"{ip}:{port}"、"{redis/rediss}://xxl-sso:{password}@{ip}:{port:6379}/{db}"；Multiple "," separated
xxl.sso.redis.address=redis://xxl-sso:[email protected]:6379/0

2.4 驗證

  • 修改Host檔案：域名方式訪問認證中心，模擬跨域與線上真實環境
### 在host檔案中新增以下內容0
127.0.0.1 xxlssoserver.com
127.0.0.1 xxlssoclient1.com
127.0.0.1 xxlssoclient2.com

  • 分別執行 "xxl-sso-server" 與 "xxl-sso-web-sample-springboot"

    1、SSO認證中心地址：
    http://xxlssoserver.com:8080/xxl-sso-server

    2、Client01應用地址：
    http://xxlssoclient1.com:8081/xxl-sso-web-sample-springboot/

    3、Client02應用地址：
    http://xxlssoclient2.com:8081/xxl-sso-web-sample-springboot/

  • SSO登入/登出流程驗證

    正常情況下，登入流程如下：
    1、訪問 "Client01應用地址" ，將會自動 redirect 到 "SSO認證中心地址" 登入介面
    2、成功登入後，將會自動 redirect 返回到 "Client01應用地址"，並切換為已登入狀態
    3、此時，訪問 "Client02應用地址"，不需登陸將會自動切換為已登入狀態

    正常情況下，登出流程如下：
    1、訪問 "Client01應用地址" 配置的 "登出登陸path"，將會自動 redirect 到 "SSO認證中心地址" 並自動登出登陸狀態
    2、此時，訪問 "Client02應用地址"，也將會自動登出登陸狀態

三、快速入門（基於Token）

基於Token，相關概念可參考 "章節 4.7"；（在一些無法使用Cookie的場景下，可使用該方式，否則可以忽略本章節）

3.1 "認證中心（SSO Server）" 搭建

可參考 "章節二" 搭建

"認證中心" 搭建成功後，預設為Token方式登陸提供API介面如下：

  • 1、登陸介面：/app/login

    • 引數：POST引數
      • username：賬號
      • password：賬號
    • 響應：JSON格式
      • code：200 表示成功、其他失敗
      • msg：錯誤提示
      • data: 登陸使用者的 sso sessionid

  • 2、登出介面：/app/logout

    • 引數：POST引數
      • sessionId：登陸使用者的 sso sessionid
    • 響應：JSON格式
      • code：200 表示成功、其他失敗
      • msg：錯誤提示

  • 3、登陸狀態校驗介面：/app/logincheck

    • 引數：POST引數
      • sessionId：登陸使用者的 sso sessionid
    • 響應：JSON格式
      • code：200 表示成功、其他失敗
      • msg：錯誤提示
      • data：登陸使用者資訊
        • userid：使用者ID
        • username：使用者名稱

3.2 部署 "單點登陸Client端接入示例專案" (Token方式)

專案名：xxl-sso-token-sample-springboot

可參考 "章節 2.4" 部署 "單點登陸Client端接入示例專案"，唯一不同點是：將web應用的 "XxlSsoFilter" 更換為app應用 "XxlSsoTokenFilter"

3.3 驗證 (模擬請求 Token 方式接入SSO的介面)

  • 修改Host檔案：域名方式訪問認證中心，模擬跨域與線上真實環境
### 在host檔案中新增以下內容0
127.0.0.1 xxlssoserver.com
127.0.0.1 xxlssoclient1.com
127.0.0.1 xxlssoclient2.com

可參考測試用例 ：com.xxl.app.sample.test.TokenClientTest

正常情況下，登入流程如下：
1、獲取使用者輸入的賬號密碼後，請求SSO Server的登入介面，獲取使用者 sso sessionid ；（參考程式碼：TokenClientTest.loginTest）
2、登陸成功後，獲取到 sso sessionid ，需要主動儲存，後續請求時需要設定在 Header引數 中
3、此時，使用 sso sessionid 訪問受保護的 "Client01應用" 和 "Client02應用" 提供的介面，介面均正常返回（參考程式碼：TokenClientTest.clientApiRequestTest）

正常情況下，登出流程如下：
1、請求SSO Server的登出介面，登出登陸憑證 sso sessionid ；（參考程式碼：TokenClientTest.logoutTest）
2、登出成功後，sso sessionid 將會全域性失效
3、此時，使用 sso sessionid 訪問受保護的 "Client01應用" 和 "Client02應用" 提供的介面，介面請求將會被攔截，提示未登入並返回狀態碼 501（參考程式碼：TokenClientTest.clientApiRequestTest）

四、總體設計

4.1 架構圖

4.2 功能定位

XXL-SSO 是一個分散式單點登入框架。只需要登入一次就可以訪問所有相互信任的應用系統。

藉助 XXL-SSO，可以快速實現分散式系統單點登入。

4.3 核心概念

概念 說明
SSO Server 中央認證服務，支援叢集
SSO Client 接入SSO認證中心的Client應用
SSO SessionId 登入使用者會話ID，SSO 登入成功為使用者自動分配
SSO User 登入使用者資訊，與 SSO SessionId 相對應

4.4 登入流程剖析

  • 使用者於Client端應用訪問受限資源時，將會自動 redirect 到 SSO Server 進入統一登入介面
  • 使用者登入成功之後將會為使用者分配 SSO SessionId 並 redirect 返回來源Client端應用，同時附帶分配的 SSO SessionId
  • 在Client端的SSO Filter裡驗證 SSO SessionId 無誤，將 SSO SessionId 寫入到使用者瀏覽器Client端域名下 cookie 中
  • SSO Filter驗證 SSO SessionId 通過，受限資源請求放行

4.5 登出流程剖析

  • 使用者與Client端應用請求登出Path時，將會 redirect 到 SSO Server 自動銷燬全域性 SSO SessionId，實現全域性銷燬
  • 然後，訪問接入SSO保護的任意Client端應用時，SSO Filter 均會攔截請求並 redirect 到 SSO Server 的統一登入介面

4.6 基於Cookie，相關概念

  • 登陸憑證儲存：登陸成功後，使用者登陸憑證被自動儲存在瀏覽器Cookie中

  • Client端校驗登陸狀態：通過校驗請求Cookie中的是否包含使用者登入憑證判斷

  • 系統角色模型：

    • SSO Server：認證中心，提供使用者登陸、登出以及登陸狀態校驗等功能
    • Client應用：受SSO保護的Client端Web應用，為使用者瀏覽器訪問提供服務
    • 使用者：發起請求的使用者，使用瀏覽器訪問

4.7 基於Token，相關概念

  • 登陸憑證儲存：登陸成功後，獲取到登入憑證（xxl_sso_sessionid=xxx），需要主動儲存，如儲存在 localStorage、Sqlite 中
  • Client端校驗登陸狀態：通過校驗請求 Header引數 中的是否包含使用者登入憑證（xxl_sso_sessionid=xxx）判斷；因此，傳送請求時需要在 Header引數 中設定登陸憑證
  • 系統角色模型：
    • SSO Server：認證中心，提供使用者登陸、登出以及登陸狀態校驗等功能
    • Client應用：受SSO保護的Client端Web應用，為使用者請求提供介面服務
    • 使用者：發起請求的使用者，如使用Android、IOS、桌面客戶端等請求訪問

4.8 未登入狀態請求處理

基於Cookie，未登入狀態請求：

  • 頁面請求：redirect 到SSO Server登入介面
  • JSON請求：返回未登入的JSON格式響應資料
    • 資料格式：
      • code：501 錯誤碼
      • msg：sso not login.

基於Token，未登入狀態請求：

  • 返回未登入的JSON格式響應資料
    • 資料格式：
      • code：501 錯誤碼
      • msg：sso not login.

4.9 登入態自動延期

支援自定義登入態有效期視窗，預設24H，當登入態有效期視窗過半時，自動順延一個週期。

4.10 記住密碼

未記住密碼時，關閉瀏覽器則登入態失效；記住密碼時，登入態自動延期，在自定義延期時間的基礎上，原則上可以無限延期。

4.11 路徑排除

自定義路徑排除Path，允許設定多個，且支援Ant表示式。用於排除SSO客戶端不需要過濾的路徑。

測試：

打包

執行：

客戶端1：

客戶端2：

相關推薦

穀粒商城XXL-SSO(三十六)

231-232 一、簡介 1.1 概述 XXL-SSO 是一個分散式單點登入框架。只需要登入一次就可以訪問所有相互信任的應用系統。

穀粒商城檢索服務(三十)

穀粒商城檢索服務(三十) 173、商城業務-檢索服務-搭建頁面環境 - 192、商城業務-檢索服務-條件篩選聯動

穀粒商城訊息佇列(三十九)

248-260 訊息佇列 程式碼提交到:https://gitee.com/dalianpai/gulimall 其實只要看過尚矽谷的springboot視訊，就會發現和裡面講解的都是一模一樣。

穀粒商城SpringCache快取(二十九)

167、快取-SpringCache-簡介-172、快取-SpringCache-原理與不足 感覺也比較簡單，視訊中也是跟著官網的介紹做的，可以參考前面一篇的中文翻譯。

穀粒商城訂單服務(四十)

261-284 訂單服務 程式碼提交到碼雲：https://gitee.com/dalianpai/gulimall 感覺訂單服務業務邏輯還是比較複雜的，改html改的頭皮發麻。

穀粒商城高階結束(四十八)

325-338 整合鏈路追蹤和sentinel 全部的Java程式碼已經提交到：https://gitee.com/dalianpai/gulimall

穀粒商城SpringSession(三十五)

225-230 在官網上截了2個片段，具體如下： 5. HttpSession Integration Spring Session 使用HttpSession提供透明的 integration。這意味著開發人員可以使用 Spring Session 支援的 implementation 切換HttpSession

穀粒商城購物車(三十八)

236 - 247 讓人感興趣的就是執行緒隔離和攔截器一起用，還有一個就是新增購物車後進行重定向。思路的話，就是臨時使用者和登入使用者的那塊邏輯不要忘了，實時增加刪減購物車都要對redis進行操作。

穀粒商城秒殺商品上架(四十六)

310-320秒殺商品上架 斷斷續續差不多敲了3個月，這個星期差不多可以把高階結束，叢集還有30級，下週應該可以把穀粒商城全部完結。

穀粒商城整合支付寶(四十五)

304-309 主要對支付寶的開放平臺對接的使用，驗簽收單有了一定的連線。 視訊中的nginx配置：

穀粒商城上生產準備(五十)

378-382 上線準備工作 這幾集中感覺最麻煩的就是修改上線指令碼，頭皮發麻，而且雷神也有遺漏的地方，個人總結了一下大約有下面幾點：

穀粒商城部署推送映象(五十一)

383-390 流水線部署 問題：在程式碼掃描的時候，會有報錯，無法識別kubesphere內嵌的snoarqube,但是改成我主機安裝的發現又沒什麼問題，但是最後會發送回調請求判斷這個階段有沒有成功，所以也有問題，所以先跳過程式

穀粒商城分散式基礎（三）—— 開發配置統一 & 服務構建

四、開發環境統一 & 服務搭建 1、IDEA配置統一 　　注意：關於idea的安裝破解和基礎資訊這裡就不做介紹了

史上最簡單的MySQL資料備份與還原教程（中）（三十六）

資料備份與還原第二篇，具體如下 基礎概念： 備份，將當前已有的資料或記錄另存一份；

yb課堂 前端專案通用底部選項卡 CommonsFooter 《三十六》

學會看cube-UI文件，並掌握cube-tab-bar開發 前端需求分析 底部導航 首頁Banner 首頁視訊列表

Hadoop基礎（三十六）：監聽伺服器節點動態上下線案例

1．需求 某分散式系統中，主節點可以有多臺，可以動態上下線，任意一臺客戶端都能實時感知到主節點伺服器的上下線。

pytest（三十六）--引數化ids用例描述為中文時，控制檯輸出unicode編碼問題（pytest_collection_modifyitems）

前言 使用pytest.mark.parametrize引數化的時候，加ids引數用例描述有中文時，在控制檯輸出會顯示unicode編碼，中文不能正常顯示。

2020.8.11第三十六天

例3.1求一元二次方程的根 1 import java.util.Scanner; 2 public class cjava { 3public static void main(String[] args) {

大資料實戰（三十六）：電商數倉（二十九）之使用者行為資料倉庫（十五）本週迴流使用者數

本週迴流=本週活躍-本週新增-上週活躍 1 DWS層 使用日活明細表dws_uv_detail_day作為DWS層資料

大資料實戰（五十三）：電商數倉（三十六）之系統業務資料倉庫（九）轉化率之使用者新鮮度及漏斗分析

1 什麼是轉化率 2ADS層之新增使用者佔日活躍使用者比率（使用者新鮮度） 2.1 建表語句