在项目开发中,登录注册界面需要用到短信验证功能,在查阅相关资料后实现了这部分的功能,现记录如下
1.涉及到的流程
开通短信服务>开发工具类>开发调用接口
2.开通短信服务
短信服务开通方法,详情请参见如下链接阿里云短信服务,需要特别注意的是短信服务需要开通一个RAM子账户,并申请AccessKey和AccessSecret,并赋予其短信服务权限,否则会在后续开发中提示没有权限操作
3.开发工具类
在进行工具类的开发中需要用到三个jar包,我没用用maven所以是直接导入的,有需要的可以在我上传的资源中下载。代码主要参考了阿里云短信接口的使用,我在这个的基础上做了改进,放弃了Redis,验证码生成后使用serssion存储,并采用timer做一个定时器,当时间超过五分钟的时候清除当前验证码,具体代码如下敏感信息用*****代替。
public class AliyunMessageUtil {
//产品名称:云通信短信API产品,开发者无需替换
static final String product = "Dysmsapi";
//产品域名,开发者无需替换
static final String domain = "dysmsapi.aliyuncs.com";
// 此处需要替换成开发者自己的AK(在阿里云访问控制台寻找)
static final String accessKeyId = "*******";
static final String accessKeySecret = "********";
// 短信签名
static final String signName = "******";
// 短信模板code(根据需要,注册、密码重置可用不同的模板code,阿里云访问控制台设置多套模板)
static final String identityTemplateCode = "******";// 验证码模板
// 随机生成验证码(六位数)
private static int identifyingCode;
public static int getIdentifyingCode(){
return identifyingCode = new Random().nextInt(900000)+100000;
//每次调用生成一次六位数的随机数
}
//发送验证码
public static SendSmsResponse sendSms(String phoneNumber, String templateCode, String templateParam) 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(phoneNumber);
//必填:短信签名-可在短信控制台中找到
request.setSignName(signName);
//必填:短信模板-可在短信控制台中找到
request.setTemplateCode(templateCode);
//可选:模板中的变量替换JSON串,如模板内容为"亲爱的${name},您的验证码为${code}"时,此处的值为
//request.setTemplateParam("{\"name\":\"Tom\", \"code\":\"123\"}");
request.setTemplateParam(templateParam);
//选填-上行短信扩展码(无特殊需求用户请忽略此字段)
//request.setSmsUpExtendCode("90997");
//可选:outId为提供给业务方扩展字段,最终在短信回执消息中将此值带回给调用者
request.setOutId("yourOutId");
//hint 此处可能会抛出异常,注意catch
SendSmsResponse sendSmsResponse = acsClient.getAcsResponse(request);
return sendSmsResponse;
}
public static QuerySendDetailsResponse querySendDetails(String bizId,String phoneNumber) 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(phoneNumber);
//可选-流水号
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;
}
/**
* 修改密码发送验证码短信(templateParam 根据模板需要传入的参数进行json格式拼接)
* @param phoneNumber
* @throws ClientException
* @throws InterruptedException
*/
public static SendSmsResponse sendIdentifyingCode(String phoneNumber,int identifyingCode) throws ClientException {
String templateParam = "{\"code\":\"" + identifyingCode + "\"}";
return sendSms(phoneNumber,identityTemplateCode,templateParam);
}
public static void main(String[] args) throws ClientException, InterruptedException {
//发短信
SendSmsResponse response = sendSms(args[0],identityTemplateCode,"{\"code\":\"" + getIdentifyingCode() + "\"}");
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+"]:");
}
}
}
}
4.开发调用工具类的接口(controller)
这里直接贴出发短信controller的代码,当然发送之前首先要进行手机号的判定,这些在前端就可以完成
//发短信的调用
@RequestMapping(value = "sendIdentifyingCode",method = RequestMethod.POST)
@ResponseBody
public Map<String,Object> sendIdentifyingCode(ServletRequest servletRequest,String phoneNumber) {
final HttpServletRequest request =(HttpServletRequest) servletRequest;
Map<String, Object> resultMap =new HashMap<String, Object>();
int state=-1;
try {
// 验证码生成发送
int identifyingCode = AliyunMessageUtil.getIdentifyingCode();
SendSmsResponse sendSmsResponse = AliyunMessageUtil.sendIdentifyingCode(phoneNumber,identifyingCode);
// ok代表的是接口发送成功的状态码
if (sendSmsResponse.getCode()!= null && sendSmsResponse.getCode().equals("OK")) {
state=1;
//TimerTask实现5分钟后从session中删除checkCode
request.getSession().setAttribute(phoneNumber,identifyingCode);
final Timer timer=new Timer();
final String phoneNum=phoneNumber;
timer.schedule(new TimerTask() {
@Override
public void run() {
request.removeAttribute(phoneNum);
System.out.println("checkCode删除成功");
timer.cancel();
}
},5*60*1000);
resultMap.put("state", state);
resultMap.put("msg", "发送成功");
} else {
resultMap.put("state", state);
resultMap.put("msg", "发送失败,请重新发送");
}
} catch (ClientException e) {
e.printStackTrace();
resultMap.put("state", state);
resultMap.put("msg", "发送失败,请重新发送");
}
return resultMap;
}
5.总结
整个过程耗时半天完成,阿里云的帮助文档对于一些设置是比较有帮助的,但是对于代码的编写,我更喜欢直接寻找资源并在基础上进行改造,毕竟这是一个互联网的时代。