我和我的项目之整合腾讯云短信SDK

写在前面：

平常生活中老是能收到各种各样的手机短信验证码，例如，快递取包裹快递柜上有一串密码，网站app登录，忘记密码，确认身份，绑定用户等都能收到各种验证码，再比如银行里各种短信验证码……数不胜数。那时就感觉很神奇到底是怎么做到的。系统又是怎么知道我输入的验证码和它发送的是否是一致的。后来慢慢接触到了短信SDK，什么阿里云、华为云、腾讯云传统的电信服务商上网一搜很多提供了短信发送业务。开发人员只需要集成它们提供的接口就能轻松实现发送短信功能。我这里用的是腾讯云的，为啥选择它呢。因为它对首次认证的用户免费赠送100条短信……献上领取地址https://cloud.tencent.com/product/sms

API和SDK区别 API 前端调用后端数据的一个通道，就是我们俗说的接口，通过这个通道，可以访问到后端的数据，但是又无需调用源代码。 SDK 工程师为辅助开发某类软件的相关文档、范例和工具的集合，使用SDK可以提高开发效率，更简单的接入某个功能。举例说明：一个产品想实现某个功能，可以找到相关的SDK，工程师直接接入SDK，就不用再重新开发了

Let’s go

1. 首先要登录刚才的网址

https://cloud.tencent.com/product/sms

进行登录并认证领取。认证成功后进入到短信控制台。左侧列表有快速入门。跟着里面的提示一步步去完成即可。Ps我选用的是国内短信业务。创建短信签名时，要注意签名类型。我这里用的是自己的公众号。

2.国内短信由签名+正文组成，签名符号为【】（注：全角），发送短信内容时必须带签名。创建正文模板，Ps:注意语言组织，提高审核通过率。还有短信模板id不要透露。

3.签名+短信模板创建完成后（Ps:可能它们各自审核需要一段时间耐心等待。好像15分钟左右就可以了）查看短信SDK。左侧应用管理里应用列表就能看到。点击基础配置能对短信进行各自配置。SDK AppID是短信应用的唯一标识，调用短信API接口时，需要提供该参数。SDK AppID不要透露。

4.https://cloud.tencent.com/document/product/382/43194。1、2、3步骤完成后打开Java SDK API文档。文档很详细，记录了如何在后台集成。跟着操作一步步来即可。Ps:注意这里的前提条件。SecretID 和 SecretKey还有endpoint后续都会用到。

5.【安装SDK。通过 Maven 安装】我用的是3.1.35版本的。后面可能版本不适配导致发送失败，记得回过头来看检查下这里版本是否匹配。https://search.maven.org/search?q=tencentcloud-sdk-java查询最新版本。

<dependency>
   <groupId>com.tencentcloudapi</groupId>
   <artifactId>tencentcloud-sdk-java</artifactId>
   <version>3.1.35</version>
</dependency>

6.【老样子，配置完pom，去yml配置属性。顺带把参数集成到GlobalConfig中统一管理】

//全局参数变量设置
@Configuration
public class GlobalConfig implements InitializingBean {
    //======================================短信配置========================================================
    @Value("${sms.sign}")
    private String sign;
    @Value("${sms.moduleId}")
    private String moduleId;
    @Value("${sms.sdkAppId}")
    private String sdkAppId;
    @Value("${sms.url}")
    private String url;
    @Value("${sms.secretId}")
    private String secretId;
    @Value("${sms.secretKey}")
    private String secretKey;
    //=====================短信配置======================
    public static String SMS_SIGN;
    public static String SMS_MODULEID;
    public static String SMS_SDKAPPID;
    public static String SMS_URL;
    public static String SMS_SECRETID;
    public static String SMS_SECRETKEY;
    @Override
    public void afterPropertiesSet() throws Exception {
        //=======短信配置=============
        SMS_SIGN = sign;
        SMS_MODULEID = moduleId;
        SMS_SDKAPPID = sdkAppId;
        SMS_URL = url;
        SMS_SECRETID = secretId;
        SMS_SECRETKEY = secretKey;
    }
}

7.【参考Java SDK中发送短信代码】做成一个工具类，业务代码中直接调用即可。已经修改了其中一些配置，如若自定义修改，阅读代码进行相应修改即可。

import com.example.demojinghuadianli.config.GlobalConfig;
import com.tencentcloudapi.common.Credential;
import com.tencentcloudapi.common.exception.TencentCloudSDKException;
import com.tencentcloudapi.common.profile.ClientProfile;
import com.tencentcloudapi.common.profile.HttpProfile;
import com.tencentcloudapi.sms.v20190711.SmsClient;
import com.tencentcloudapi.sms.v20190711.models.SendSmsRequest;
import com.tencentcloudapi.sms.v20190711.models.SendSmsResponse;
//导入可选配置类
//导入 SMS 模块的 client
//导入要请求接口对应的 request response 类


/**
 * @description: 发送短信工具类
 */
public class SendSmsUtil {
    /**
     * @param phoneNum 手机号
     * @param authCode 验证码
     * @param minute 有效时间
     */
    public static boolean send(String phoneNum,String authCode,Integer minute) {


        /* 必要步骤：
         * 实例化一个认证对象，入参需要传入腾讯云账户密钥对 secretId 和 secretKey
         * 本示例采用从环境变量读取的方式，需要预先在环境变量中设置这两个值
         * 您也可以直接在代码中写入密钥对，但需谨防泄露，不要将代码复制、上传或者分享给他人
         * CAM 密钥查询：https://console.cloud.tencent.com/cam/capi*/


        //======================================实例化一个认证对象====必要================================================
        Credential cred = new Credential(GlobalConfig.SMS_SECRETID, GlobalConfig.SMS_SECRETKEY);


        //======================================实例化一个 http选项======可选，无特殊需求时可以跳过=========================
        HttpProfile httpProfile = new HttpProfile();
        // 设置代理
        //httpProfile.setProxyHost("host");
        //httpProfile.setProxyPort(port);
        /* SDK 默认使用 POST 方法。
         * 如需使用 GET 方法，可以在此处设置，但 GET 方法无法处理较大的请求 */
        httpProfile.setReqMethod("POST");
        /* SDK 有默认的超时时间，非必要请不要进行调整
         * 如有需要请在代码中查阅以获取最新的默认值 */
        httpProfile.setConnTimeout(60);
        /* SDK 会自动指定域名，通常无需指定域名，但访问金融区的服务时必须手动指定域名
         * 例如 SMS 的上海金融区域名为 sms.ap-shanghai-fsi.tencentcloudapi.com */
        httpProfile.setEndpoint(GlobalConfig.SMS_URL);


        //======================================客户端配置对象=====非必要=================================================
        /* 非必要步骤:
         * 实例化一个客户端配置对象，可以指定超时时间等配置 */
        ClientProfile clientProfile = new ClientProfile();
        /* SDK 默认用 TC3-HMAC-SHA256 进行签名
         * 非必要请不要修改该字段 */
        clientProfile.setSignMethod("HmacSHA256");
        clientProfile.setHttpProfile(httpProfile);


        //======================================实例化SMS的client对象====================================================
        /* 第二个参数是地域信息，可以直接填写字符串 ap-guangzhou，或者引用预设的常量 */
        SmsClient client = new SmsClient(cred, "ap-guangzhou", clientProfile);


        //======================================实例化一个请求对象========================================================
        /* 实例化一个请求对象，根据调用的接口和实际情况，可以进一步设置请求参数
         * 您可以直接查询 SDK 源码确定接口有哪些属性可以设置
         * 属性可能是基本类型，也可能引用了另一个数据结构
         * 推荐使用 IDE 进行开发，可以方便地跳转查阅各个接口和数据结构的文档说明 */
        SendSmsRequest req = new SendSmsRequest();


        /* 填充请求参数，这里 request 对象的成员变量即对应接口的入参
         * 您可以通过官网接口文档或跳转到 request 对象的定义处查看请求参数的定义
         * 基本类型的设置:
         * 帮助链接：
         * 短信控制台：https://console.cloud.tencent.com/smsv2
         * sms helper：https://cloud.tencent.com/document/product/382/3773 */


        /* 短信应用 ID: 在 [短信控制台] 添加应用后生成的实际 SDKAppID，例如1400006666 */
        String appid = GlobalConfig.SMS_SDKAPPID;
        req.setSmsSdkAppid(appid);


        /* 短信签名内容: 使用 UTF-8 编码，必须填写已审核通过的签名，可登录 [短信控制台] 查看签名信息 */
        String sign = GlobalConfig.SMS_SIGN;
        req.setSign(sign);


        /* 国际/港澳台短信 senderid: 国内短信填空，默认未开通，如需开通请联系 [sms helper] */
        //String senderid = "";
        //req.setSenderId(senderid);


        /* 用户的 session 内容: 可以携带用户侧 ID 等上下文信息，server 会原样返回 */
        //String session = "xxx";
        //req.setSessionContext(session);


        /* 短信码号扩展号: 默认未开通，如需开通请联系 [sms helper] */
        //String extendcode = "xxx";
        //req.setExtendCode(extendcode);


        /* 模板 ID: 必须填写已审核通过的模板 ID，可登录 [短信控制台] 查看模板 ID */
        String templateID = GlobalConfig.SMS_MODULEID;
        req.setTemplateID(templateID);


        /* 下发手机号码，采用 e.164 标准，+[国家或地区码][手机号]
         * 例如+8613711112222， 其中前面有一个+号 ，86为国家码，13711112222为手机号，最多不要超过200个手机号*/
        StringBuilder stringBuilder = new StringBuilder();
        stringBuilder.append("+86").append(phoneNum);
        String[] phoneNumbers = {stringBuilder.toString()};
        //String[] phoneNumbers = {"+8621212313123", "+8612345678902", "+8612345678903"};
        req.setPhoneNumberSet(phoneNumbers);


        /* 模板参数: 若无模板参数，则设置为空*/
        //authCode验证码 minute过期时间
        String[] templateParams = {authCode,String.valueOf(minute)};
        req.setTemplateParamSet(templateParams);


        //==============================================================================================================
        /* 通过 client 对象调用 SendSms 方法发起请求。注意请求方法名与请求对象是对应的
         * 返回的 res 是一个 SendSmsResponse 类的实例，与请求对象对应 */
        SendSmsResponse res = null;
        try {
            res = client.SendSms(req);
        } catch (TencentCloudSDKException e) {
            return false;
        }


        // 输出 JSON 格式的字符串回包
        System.out.println(SendSmsResponse.toJsonString(res));
        // 可以取出单个值，您可以通过官网接口文档或跳转到 response 对象的定义处查看返回字段的定义
        System.out.println(res.getRequestId());
        return true;
    }
}

8.写一个测试接口，校验下是否可以。代码里稍微加了手机号码和格式的校验。

@RestController
@RequestMapping("/sms")
public class SendSMSController {


    @PostMapping("/send/{phoneNum}")
    public WebResponse send(@PathVariable(value = "phoneNum",required = true)String phoneNum){
        if(null == phoneNum){
            return WebResponse.resFail("手机号码不允许为空",0);
            //RegularUtil.validate(phoneNum,RegularUtil.MOBILE)校验手机号码格式
        }else if(RegularUtil.validate(phoneNum,RegularUtil.MOBILE)!=true&&phoneNum.length()!=11){
            return WebResponse.resFail("手机号码格式错误",0);
        }
        //AuthCodeUtil.generateAuthCode()随机生成6位校验码
        boolean send = SendSmsUtil.send(phoneNum, AuthCodeUtil.generateAuthCode(), 2);
        if(false != send){
            return WebResponse.resSuccess("发送成功",1);
        }
        return WebResponse.resFail("发送失败",0);
    }
}

9.Postman来发起请求。

10.Bingo~发送成功。在短信控制台业务统计也可以看到发送情况。

11.还可以结合Redis.存验证码有效期。后面再优化整合吧。

Nice~