SysSmsService.cs 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308
  1. // Admin.NET 项目的版权、商标、专利和其他相关权利均受相应法律法规的保护。使用本项目应遵守相关法律法规和许可证的要求。
  2. //
  3. // 本项目主要遵循 MIT 许可证和 Apache 许可证(版本 2.0)进行分发和使用。许可证位于源代码树根目录中的 LICENSE-MIT 和 LICENSE-APACHE 文件。
  4. //
  5. // 不得利用本项目从事危害国家安全、扰乱社会秩序、侵犯他人合法权益等法律法规禁止的活动!任何基于本项目二次开发而产生的一切法律纠纷和责任,我们不承担任何责任!
  6. using AlibabaCloud.SDK.Dysmsapi20170525.Models;
  7. using TencentCloud.Common;
  8. using TencentCloud.Common.Profile;
  9. using TencentCloud.Sms.V20190711;
  10. namespace Admin.NET.Core.Service;
  11. /// <summary>
  12. /// 系统短信服务 🧩
  13. /// </summary>
  14. [AllowAnonymous]
  15. [ApiDescriptionSettings(Order = 150)]
  16. public class SysSmsService : IDynamicApiController, ITransient
  17. {
  18. private readonly SMSOptions _smsOptions;
  19. private readonly SysCacheService _sysCacheService;
  20. public SysSmsService(IOptions<SMSOptions> smsOptions,
  21. SysCacheService sysCacheService)
  22. {
  23. _smsOptions = smsOptions.Value;
  24. _sysCacheService = sysCacheService;
  25. }
  26. /// <summary>
  27. /// 发送短信 📨
  28. /// </summary>
  29. /// <param name="phoneNumber"></param>
  30. /// <param name="templateId">短信模板id</param>
  31. /// <returns></returns>
  32. [AllowAnonymous]
  33. [DisplayName("发送短信")]
  34. public async Task SendSms([Required] string phoneNumber, string templateId = "0")
  35. {
  36. if (_smsOptions.Custom != null && _smsOptions.Custom.Enabled && !string.IsNullOrWhiteSpace(_smsOptions.Custom.ApiUrl))
  37. {
  38. await CustomSendSms(phoneNumber, templateId);
  39. }
  40. else if (!string.IsNullOrWhiteSpace(_smsOptions.Aliyun.AccessKeyId) && !string.IsNullOrWhiteSpace(_smsOptions.Aliyun.AccessKeySecret))
  41. {
  42. await AliyunSendSms(phoneNumber, templateId);
  43. }
  44. else
  45. {
  46. await TencentSendSms(phoneNumber, templateId);
  47. }
  48. }
  49. /// <summary>
  50. /// 校验短信验证码
  51. /// </summary>
  52. /// <param name="input"></param>
  53. /// <returns></returns>
  54. [AllowAnonymous]
  55. [DisplayName("校验短信验证码")]
  56. public bool VerifyCode(SmsVerifyCodeInput input)
  57. {
  58. var verifyCode = _sysCacheService.Get<string>($"{CacheConst.KeyPhoneVerCode}{input.Phone}");
  59. if (string.IsNullOrWhiteSpace(verifyCode)) throw Oops.Oh("验证码不存在或已失效,请重新获取!");
  60. if (verifyCode != input.Code) throw Oops.Oh("验证码错误!");
  61. return true;
  62. }
  63. /// <summary>
  64. /// 阿里云发送短信 📨
  65. /// </summary>
  66. /// <param name="phoneNumber">手机号</param>
  67. /// <param name="templateId">短信模板id</param>
  68. /// <returns></returns>
  69. [AllowAnonymous]
  70. [DisplayName("阿里云发送短信")]
  71. public async Task AliyunSendSms([Required] string phoneNumber, string templateId = "0")
  72. {
  73. if (!phoneNumber.TryValidate(ValidationTypes.PhoneNumber).IsValid) throw Oops.Oh("请正确填写手机号码");
  74. // 生成随机验证码
  75. var random = new Random();
  76. var verifyCode = random.Next(100000, 999999);
  77. var templateParam = new
  78. {
  79. code = verifyCode
  80. };
  81. var client = CreateAliyunClient();
  82. var template = _smsOptions.Aliyun.GetTemplate(templateId);
  83. var sendSmsRequest = new SendSmsRequest
  84. {
  85. PhoneNumbers = phoneNumber, // 待发送手机号, 多个以逗号分隔
  86. SignName = template.SignName, // 短信签名
  87. TemplateCode = template.TemplateCode, // 短信模板
  88. TemplateParam = templateParam.ToJson(), // 模板中的变量替换JSON串
  89. OutId = YitIdHelper.NextId().ToString()
  90. };
  91. var sendSmsResponse = await client.SendSmsAsync(sendSmsRequest);
  92. if (sendSmsResponse.Body.Code == "OK" && sendSmsResponse.Body.Message == "OK")
  93. {
  94. // var bizId = sendSmsResponse.Body.BizId;
  95. _sysCacheService.Set($"{CacheConst.KeyPhoneVerCode}{phoneNumber}", verifyCode, TimeSpan.FromSeconds(_smsOptions.VerifyCodeExpireSeconds));
  96. }
  97. else
  98. {
  99. throw Oops.Oh($"短信发送失败:{sendSmsResponse.Body.Code}-{sendSmsResponse.Body.Message}");
  100. }
  101. await Task.CompletedTask;
  102. }
  103. /// <summary>
  104. /// 发送短信模板
  105. /// </summary>
  106. /// <param name="phoneNumber">手机号</param>
  107. /// <param name="templateParam">短信内容</param>
  108. /// <param name="templateId">短信模板id</param>
  109. /// <returns></returns>
  110. [AllowAnonymous]
  111. [DisplayName("发送短信模板")]
  112. public async Task AliyunSendSmsTemplate([Required] string phoneNumber, [Required] dynamic templateParam, string templateId)
  113. {
  114. if (!phoneNumber.TryValidate(ValidationTypes.PhoneNumber).IsValid) throw Oops.Oh("请正确填写手机号码");
  115. if (string.IsNullOrWhiteSpace(templateParam.ToString())) throw Oops.Oh("短信内容不能为空");
  116. var client = CreateAliyunClient();
  117. var template = _smsOptions.Aliyun.GetTemplate(templateId);
  118. var sendSmsRequest = new SendSmsRequest
  119. {
  120. PhoneNumbers = phoneNumber, // 待发送手机号, 多个以逗号分隔
  121. SignName = template.SignName, // 短信签名
  122. TemplateCode = template.TemplateCode, // 短信模板
  123. TemplateParam = templateParam.ToString(), // 模板中的变量替换JSON串
  124. OutId = YitIdHelper.NextId().ToString()
  125. };
  126. var sendSmsResponse = await client.SendSmsAsync(sendSmsRequest);
  127. if (sendSmsResponse.Body.Code == "OK" && sendSmsResponse.Body.Message == "OK")
  128. {
  129. }
  130. else
  131. {
  132. throw Oops.Oh($"短信发送失败:{sendSmsResponse.Body.Code}-{sendSmsResponse.Body.Message}");
  133. }
  134. await Task.CompletedTask;
  135. }
  136. /// <summary>
  137. /// 腾讯云发送短信 📨
  138. /// </summary>
  139. /// <param name="phoneNumber"></param>
  140. /// <param name="templateId">短信模板id</param>
  141. /// <returns></returns>
  142. [AllowAnonymous]
  143. [DisplayName("腾讯云发送短信")]
  144. public async Task TencentSendSms([Required] string phoneNumber, string templateId = "0")
  145. {
  146. if (!phoneNumber.TryValidate(ValidationTypes.PhoneNumber).IsValid) throw Oops.Oh("请正确填写手机号码");
  147. // 生成随机验证码
  148. var random = new Random();
  149. var verifyCode = random.Next(100000, 999999);
  150. // 实例化要请求产品的client对象,clientProfile是可选的
  151. var client = new SmsClient(CreateTencentClient(), "ap-guangzhou", new ClientProfile() { HttpProfile = new HttpProfile() { Endpoint = ("sms.tencentcloudapi.com") } });
  152. var template = _smsOptions.Tencentyun.GetTemplate(templateId);
  153. // 实例化一个请求对象,每个接口都会对应一个request对象
  154. var req = new TencentCloud.Sms.V20190711.Models.SendSmsRequest
  155. {
  156. PhoneNumberSet = new string[] { "+86" + phoneNumber.Trim(',') },
  157. SmsSdkAppid = _smsOptions.Tencentyun.SdkAppId,
  158. Sign = template.SignName,
  159. TemplateID = template.TemplateCode,
  160. TemplateParamSet = new string[] { verifyCode.ToString() }
  161. };
  162. // 返回的resp是一个SendSmsResponse的实例,与请求对象对应
  163. TencentCloud.Sms.V20190711.Models.SendSmsResponse resp = client.SendSmsSync(req);
  164. if (resp.SendStatusSet[0].Code == "Ok" && resp.SendStatusSet[0].Message == "send success")
  165. {
  166. // var bizId = sendSmsResponse.Body.BizId;
  167. _sysCacheService.Set($"{CacheConst.KeyPhoneVerCode}{phoneNumber}", verifyCode, TimeSpan.FromSeconds(_smsOptions.VerifyCodeExpireSeconds));
  168. }
  169. else
  170. {
  171. throw Oops.Oh($"短信发送失败:{resp.SendStatusSet[0].Code}-{resp.SendStatusSet[0].Message}");
  172. }
  173. await Task.CompletedTask;
  174. }
  175. /// <summary>
  176. /// 阿里云短信配置
  177. /// </summary>
  178. /// <returns></returns>
  179. private AlibabaCloud.SDK.Dysmsapi20170525.Client CreateAliyunClient()
  180. {
  181. var config = new AlibabaCloud.OpenApiClient.Models.Config
  182. {
  183. AccessKeyId = _smsOptions.Aliyun.AccessKeyId,
  184. AccessKeySecret = _smsOptions.Aliyun.AccessKeySecret,
  185. Endpoint = "dysmsapi.aliyuncs.com"
  186. };
  187. return new AlibabaCloud.SDK.Dysmsapi20170525.Client(config);
  188. }
  189. /// <summary>
  190. /// 腾讯云短信配置
  191. /// </summary>
  192. /// <returns></returns>
  193. private Credential CreateTencentClient()
  194. {
  195. var cred = new Credential
  196. {
  197. SecretId = _smsOptions.Tencentyun.AccessKeyId,
  198. SecretKey = _smsOptions.Tencentyun.AccessKeySecret
  199. };
  200. return cred;
  201. }
  202. /// <summary>
  203. /// 自定义短信接口发送短信 📨
  204. /// </summary>
  205. /// <param name="phoneNumber">手机号</param>
  206. /// <param name="templateId">短信模板id</param>
  207. /// <returns></returns>
  208. [AllowAnonymous]
  209. [DisplayName("自定义短信接口发送短信")]
  210. public async Task CustomSendSms([DataValidation(ValidationTypes.PhoneNumber)] string phoneNumber, string templateId = "0")
  211. {
  212. if (_smsOptions.Custom == null || !_smsOptions.Custom.Enabled)
  213. throw Oops.Oh("自定义短信接口未启用");
  214. if (string.IsNullOrWhiteSpace(_smsOptions.Custom.ApiUrl))
  215. throw Oops.Oh("自定义短信接口地址未配置");
  216. // 生成随机验证码
  217. var verifyCode = Random.Shared.Next(100000, 999999);
  218. // 获取模板
  219. var template = _smsOptions.Custom.GetTemplate(templateId);
  220. if (template == null)
  221. throw Oops.Oh($"短信模板[{templateId}]不存在");
  222. // 替换模板内容中的占位符
  223. var content = template.Content.Replace("{code}", verifyCode.ToString());
  224. try
  225. {
  226. using var httpClient = new HttpClient();
  227. httpClient.Timeout = TimeSpan.FromSeconds(30);
  228. HttpResponseMessage response;
  229. //替换URL占位符
  230. var url = _smsOptions.Custom.ApiUrl
  231. .Replace("{templateId}", templateId)
  232. .Replace("{mobile}", phoneNumber)
  233. .Replace("{content}", Uri.EscapeDataString(content))
  234. .Replace("{code}", verifyCode.ToString());
  235. if (_smsOptions.Custom.Method.ToUpper() == "POST")
  236. {
  237. // 替换占位符
  238. var postData = _smsOptions.Custom.PostData?
  239. .Replace("{templateId}", templateId)
  240. .Replace("{mobile}", phoneNumber)
  241. .Replace("{content}", content)
  242. .Replace("{code}", verifyCode.ToString());
  243. HttpContent httpContent = new StringContent(postData ?? string.Empty, Encoding.UTF8, _smsOptions.Custom.ContentType ?? "application/x-www-form-urlencoded");
  244. response = await httpClient.PostAsync(url, httpContent);
  245. }
  246. else
  247. {
  248. // GET 请求
  249. response = await httpClient.GetAsync(url);
  250. }
  251. var responseContent = await response.Content.ReadAsStringAsync();
  252. // 判断是否发送成功
  253. if (response.IsSuccessStatusCode && responseContent.Contains(_smsOptions.Custom.SuccessFlag))
  254. {
  255. if (_smsOptions.Custom.ApiUrl.Contains("{code}") || template.Content.Contains("{code}") || (_smsOptions.Custom.PostData?.Contains("{code}") == true))
  256. {
  257. // 如果模板含有验证码,则添加到缓存
  258. _sysCacheService.Set($"{CacheConst.KeyPhoneVerCode}{phoneNumber}", verifyCode, TimeSpan.FromSeconds(_smsOptions.VerifyCodeExpireSeconds));
  259. }
  260. }
  261. else
  262. {
  263. throw Oops.Oh($"短信发送失败:{responseContent}");
  264. }
  265. }
  266. catch (Exception ex)
  267. {
  268. throw Oops.Oh($"短信发送异常:{ex.Message}");
  269. }
  270. }
  271. }