C# 通用 HTTP 簽名組件的另類實現

来源:https://www.cnblogs.com/JiuLing-zhang/archive/2022/09/26/16732526.html
-Advertisement-
Play Games

1、初衷 開發中經常需要做一些介面的簽名生成和校驗工作,最開始的時候都是每個介面去按照約定單獨實現,久而久之就變的非常難維護,因此就琢磨怎麼能夠寫了一個比較通用的簽名生成工具。 2、思路 採用鏈式調用的方式,使得簽名的步驟可以動態拼湊組合。 3、直接看效果 //設置數據源 var signSourc ...


1、初衷

開發中經常需要做一些介面的簽名生成和校驗工作,最開始的時候都是每個介面去按照約定單獨實現,久而久之就變的非常難維護,因此就琢磨怎麼能夠寫了一個比較通用的簽名生成工具。

2、思路

採用鏈式調用的方式,使得簽名的步驟可以動態拼湊組合。

3、直接看效果

    //設置數據源
    var signSource = new Dictionary<string, string>()
    {
        { "param1", "1" },
        { "param3", "3+" },
        { "param2", "2" }
    };
    var signer = new HttpSigner();
    signer.SetSignData(signSource);

    //設置數據源並配置規則
    signer.SetSignData(signSource, setting =>
    {
        //按參數名排序
        //result --> param1 param2 param3
        setting.IsOrderByWithKey = false;

        //是否對簽名數據的參數值進行UrlEncode
        setting.IsDoUrlEncodeForSourceValue = false;

        //簽名主體是否包含參數名
        setting.IsSignTextContainKey = true;
        //簽名主體中參數和參數值的連接符(需要啟用IsSignTextContainKey)
        setting.SignTextKeyValueSeparator = "=";
        //簽名主體中不同參數項的連接符
        setting.SignTextItemSeparator = "&";
        //以上都開啟後  --> param1=1&param2=2&param3=3

        //編碼
        setting.DefaultEncoding = Encoding.UTF8;
    });

    //簽名主體設置首碼
    signer.SetSignData(signSource).SetSignTextPrefix("TestPrefix");

    //簽名主體設置尾碼
    signer.SetSignData(signSource).SetSignTextSuffix("TestSuffix");

    //簽名主體進行Base64
    signer.SetSignData(signSource).SetSignTextBase64();

    //簽名主體進行MD5,(方法參數為簽名結果是否轉小寫)
    signer.SetSignData(signSource).SetSignTextMD5(bool isToLower = true);

    //簽名主體進行SHA1,(方法參數為簽名結果是否轉小寫)
    signer.SetSignData(signSource).SetSignTextSHA1(bool isToLower = true);

    //獲取簽名結果
    string signString = signer.SetSignData(signSource).GetSignResult();

    //組合調用
    string signString = signer.SetSignData(signSource).SetSignTextBase64().SetSignTextMD5().SetSignTextSHA1();

4、代碼實現

HttpSignItem類

用於保存簽名的參數集合。

namespace JiuLing.CommonLibs.Security.HttpSign
{
    internal class HttpSignItem
    {
        public string Key { get; set; }
        public string Value { get; set; }

        public HttpSignItem(string key, string value)
        {
            Key = key;
            Value = value;
        }
    }
}

HttpSignSetting類

用於簽名的基本配置。

using System.Text;

namespace JiuLing.CommonLibs.Security.HttpSign
{
    /// <summary>
    /// 簽名配置
    /// </summary>
    public class HttpSignSetting
    {
        /// <summary>
        /// 是否按參數名進行排序
        /// </summary>
        public bool IsOrderByWithKey { get; set; } = false;

        /// <summary>
        /// 是否對簽名數據的參數值進行UrlEncode
        /// </summary>
        public bool IsDoUrlEncodeForSourceValue { get; set; } = false;

        /// <summary>
        /// 簽名主體是否包含參數名
        /// </summary>
        public bool IsSignTextContainKey { get; set; } = true;

        /// <summary>
        /// 簽名主體中參數和參數值的連接符(需要啟用IsSignTextContainKey)
        /// </summary>
        public string SignTextKeyValueSeparator { get; set; } = "=";

        /// <summary>
        /// 簽名主體中不同參數項的連接符
        /// </summary>
        public string SignTextItemSeparator { get; set; } = "&";

        /// <summary>
        /// 編碼
        /// </summary>
        public Encoding DefaultEncoding { get; set; } = Encoding.UTF8;
    }
}

HttpSigner類

簽名組件的具體實現。

using System;
using System.Collections.Generic;
using System.Linq;

namespace JiuLing.CommonLibs.Security.HttpSign
{
    /// <summary>
    /// 網路請求簽名工具
    /// </summary>
    public class HttpSigner
    {
        /// <summary>
        /// 簽名配置
        /// </summary>
        private readonly HttpSignSetting _setting = new HttpSignSetting();
        /// <summary>
        /// 最終的簽名串
        /// </summary>
        private string _signString;

        /// <summary>
        /// 設置簽名數據
        /// </summary>
        /// <param name="signSource">待簽名的鍵值對</param>
        /// <param name="setting">配置簽名規則</param>
        /// <returns></returns>
        /// <exception cref="ArgumentException"></exception>
        public HttpSigner SetSignData(Dictionary<string, string> signSource, Action<HttpSignSetting> setting = null)
        {
            setting?.Invoke(_setting);
            if (_setting == null)
            {
                throw new ArgumentNullException("無效的簽名配置", "setting");
            }

            if (signSource == null || signSource.Count == 0)
            {
                throw new ArgumentException("待簽名數據異常", nameof(signSource));
            }

            var signSourceList = new List<HttpSignItem>(signSource.Count);
            foreach (var item in signSource)
            {
                var itemValue = item.Value;
                if (_setting.IsDoUrlEncodeForSourceValue)
                {
                    itemValue = System.Web.HttpUtility.UrlEncode(itemValue, _setting.DefaultEncoding);
                }
                signSourceList.Add(new HttpSignItem(item.Key, itemValue));
            }

            if (_setting.IsOrderByWithKey)
            {
                signSourceList = signSourceList.OrderBy(x => x.Key).ToList();
            }

            if (_setting.IsSignTextContainKey)
            {
                _signString = string.Join(_setting.SignTextItemSeparator, signSourceList.Select(x => $"{x.Key}{_setting.SignTextKeyValueSeparator}{x.Value}"));
            }
            else
            {
                _signString = string.Join(_setting.SignTextItemSeparator, signSourceList.Select(x => x.Value));
            }

            return this;
        }

        /// <summary>
        /// 簽名主體設置首碼
        /// </summary>
        /// <param name="input">首碼值</param>
        /// <returns></returns>
        public HttpSigner SetSignTextPrefix(string input)
        {
            _signString = $"{input}{_signString}";
            return this;
        }

        /// <summary>
        /// 簽名主體設置尾碼
        /// </summary>
        /// <param name="input">尾碼值</param>
        /// <returns></returns>
        public HttpSigner SetSignTextSuffix(string input)
        {
            _signString = $"{_signString}{input}";
            return this;
        }

        /// <summary>
        /// 簽名主體設置尾碼
        /// </summary>
        /// <returns></returns>
        public HttpSigner SetUrlEncode()
        {
            _signString = System.Web.HttpUtility.UrlEncode(_signString, _setting.DefaultEncoding);
            return this;
        }

        /// <summary>
        /// 簽名主體進行Base64
        /// </summary>
        /// <returns></returns>
        public HttpSigner SetSignTextBase64()
        {
            _signString = Base64Utils.GetStringValue(_signString);
            return this;
        }

        /// <summary>
        /// 簽名主體進行MD5
        /// </summary>
        /// <param name="isToLower">簽名結果是否轉小寫</param>
        /// <returns></returns>
        public HttpSigner SetSignTextMD5(bool isToLower = true)
        {
            if (isToLower)
            {
                _signString = MD5Utils.GetStringValueToLower(_signString);
            }
            else
            {
                _signString = MD5Utils.GetStringValueToUpper(_signString);
            }
            return this;
        }

        /// <summary>
        /// 簽名主體進行SHA1
        /// </summary>
        /// <param name="isToLower">簽名結果是否轉小寫</param>
        /// <returns></returns>
        public HttpSigner SetSignTextSHA1(bool isToLower = true)
        {
            if (isToLower)
            {
                _signString = SHA1Utils.GetStringValueToLower(_signString);
            }
            else
            {
                _signString = SHA1Utils.GetStringValueToUpper(_signString);
            }
            return this;
        }

        /// <summary>
        /// 獲取簽名結果
        /// </summary>
        /// <returns></returns>
        public string GetSignResult()
        {
            return _signString;
        }
    }
}

5、附上倉庫地址

以上代碼包含在我的通用類庫中,可以直接Nuget搜索JiuLing.CommonLibs安裝。
GitHub類庫地址
文章代碼地址


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

-Advertisement-
Play Games
更多相關文章
  • 什麼是 Session 會話? 1、Session 就一個介面(HttpSession)。 2、Session 就是會話。它是用來維護一個客戶端和伺服器之間關聯的一種技術。 3、每個客戶端都有自己的一個 Session 會話。 4、Session 會話中,我們經常用來保存用戶登錄之後的信息。 如何創 ...
  • Spring中AOP的底層原理就是動態代理模式,所以我們在這裡對代理模式進行學習。 一、代理模式 1.什麼是代理 代理,顧名思義,就是一個人代替另一個人去做他需要做的事情。代理是一種設計模式,具體實現就是一個類代替某個類去實現功能。 我們舉一個例子: 我要租房子,我可以找房東直接租房子。同樣我可以找 ...
  • 特殊說明:第一章只包含了 初始化上下文,初始化監聽器列表,發佈springboot啟動事件 相關內容 其中一部分代碼 /** * Run the Spring application, creating and refreshing a new * {@link ApplicationContext ...
  • 前言 在使用SpringBoot的時候經常需要對客戶端傳入的參數進行合法性的校驗,校驗的方法基本上都是使用SpringBoot提供的註解,有時候遇上註解不能滿足需求的時候還需要在業務邏輯上進行判斷。這樣根本就沒有實現解耦。 使用方法 項目maven引入 <dependency> <groupId>c ...
  • 0.基本的數據類型: Number(數字) String(字元串) List(列表) Tuple(元組) Set(集合) Dictionary(字典) 1.基本的輸入輸出: input #輸入 print #輸出 age = 10; name = "小明"; print(age,type(age)) ...
  • ConcurrentHashMap 思考:HashTable是線程安全的,為什麼不推薦使用? HashTable是一個線程安全的類,它使用synchronized來鎖住整張Hash表來實現線程安全,即每次鎖住整張表讓線程獨占,相當於所有線程進行讀寫時都去競爭一把鎖,導致效率非常低下。 1 Concu ...
  • zip 是一個非常常見的壓縮包格式,本文主要用於說明如何使用代碼 文件或文件夾壓縮為 zip壓縮包及其解壓操作, 我們採用的是 微軟官方的實現,所以也不需要安裝第三方的組件包。 使用的時候記得 using System.IO.Compression; /// <summary> /// 將指定目錄壓 ...
  • 1. 融合效果 融合效果是指對兩個接近的元素進行高斯模糊後再提高對比度,使它們看上去“粘”在一起。在之前的一篇文章中,我使用 Win2D 實現了融合效果,效果如下: 不過 Win2D 不適用於 WPF,在 WPF 中可以使用 BlurEffect 配合自定義 Effect 實現類似的效果。Handy ...
一周排行
    -Advertisement-
    Play Games
  • Timer是什麼 Timer 是一種用於創建定期粒度行為的機制。 與標準的 .NET System.Threading.Timer 類相似,Orleans 的 Timer 允許在一段時間後執行特定的操作,或者在特定的時間間隔內重覆執行操作。 它在分散式系統中具有重要作用,特別是在處理需要周期性執行的 ...
  • 前言 相信很多做WPF開發的小伙伴都遇到過表格類的需求,雖然現有的Grid控制項也能實現,但是使用起來的體驗感並不好,比如要實現一個Excel中的表格效果,估計你能想到的第一個方法就是套Border控制項,用這種方法你需要控制每個Border的邊框,並且在一堆Bordr中找到Grid.Row,Grid. ...
  • .NET C#程式啟動閃退,目錄導致的問題 這是第2次踩這個坑了,很小的編程細節,容易忽略,所以寫個博客,分享給大家。 1.第一次坑:是windows 系統把程式運行成服務,找不到配置文件,原因是以服務運行它的工作目錄是在C:\Windows\System32 2.本次坑:WPF桌面程式通過註冊表設 ...
  • 在分散式系統中,數據的持久化是至關重要的一環。 Orleans 7 引入了強大的持久化功能,使得在分散式環境下管理數據變得更加輕鬆和可靠。 本文將介紹什麼是 Orleans 7 的持久化,如何設置它以及相應的代碼示例。 什麼是 Orleans 7 的持久化? Orleans 7 的持久化是指將 Or ...
  • 前言 .NET Feature Management 是一個用於管理應用程式功能的庫,它可以幫助開發人員在應用程式中輕鬆地添加、移除和管理功能。使用 Feature Management,開發人員可以根據不同用戶、環境或其他條件來動態地控制應用程式中的功能。這使得開發人員可以更靈活地管理應用程式的功 ...
  • 在 WPF 應用程式中,拖放操作是實現用戶交互的重要組成部分。通過拖放操作,用戶可以輕鬆地將數據從一個位置移動到另一個位置,或者將控制項從一個容器移動到另一個容器。然而,WPF 中預設的拖放操作可能並不是那麼好用。為瞭解決這個問題,我們可以自定義一個 Panel 來實現更簡單的拖拽操作。 自定義 Pa ...
  • 在實際使用中,由於涉及到不同編程語言之間互相調用,導致C++ 中的OpenCV與C#中的OpenCvSharp 圖像數據在不同編程語言之間難以有效傳遞。在本文中我們將結合OpenCvSharp源碼實現原理,探究兩種數據之間的通信方式。 ...
  • 一、前言 這是一篇搭建許可權管理系統的系列文章。 隨著網路的發展,信息安全對應任何企業來說都越發的重要,而本系列文章將和大家一起一步一步搭建一個全新的許可權管理系統。 說明:由於搭建一個全新的項目過於繁瑣,所有作者將挑選核心代碼和核心思路進行分享。 二、技術選擇 三、開始設計 1、自主搭建vue前端和. ...
  • Csharper中的表達式樹 這節課來瞭解一下表示式樹是什麼? 在C#中,表達式樹是一種數據結構,它可以表示一些代碼塊,如Lambda表達式或查詢表達式。表達式樹使你能夠查看和操作數據,就像你可以查看和操作代碼一樣。它們通常用於創建動態查詢和解析表達式。 一、認識表達式樹 為什麼要這樣說?它和委托有 ...
  • 在使用Django等框架來操作MySQL時,實際上底層還是通過Python來操作的,首先需要安裝一個驅動程式,在Python3中,驅動程式有多種選擇,比如有pymysql以及mysqlclient等。使用pip命令安裝mysqlclient失敗應如何解決? 安裝的python版本說明 機器同時安裝了 ...