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
  • 在C#中使用SQL Server實現事務的ACID(原子性、一致性、隔離性、持久性)屬性和使用資料庫鎖(悲觀鎖和樂觀鎖)時,你可以通過ADO.NET的SqlConnection和SqlTransaction類來實現。下麵是一些示例和概念說明。 實現ACID事務 ACID屬性是事務處理的四個基本特征, ...
  • 我們在《SqlSugar開發框架》中,Winform界面開發部分往往也用到了自定義的用戶控制項,對應一些特殊的界面或者常用到的一些局部界面內容,我們可以使用自定義的用戶控制項來提高界面的統一性,同時也增強了使用的便利性。如我們Winform界面中用到的分頁控制項、附件顯示內容、以及一些公司、部門、菜單的下... ...
  • 在本篇教程中,我們學習瞭如何在 Taurus.MVC WebMVC 中進行數據綁定操作。我們還學習瞭如何使用 ${屬性名稱} CMS 語法來綁定頁面上的元素與 Model 中的屬性。通過這些步驟,我們成功實現了一個簡單的數據綁定示例。 ...
  • 是在MVVM中用來傳遞消息的一種方式。它是在MVVMLight框架中提供的一個實現了IMessenger介面的類,可以用來在ViewModel之間、ViewModel和View之間傳遞消息。 Send 接受一個泛型參數,表示要發送的消息內容。 Register 方法用於註冊某個對象接收消息。 pub ...
  • 概述:在WPF中,通過EventHandler可實現基礎和高級的UI更新方式。基礎用法涉及在類中定義事件,併在UI中訂閱以執行更新操作。高級用法藉助Dispatcher類,確保在非UI線程上執行操作後,通過UI線程更新界面。這兩種方法提供了靈活而可靠的UI更新機制。 在WPF(Windows Pre ...
  • 概述:本文介紹了在C#程式開發中如何利用自定義擴展方法測量代碼執行時間。通過使用簡單的Action委托,開發者可以輕鬆獲取代碼塊的執行時間,幫助優化性能、驗證演算法效率以及監控系統性能。這種通用方法提供了一種便捷而有效的方式,有助於提高開發效率和代碼質量。 在軟體開發中,瞭解代碼執行時間是優化程式性能 ...
  • 概述:Cron表達式是一種強大的定時任務調度工具,通過配置不同欄位實現靈活的時間規定。在.NET中,Quartz庫提供了簡便的方式配置Cron表達式,實現精準的定時任務調度。這種靈活性和可擴展性使得開發者能夠根據需求輕鬆地制定和管理定時任務,例如每天備份系統日誌或其他重要操作。 Cron表達式詳解 ...
  • 概述:.NET提供多種定時器,如System.Windows.Forms.Timer適用於UI,System.Web.UI.Timer用於Web,System.Diagnostics.Timer用於性能監控,System.Threading.Timer和System.Timers.Timer用於一般 ...
  • 問題背景 有同事聯繫我說,在生產環境上,訪問不了我負責的common服務,然後我去檢查common服務的health endpoint, 沒問題,然後我問了下異常,timeout導致的System.OperationCanceledException。那大概率是客戶端的問題,會不會是埠耗盡,用ne ...
  • 前言: 在本篇 Taurus.MVC WebMVC 入門開發教程的第四篇文章中, 我們將學習如何實現數據列表的綁定,通過使用 List<Model> 來展示多個數據項。 我們將繼續使用 Taurus.Mvc 命名空間,同時探討如何在視圖中綁定並顯示一個 Model 列表。 步驟1:創建 Model ...