单一功能学习——阿里云的短信服务

2018-06-18 02:20:27来源：未知阅读 ()

一、学习该功能的时间：2018年4月1日

　　在大家学习别人提供的接口的时候，一定要去看一下这个接口的适用时间。我在学习这块的时候，大神给了我一个他之前封装过的代码，但是发现用不了，原因是阿里云的功能更新了，大神使用的那个接口已经被干掉了……

二、首先说明一下，阿里云的短信服务是要收短信费的，还是4.5个亿/条，我不知道有没有别的更便宜的或者免费的，公司大神推荐我用这个。项目功能完成后记得换下自己的账号，用公司的或者客户的

三、正文（官网开发指南 https://help.aliyun.com/document_detail/55284.html?spm=5176.10629532.106.1.5fe71cbeAXwwJC 我的基本上是复制了一遍，标记一下重点，后面有个扩展）

　　第一步，先要有一个阿里云账号并且实名认证

　　第二步，申请开通短信服务

　　第三步，进入控制台，创建应用：创建AccessKey ，获取它的ID和Secret

　　第四步，申请短信签名，获取签名名称

　　第五步，申请短信模板，获取模板CODE（分为三类，验证码0.045元/条，短信通知0.045元/条，推广短信0.055元/条），自己根据业务需求创建模板，模板内容有变量，变量的格式为 ${code}

　　第六步，下载SDK工具包：aliyun-java-sdk-core，alicom-dysms-api，自行下载，或者用maven都行

　　第七步，调用接口要传的参数以及得到的参数

　　　　　　入参列表

参数名称	参数类型	必填与否	样例取值	参数说明
PhoneNumbers	String	必须	15000000000	短信接收号码,支持以逗号分隔的形式进行批量调用，批量上限为1000个手机号码,批量调用相对于单条调用及时性稍有延迟,验证码类型的短信推荐使用单条调用的方式
SignName	String	必须	云通信	短信签名
TemplateCode	String	必须	SMS_0000	短信模板ID
TemplateParam	String	可选	{“code”:”1234”,”product”:”ytx”}	短信模板变量替换JSON串,友情提示:如果JSON中需要带换行符,请参照标准的JSON协议。
SmsUpExtendCode	String	可选	90999	上行短信扩展码,无特殊需要此字段的用户请忽略此字段
OutId	String	可选	abcdefgh	外部流水扩展字段

　　　　　　出参列表

出参名称	出参类型	样例取值	参数说明
RequestId	String	8906582E-6722	请求ID
Code	String	OK	状态码-返回OK代表请求成功,其他错误码详见错误码列表
Message	String	请求成功	状态码的描述
BizId	String	134523^4351232	发送回执ID,可根据该ID查询具体的发送状态

　　第八步，编写样例程序。注：有备注无需修改的位置请勿改动。

 1 //设置超时时间-可自行调整
 2 System.setProperty("sun.net.client.defaultConnectTimeout", "10000");
 3 System.setProperty("sun.net.client.defaultReadTimeout", "10000");
 4 //初始化ascClient需要的几个参数
 5 final String product = "Dysmsapi";//短信API产品名称（短信产品名固定，无需修改）
 6 final String domain = "dysmsapi.aliyuncs.com";//短信API产品域名（接口地址固定，无需修改）
 7 //替换成你的AK
 8 final String accessKeyId = "yourAccessKeyId";//你的accessKeyId,参考本文档步骤2
 9 final String accessKeySecret = "yourAccessKeySecret";//你的accessKeySecret，参考本文档步骤2
10 //初始化ascClient,暂时不支持多region（请勿修改）
11 IClientProfile profile = DefaultProfile.getProfile("cn-hangzhou", accessKeyId,
12 accessKeySecret);
13 DefaultProfile.addEndpoint("cn-hangzhou", "cn-hangzhou", product, domain);
14 IAcsClient acsClient = new DefaultAcsClient(profile);
15  //组装请求对象
16  SendSmsRequest request = new SendSmsRequest();
17  //使用post提交
18  request.setMethod(MethodType.POST);
19  //必填:待发送手机号。支持以逗号分隔的形式进行批量调用，批量上限为1000个手机号码,批量调用相对于单条调用及时性稍有延迟,验证码类型的短信推荐使用单条调用的方式
20  request.setPhoneNumbers("1500000000");
21  //必填:短信签名-可在短信控制台中找到
22  request.setSignName("云通信");
23  //必填:短信模板-可在短信控制台中找到
24  request.setTemplateCode("SMS_1000000");
25  //可选:模板中的变量替换JSON串,如模板内容为"亲爱的${name},您的验证码为${code}"时,此处的值为
26  //友情提示:如果JSON中需要带换行符,请参照标准的JSON协议对换行符的要求,比如短信内容中包含\r\n的情况在JSON中需要表示成\\r\\n,否则会导致JSON在服务端解析失败
27  request.setTemplateParam("{\"name\":\"Tom\", \"code\":\"123\"}");
28  //可选-上行短信扩展码(扩展码字段控制在7位或以下，无特殊需求用户请忽略此字段)
29  //request.setSmsUpExtendCode("90997");
30  //可选:outId为提供给业务方扩展字段,最终在短信回执消息中将此值带回给调用者，短信查询等API需要用到这个参数
31  request.setOutId("yourOutId");
32 //请求失败这里会抛ClientException异常
33 SendSmsResponse sendSmsResponse = acsClient.getAcsResponse(request);
34 if(sendSmsResponse.getCode() != null && sendSmsResponse.getCode().equals("OK")) {
35 //请求成功
36 }

　　第九步，短信接口调用错误码：https://help.aliyun.com/knowledge_detail/57717.html?spm=a2c4g.11186623.2.9.Sp6CgU

　　第十步，对接口的封装

 1 package com.xxx.util;
 2 
 3 import java.util.Map;
 4 import com.aliyuncs.DefaultAcsClient;
 5 import com.aliyuncs.IAcsClient;
 6 import com.aliyuncs.dysmsapi.model.v20170525.SendSmsRequest;
 7 import com.aliyuncs.dysmsapi.model.v20170525.SendSmsResponse;
 8 import com.aliyuncs.http.MethodType;
 9 import com.aliyuncs.profile.DefaultProfile;
10 import com.aliyuncs.profile.IClientProfile;
11 
12 /****
13  * 阿里的短信服务封装</br>
14  * ***目前阿里在2017年4月30日后与消息服务合并的原短信服务（整合在消息服务内）已停止开通，迁移到了新短信服务。</br>
15  * ***开发文档地址：（更新时间：2017-12-15 14:43:58）
16  * ***https://help.aliyun.com/document_detail/55284.html?spm=5176.10629532.106.1
17  * .7e321cbeUCywaH </br>
18  * *****
19  * 
20  * @createTime 2018-04-02
21  * @author linchen
22  *
23  */
24 public final class SmsUtil {
25 
26     /**
27      * 阿里云短信服务ak：查看第三步
28      */
29     private static String AccessKeyID = "xxxxxxxxxxxxxxxxxxxx";
30     private static String AccessKeySecret = "xxxxxxxxxxxxxxxxxxxxxxxxxxx";
31 
32     /**
33      * 短信签名名称：查看第四步
34      */
35     private static String SmsSign = "xxxxxxx";
36 
37     // 初始化ascClient需要的几个参数
38     final static String product = "Dysmsapi";// 短信API产品名称
39     final static String domain = "dysmsapi.aliyuncs.com";// 短信API产品域名
40 
41     /**
42      * 短信模板CODE：短信通知：查看第五步
43      * public声明，供外部调用
44      */
45     public static String SMS_CODE1 = "xxxxxxxxxxx";
46 
47     /**
48      * 短信模板CODE：验证码
49      */
50     public static String SMS_CODE2 = "xxxxxxxxxxxx";
51 
52 
53     public static SendSmsResponse send(String templateCode, Map<String, String> params, String phone) {
54         return sendMessage(templateCode, params, phone);
55     }
56 
57     public static SendSmsResponse send(String templateCode, Map<String, String> params, String... phones) {
58         return sendMessage(templateCode, params, phones);
59     }
60 
61     public static SendSmsResponse send(String templateCode, Map<String, String> params, List<String> phones) {
62         String str = Joiner.on(",").join(phones);
63         return sendMessage(templateCode, params, str);
64     }
65 
66     private static SendSmsResponse sendMessage(String templateCode, Map<String, String> params, String... phones) {
67         try {
68             IClientProfile profile = DefaultProfile.getProfile("cn-hangzhou", AccessKeyID, AccessKeySecret);
69             DefaultProfile.addEndpoint("cn-hangzhou", "cn-hangzhou", product, domain);
70             IAcsClient acsClient = new DefaultAcsClient(profile);
71             SendSmsRequest request = new SendSmsRequest();
72             request.setMethod(MethodType.POST);
73             request.setPhoneNumbers(StringUtils.join(phones, ","));
74             request.setSignName(SmsSign);
75             request.setTemplateCode(templateCode);
76             String json = GsonUtil.ObjectToJsonStr(params);
77             request.setTemplateParam(json);
78             SendSmsResponse sendSmsResponse = acsClient.getAcsResponse(request);
79             return sendSmsResponse;
80         } catch (Exception e) {
81             return null;
82         }
83     }
84 }