阿里云短信服务接入流程

向右看齐 2024-04-08 13:51 13阅读 0赞

## 背景 ##

> 在最近的项目需求中, 需要将复用阿里短信能力, 实现用户手机号验证: 如果用户号码验证通过后, 可以让用户上传文件资料并进行打印.  
> 故核心内容就是: **阿里云短信服务接入**, 下面我们主要来介绍下阿里云短信服务接入流程

## 一. 熟悉整个对接流程 ##

1.  进入阿里云短信服务[新手指引][Link 1]页面  
    可以看到整个对接流程如下图所示:  
    ![在这里插入图片描述][9cc1e8f6c9b24c719dae2e08e69c85b5.png]
2.  **每个过程如下图所示:**  
    ![在这里插入图片描述][37517839b26c4c53a5d2e0ccb7019de7.png]

## 二. 具体搭建过程 ##

### 准备工作 ###

1.  注册后登录[云通信产品试用][Link 2]界面
2.  进行实名认证,如下图所示  
    ![在这里插入图片描述][1993c5405d2347ffb4c18fcea907658b.png]  
    ![在这里插入图片描述][5a515b316a8a47749da1a6b95375df0e.png]  
    ![在这里插入图片描述][75db60173a3649398d10653d5e156ec3.png]
3.  **开通短信服务**  
    购买[免费的短信包][Link 3], 然后零元购后就可以在短信控制台进行配置  
    ![在这里插入图片描述][4909a3d2f1404d6d837c2850089590b8.png]  
    点击进入 [阿里云短信服务控制台][Link 4]. 这里可以修改每分钟, 每小时, 每天发送信息的频率  
    ![在这里插入图片描述][e46f93e88d5e4c0ea9190d694ec8da4d.png]
4.  **获取AccessKey**  
    在阿里云短信服务控制台右上角点击AccessKey管理  
    ![在这里插入图片描述][c80f0031a7144411ba30fbf45841b671.png]  
    创建用户组  
    ![在这里插入图片描述][841f7cec6fff4e919c5e9ac57c9234bc.png]  
    配置用户组权限  
    ![在这里插入图片描述][e99e2239d76b4d968304e8a4421665c4.png]  
    在用户组-添加组成员页面新建用户  
    ![在这里插入图片描述][8b191933382349f98990a36c809f026d.png]  
    新建用户  
    ![在这里插入图片描述][1c475930913f47f1bc50b97aaaee4452.png]  
    新建用户配置(该用户属于子用户, 用于发送短信)  
    ![在这里插入图片描述][3cc98fb56bdb44869a12636ab0df8fb3.png]  
    **复制并保存 AccessKey ID和AccessKey Secret**, 以便在后续SDK中使用  
    (这一步非常重要, 因为AccessKey ID 和 AccessKey Secret只显示一次, 无法找回, 只能重新生成)  
    ![在这里插入图片描述][d9515ccca4dd4fde9ffff9067d99d04c.png]

### 添加签名 ###

> 注意: 如果仅仅测试的话, 可以跳过**添加签名**和**添加模板**步骤. 直接调用sdk, 并使用无限制的测试签名和模板进行测试

1.  添加签名设置  
    ![在这里插入图片描述][547afa777a41495c9444cc46434bf863.png]
2.  根据用途选择适用场景和签名用途, 然后进行审核  
    ![在这里插入图片描述][3ccf38146b2c482d8b746cc1670482b7.png]

### 添加模板 ###

1.  创建模板  
    模板就是指短信模板, 具体就是在发送验证短信时, 短信发送内容的模板  
    ![在这里插入图片描述][e87bac0d539d4561a832150e8876d5af.png]
2.  配置短信模板内容后进行审核, 审核通过即可使用  
    ![在这里插入图片描述][c901862e87664968924b6fcc6eb65e43.png]

### 发送短信(SDK) ###

> 注意: 这里因为**使用sdk进行测试调用**, 因此**无需等待签名和模板审核成功**. 使用下面短信测试专用的签名和模板编码即可  
> `SignName: 阿里云短信测试`,  
> `TemplateCode: SMS_154950909`

**整体流程**  
**进入[OpenApi页面][OpenApi] \-> 添加参数 -> 发起调用 -> 复制生成的sdk代码 -> 下载jar包->封装并复用代码**

1.  **配置测试手机号**  
    因为使用的是测试模板和签名, 因此需要我们配置用于测试的手机号  
    ![在这里插入图片描述][44889fabb6dd4b6e8395adde04a1be95.png]  
    否则则会提示: `只能向已回复授权信息的手机号发送`  
    ![在这里插入图片描述][11ec27099b0440ea8f7f2b7d95f8eaf3.png]
2.  **在线调用sdk**  
    这里调用成功后, 就会发送短信.  
    ![在这里插入图片描述][ab14721943d64dfbb8e0be5e6f5830f6.png]
3.  **查看是否调用成功(成功后复制sdk代码)**  
    发起调用成功并收到短信后(如下图), 复制上图右侧生成的**sdk示例**代码到项目中  
    ![在这里插入图片描述][c2d999c4c5fb444287aa76db44c74640.png]
4.  **添加依赖( 获取sdk的jar包 )**  
    如果是maven项目. 直接复制下图展示的Maven坐标  
    ![在这里插入图片描述][64032aa10a8644b0b0246a7a2827100c.png]

**注意:** 如果是SSM/JavaEE项目(需要手动放入jar), 配置过程如下

1.  直接将下图包放到指定目录下(**博客底部会将jar分享**)  
    ![在这里插入图片描述][52c16f041cf342e89b415bbc9a9562ca.png]
2.  在 `Project Structure`\->`Libraries` 中, 将lib下面的jar添加到项目中  
    ![在这里插入图片描述][bb39fe3948184ff1a594119ce0300a9a.png]
3.  选择jar所在目录, 添加后如下图所示  
    ![在这里插入图片描述][9b704998f28049b5bc2c6b4de7099678.png]
4.  添加成功后, 对应的sdk代码则不会报红, 项目也可以正常运行

## 三. 封装sdk方法 ##

1.  将上一步的sdk方法进行封装  
    这里主要有三个方法: 第一个用于使用AK&SK初始化账号Client, 第二个用于生成6位验证码. 第三个用于获取发送短信结果
    
        import com.aliyun.dysmsapi20170525.Client;
        import com.aliyun.dysmsapi20170525.models.SendSmsResponse;
        import com.aliyun.tea.TeaException;
        import com.aliyun.teaopenapi.models.Config;
        import org.springframework.stereotype.Component;
        
        /**
         * info:
         *
         * @Author caoHaiYang
         * @Date 2022/8/29 11:47
         */
        @Component
        public class SendSms {
              
        
            public static final String accessKeyId = "你的accessKeyId ";
            public static final String accessKeySecret = "你的accessKeySecret ";
            public static final String templateCode = "SMS_154950909";
            public static final String signName = "阿里云短信测试";
        
            /**
             * 使用AK&SK初始化账号Client
             * @param accessKeyId
             * @param accessKeySecret
             * @return Client
             * @throws Exception
             */
            public static com.aliyun.dysmsapi20170525.Client createClient(String accessKeyId, String accessKeySecret) throws Exception {
              
                Config config = new com.aliyun.teaopenapi.models.Config()
                        // 您的 AccessKey ID
                        .setAccessKeyId(accessKeyId)
                        // 您的 AccessKey Secret
                        .setAccessKeySecret(accessKeySecret);
                // 访问的域名
                config.endpoint = "dysmsapi.aliyuncs.com";
                return new com.aliyun.dysmsapi20170525.Client(config);
            }
        
            /**
             * 获取6位验证码
             * @return
             */
            public  String getVerifyCode() {
              
                Long codeL = System.nanoTime();
                String codeStr = Long.toString(codeL);
                String verifyCode = codeStr.substring(codeStr.length() - 6);
                System.out.println("生成的6位验证码为:" + verifyCode);
                return verifyCode;
            }
        
            /**
             * 发送短信
             * @param phoneNumber   手机号
             * @throws Exception
             * @return   短信验证码(如果为null说明出现错误)
             */
            public String sendMessage(String phoneNumber) throws Exception {
              
                //随机生成6位验证码
                String verifyCode = this.getVerifyCode();
        
                Client client = SendSms.createClient(accessKeyId, accessKeySecret);
                com.aliyun.dysmsapi20170525.models.SendSmsRequest sendSmsRequest = new com.aliyun.dysmsapi20170525.models.SendSmsRequest()
                        .setPhoneNumbers(phoneNumber)
                        .setSignName(signName)
                        .setTemplateCode(templateCode)
                        .setTemplateParam("{\"code\":\""+verifyCode+"\"}");
                com.aliyun.teautil.models.RuntimeOptions runtime = new com.aliyun.teautil.models.RuntimeOptions();
                try {
              
                    // 复制代码运行请自行打印 API 的返回值
                    SendSmsResponse sendSmsResponse = client.sendSmsWithOptions(sendSmsRequest, runtime);
                    System.out.println(sendSmsResponse.getBody().getMessage());
                    return verifyCode;
                } catch (TeaException error) {
              
                    // 如有需要，请打印 error
                    com.aliyun.teautil.Common.assertAsString(error.message);
                } catch (Exception _error) {
              
                    TeaException error = new TeaException(_error.getMessage(), _error);
                    // 如有需要，请打印 error
                    com.aliyun.teautil.Common.assertAsString(error.message);
                }
                return null;
            }
            
        }
2.  新建短信发送业务
    
        /**
         * 发送短信业务
         * @Author caoHaiYang
         * @Date 2022/8/29 13:47
         */
        public interface SendMessageService {
              
        
            /**
             * 短信发送接口
             * @param phoneNumber
             * @return
             */
            int sendMessage(String phoneNumber) throws Exception;
        
            /**
             * 验证短信码
             * @param phoneNumber
             * @param verifyCode
             * @return
             */
            int verifyMessageCode(String phoneNumber, String verifyCode);
        }
3.  创建业务实现类
    
    > 这里的逻辑就是:  
    > **发送短信接口传入手机号之后, 调用 `sendSms.sendMessage` 返回验证码, 然后将手机号作为key验证码作为value放入redis中并设置过期时间. 而在验证短信码接口调用时: 根据传入的手机号去redis中查验证码, 将查询到的验证码和接口传入的验证码进行比对. 成功返回1, 不成功返回0**
    
        import com.ring.config.Constants;
        import com.ring.config.JedisPoolUtil;
        import com.ring.model.BannerBean;
        import com.ring.service.SendMessageService;
        import com.ring.sms.SendSms;
        import org.apache.commons.lang3.StringUtils;
        import org.springframework.stereotype.Service;
        import redis.clients.jedis.Jedis;
        
        import javax.annotation.Resource;
        
        /**
         * info:
         *
         * @Author caoHaiYang
         * @Date 2022/8/29 16:07
         */
        @Service
        public class SendMessageServiceImpl implements SendMessageService {
              
            @Resource
            private SendSms sendSms;
        
        
            @Override
            public int sendMessage(String phoneNumber) throws Exception {
              
                //通过阿里sms发送短信
                String verifyCode = sendSms.sendMessage(phoneNumber);
                if (StringUtils.isEmpty(verifyCode)) {
              
                    return 0;
                }
                //将短信保存到redis中
                Jedis jedis = null;
                try {
              
                    jedis = JedisPoolUtil.getJedis();
                    jedis.auth(Constants.REDIS_PASSWORD);
                    jedis.select(Constants.REDIS_DB);
                    jedis.setex(phoneNumber, 600, verifyCode);
                    return 1;
                } catch (Exception e) {
              
                    e.printStackTrace();
                }
                return -1;
            }
        
            @Override
            public int verifyMessageCode(String phoneNumber, String verifyCode) {
              
                Jedis jedis = null;
                try {
              
                    jedis = JedisPoolUtil.getJedis();
                    jedis.auth(Constants.REDIS_PASSWORD);
                    jedis.select(Constants.REDIS_DB);
                    String currentVerifyCode = jedis.get(phoneNumber);
                    if (verifyCode.equals(currentVerifyCode)) {
              
                        return 1;
                    }
                } catch (Exception e) {
              
                    e.printStackTrace();
                }
                return 0;
            }
        }
4.  生成代码操作  
    在测试完短信验证码后, 我们可以根据以下流程流程编写其他接口代码  
    **进入[OpenApi页面][OpenApi] \-> 添加参数 -> 发起调用 -> 复制生成的sdk代码 -> 封装并复用代码**
5.  当前阿里云短信服务可以提供的接口如下图所示  
    ![在这里插入图片描述][7ea857cbcf6f4d8a9d2c69f393dbe89c.png]  
    ![在这里插入图片描述][4dc10760d35f486ca26aadcb631a863b.png]

### 查询发送详情 ###

**发送成功后, 可以在短信服务控制台查看发送详情**  
查看指定时段短信发送量  
![在这里插入图片描述][f9021d86affe456ca28b39896547170f.jpeg]  
查看短信具体发送内容  
![在这里插入图片描述][6d0c756f8f65436ea47f2233121f0abe.png] https://pan.baidu.com/s/1a3FeYANNIEo8ZvO5tIPeJg?pwd=pces

--------------------

> 链接：https://pan.baidu.com/s/1a3FeYANNIEo8ZvO5tIPeJg  
> 关注后进入私聊, 回复括号内关键字\[ **短信服务** \] 获取阿里云短信服务jar包提取码

[Link 1]: https://help.aliyun.com/document_detail/59210.html
[9cc1e8f6c9b24c719dae2e08e69c85b5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/be55ae2140454ef6bde5f9cdb37e3e3d.png
[37517839b26c4c53a5d2e0ccb7019de7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/8769b63916ea47118714ab6957597e4d.png
[Link 2]: https://free.aliyun.com/product/cloudcommunication-free-trial
[1993c5405d2347ffb4c18fcea907658b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/c0920e9c3bb34e72ac187281a888876c.png
[5a515b316a8a47749da1a6b95375df0e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/3f1d9cc2ea294ab1969bb206e8aebc61.png
[75db60173a3649398d10653d5e156ec3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/7dd3e6faa7e243f2ba5dff6d0ac4c5f4.png
[Link 3]: https://free.aliyun.com/product/cloudcommunication-free-trial?,spm=5176.8195934.J_5834642020.1.ec4d4378aVGFnu
[4909a3d2f1404d6d837c2850089590b8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/deb1860441704c66aa9e1f9b5f2870f6.png
[Link 4]: https://dysms.console.aliyun.com/overview
[e46f93e88d5e4c0ea9190d694ec8da4d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/cf8c7763f7974801a28abf103b2ad1b2.png
[c80f0031a7144411ba30fbf45841b671.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/01fabf704d644faf88f7bde74a916192.png
[841f7cec6fff4e919c5e9ac57c9234bc.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/4cbdd0f06b0845a390f3299ef85271dd.png
[e99e2239d76b4d968304e8a4421665c4.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/dd68a58a63554550a7d7982675023146.png
[8b191933382349f98990a36c809f026d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/6edd06d922ec4812a709494c0209560f.png
[1c475930913f47f1bc50b97aaaee4452.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/5ff82158288348009867f70aa973df5e.png
[3cc98fb56bdb44869a12636ab0df8fb3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/7f9b596afa344cc49a77c8ed0e317482.png
[d9515ccca4dd4fde9ffff9067d99d04c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/2dc231af22fa4cc5abefcc9dfc0ed0c4.png
[547afa777a41495c9444cc46434bf863.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/ef202c0aa5bc4287b95e895757f453ab.png
[3ccf38146b2c482d8b746cc1670482b7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/e8b7ac59fd3148359b7a3cade02f6a3e.png
[e87bac0d539d4561a832150e8876d5af.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/1ed3c94e58514a918dd20a6686500480.png
[c901862e87664968924b6fcc6eb65e43.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/0edb236e0c4943e296bdd6cdaa0b3a8a.png
[OpenApi]: https://next.api.aliyun.com/api/Dysmsapi/2017-05-25/SendSms
[44889fabb6dd4b6e8395adde04a1be95.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/a9223a84d50a4d5eb7bd0442d5f9374e.png
[11ec27099b0440ea8f7f2b7d95f8eaf3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/15f33f5ca4fe46f29d1d0ead8eecc523.png
[ab14721943d64dfbb8e0be5e6f5830f6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/4242890d05694e79bbd4a3c4fa067deb.png
[c2d999c4c5fb444287aa76db44c74640.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/a31264e134224a94923cb4c959e60db3.png
[64032aa10a8644b0b0246a7a2827100c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/29d4d06468634e179a95970d6ebac29d.png
[52c16f041cf342e89b415bbc9a9562ca.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/a970fc13cf9746389c639b695a0c837f.png
[bb39fe3948184ff1a594119ce0300a9a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/e8f88c215e854ba68f76aeabfdc28bf6.png
[9b704998f28049b5bc2c6b4de7099678.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/95110936108c4079acc87fce23f5117c.png
[7ea857cbcf6f4d8a9d2c69f393dbe89c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/e51aaeae875441ebb500e2c1ef19f436.png
[4dc10760d35f486ca26aadcb631a863b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/7058e7958f324055bd8ce9cf7d2e04e2.png
[f9021d86affe456ca28b39896547170f.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/f4f09c9c10c34e359e9b7b29befbbeaa.jpeg
[6d0c756f8f65436ea47f2233121f0abe.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/b4b33314ce15420ea4016cb947a2e51c.png