该工具类包含了如下功能:
- 短信发送
- 发送详情查询
工具类代码如下:
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;
/**
* 发送短信工具类
* @author MrXiao
* @version 1.0.0
*/
@Configuration
@PropertySource("classpath:config/config.properties")
public class SmsUtil {
//产品名称:云通信短信API产品,固定值
private static final String product = "Dysmsapi";
//产品域名,开发者无需替换,固定值
private static final String domain = "dysmsapi.aliyuncs.com";
// 阿里云控制台自己的AK
private static String accessKeyId;
private static String accessKeySecret;;
// 短信签名
private static String signName;
// 短信模板: 注册
private static String templateCodeRegist;
// 短信模板: 重置密码
private static String templateCodeResetPwd;
// 超时时间
private static String defaultConnectTimeout;
private static String defaultReadTimeout;
/**
* 发送短信的方法
*/
public static SendSmsResponse sendSms(String mobileCode, String smsCode) throws ClientException, IOException {
//可自助调整超时时间
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);
//组装请求对象-具体描述见控制台-文档部分内容
SendSmsRequest request = new SendSmsRequest();
//必填:待发送手机号
request.setPhoneNumbers(mobileCode);
//必填:短信签名-可在短信控制台中找到
request.setSignName(signName);
//必填:短信模板-可在短信控制台中找到
request.setTemplateCode(templateCodeRegist);
//可选:模板中的变量替换JSON串,如模板内容为"亲爱的${name},您的验证码为${code}"时,此处的值为
// smsCOde为随机验证码
request.setTemplateParam("{\"code\":\"" + smsCode + "\"}");
//选填-上行短信扩展码(无特殊需求用户请忽略此字段)
//request.setSmsUpExtendCode("90997");
//可选:outId为提供给业务方扩展字段,最终在短信回执消息中将此值带回给调用者
// request.setOutId("yourOutId");
//hint 此处可能会抛出异常,注意catch
SendSmsResponse sendSmsResponse = acsClient.getAcsResponse(request);
return sendSmsResponse;
}
/**
* 查询短信发送详情
*/
public static QuerySendDetailsResponse querySendDetails(String bizId, String telphone) throws ClientException, IOException {
//可自助调整超时时间
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);
//必填-发送日期 支持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;
}
@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是通用的,在控制台可以查看到
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
# 配置超时时间
aliyun.sms.defaultConnectTimeout=10000
aliyun.sms.defaultReadTimeout=10000