1、阿里大于概述
阿里大于是阿里云旗下产品,融合了三大运营商的通信能力,通过将传统通信业务和能力与互联网相结合,创新融合阿里巴巴生态内容,全力为中小企业和开发者提供优质服务阿里大于提供包括短信、语音、流量直充、私密专线、店铺手机号等个性化服务。通过阿里大于打通三大运营商通信能力,全面融合阿里巴巴生态,以开放API及SDK的方式向开发者提供通信和数据服务,更好地支撑企业业务发展和创新服务。本博文主要介绍其中的短信服务。
2、前提:订阅短信服务
(1)进入阿里云官网,搜索“短信服务”,找到“短信服务”并开通。
(2)需要申请两个东西:短信签名和短信模板。在项目中开发短信通知模块的时,需要使用到签名和模板。同时,还需要使用到AccessKey ID和AccessKey Secret。这个会在阿里云官网生成,可以下载到本地保存。
添加短信模板:
添加短信签名:
3、SpringBoot整各阿里大于
(1)SDK安装到本地
从阿里云通信官网上下载Demo工程
解压后导入Eclipce/IDEA
红线框起来的两个工程就是阿里云通信的依赖jar源码,我们将其安装到本地仓库
(删除aliyun-java-sdk-core的单元测试类)
安装后,可以在项目的依赖文件中看到jar包,如下:
也可以在本地的maven库中查看到,如下:
(2)pom依赖
<!-- 短信服务-->
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>aliyun-java-sdk-dysmsapi</artifactId>
<version>1.0.0-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>aliyun-java-sdk-core</artifactId>
<version>3.2.5</version>
</dependency>
(3)配置文件application.properties,四个参数都可以在自己的阿里云账号中查看到。
#短息服务配置
accessKeyId= XXXXXXXXXXXXXXXXXXXXXX
accessKeySecret=XXXXXXXXXXXXXXXXXXX
template_code=XXXXXXXXXXXXXXXXXXXXX
sign_name=XXXXXXXXXXXXXXXXXXXXXXXXX
(4)发送短信工具类
编写一个工具类SmsUtil.java,如下,所以在发送短信的地方可以直接调用SmsUtil中的sendSms方法,传入正确合适的参数即可。
@Component
public class SmsUtil {
//产品名称:云通信短信API产品,开发者无需替换
static final String product = "Dysmsapi";
//产品域名,开发者无需替换
static final String domain = "dysmsapi.aliyuncs.com";
// TODO 此处需要替换成开发者自己的AK(在阿里云访问控制台寻找)
@Autowired
private Environment env;
public SendSmsResponse sendSms(String mobile,String template_code,String sign_name,String param) throws ClientException {
String accessKeyId=env.getProperty("accessKeyId");
String accessKeySecret=env.getProperty("accessKeySecret");
//可自助调整超时时间
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(mobile);
//必填:短信签名-可在短信控制台中找到
request.setSignName(sign_name);
//必填:短信模板-可在短信控制台中找到
request.setTemplateCode(template_code);
//可选:模板中的变量替换JSON串,如模板内容为"亲爱的${name},您的验证码为${code}"时,此处的值为
request.setTemplateParam(param);
//选填-上行短信扩展码(无特殊需求用户请忽略此字段)
//request.setSmsUpExtendCode("90997");
//可选:outId为提供给业务方扩展字段,最终在短信回执消息中将此值带回给调用者
request.setOutId("yourOutId");
//hint 此处可能会抛出异常,注意catch
SendSmsResponse sendSmsResponse = acsClient.getAcsResponse(request);
return sendSmsResponse;
}
}
注意:
a、sendSms()方法有4个参数:mobile,template_code,sign_name,param。分别代表手机号,模板名称(自己申请的),签名(自己申请的),参数。
b、关于上述的param参数,特别注意,必须要是json格式的字符串,如果不是,需要使用JSON.toJSONString(param)进行转换。还要特别注意,json格式的字符串中,要注意键值对中键的名称,要如自己申请的模板中的变量一致,如果模板中的是变量是${code},则在即在传参的时候,也要保证键值对的键名是“code”,否则会报错
(5)测试类
可以直接写个测试类,调用SmsUtil中的sendSms方法,传入格式的参数,就可以。
(6)可能遇到的问题
官方列出了一些可能遇到的问题:
摘取几个:
isv.SMS_TEMPLATE_ILLEGAL | 短信模版不合法 | TemplateCode参数请传入审核通过的模版ID,模版见:见:https://dysms.console.aliyun.com/dysms.htm#/template |
isv.SMS_SIGNATURE_ILLEGAL | 短信签名不合法 | SignName请传入审核通过的签名内容,签名见:https://dysms.console.aliyun.com/dysms.htm#/sign |
isv.INVALID_PARAMETERS | 参数异常 | 对照文档,检查参数格式。例:短信查询接口SendDate日期格式yyyyMMdd,错误:2017-01-01正确:20170101 |
isv.TEMPLATE_MISSING_PARAMETERS | 模版缺少变量 | TemplateParam中需要以json格式字符串给使用的模版中出现的所有变量进行赋值。例:模版为:您好${name},验证码${code} TemplateParam={“name”:”Tom”,”code”:”123”} |
isv.BUSINESS_LIMIT_CONTROL | 业务限流 | 将短信发送频率限制在正常的业务流控范围内,默认流控:短信验证码 :使用同一个签名,对同一个手机号码发送短信验证码,支持1条/分钟,5条/小时 ,累计10条/天。 |
isv.INVALID_JSON_PARAM | JSON参数不合法,只接受字符串值 | TemplateParam入参以Json格式字符串形式传入。例:正确{“code”:”123”} |
isv.PARAM_LENGTH_LIMIT | 参数超出长度限制 | 单个变量长度限制在20字符内。 |