阿里云短信服务
阿里云短信
最近要完成学校里面的万众艺兴的项目，移动端的用户通过使用手机号发送验证码的方式来完成注册。这是第一次使用第三方的短信支付平台，使用前在网上给你找了好久，第三方的短信发送平台，最终找到阿里云和腾讯云的短信服务，阿里云的短信服务就是之前的阿里大鱼。
小插曲：发送短信前申请短信签名和模板，最开始使用APP开发的方式去申请，一直不通过，因为还没有APP的后台管理的截图。最后发现有一个微信公众号开通，所以注册了一个公主号，以公众号的名义来申请，最终成功。
服务搭建过程
开通短信服务，获取自己的AK，然后申请签名和模板，个人开发想可以考虑使用公众号来申请，更加方便。
完成了申请和配置之后，首先开始跑Demo
package com.alicom.dysms.api;
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.text.SimpleDateFormat;
import java.util.Date;
/**
* Created on 17/6/7.
* 短信API产品的DEMO程序,工程中包含了一个SmsDemo类，直接通过
* 执行main函数即可体验短信产品API功能(只需要将AK替换成开通了云通信-短信产品功能的AK即可)
* 工程依赖了2个jar包(存放在工程的libs目录下)
* 1:aliyun-java-sdk-core.jar
* 2:aliyun-java-sdk-dysmsapi.jar
*
* 备注:Demo工程编码采用UTF-8
* 国际短信发送请勿参照此DEMO
*/
public class SmsDemo {
//产品名称:云通信短信API产品,开发者无需替换
static final String product = "Dysmsapi";
//产品域名,开发者无需替换
static final String domain = "dysmsapi.aliyuncs.com";
// TODO 此处需要替换成开发者自己的AK(在阿里云访问控制台寻找)
static final String accessKeyId = "替换成自己的";
static final String accessKeySecret = "替换成自己的";
public static SendSmsResponse sendSms() 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("XXXXX");
//必填:短信签名-可在短信控制台中找到
request.setSignName("XXXXXX");
//必填:短信模板-可在短信控制台中找到
request.setTemplateCode("xxxxx");
//可选:模板中的变量替换JSON串,如模板内容为"亲爱的${name},您的验证码为${code}"时,此处的值为
request.setTemplateParam("{\"code\":\"123456\"}");
//选填-上行短信扩展码(无特殊需求用户请忽略此字段)
//request.setSmsUpExtendCode("90997");
//可选:outId为提供给业务方扩展字段,最终在短信回执消息中将此值带回给调用者
request.setOutId("XXXX");
//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("18629501095");
//可选-流水号
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 {
//发短信
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());
}
}
}
从上面的代码可以看出，要实现短信的发送主要有两部分要做。
- 首先 要构建一个本地的短信客户端，也就是使用一些配置信息来初始化IACSClient对象，
- 第二部分要构造一个要发送的短信的对象，检查代码可知，主要有手机号、签名、模板编号、模板参数这四个对象。
通过上面的分析，如果要构建一个发送短信的工具类，实现下面的功能就可以了
- 在工具类里面初始化本地短信客户端
- 使用一个方法来接受四个参数、构建发送对象QuerySendDetailsRequest， 然后调用客户端的方法发送就可以了。可以把这个方法作为私有的，让更加具体的方法来封装。
- 对于发送验证码，更加具体的业务，可以在上面的基础上进行封装，因为签名和模板已经确定了。可以封装一个接受手机号来验证码的方法，向外提供往指定手机发送验证码的服务。
实现的代码如下
package com.wzyx.util;
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.exceptions.ClientException;
import com.aliyuncs.profile.DefaultProfile;
import com.aliyuncs.profile.IClientProfile;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* 用来发送短信的工具类
*/
public class SMSUtil {
private static Logger log = LoggerFactory.getLogger(SMSUtil.class);
//发送短信的客户端， 第一次使用时进行初始化，静态变量
private static IAcsClient acsClient;
//产品名称:云通信短信API产品,开发者无需替换
private static final String product = "Dysmsapi";
//产品域名,开发者无需替换
private static final String domain = "dysmsapi.aliyuncs.com";
// 配置个人阿里云的AK，保密信息
private static String accessKeyId = PropertiesUtil.getProperty("dysms.accessKeyId");
private static String accessKeySecret = PropertiesUtil.getProperty("dysms.accessKeySecret");
//默认的超时时间，分为连接超时和读取超时
private static String defaultConnectTimeout = PropertiesUtil.getProperty("dysms.defaultConnectTimeout");
private static String defaultReadTimeout = PropertiesUtil.getProperty("dysms.defaultReadTimeout");
//发送验证码短信的配置信息
private static String signName = PropertiesUtil.getProperty("dysms.signName");
private static String templateCode = PropertiesUtil.getProperty("dysms.templateCode");
// 初始化短信发送客户端的一些配置
static {
//可通过修改wzyx.properties来调整超时时间
System.setProperty("sun.net.client.defaultConnectTimeout", defaultConnectTimeout);
System.setProperty("sun.net.client.defaultReadTimeout", defaultReadTimeout);
//初始化acsClient,暂不支持region化
IClientProfile profile = DefaultProfile.getProfile("cn-hangzhou", accessKeyId, accessKeySecret);
try {
DefaultProfile.addEndpoint("cn-hangzhou", "cn-hangzhou", product, domain);
acsClient = new DefaultAcsClient(profile);
} catch (ClientException e) {
// 初始化失败，打印错误日志
log.error("SMS init Error", e);
}
}
/**
* 向指定手机号发送指定验证码
* @param phoneNumber 手机号
* @param verificationCode 验证码，由服务调用方提供
* @return 返回发送短信的相应对象
*/
public static SendSmsResponse sendSms(String phoneNumber, String verificationCode) {
String templateParam = "{\"code\":\"" + verificationCode + "\"}";
return sendSms(phoneNumber, signName, templateCode, templateParam);
}
/**
* 执行发送短信的工具类，可以发送指定手机号，签名、模板代码的、模板变量的信息,私有化，被类里面其他更具体的方法调用，例如发送验证码的方法
* @param phoneNumber 手机号
* @param signName 短信签名，提前在阿里云申请
* @param templateCode 模板代码，提前在阿里云申请
* @param templateParam 模板变量，和具体的模板有关，用来代替模板里面的变量值
* @return
*/
private static SendSmsResponse sendSms(String phoneNumber, String signName, String templateCode, String templateParam) {
//组装请求对象-具体描述见控制台-文档部分内容
SendSmsRequest request = new SendSmsRequest();
//必填:待发送手机号 例如 "18629501095"
request.setPhoneNumbers(phoneNumber);
//必填:短信签名-可在短信控制台中找到 例如 "debug"
request.setSignName(signName);
//必填:短信模板-可在短信控制台中找到， 例如 "SMS_151178564"
request.setTemplateCode(templateCode);
//可选:模板中的变量替换JSON串,如模板内容为"您的验证码为${code}"时,此处的值用来填充${code}变量的值，示例"{\"code\":\"123456\"}"
request.setTemplateParam(templateParam);
//选填-上行短信扩展码(无特殊需求用户请忽略此字段)
//request.setSmsUpExtendCode("90997");
//可选:outId为提供给业务方扩展字段,最终在短信回执消息中将此值带回给调用者， 这里暂时设置为用户的手机号
request.setOutId(phoneNumber);
//hint 此处可能会抛出异常，注意catch
SendSmsResponse sendSmsResponse = null;
try {
sendSmsResponse = acsClient.getAcsResponse(request);
} catch (ClientException e) {
log.error("send SMS fail", e);
}
return sendSmsResponse;
}
}
为了进一步简化业务层的代码，再封装一个工具类，完成验证码的生成和发送功能，并返回验证码。业务层只需要提供手机号，就可以了。代码如下。
package com.wzyx.util;
import java.util.Random;
/**
* 验证码的工具类，用来生成和发送验证码，依赖SMSUtil
*/
public class VerificationCodeUtil {
private static Random random = new Random(17);// 随机数生成类，用来生成随机验证码
/**
* 生成随机的验证码，并且发送验证码短信，将生成验证码返回给服务调用方
* @param phoneNumber
* @return 生成的随机的验证码
*/
public static String sendVerificationCode(String phoneNumber) {
StringBuilder stringBuilder = new StringBuilder();
for (int i = 0; i < 6; i++) {
stringBuilder.append(random.nextInt(10));
}
SMSUtil.sendSms(phoneNumber, stringBuilder.toString());
return stringBuilder.toString();
}
}
后面要使用消息队列来完成短信发送功能的异步调用，提高可用性、扩展性、并发。