阿里云短信服务
程序员文章站
2024-02-29 19:10:58
...
短信服务(Short Message Service)是阿里云为用户提供的一种通信服务的能力,支持快速发送短信验证码、短信通知等。
在此分享一下相关代码,希望对大家能有所帮助。
以下主要记录代码部分:
1.导入aliyun-java-sdk-core.jar和aliyun-java-sdk-dysmsapi.jar,maven项目pom.xml文件添加如下代码:
<!-- 阿里云短信验证码 -->
<dependency>
<groupId>aliyun</groupId>
<artifactId>aliyun-java-sdk-core</artifactId>
<version>3.3.1</version>
</dependency>
<dependency>
<groupId>aliyun</groupId>
<artifactId>aliyun-java-sdk-dysmsapi</artifactId>
<version>1.0.0</version>
</dependency>
2.编写CodeUtils类,其中包含发短信和查明细功能,可根据业务需求增减
package com.lvqutour.utils;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;
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;
/**
* 只需要将AK替换成开通了云通信-短信产品功能的AK即可)
* 工程依赖了2个jar包
* 1:aliyun-java-sdk-core.jar
* 2:aliyun-java-sdk-dysmsapi.jar
* 备注:Demo工程编码采用UTF-8
* 国际短信发送请勿参照此DEMO
*/
public class CodeUtils {
//产品名称:云通信短信API产品,开发者无需替换
static final String product = "Dysmsapi";
//产品域名,开发者无需替换
static final String domain = "dysmsapi.aliyuncs.com";
// TODO 此处需要替换成开发者自己的AK(在阿里云访问控制台寻找)
static final String accessKeyId = "WXMLTAI1LOJ9abkMKOe";
static final String accessKeySecret = "WXMZGLDXvBpOVmiA42GLiyls0HrJXLqGL";
//发短信
public static SendSmsResponse sendSms(Map<String, String> paramMap) throws 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(paramMap.get("phoneNumber"));
//必填:短信签名-可在短信控制台中找到
request.setSignName(paramMap.get("msgSign"));
//必填:短信模板-可在短信控制台中找到
request.setTemplateCode(paramMap.get("templateCode"));
//可选:模板中的变量替换JSON串,如模板内容为"亲爱的${name},您的验证码为${code}"时,此处的值为
request.setTemplateParam(paramMap.get("jsonContent"));
//选填-上行短信扩展码(无特殊需求用户请忽略此字段)
//request.setSmsUpExtendCode("90997");
//可选:outId为提供给业务方扩展字段,最终在短信回执消息中将此值带回给调用者
request.setOutId("yourOutId");
//hint 此处可能会抛出异常,注意catch
SendSmsResponse sendSmsResponse = acsClient.getAcsResponse(request);
return sendSmsResponse;
}
//查明细
public static QuerySendDetailsResponse querySendDetails(String bizId) throws 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("17702714360");
//可选-流水号
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 String createRandomNum(int num){
String randomNumStr = "";
for(int i = 0; i < num;i ++){
int randomNum = (int)(Math.random() * 10);
randomNumStr += randomNum;
}
return randomNumStr;
}
//获取验证码
public static String getCode(Long telephone) {
SendSmsResponse response;
String name = "驴趣用户";
String phoneNumber = telephone.toString();
String randomNum = createRandomNum(6);
if(randomNum.substring(0,1).equals("0")){
randomNum = "1" + randomNum.substring(1,6);
}
String jsonContent = "{\"name\":\"" + name + "\",\"code\":" + randomNum+"}";
Map<String, String> paramMap = new HashMap<>();
paramMap.put("phoneNumber", phoneNumber);
paramMap.put("msgSign", "驴趣导游");
paramMap.put("templateCode", "SMS_113445090");
paramMap.put("jsonContent", jsonContent);
try {
//发短信
response = CodeUtils.sendSms(paramMap);
System.out.println(jsonContent);
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 = CodeUtils.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());
}
return randomNum;
} catch (Exception e) {
e.printStackTrace();
return null;
}
}
}
2.定时器,定时执行
package com.lvqutour.utils;
import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;
/**
* Created with IntelliJ IDEA.
* Date: 2018/1/15 21:08
* User: pc
* Description:定时器
*/
public class Timer {
/**
* @param runnable 方法
* @param time 延迟执行时间
* 只在time时间后执行一次runnable方法
*/
public static void onlyOnce(Runnable runnable,Long time){
ScheduledExecutorService service = Executors.newSingleThreadScheduledExecutor();
service.schedule(runnable, time, TimeUnit.SECONDS);
}
}
3.实现类,调用CodeUtils.getCode(Long telephone)方法,该方法中包含发短信和查明细,可根据业务需求增减
package com.lvqutour.service.impl;
import com.lvqutour.api.LvQuResult;
import com.lvqutour.mapper.SecurityCodeMapper;
import com.lvqutour.pojo.SecurityCode;
import com.lvqutour.pojo.SecurityCodeExample;
import com.lvqutour.service.ISecurityCode;
import com.lvqutour.utils.CodeUtils;
import com.lvqutour.utils.Timer;
import org.springframework.beans.factory.annotation.Autowired;
public class SecurityCodeImpl implements ISecurityCode {
@Autowired
private SecurityCodeMapper securityCodeMapper;
//3分钟有效时间
final long time = 60*3;
@Override
public LvQuResult getCode(Long telephone) {
String code = CodeUtils.getCode(telephone);
SecurityCode securityCode = new SecurityCode();
securityCode.setTelephone(telephone);
securityCode.setCode(code);
int result = securityCodeMapper.insertSelective(securityCode);
if(code != null && result == 1) {
//匿名方法
Runnable runnable = () -> {
SecurityCodeExample securityCodeExample = new SecurityCodeExample();
securityCodeExample.createCriteria().andTelephoneEqualTo(telephone).andCodeEqualTo(code);
securityCodeMapper.deleteByExample(securityCodeExample);
};
//3分钟后清除验证码
Timer.onlyOnce(runnable, time);
return LvQuResult.ok().setReason("验证码发送成功");
}else {
return LvQuResult.msg(false,"验证码发送失败");
}
}
}
详细文档请参考:阿里云-短信服务-开发指南上一篇: Android 调用WCF实例详解
下一篇: Android8.0启动Service