ABPZero並沒有手機短信發送功能,現在我們來集成一個,為后面注冊、登錄作鋪墊。
阿里雲短信服務
首先需要在阿里雲開通短信服務,連接地址
開通后,在簽名管理中添加一個簽名
在模板管理中添加一個模板,如下圖所示
最后需要使用阿里雲提供的.NET發送短信類庫,下面可以直接下載我上傳的類庫,也可以去官方下載,然后提取我所說的2個類庫(aliyun-net-sdk-core.dll、aliyun-net-sdk-dysmsapi.dll)
直接下載文件:https://files.cnblogs.com/files/shensigzs/aliyun-net-sdk.zip (里面包含2個類庫,把這2個類庫引用到Core項目)
.NET發送短信SDK:https://help.aliyun.com/document_detail/59836.html?spm=5176.doc55284.6.573.GaNxg6
安裝類庫
如下圖所示
使用的模塊是Abp.Net.Sms,源碼地址:https://github.com/berkaroad/Abp.Net.Sms
Core項目添加實現
添加AliDayuSmsSender類,實現2個方法(一個同步、一個異步)
文件路徑:D:\abp version\aspnet-zero-3.4.0\aspnet-zero-3.4.0\src\MyCompanyName.AbpZeroTemplate.Core\Authorization\Users\AliDayuSmsSender.cs
using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Threading.Tasks; using Abp.Dependency; using Abp.Net.Sms; using Abp.UI; using Aliyun.Acs.Core; using Aliyun.Acs.Core.Exceptions; using Aliyun.Acs.Core.Profile; using Aliyun.Acs.Dysmsapi.Model.V20170525; using Castle.Core.Logging; namespace MyCompanyName.AbpZeroTemplate.Authorization.Users { public class AliDayuSmsSender : SmsSenderBase, ITransientDependency { private IClientProfile profile = null; public ILogger Logger { get; set; } public AliDayuSmsSender(ISmsSenderConfiguration configuration) : base(configuration) { Logger = NullLogger.Instance; profile = DefaultProfile.GetProfile("cn-hangzhou", configuration.GetAppKey(), configuration.GetAppSecret()); } protected override void SendSms(SmsMessage sms) { DefaultProfile.AddEndpoint("cn-hangzhou", "cn-hangzhou", "Dysmsapi", "dysmsapi.aliyuncs.com"); IAcsClient acsClient = new DefaultAcsClient(profile); SendSmsRequest request = new SendSmsRequest(); try { //必填:待發送手機號。支持以逗號分隔的形式進行批量調用,批量上限為1000個手機號碼,批量調用相對於單條調用及時性稍有延遲,驗證碼類型的短信推薦使用單條調用的方式 request.PhoneNumbers = sms.To; //必填:短信簽名-可在短信控制台中找到 request.SignName = sms.FreeSignName; //必填:短信模板-可在短信控制台中找到 request.TemplateCode = string.IsNullOrEmpty(sms.TemplateCode) ? _configuration.GetDefaultSmsTemplateCode() : sms.TemplateCode; //可選:模板中的變量替換JSON串,如模板內容為"親愛的${name},您的驗證碼為${code}"時,此處的值為 request.TemplateParam = sms.TemplateParams; //可選:outId為提供給業務方擴展字段,最終在短信回執消息中將此值帶回給調用者 //request.OutId = "yourOutId"; //請求失敗這里會拋ClientException異常 SendSmsResponse sendSmsResponse = acsClient.GetAcsResponse(request); Logger.Info("發送返回:" + sendSmsResponse.Message); } catch (ServerException e) { throw new UserFriendlyException("短信發送失敗", new Exception(string.Format("to:{0},errCode:{1},errMsg:{2}", sms.To, e.ErrorCode, e.Message))); } catch (ClientException e) { throw new UserFriendlyException("短信發送失敗", new Exception(string.Format("to:{0},errCode:{1},errMsg:{2}", sms.To, e.ErrorCode, e.Message))); } } protected override Task SendSmsAsync(SmsMessage sms) { DefaultProfile.AddEndpoint("cn-hangzhou", "cn-hangzhou", "Dysmsapi", "dysmsapi.aliyuncs.com"); var task = new Task(() => { IAcsClient acsClient = new DefaultAcsClient(profile); SendSmsRequest request = new SendSmsRequest(); try { //必填:待發送手機號。支持以逗號分隔的形式進行批量調用,批量上限為1000個手機號碼,批量調用相對於單條調用及時性稍有延遲,驗證碼類型的短信推薦使用單條調用的方式 request.PhoneNumbers = sms.To; //必填:短信簽名-可在短信控制台中找到 request.SignName = sms.FreeSignName; //必填:短信模板-可在短信控制台中找到 request.TemplateCode = string.IsNullOrEmpty(sms.TemplateCode) ? _configuration.GetDefaultSmsTemplateCode() : sms.TemplateCode; //可選:模板中的變量替換JSON串,如模板內容為"親愛的${name},您的驗證碼為${code}"時,此處的值為 request.TemplateParam = sms.TemplateParams; //可選:outId為提供給業務方擴展字段,最終在短信回執消息中將此值帶回給調用者 //request.OutId = "yourOutId"; //請求失敗這里會拋ClientException異常 SendSmsResponse sendSmsResponse = acsClient.GetAcsResponse(request); Logger.Info("發送返回:" + sendSmsResponse.Message); } catch (ServerException e) { throw new UserFriendlyException("短信發送失敗", new Exception(string.Format("to:{0},errCode:{1},errMsg:{2}", sms.To, e.ErrorCode, e.Message))); } catch (ClientException e) { throw new UserFriendlyException("短信發送失敗", new Exception(string.Format("to:{0},errCode:{1},errMsg:{2}", sms.To, e.ErrorCode, e.Message))); } }); task.Start(); return task; } } }
修改AppSettingProvider.cs,在return new[]里面添加如下代碼
文件路徑:D:\abpweb\PddSellerAssistant\PddSellerAssistant.Core\Configuration\AppSettingProvider.cs
return new[] { // Sms config new SettingDefinition(SmsSettingNames.ServiceUrl, ConfigurationManager.AppSettings[SmsSettingNames.ServiceUrl] ?? ""), new SettingDefinition(SmsSettingNames.AppKey, ConfigurationManager.AppSettings[SmsSettingNames.AppKey] ?? ""), new SettingDefinition(SmsSettingNames.AppSecret, ConfigurationManager.AppSettings[SmsSettingNames.AppSecret] ?? ""), new SettingDefinition(SmsSettingNames.DefaultFreeSignName, ConfigurationManager.AppSettings[SmsSettingNames.DefaultFreeSignName] ?? ""), new SettingDefinition(SmsSettingNames.DefaultSmsTemplateCode, ConfigurationManager.AppSettings[SmsSettingNames.DefaultSmsTemplateCode] ?? ""), //Host settings
修改web.config,添加如下配置節點
<!-- 短信api配置開始--> <add key="Abp.Net.Sms.AppKey" value="" /> <add key="Abp.Net.Sms.AppSecret" value="" /> <add key="Abp.Net.Sms.DefaultFreeSignName" value="填寫簽名名稱" /> <add key="Abp.Net.Sms.DefaultSmsTemplateCode" value="填寫模板ID" /> <add key="Abp.Net.Sms.ServiceUrl" value="" /> <!-- 短信api配置結束-->
AppKey、AppSecret都可以在阿里雲后台獲取
修改AbpZeroTemplateCoreModule,代碼修改如下
文件路徑:D:\abp version\aspnet-zero-3.4.0\aspnet-zero-3.4.0\src\MyCompanyName.AbpZeroTemplate.Core\AbpZeroTemplateCoreModule.cs
if (DebugHelper.IsDebug) { //調試模式禁用郵件發送 //IocManager.Register<IEmailSender, NullEmailSender>(DependencyLifeStyle.Transient); //調試模式禁用手機短信發送 //IocManager.Register<ISmsSender, NullSmsSender>(DependencyLifeStyle.Transient); }
可以看到我都備注掉,因為我就是要在調試模式下測試郵件、短信是否能夠發送。
[DependsOn(typeof(AbpZeroCoreModule), typeof(AbpZeroLdapModule), typeof(AbpAutoMapperModule), typeof(AbpNetSmsModule) )]
此處是添加短信模塊依賴
Application項目
添加文件ISmsMessageService.cs
文件路徑:D:\abp version\aspnet-zero-3.4.0\aspnet-zero-3.4.0\src\MyCompanyName.AbpZeroTemplate.Application\Authorization\Users\ISmsMessageService.cs
public interface ISmsMessageService : IApplicationService { void Send(string to, string templateCode, string templateParams); Task SendAsync(string to, string templateCode, string templateParams); }
再添加實現文件SmsMessageService.cs
文件路徑:D:\abp version\aspnet-zero-3.4.0\aspnet-zero-3.4.0\src\MyCompanyName.AbpZeroTemplate.Application\Authorization\Users\SmsMessageService.cs
public class SmsMessageService: ISmsMessageService { private readonly ISmsSender _smsSender; public SmsMessageService(ISmsSender smsSender) { _smsSender = smsSender; } public void Send(string to, string templateCode, string templateParams) { _smsSender.Send(to, templateCode, templateParams); } public async Task SendAsync(string to, string templateCode, string templateParams) { await _smsSender.SendAsync(to, templateCode, templateParams); } }
測試短信發送
最后,生成項目
瀏覽器打開:http://localhost:8088/swagger/ui/index(8088是IIS配置的端口)
找到app_smsMessageService服務進行測試
同步、異常都測試通過,至此手機短信發送模塊集成完成。