今天咱們接着 上一篇 第七章 Rocketmq–消息驅動
繼續寫 SpringCloud Alibaba全家桶 —> 第八章 SMS–短信服務,廢話不多說,開幹
8.1 短信服務介紹
短信服務(Short Message Service)是阿里云爲用戶提供的一種通信服務的能力。
產品優勢:覆蓋全面、高併發處理、消息堆積處理、開發管理簡單、智能監控調度
產品功能:短信通知、短信驗證碼、推廣短信、異步通知、數據統計
應用場景:短信驗證碼、系統信息推送、推廣短信等
8.2 短信服務使用
接下來,我們使用短信驗證碼功能來演示短信服務的使用。流程如下:
8.2.1 準備工作
8.2.1.1 實名認證
8.2.1.2 開通短信服務
or
8.2.1.3 申請認證祕鑰
跟着下面操作
8.2.1.3 申請短信簽名
8.2.1.5 申請短信模板
注意:
儘量短信簽名有關聯,不然通過不了
8.2.2 短信服務API介紹
8.2.2.1 短信發送(SendSms)
調用SendSms發送短信。
請求參數
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
---|---|---|---|---|
PhoneNumbers | String | 是 | 15900000000 | 接收短信的手機號碼。 |
SignName | String | 是 | 阿里雲 | 短信簽名名稱 |
TemplateCode | String | 是 | SMS_153055065 | 短信模板ID |
TemplateParam | String | 否 | {“code”:“1111”} | 短信模板變量的值,JSON格式 |
返回數據
名稱 | 類型 | 示例值 | 描述 |
---|---|---|---|
BizId | String | 900619746936498440^0 | 發送回執ID,可根據它查詢具體的發送狀態 |
Code | String | OK | 請求狀態碼。返回OK代表請求成功。 |
Message | String | OK | 狀態碼的描述 |
RequestId | String | F655A8D5-B967-440B-8683 | 請求ID。 |
8.2.2.2 短信查詢(QuerySendDetails)
調用QuerySendDetails接口查看短信發送記錄和發送狀態。
請求參數
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
---|---|---|---|---|
CurrentPage | Long | 是 | 1 | 分頁查看,指定發送記錄的的當前頁碼。 |
PageSize | Long | 是 | 10 | 分頁查看,指定每頁顯示的短信記錄數量。 |
PhoneNumber | String | 是 | 15900000000 | 接收短信的手機號碼。 |
SendDate | String | 是 | 20181228 | 短信發送日期,支持查詢最近30天的記錄。 |
BizId | String | 否 | 134523^4351232 | 發送回執ID,即發送流水號。 |
返回數據
名稱 | 類型 | 示例值 | 描述 |
---|---|---|---|
Code | String | OK | 請求狀態碼。返回OK代表請求成功。 |
Message | String | OK | 狀態碼的描述。 |
RequestId | String | 819BE656-D2E0 | 請求ID。 |
SmsSendDetailDTOs | Array | 短信發送明細。 | |
TotalCount | String | 1 短信發送總條數。 |
8.2.2.3 功能測試
第1步: 引入阿里雲服務依賴
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-alicloud-sms</artifactId>
</dependency>
第2步: 使用阿里雲提供的Demo測試短信發送
import com.aliyun.mns.common.ClientException;
import com.aliyuncs.DefaultAcsClient;
import com.aliyuncs.IAcsClient;
import com.aliyuncs.dysmsapi.model.v20170525.QuerySendDetailsRequest;
import com.aliyuncs.dysmsapi.model.v20170525.QuerySendDetailsResponse;
import com.aliyuncs.dysmsapi.model.v20170525.SendSmsRequest;
import com.aliyuncs.dysmsapi.model.v20170525.SendSmsResponse;
import com.aliyuncs.profile.DefaultProfile;
import com.aliyuncs.profile.IClientProfile;
import java.text.SimpleDateFormat;
import java.util.Date;
public class SmsDemoTest {
//產品名稱:雲通信短信API產品,開發者無需替換
static final String product = "Dysmsapi";
//產品域名,開發者無需替換
static final String domain = "dysmsapi.aliyuncs.com";
// TODO 此處需要替換成開發者自己的AK(在阿里雲訪問控制檯尋找)
static final String accessKeyId = "yourAccessKeyId";
static final String accessKeySecret = "yourAccessKeySecret";
//短信發送
public static SendSmsResponse sendSms() throws ClientException, com.aliyuncs.exceptions.ClientException {
//可自助調整超時時間
System.setProperty("sun.net.client.defaultConnectTimeout", "10000");
System.setProperty("sun.net.client.defaultReadTimeout", "10000");
//初始化acsClient,暫不支持region化
IClientProfile profile = DefaultProfile.getProfile("cn-hangzhou", accessKeyId, accessKeySecret);
DefaultProfile.addEndpoint("cn-hangzhou", "cn-hangzhou", product, domain);
IAcsClient acsClient = new DefaultAcsClient(profile);
//組裝請求對象-具體描述見控制檯-文檔部分內容
SendSmsRequest request = new SendSmsRequest();
//必填:待發送手機號
request.setPhoneNumbers("15000000000");
//必填:短信簽名-可在短信控制檯中找到
request.setSignName("雲通信");
//必填:短信模板-可在短信控制檯中找到
request.setTemplateCode("SMS_1000000");
//可選:模板中的變量替換JSON串,如模板內容爲"親愛的${name},您的驗證碼爲${code}"時,此處的值爲
request.setTemplateParam("{\"name\":\"Tom\", \"code\":\"123\"}");
//選填-上行短信擴展碼(無特殊需求用戶請忽略此字段)
//request.setSmsUpExtendCode("90997");
//可選:outId爲提供給業務方擴展字段,最終在短信回執消息中將此值帶回給調用者
request.setOutId("yourOutId");
//hint 此處可能會拋出異常,注意catch
SendSmsResponse sendSmsResponse = acsClient.getAcsResponse(request);
return sendSmsResponse;
}
//短信查詢
public static QuerySendDetailsResponse querySendDetails(String bizId) throws ClientException, com.aliyuncs.exceptions.ClientException {
//可自助調整超時時間
System.setProperty("sun.net.client.defaultConnectTimeout", "10000");
System.setProperty("sun.net.client.defaultReadTimeout", "10000");
//初始化acsClient,暫不支持region化
IClientProfile profile = DefaultProfile.getProfile("cn-hangzhou", accessKeyId, accessKeySecret);
DefaultProfile.addEndpoint("cn-hangzhou", "cn-hangzhou", product, domain);
IAcsClient acsClient = new DefaultAcsClient(profile);
//組裝請求對象
QuerySendDetailsRequest request = new QuerySendDetailsRequest();
//必填-號碼
request.setPhoneNumber("15000000000");
//可選-流水號
request.setBizId(bizId);
//必填-發送日期 支持30天內記錄查詢,格式yyyyMMdd
SimpleDateFormat ft = new SimpleDateFormat("yyyyMMdd");
request.setSendDate(ft.format(new Date()));
//必填-頁大小
request.setPageSize(10L);
//必填-當前頁碼從1開始計數
request.setCurrentPage(1L);
//hint 此處可能會拋出異常,注意catch
QuerySendDetailsResponse querySendDetailsResponse = acsClient.getAcsResponse(request);
return querySendDetailsResponse;
}
public static void main(String[] args) throws ClientException, InterruptedException, com.aliyuncs.exceptions.ClientException {
//發短信
SendSmsResponse response = sendSms();
System.out.println("短信接口返回的數據----------------");
System.out.println("Code=" + response.getCode());
System.out.println("Message=" + response.getMessage());
System.out.println("RequestId=" + response.getRequestId());
System.out.println("BizId=" + response.getBizId());
Thread.sleep(3000L);
//查明細
if (response.getCode() != null && response.getCode().equals("OK")) {
QuerySendDetailsResponse querySendDetailsResponse = querySendDetails(response.getBizId());
System.out.println("短信明細查詢接口返回數據----------------");
System.out.println("Code=" + querySendDetailsResponse.getCode());
System.out.println("Message=" + querySendDetailsResponse.getMessage());
int i = 0;
for (QuerySendDetailsResponse.SmsSendDetailDTO smsSendDetailDTO : querySendDetailsResponse.getSmsSendDetailDTOs()) {
System.out.println("SmsSendDetailDTO[" + i + "]:");
System.out.println("Content=" + smsSendDetailDTO.getContent());
System.out.println("ErrCode=" + smsSendDetailDTO.getErrCode());
System.out.println("OutId=" + smsSendDetailDTO.getOutId());
System.out.println("PhoneNum=" + smsSendDetailDTO.getPhoneNum());
System.out.println("ReceiveDate=" + smsSendDetailDTO.getReceiveDate());
System.out.println("SendDate=" + smsSendDetailDTO.getSendDate());
System.out.println("SendStatus=" + smsSendDetailDTO.getSendStatus());
System.out.println("Template=" + smsSendDetailDTO.getTemplateCode());
}
System.out.println("TotalCount=" + querySendDetailsResponse.getTotalCount());
System.out.println("RequestId=" + querySendDetailsResponse.getRequestId());
}
}
}
8.3 下單之後發送短信
1 在shop-user
模塊中加入sms依賴
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-alicloud-sms</artifactId>
</dependency>
2 將阿里短信給出的demo封裝成工具類
import com.aliyuncs.DefaultAcsClient;
import com.aliyuncs.IAcsClient;
import com.aliyuncs.dysmsapi.model.v20170525.SendSmsRequest;
import com.aliyuncs.dysmsapi.model.v20170525.SendSmsResponse;
import com.aliyuncs.profile.DefaultProfile;
import com.aliyuncs.profile.IClientProfile;
import lombok.extern.slf4j.Slf4j;
@Slf4j
public class SmsUtil {
//替換成自己申請的accessKeyId
private static String accessKeyId = "LTAIMLlf8NKYXn1M";
//替換成自己申請的accessKeySecret
private static String accessKeySecret = "hqyW0zTNzeSIFnZhMEkOaZXVVcr3Gj";
static final String product = "Dysmsapi";
static final String domain = "dysmsapi.aliyuncs.com";
/**
* 發送短信
*
* @param phoneNumbers 要發送短信到哪個手機號
* @param signName 短信簽名[必須使用前面申請的]
* @param templateCode 短信短信模板ID[必須使用前面申請的]
* @param param 模板中${code}位置傳遞的內容
*/
public static void sendSms(String phoneNumbers, String signName, String templateCode, String param) {
try {
System.setProperty("sun.net.client.defaultConnectTimeout", "10000");
System.setProperty("sun.net.client.defaultReadTimeout", "10000");
//初始化acsClient,暫不支持region化
IClientProfile profile = DefaultProfile.getProfile("cn-hangzhou", accessKeyId, accessKeySecret);
DefaultProfile.addEndpoint("cn-hangzhou", "cn-hangzhou", product, domain);
IAcsClient acsClient = new DefaultAcsClient(profile);
SendSmsRequest request = new SendSmsRequest();
request.setPhoneNumbers(phoneNumbers);
request.setSignName(signName);
request.setTemplateCode(templateCode);
request.setTemplateParam(param);
request.setOutId("yourOutId");
SendSmsResponse sendSmsResponse = acsClient.getAcsResponse(request);
if (!"OK".equals(sendSmsResponse.getCode())) {
log.info("發送短信失敗,{}", sendSmsResponse);
throw new RuntimeException(sendSmsResponse.getMessage());
}
} catch (Exception e) {
log.info("發送短信失敗,{}", e);
throw new RuntimeException("發送短信失敗");
}
}
}
3 修改短信發送的服務
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.apache.rocketmq.spring.annotation.ConsumeMode;
import org.apache.rocketmq.spring.annotation.MessageModel;
import org.apache.rocketmq.spring.annotation.RocketMQMessageListener;
import org.apache.rocketmq.spring.core.RocketMQListener;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import java.util.Random;
@Slf4j
@Service("shopSmsService")
//consumerGroup-消費者組名 topic-要消費的主題
@RocketMQMessageListener(
consumerGroup = "shop-user", //消費者組名
topic = "order-topic",//消費主題
consumeMode = ConsumeMode.CONCURRENTLY,//消費模式,指定是否順序消費 CONCURRENTLY(同步,默認) ORDERLY(順序)
messageModel = MessageModel.CLUSTERING//消息模式 BROADCASTING(廣播) CLUSTERING(集羣,默認)
)
public class SmsService implements RocketMQListener<Order> {
@Autowired
private UserDao userDao;
//消費邏輯
@Override
public void onMessage(Order message) {
log.info("接收到了一個訂單信息{},接下來就可以發送短信通知了", message);
//根據uid 獲取手機號
User user = userDao.findById(message.getUid()).get();
//生成驗證碼 1-9 6
StringBuilder builder = new StringBuilder();
for (int i = 0; i < 6; i++) {
builder.append(new Random().nextInt(9) + 1);
}
String smsCode = builder.toString();
Param param = new Param(smsCode);
try {
//發送短信 {"code":"123456"}
SmsUtil.sendSms(user.getTelephone(), "你的簽名", "SMS_170836451", JSON.toJSONString(param));
log.info("短信發送成功");
} catch (Exception e) {
e.printStackTrace();
}
}
@Data
@AllArgsConstructor
@NoArgsConstructor
class Param {
private String code;
}
}
最近比較忙,沒時間更新,感謝您能學到這,更多學習請參考官網,
參考資料: