該工具類包含了如下功能:
- 短信發(fā)送
- 發(fā)送詳情查詢
工具類代碼如下:
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.exceptions.ClientException;
import com.aliyuncs.profile.DefaultProfile;
import com.aliyuncs.profile.IClientProfile;
import java.io.IOException;
import java.text.SimpleDateFormat;
import java.util.Date;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;
/**
* 發(fā)送短信工具類
* @author MrXiao
* @version 1.0.0
*/
@Configuration
@PropertySource("classpath:config/config.properties")
public class SmsUtil {
//產(chǎn)品名稱:云通信短信API產(chǎn)品,固定值
private static final String product = "Dysmsapi";
//產(chǎn)品域名,開發(fā)者無需替換,固定值
private static final String domain = "dysmsapi.aliyuncs.com";
// 阿里云控制臺(tái)自己的AK
private static String accessKeyId;
private static String accessKeySecret;;
// 短信簽名
private static String signName;
// 短信模板: 注冊
private static String templateCodeRegist;
// 短信模板: 重置密碼
private static String templateCodeResetPwd;
// 超時(shí)時(shí)間
private static String defaultConnectTimeout;
private static String defaultReadTimeout;
/**
* 發(fā)送短信的方法
*/
public static SendSmsResponse sendSms(String mobileCode, String smsCode) throws ClientException, IOException {
//可自助調(diào)整超時(shí)時(shí)間
System.setProperty("sun.net.client.defaultConnectTimeout", defaultConnectTimeout);
System.setProperty("sun.net.client.defaultReadTimeout", defaultReadTimeout);
//初始化acsClient,暫不支持region化
IClientProfile profile = DefaultProfile.getProfile("cn-hangzhou", accessKeyId, accessKeySecret);
DefaultProfile.addEndpoint("cn-hangzhou", "cn-hangzhou", product, domain);
IAcsClient acsClient = new DefaultAcsClient(profile);
//組裝請求對象-具體描述見控制臺(tái)-文檔部分內(nèi)容
SendSmsRequest request = new SendSmsRequest();
//必填:待發(fā)送手機(jī)號
request.setPhoneNumbers(mobileCode);
//必填:短信簽名-可在短信控制臺(tái)中找到
request.setSignName(signName);
//必填:短信模板-可在短信控制臺(tái)中找到
request.setTemplateCode(templateCodeRegist);
//可選:模板中的變量替換JSON串,如模板內(nèi)容為"親愛的${name},您的驗(yàn)證碼為${code}"時(shí),此處的值為
// smsCOde為隨機(jī)驗(yàn)證碼
request.setTemplateParam("{\"code\":\"" + smsCode + "\"}");
//選填-上行短信擴(kuò)展碼(無特殊需求用戶請忽略此字段)
//request.setSmsUpExtendCode("90997");
//可選:outId為提供給業(yè)務(wù)方擴(kuò)展字段,最終在短信回執(zhí)消息中將此值帶回給調(diào)用者
// request.setOutId("yourOutId");
//hint 此處可能會(huì)拋出異常,注意catch
SendSmsResponse sendSmsResponse = acsClient.getAcsResponse(request);
return sendSmsResponse;
}
/**
* 查詢短信發(fā)送詳情
*/
public static QuerySendDetailsResponse querySendDetails(String bizId, String telphone) throws ClientException, IOException {
//可自助調(diào)整超時(shí)時(shí)間
System.setProperty("sun.net.client.defaultConnectTimeout", defaultConnectTimeout);
System.setProperty("sun.net.client.defaultReadTimeout", defaultReadTimeout);
//初始化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(telphone);
//可選-流水號
request.setBizId(bizId);
//必填-發(fā)送日期 支持30天內(nèi)記錄查詢,格式y(tǒng)yyyMMdd
SimpleDateFormat ft = new SimpleDateFormat("yyyyMMdd");
request.setSendDate(ft.format(new Date()));
//必填-頁大小
request.setPageSize(10L);
//必填-當(dāng)前頁碼從1開始計(jì)數(shù)
request.setCurrentPage(1L);
//hint 此處可能會(huì)拋出異常,注意catch
QuerySendDetailsResponse querySendDetailsResponse = acsClient.getAcsResponse(request);
return querySendDetailsResponse;
}
@Value("${aliyun.accessKeyId}")
public void setAccessKeyId(String accessKeyId) {
SmsUtil.accessKeyId = accessKeyId;
}
@Value("${aliyun.accessKeySecret}")
public void setAccessKeySecret(String accessKeySecret) {
SmsUtil.accessKeySecret = accessKeySecret;
}
@Value("${aliyun.sms.signName}")
public void setSignName(String signName) {
SmsUtil.signName = signName;
}
@Value("${aliyun.sms.templateCodeRegist}")
public void setTemplateCodeRegist(String templateCodeRegist) {
SmsUtil.templateCodeRegist = templateCodeRegist;
}
@Value("${aliyun.sms.templateCodeResetPwd}")
public void setTemplateCodeResetPwd(String templateCodeResetPwd) {
SmsUtil.templateCodeResetPwd = templateCodeResetPwd;
}
@Value("${aliyun.sms.defaultConnectTimeout}")
public void setDefaultConnectTimeout(String defaultConnectTimeout) {
SmsUtil.defaultConnectTimeout = defaultConnectTimeout;
}
@Value("${aliyun.sms.defaultReadTimeout}")
public void setDefaultReadTimeout(String defaultReadTimeout) {
SmsUtil.defaultReadTimeout = defaultReadTimeout;
}
}
配置文件代碼如下:
# Aliyun Config
# ID和Secret是通用的,在控制臺(tái)可以查看到
aliyun.accessKeyId=
aliyun.accessKeySecret=
# Aliyun SMS Config
# 短信簽名
aliyun.sms.signName=\u963F\u91CC\u4E91\u77ED\u4FE1\u6D4B\u8BD5\u4E13\u7528
# 注冊類型模板ID(阿里云控制申請)
aliyun.sms.templateCodeRegist=SMS_139355012
# 找回密碼類型模板ID(阿里云控制申請)
aliyun.sms.templateCodeResetPwd=SMS_139355011
# 配置超時(shí)時(shí)間
aliyun.sms.defaultConnectTimeout=10000
aliyun.sms.defaultReadTimeout=10000