阿里云短信服务集成SpringBoot
随着智能时代的开启,我们几乎人手一部手机。在我们日常生活中使用各种APP都会有短信登陆的功能,这里我们通过阿里云的短信服务实现这个功能,这篇文章,主要分为两个模块向大家展示功能的实现。
短信服务
短信服务实现需要两步:
- Accesskey,包括
AccessKey ID
和AccessKey Secret
。 - 短信服务的开通
AccessKey的创建
首先我们登录阿里云的官网:
链接我放这里:阿里云
登录成功后,点击控制台
点击AccessKey管理
可以看到有两个选项继续使用AccessKey,开始使用子用户AccessKey,根据个人需求选择。这里点击第一个选项继续使用AccessKey
。
点击创建AccessKey
创建成功后,保存自己的AccessKey ID
和AccessKey Secret
,这个是实现短信服务的钥匙。
短信服务开通
短信开通需要模板跟签名:
- 签名管理
- 模板管理
签名管理
输入提示信息
模板管理
跟签名一样都是需要申请的,当然我们也可以用自带的。
输入提示信息
到此为止,我们的准备阶段完成,下来上代码!
代码实现
引入依赖
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>aliyun-java-sdk-core</artifactId>
<version>4.0.6</version> <!-- 注:如提示报错,先升级基础包版,无法解决可联系技术支持 -->
</dependency>
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>aliyun-java-sdk-dysmsapi</artifactId>
<version>1.1.0</version>
</dependency>
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>dysmsapi20170525</artifactId>
<version>2.0.23</version>
</dependency>
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
</dependency>
实现及测试
下面提供简单实现的方法跟涉及业务的两种方法:
方法一:简单实现
public class aLiYun {
//产品名称:云通信短信API产品,开发者无需替换
static final String product = "Dysmsapi";
//产品域名,开发者无需替换
static final String domain = "dysmsapi.aliyuncs.com";
// 需开发者指定,AccessKey申请到的id
private static String accessKeyId = "输入accessKeyId";
// 需开发者指定,AccessKey申请到的secret
private static String accessKeySecret = "输入accessKeySecret";
// 需开发者指定(签名),短信服务中的签名
private static String signName = "输入签名";
// 需开发者指定(模板),短信服务中的模板
private static String templateCode = "输入模板code";
/**
* 调用阿里云平台发送短信
*
* @param phoneNumbers 手机号
* @param param 参数
* @return
* @throws ClientException
*/
public static SendSmsResponse sendSms(String phoneNumbers, String param) 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(phoneNumbers);
//必填:短信签名-可在短信控制台中找到
request.setSignName(signName);
//必填:短信模板-可在短信控制台中找到
request.setTemplateCode(templateCode);
//可选:模板中的变量替换JSON串,如模板内容为"亲爱的${name},您的验证码为${code}"时,此处的值为
request.setTemplateParam("{\"code\":\"" + param + "\"}");
//选填-上行短信扩展码(无特殊需求用户请忽略此字段)
//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;
}
public static void main(String[] args) throws Exception {
SendSmsResponse sendSmsResponse = sendSms("输入你的发送的电话", "发送的验证码");
System.out.println(sendSmsResponse);
}
}
方法二:生成随机验证码,并储存在redis中
涉及业务我们考虑两个问题:
- 生成随机验证码
- 测试阶段仅在控制台输出
代码大同小异,表达能力不行,我直接粘贴下来方便大家理解。
serviceImpl:
接口内容Alt+Enter
快捷生成。
@Service
public class SmsCodeLoginImpl implements SmsService {
@Resource
private StringRedisTemplate stringRedisTemplate;
@Override
public RespResult sendSms(String telephone) {
Random random=new Random();
//把随机生成的数字转成字符串
String smsCode = String.valueOf(random.nextInt(9));
for (int i = 0; i < 5; i++) {
smsCode += random.nextInt(9);
}
//创建的常量,redis的key
String key= redisKey.KEY_SMS_CODE_LOGIN+telephone;
stringRedisTemplate.boundValueOps(key).set(smsCode,3, TimeUnit.MINUTES);
// TODO 开发期间不再真实发送短信
System.out.println("短信验证码:" + smsCode);
// try {
// aLiYun.sendSms(telephone, smsCode);
// } catch (ClientException e) {
// // throw new RuntimeException(e);
// return RespResult.fail();
// }
return RespResult.ok();
}
@Override
public boolean checkSmsCode(String phone, String smsCode) {
String key=redisKey.KEY_SMS_CODE_LOGIN+phone;
if (stringRedisTemplate.hasKey(key)){
String querySmsCode = stringRedisTemplate.boundValueOps(key).get();
if (smsCode.equals(querySmsCode)){
return true;
}
}
return false;
}
}
aliyun:
将mian
方法注释掉。
public class aLiYun {
//产品名称:云通信短信API产品,开发者无需替换
static final String product = "Dysmsapi";
//产品域名,开发者无需替换
static final String domain = "dysmsapi.aliyuncs.com";
// 需开发者指定,AccessKey申请到的id
private static String accessKeyId = "输入accessKeyId";
// 需开发者指定,AccessKey申请到的secret
private static String accessKeySecret = "输入accessKeySecret";
// 需开发者指定(签名),短信服务中的签名
private static String signName = "输入签名";
// 需开发者指定(模板),短信服务中的模板
private static String templateCode = "输入模板code";
/**
* 调用阿里云平台发送短信
*
* @param phoneNumbers 手机号
* @param param 参数
* @return
* @throws ClientException
*/
public static SendSmsResponse sendSms(String phoneNumbers, String param) 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(phoneNumbers);
//必填:短信签名-可在短信控制台中找到
request.setSignName(signName);
//必填:短信模板-可在短信控制台中找到
request.setTemplateCode(templateCode);
//可选:模板中的变量替换JSON串,如模板内容为"亲爱的${name},您的验证码为${code}"时,此处的值为
request.setTemplateParam("{\"code\":\"" + param + "\"}");
//选填-上行短信扩展码(无特殊需求用户请忽略此字段)
//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;
}
// public static void main(String[] args) throws Exception {
// SendSmsResponse sendSmsResponse = sendSms("", getSmsCode());
// System.out.println(sendSmsResponse);
// }
}