实现在SpringBoot项目中使用腾讯云发送短信

在一些项目中总会不可避免的要用到短信服务，比如发送验证码等，那么如何进行短信的发送呢，我们这就来捋一捋，我这里采用的是腾讯云的短信服务。其他的云服务也大致一样。

第一步、申请腾讯云的短信服务并配置基本信息

首先进入腾讯云的短信服务界面传送门https://console.cloud.tencent.com/smsv2

如上图所示，我们会看到要我们申请开通短信服务，开通后它会免费送我们100条国内短信。

接下来我们就要进行相关的配置，首先进行创建签名，按照要求填写就行。

这步之后创建短信正文的模板

创建正文模板我们可以选择使用标准模板。

配置完毕后就等待审核，审核完成后我们就可以使用接口发送短信了。

第二步、我们可以在API Explore中进行一下测试

测试前我们要首先找一下短信应用的APPID，如下图

填写完信息后点击发起调用即可将短信发送到对应的手机上。

之后在程序代码中进行调用，我们进行配置的参数和表单中的参数是一样的，只是多了secretID，secretKey。

第三步、安装java的SDK

在项目添加 Maven 依赖项，只需在 pom.xml 中找到<dependencies>标签，在里面添加以下依赖项即可。

<dependency>
     <groupId>com.tencentcloudapi</groupId>
     <artifactId>tencentcloud-sdk-java</artifactId>
     <!-- go to https://search.maven.org/search?q=tencentcloud-sdk-java and get the latest version. -->
     <!-- 请到https://search.maven.org/search?q=tencentcloud-sdk-java查询所有版本，最新版本如下 -->
     <version>3.1.322</version>
</dependency>

若是用其他语言进行配置，可进入网站查看详细说明：传送

第四步、在项目中编写代码，调用接口

以下是一些必要步骤

首先在项目yml文件中配置一些必要的参数信息，避免硬编码，便于维护。

sms:
  sdkAppId: 这里输入短信应用id
  secretId: 这里输入secretID
  secretKey: 这里输入key
  signName: 这里输入短信签名
  templateCodeId: 验证码模板id，有多个模板可以配置多个参数
  timeout: 配置RedisCache过期时间

配置好参数后，我们就要在程序中编写代码进行操作。

首先可以编写一个发送短息的组件代码SmsComponent，在里面完成获取SmsClient客户端，以及对表单参数进行设置内容和发送短信代码的封装。


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.v20210111.SmsClient;
import com.tencentcloudapi.sms.v20210111.models.SendSmsRequest;
import com.tencentcloudapi.sms.v20210111.models.SendSmsResponse;
import lombok.Data;
import lombok.ToString;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@ToString
@Data
@Component
@Slf4j
public class SmsComponent {

    @Value("${sms.sdkAppId}")   // 注入参数值
    private String sdkAppId;

    @Value("${sms.secretId}")
    private String secretId;

    @Value("${sms.secretKey}")
    private String secretKey;

    @Value("${sms.signName}")
    private String signName;

    @Value("${sms.templateCodeId}")
    private String templateCodeId;

    @Value("${sms.timeout}")
    private Integer timeout;

    /**
     * 获取SmsClient客户端
     * @return
     */
    public SmsClient getClient() {

        // 实例化一个认证对象，入参需要传入腾讯云账户secretId，secretKey,此处还需注意密钥对的保密
        // 密钥可前往https://console.cloud.tencent.com/cam/capi网站进行获取
        Credential cred = new Credential(secretId, secretKey);
        // 实例化一个http选项，可选的，没有特殊需求可以跳过
        HttpProfile httpProfile = new HttpProfile();
        //这个setEndpoint可以省略的
        httpProfile.setEndpoint("sms.tencentcloudapi.com");
        // 实例化一个client选项，可选的，没有特殊需求可以跳过
        ClientProfile clientProfile = new ClientProfile();
        clientProfile.setHttpProfile(httpProfile);
        // 实例化要请求产品的client对象,clientProfile是可选的
        return new SmsClient(cred, "ap-beijing", clientProfile);
    }


    /**
     * 获取req请求 2个参数，就是短息模板是两个参数，根据具体情况改变
     *
     * @param phone
     * @param code  参数1，这里是验证码，param2为参数2这里为分钟
     * @param templateId  短息模板id
     * @return
     */
    public SendSmsRequest getReqTwo(String phone, String code, String param2, String templateId) {
        SendSmsRequest req = new SendSmsRequest();
        String[] phoneNumberSet = {"+86" + phone}; 
        req.setSmsSdkAppId(sdkAppId);     // 设置参数
        req.setPhoneNumberSet(phoneNumberSet);    
        req.setSignName(signName);
        req.setTemplateId(templateId);
        //模板内容的参数有几个就设置几个，我这里是两个
        String[] templateParamSet = {code,param2};
        req.setTemplateParamSet(templateParamSet);
        return req;     // 返回请求参数内容
    }

    /**
     * 发送验证码
     *
     * @param phone
     * @param code
     * @param
     * @return
     */
    public void sendCode(String phone, String code, String param2) {

        // 返回的resp是一个SendSmsResponse的实例，与请求对象对应
        SendSmsResponse resp;
        try {
            resp = getClient().SendSms(getReqTwo(phone, code,param2 ,templateCodeId));  // 模板id是自己设置好的
            log.info(SendSmsResponse.toJsonString(resp));   // 把返回信息输入到日志中
        } catch (TencentCloudSDKException e) {
            e.printStackTrace();
        }
    }
}

然后可以在service层创建发送短信的接口


public interface ISmsService {
    /**
     * @param phone  给手机号发送验证码
     * @param leastTime 短信有效时间
     * @return
     */
    public String sendCode( String phone,int leastTime);

    /**
     * 校验验证码
     */
    boolean checkCode(String phone, String code);
}

然后实现发送短信的接口，同时我们要自己写生成验证码的函数来确保每次发送的6位数字是随机的，并且实现校验验证码的函数，如果只是发送信息，那么只需要完成发送信息的那部分代码就行。

import java.util.Random;
import java.util.concurrent.TimeUnit;

@Service
public class ISmsServiceImpl implements ISmsService {
    @Autowired
    SmsComponent smsComponent;
    @Autowired
    RedisCache redisCache;


    /**
     * @param phone  给手机号发送验证码
     * @param leastTime 短信有效时间
     * @return
     */
    public String sendCode(String phone, int leastTime) {
        if (phone == null || phone.length() == 0) {
            throw new ServiceException("手机号为空");
        }

        // 判断是否已经发送过
        String redisCode = redisCache.getCacheObject(Constants.HEAD + phone);
        if (!StringUtils.isEmpty(redisCode)) {
            long time = Long.parseLong(redisCode.split("_")[1]);
            if (System.currentTimeMillis() - time < leastTime) {
                throw new ServiceException("发送频率过高");
            }
        }
        String code = getSixBitCode();  // 生成新的验证码
        //存储 phone->code   
        redisCache.setCacheObject(Constants.HEAD + phone, code + "_" + System.currentTimeMillis(), smsComponent.getTimeout(), TimeUnit.MINUTES);
        Integer minute = leastTime / 60 / 1000; //分钟
        smsComponent.sendCode(phone, code, minute.toString());
        return "已发送验证码 " + phone;
    }


    /**
     * 获取6位验证码
     */
    private String getSixBitCode() {
        //随机数
        StringBuilder sb = new StringBuilder();
        Random rand = new Random();
        for (int i = 0; i < 6; i++) {
            sb.append(rand.nextInt(10));
        }
        return sb.toString();
    }

    /**
     * 校验验证码
     */
    @Override
    public boolean checkCode(String phone, String code) {
        String redisCode = redisCache.getCacheObject(Constants.HEAD + phone);
        if (StringUtils.isEmpty(redisCode)) {
            throw new ServiceException("验证码失效");
        }
        if (!StringUtils.equals(redisCode.split("_")[0], code)) {
            throw new ServiceException("验证码错误");
        } else {
            redisCache.deleteObject(Constants.HEAD + phone);
            return true;
        }
    }
}

其中Constant.HEAD为自己定义的前缀，便于进行区分,自行设置

    public static final String HEAD = "sms:code:";

最后根据具体情况编写编写Controller层代码实现调用。

调用时，我们只需要获取用户输入的电话参数即可，模板中的第二个参数时间范围，我们自己设置好就行。

        // 获取用户电话，调用发送短信接口
        String msg = smsService.sendCode(sysUser.getPhonenumber(), 5 * 60 * 1000);

至此就可以在前端界面的表单中填写数据，或者在微信小程序里面发送短信了，在微信小程序中使用短信服务的话，要在后端代码中把微信小程序的appid，Secret等参数配置好才能正常调用。