简介
- 短信服务(Short Message Service、SMS)是指通过调用短信发送API,将指定短信内容发送给指定手机用户。
阿里云短信服务产品介绍:https://www.aliyun.com/product/sms
短信发送API帮助文档(Java):https://help.aliyun.com/document_detail/55284.html
发送短信(发送验证码)
- 需要以下配置
- 购买产品后,后台分配的accessKeyId、accessKeySecret
- 自己配置的短信模板ID(如:SMS_45680123)
- 模板变量(如果模板中存在变量)
- 下载官方SDK:https://help.aliyun.com/document_detail/55359.html
- 不支持迅雷等工具进行下载
- 解压后包含文件夹:
api_demo
、api_sdk
、msg_demo
、msg_sdk
。只需关注api的两个文件夹
- 使用sdk
- 直接导入jar包:取
api_demo/alicom-dysms-api/libs
里面的aliyun-java-sdk-core-3.2.3.jar
和aliyun-java-sdk-dysmsapi-1.0.0.jar
即可 - 使用maven:走本地jar,如:
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>aliyun-java-sdk-core</artifactId>
<version>3.2.3</version>
<scope>system</scope>
<systemPath>${basedir}/src/main/resources/lib/aliyun-java-sdk-core-3.2.3.jar</systemPath>
</dependency>
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>aliyun-java-sdk-dysmsapi</artifactId>
<version>1.0.0</version>
<scope>system</scope>
<systemPath>${basedir}/src/main/resources/lib/aliyun-java-sdk-dysmsapi-1.0.0.jar</systemPath>
</dependency>
- 示例
public static Boolean send(String telphone, String code) throws Exception {
//设置超时时间-可自行调整(指连接服务器超时时间)
System.setProperty("sun.net.client.defaultConnectTimeout", "10000");
System.setProperty("sun.net.client.defaultReadTimeout", "10000");
//初始化ascClient需要的几个参数
final String product = "Dysmsapi";//短信API产品名称(短信产品名固定,无需修改)
final String domain = "dysmsapi.aliyuncs.com";//短信API产品域名(接口地址固定,无需修改)
// TODO 替换成你的AK
final String accessKeyId = "LTAIzIZWzVeeeqqqe";//你的accessKeyId,参考本文档步骤2
final String accessKeySecret = "bnLKDS4LErpgLqwersdfwewe4SWEEd";//你的accessKeySecret,参考本文档步骤2
//初始化ascClient,暂时不支持多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();
//使用post提交
request.setMethod(MethodType.POST);
//必填:待发送手机号。支持以逗号分隔的形式进行批量调用,批量上限为1000个手机号码,批量调用相对于单条调用及时性稍有延迟,验证码类型的短信推荐使用单条调用的方式
request.setPhoneNumbers(telphone);
// TODO 必填:短信签名-可在短信控制台中找到
request.setSignName("随便,客户看不到");
// TODO 必填:短信模板-可在短信控制台中找到
request.setTemplateCode("SMS_23680123");
//TODO 可选:模板中的变量替换JSON串,如模板内容为"亲爱的${name},您的验证码为${code}"时,此处的值为
//友情提示:如果JSON中需要带换行符,请参照标准的JSON协议对换行符的要求,比如短信内容中包含\r\n的情况在JSON中需要表示成\\r\\n,否则会导致JSON在服务端解析失败
request.setTemplateParam(String.format("{\"code\":\"%s\"}", code));
//可选-上行短信扩展码(无特殊需求用户请忽略此字段)
//request.setSmsUpExtendCode("90997");
//可选:outId为提供给业务方扩展字段,最终在短信回执消息中将此值带回给调用者
request.setOutId("yourOutId");
//请求失败这里会抛ClientException异常
SendSmsResponse sendSmsResponse = acsClient.getAcsResponse(request);
if(sendSmsResponse.getCode() != null && sendSmsResponse.getCode().equals("OK")) {
//请求成功
return true;
} else {
logger.error("code: {}, message: {}", sendSmsResponse.getCode(), sendSmsResponse.getMessage());
}
return false;
}
public static Boolean send(String telphone, String code) throws Exception {
//设置超时时间-可自行调整(指连接服务器超时时间)
System.setProperty("sun.net.client.defaultConnectTimeout", "10000");
System.setProperty("sun.net.client.defaultReadTimeout", "10000");
//初始化ascClient需要的几个参数
final String product = "Dysmsapi";//短信API产品名称(短信产品名固定,无需修改)
final String domain = "dysmsapi.aliyuncs.com";//短信API产品域名(接口地址固定,无需修改)
// TODO 替换成你的AK
final String accessKeyId = "LTAIzIZWzVeeeqqqe";//你的accessKeyId,参考本文档步骤2
final String accessKeySecret = "bnLKDS4LErpgLqwersdfwewe4SWEEd";//你的accessKeySecret,参考本文档步骤2
//初始化ascClient,暂时不支持多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();
//使用post提交
request.setMethod(MethodType.POST);
//必填:待发送手机号。支持以逗号分隔的形式进行批量调用,批量上限为1000个手机号码,批量调用相对于单条调用及时性稍有延迟,验证码类型的短信推荐使用单条调用的方式
request.setPhoneNumbers(telphone);
// TODO 必填:短信签名-可在短信控制台中找到
request.setSignName("随便,客户看不到");
// TODO 必填:短信模板-可在短信控制台中找到
request.setTemplateCode("SMS_23680123");
//TODO 可选:模板中的变量替换JSON串,如模板内容为"亲爱的${name},您的验证码为${code}"时,此处的值为
//友情提示:如果JSON中需要带换行符,请参照标准的JSON协议对换行符的要求,比如短信内容中包含\r\n的情况在JSON中需要表示成\\r\\n,否则会导致JSON在服务端解析失败
request.setTemplateParam(String.format("{\"code\":\"%s\"}", code));
//可选-上行短信扩展码(无特殊需求用户请忽略此字段)
//request.setSmsUpExtendCode("90997");
//可选:outId为提供给业务方扩展字段,最终在短信回执消息中将此值带回给调用者
request.setOutId("yourOutId");
//请求失败这里会抛ClientException异常
SendSmsResponse sendSmsResponse = acsClient.getAcsResponse(request);
if(sendSmsResponse.getCode() != null && sendSmsResponse.getCode().equals("OK")) {
//请求成功
return true;
} else {
logger.error("code: {}, message: {}", sendSmsResponse.getCode(), sendSmsResponse.getMessage());
}
return false;
}
- 其中模板中的
${code}
即为随机生成的验证码,将此验证码发送到用户手机,并将此验证码和其过期时间一起保存到session中供提交验证