脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 网络编程 → ASP.NET → 实用技巧 → HTTP 签名组件

通用 HTTP 签名组件的另类实现方式

 更新时间：2022年09月27日 08:24:27   作者：码术  
这篇文章主要介绍了通用 HTTP 签名组件的另类实现方式，实现思路大概是采用链式调用的方式，使得签名的步骤可以动态拼凑组合，本文结合实例代码给大家介绍的非常详细，需要的朋友可以参考下

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类库地址
文章代码地址

到此这篇关于通用 HTTP 签名组件的另类实现的文章就介绍到这了,更多相关HTTP 签名组件内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

相关文章

  • 基于asp.net实现图片在线上传并在线裁剪功能

    基于asp.net实现图片在线上传并在线裁剪功能

    本文主要介绍了基于asp.net实现图片在线上传并在线裁剪功能的具体事例代码，具有一定的参考价值。需要的朋友可以参考下
    2016-12-12
  • Request.QueryString与一般NameValueCollection的区别

    Request.QueryString与一般NameValueCollection的区别

    最近在做一个搜索程序的优化改进，将搜索结果按照查询的参数不同进行缓存。缓存的Key很自然的就想到了用查询字符串，而获取查询字符串的最简单方式是通过Request.QueryString.ToString()方法
    2011-12-12
  • Visual Studio2022创建WebAPI项目步骤记录

    Visual Studio2022创建WebAPI项目步骤记录

    不管是前后端分离还是提供数据服务,WebApi使用的越来越广泛,而且.NET Core也是我们.NET开发人员未来发展的趋势,所以说学会使用.NET Core Api是非常有必要的,这篇文章主要给大家介绍了关于Visual Studio2022创建WebAPI项目步骤的相关资料,需要的朋友可以参考下
    2024-01-01
  • asp.net数据验证控件

    asp.net数据验证控件

    ASP.NET不仅把窗体的验证作为服务器控件引入，还使这些控件智能化。如果浏览器支持JavaScript，而ASP.NET可以发送JavaScript，验证就在客户端进行；如果客户机不支持用于验证的JavaScript，这些JavaScript就被忽略，验证就在服务器上进行。
    2015-11-11
  • .NET操作Excel实例分享

    .NET操作Excel实例分享

    这篇文章主要介绍了.NET操作Excel实例，有需要的朋友可以参考一下
    2014-01-01
  • gridview+objectdatasource+aspnetpager整合实例

    gridview+objectdatasource+aspnetpager整合实例

    gridview+objectdatasource+aspnetpager整合实例，需要的朋友可以参考一下
    2013-04-04
  • Asp.net core WebApi 使用Swagger生成帮助页实例

    Asp.net core WebApi 使用Swagger生成帮助页实例

    本篇文章主要介绍了Asp.net core WebApi 使用Swagger生成帮助页实例，具有一定的参考价值，感兴趣的小伙伴们可以参考一下。
    2017-04-04
  • asp.net自动更新组件分享

    asp.net自动更新组件分享

    前两天在博客上发布了一篇英文的自动更新组件文章Release a AutoUpdater tool，那么在这篇文章中，我们也对其功能进行一些简单说明，这个组件非常简单，所以大家可以下载进行一些改进。
    2010-10-10
  • C#通过POP3获取邮件的代码(正文和附件)

    C#通过POP3获取邮件的代码(正文和附件)

    C# POP3获取邮件的代码 包括正文和附件，需要的朋友可以参考下。
    2010-03-03
  • .net core日志结构化

    .net core日志结构化

    如果我们的日志结构化了，那么可以使用elasticsearch 这样的框架进行二次整理，再借助一些分析工具。我们就能做到可视化分析系统的运行情况，做到日志告警、上下文关联、实现追踪系统集成，同样也易于检索相关信息。本文讲解的结构化，借助需要借助serilog工具
    2021-06-06

最新评论