拒绝臃肿,一个文件搞定 C# 调用阿里云短信服务发送短信

本文涉及的产品
数字短信套餐包(仅限零售电商行业),100条 12个月
短信服务,100条 3个月
短信服务,200条 3个月
简介: 短信发送是软件开发中的一个常见功能,在国内常用于基于短信验证码的用户注册、找回密码和操作授权等场景。阿里云的短信服务在调用时需要实现一个不是那么容易的签名算法,但如果只是为了发送短信这一个功能就去引用其提供的 SDK 显得非常不经济。

短信发送是软件开发中的一个常见功能,在国内常用于基于短信验证码的用户注册、找回密码和操作授权等场景。阿里云的短信服务在调用时需要实现一个不是那么容易的签名算法,但如果只是为了发送短信这一个功能就去引用其提供的 SDK 显得非常不经济。同时该 SDK 并未对 .NET 5 进行适配,编译时会提示警告信息:

warning NU1701: 已使用“.NETFramework,Version=v4.6.1, .NETFramework,Version=v4.6.2, .NETFramework,Version=v4.7, .NETFramework,Version=v4.7.1, .NETFramework,Version=v4.7.2, .NETFramework,Version=v4.8”而不是项目目标框架“.NETStandard,Version=v2.0”还原包“BouncyCastle 1.8.6.1”。此包可能与项目不完全兼容。

为了解决上述问题,笔者参照其 SDK 实现了一个简洁版的 AliSmsSender :仅包含短信发送功能,无需依赖阿里云的 SDK ,仅需要一个文件。

    public class AliSmsSender
    {
        private static readonly HashSet<char> TextTable =
            new HashSet<char>("abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-_.~");

        private static readonly HttpClient HttpClient = new HttpClient();

        public AliSmsSender(string accessKeyId, string accessKeySecret, string signName)
        {
            if (string.IsNullOrWhiteSpace(accessKeyId))
            {
                throw new ArgumentNullException(nameof(accessKeyId));
            }

            if (string.IsNullOrWhiteSpace(accessKeySecret))
            {
                throw new ArgumentNullException(nameof(accessKeySecret));
            }

            if (string.IsNullOrWhiteSpace(signName))
            {
                throw new ArgumentNullException(nameof(signName));
            }

            AccessKeyId = accessKeyId;
            AccessKeySecret = accessKeySecret;
            SignName = signName;
        }

        public string AccessKeyId { get; }
        public string AccessKeySecret { get; }
        public string SignName { get; }

        public async Task<SendSmsResponse> SendAsync(string phone, string templateCode, object param)
        {
            var dictionary = new SortedDictionary<string, string>(StringComparer.Ordinal)
            {
                {"AccessKeyId", AccessKeyId},
                {"Action", "SendSms"},
                {"Format", "JSON"},
                {"PhoneNumbers", phone},
                {"SignatureMethod", "HMAC-SHA1"},
                {"SignatureNonce", Guid.NewGuid().ToString()},
                {"SignatureVersion", "1.0"},
                {"SignName", SignName},
                {"TemplateCode", templateCode},
                {"TemplateParam", JsonConvert.SerializeObject(param)},
                {"Timestamp", GetTimeStamp()},
                {"Version", "2017-05-25"}
            };
            var source = ComposeStringToSign("POST", dictionary);
            var value = SignString(source, AccessKeySecret + "&");
            dictionary.Add("Signature", value);
            using (var request = new HttpRequestMessage(
                    HttpMethod.Post,
                    "http://dysmsapi.aliyuncs.com"
                )
                {
                    Content = new FormUrlEncodedContent(dictionary)
                }
            )
            {
                using (var response = await HttpClient.SendAsync(request))
                {
                    var json = await response.Content.ReadAsStringAsync();
                    return JsonConvert.DeserializeObject<SendSmsResponse>(json);
                }
            }
        }

        private string SignString(string source, string accessSecret)
        {
            string result;
            using (var keyedHashAlgorithm = KeyedHashAlgorithm.Create("HMACSHA1"))
            {
                keyedHashAlgorithm.Key = Encoding.UTF8.GetBytes(accessSecret.ToCharArray());
                result = Convert.ToBase64String(
                    keyedHashAlgorithm.ComputeHash(
                        Encoding.UTF8.GetBytes(
                            source.ToCharArray()
                        )
                    )
                );
            }

            return result;
        }

        private string ComposeStringToSign(string method, IEnumerable<KeyValuePair<string, string>> items)
        {
            var data = ComposeStringToSign(items);
            return $"{method}&{PercentEncode("/")}&{PercentEncode(data)}";
        }

        private string ComposeStringToSign(IEnumerable<KeyValuePair<string, string>> items)
        {
            var builder = new StringBuilder();
            foreach (var item in items)
            {
                builder.Append(PercentEncode(item.Key))
                    .Append('=')
                    .Append(PercentEncode(item.Value))
                    .Append('&');
            }

            if (builder.Length > 0)
            {
                builder.Length--;
            }

            return builder.ToString();
        }

        private string GetTimeStamp()
        {
            return DateTime.UtcNow.ToString("yyyy-MM-ddTHH:mm:ssZ", DateTimeFormatInfo.InvariantInfo);
        }

        private string PercentEncode(string value)
        {
            var stringBuilder = new StringBuilder();
            var bytes = Encoding.UTF8.GetBytes(value);
            foreach (var b in bytes)
            {
                var c = (char) b;
                if (TextTable.Contains(c))
                {
                    stringBuilder.Append(c);
                }
                else
                {
                    stringBuilder.Append('%')
                        .Append(string.Format(CultureInfo.InvariantCulture, "{0:X2}", (int) c));
                }
            }

            return stringBuilder.ToString();
        }

        public class SendSmsResponse
        {
            [JsonProperty("RequestId")] public string RequestId { get; set; }

            [JsonProperty("Message")] public string Message { get; set; }

            [JsonProperty("BizId")] public string BizId { get; set; }

            [JsonProperty("Code")] public string Code { get; set; }
        }
    }

该实现依赖 Newtonsoft.Json 做 Json 反序列化,同时需要引入以下命名空间:

    using System;
    using System.Collections.Generic;
    using System.Globalization;
    using System.Net.Http;
    using System.Security.Cryptography;
    using System.Text;
    using System.Threading.Tasks;
    using Newtonsoft.Json;

使用时,先用阿里云提供的访问密钥及签名信息构造 AliSmsSender 的实例,并调用其 SendAsync 方法即可:

    var sender = new AliSmsSender("accessKeyId", "accessKeySecret", "签名");
    var result = await sender.SendAsync("13888888888", "模板Code", new { arg = "模板参数值" });
    if (result.Code == "OK")
    {
        Console.WriteLine("发送成功");
    }
    else
    {
        Console.WriteLine("发送失败:{0}", result.Code);
    }

以上代码也可以在 GitHub 上获得,查看地址:

https://gist.github.com/Soar360/18b9fea0ad08e5068e1e072ee4a21aa9

目录
相关文章
|
1月前
|
SQL 分布式计算 DataWorks
DataWorks产品使用合集之如何将CSV文件从阿里云OSS同步到ODPS表,并且使用列作为表分区
DataWorks作为一站式的数据开发与治理平台,提供了从数据采集、清洗、开发、调度、服务化、质量监控到安全管理的全套解决方案,帮助企业构建高效、规范、安全的大数据处理体系。以下是对DataWorks产品使用合集的概述,涵盖数据处理的各个环节。
DataWorks产品使用合集之如何将CSV文件从阿里云OSS同步到ODPS表,并且使用列作为表分区
|
19天前
|
敏捷开发 弹性计算 Kubernetes
阿里云云效产品使用问题之自定义新的编排文件该怎么操作
云效作为一款全面覆盖研发全生命周期管理的云端效能平台,致力于帮助企业实现高效协同、敏捷研发和持续交付。本合集收集整理了用户在使用云效过程中遇到的常见问题,问题涉及项目创建与管理、需求规划与迭代、代码托管与版本控制、自动化测试、持续集成与发布等方面。
|
1月前
|
C#
【C#】C#读写Excel文件
【C#】C#读写Excel文件
27 1
|
19天前
|
缓存 运维 Devops
阿里云云效操作报错合集之在构建过程中,Docker尝试从缓存中获取某个文件(或计算缓存键)时遇到了问题,该如何处理
本合集将整理呈现用户在使用过程中遇到的报错及其对应的解决办法,包括但不限于账户权限设置错误、项目配置不正确、代码提交冲突、构建任务执行失败、测试环境异常、需求流转阻塞等问题。阿里云云效是一站式企业级研发协同和DevOps平台,为企业提供从需求规划、开发、测试、发布到运维、运营的全流程端到端服务和工具支撑,致力于提升企业的研发效能和创新能力。
|
19天前
|
运维 Devops 开发工具
阿里云云效操作报错合集之在云效中dockerFile直接想把两个目录下的文件进行合并,现在提示无法找到,该怎么办
本合集将整理呈现用户在使用过程中遇到的报错及其对应的解决办法,包括但不限于账户权限设置错误、项目配置不正确、代码提交冲突、构建任务执行失败、测试环境异常、需求流转阻塞等问题。阿里云云效是一站式企业级研发协同和DevOps平台,为企业提供从需求规划、开发、测试、发布到运维、运营的全流程端到端服务和工具支撑,致力于提升企业的研发效能和创新能力。
|
22天前
|
Java 对象存储
阿里云OSS上传下载文件java
阿里云OSS上传下载文件java
78 0
|
22天前
|
PHP 开发工具
tp5调用阿里云短信接口
tp5调用阿里云短信接口
35 0
|
1月前
|
JavaScript 前端开发 C#
初识Unity——创建代码、场景以及五个常用面板(创建C#代码、打开代码文件、场景的创建、Project、Hierarchy、Inspector、Scene、Game )
初识Unity——创建代码、场景以及五个常用面板(创建C#代码、打开代码文件、场景的创建、Project、Hierarchy、Inspector、Scene、Game )
28 0
|
2月前
|
JSON API C#
C# 通过阿里云 API 实现企业工商数据查询
C# 通过阿里云 API 实现企业工商数据查询
|
2月前
|
存储 JSON C#
C# 通过阿里云接口实现人脸属性识别
C# 通过阿里云接口实现人脸属性识别