SpringBoot集成腾讯云短信服务全攻略

<dependency>
    <groupid>com.tencentcloudapi</groupid>
    <artifactid>tencentcloud-sdk-java</artifactid>
    <version>3.1.xxx</version> <!-- 请替换为最新版本 -->
    <scope>compile</scope>
</dependency>

tencent:
  sms:
    secret-id: your-secret-id # 替换为你的secretid
    secret-key: your-secret-key # 替换为你的secretkey
    sdk-app-id: 1400000000 # 替换为你的sdkappid
    sign-name: 你的签名内容 # 替换为审核通过的签名内容
    template-id: 1234567 # 替换为你常用的默认模板id

import lombok.data;
import org.springframework.boot.context.properties.configurationproperties;
import org.springframework.context.annotation.configuration;

@configuration
@configurationproperties(prefix = "tencent.sms")
@data
public class tencentsmsproperties {
    private string secretid;
    private string secretkey;
    private string sdkappid;
    private string signname;
    private string templateid;
}

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.*;
import lombok.requiredargsconstructor;
import lombok.extern.slf4j.slf4j;
import org.springframework.stereotype.service;

@service
@slf4j
@requiredargsconstructor
public class tencentsmsservice {

    private final tencentsmsproperties smsproperties;

    /**
     * 发送短信验证码
     *
     * @param phonenumber 目标手机号（带区号，如"+8613712345678"）
     * @param templateid  模板id（可选，不填则使用配置的默认模板id）
     * @param templateparams 模板参数列表，按顺序替换模板中的变量{citation:6}
     * @return 发送是否成功
     */
    public boolean sendsms(string phonenumber, string templateid, string[] templateparams) {
        try {
            // 1. 实例化认证对象，传入secretid和secretkey[citation:10]
            credential cred = new credential(smsproperties.getsecretid(), smsproperties.getsecretkey());

            // 2. 配置http和客户端profile
            httpprofile httpprofile = new httpprofile();
            httpprofile.setendpoint("sms.tencentcloudapi.com"); // 短信api端点
            clientprofile clientprofile = new clientprofile();
            clientprofile.sethttpprofile(httpprofile);

            // 3. 实例化smsclient
            smsclient client = new smsclient(cred, "ap-guangzhou", clientprofile); // 地域根据控制台指引选择

            // 4. 构造请求对象并填充参数
            sendsmsrequest req = new sendsmsrequest();
            req.setsmssdkappid(smsproperties.getsdkappid()); // 设置应用id[citation:2]
            req.setsignname(smsproperties.getsignname()); // 设置签名[citation:2]
            req.settemplateid(templateid != null ? templateid : smsproperties.gettemplateid()); // 设置模板id
            req.setphonenumberset(new string[]{phonenumber}); // 设置手机号，支持批量
            req.settemplateparamset(templateparams); // 设置模板参数

            // 5. 发起请求并处理响应
            sendsmsresponse resp = client.sendsms(req);
            sendstatus status = resp.getsendstatusset()[0]; // 取第一个号码的发送状态
            log.info("短信发送请求id：{}，状态：{}，状态码：{}", resp.getrequestid(), status.getmessage(), status.getcode());

            // 6. 判断发送结果（通常以"ok"表示成功，请根据实际响应判断）
            return "ok".equalsignorecase(status.getcode());

        } catch (tencentcloudsdkexception e) {
            log.error("腾讯云短信sdk调用失败，错误信息：{}", e.tostring(), e);
            return false;
        }
    }

    /**
     * 简化方法：发送固定模板的短信（如验证码）
     *
     * @param phonenumber 目标手机号
     * @param code        验证码
     * @return 发送是否成功
     */
    public boolean sendverificationcode(string phonenumber, string code) {
        // 假设你的验证码模板内容为：您的验证码是{1}，有效期{2}分钟。
        string[] templateparams = {code, "5"}; // 验证码和有效期
        return sendsms(phonenumber, null, templateparams); // 使用配置中的默认模板id
    }
}

import lombok.requiredargsconstructor;
import org.springframework.web.bind.annotation.*;

@restcontroller
@requestmapping("/api/sms")
@requiredargsconstructor
public class smscontroller {

    private final tencentsmsservice smsservice;

    @postmapping("/send-code")
    public apiresponse sendverificationcode(@requestparam string phonenumber) {
        // 1. 生成随机验证码（示例）
        string code = string.valueof((int)((math.random() * 9 + 1) * 100000));

        // 2. 发送短信
        boolean issuccess = smsservice.sendverificationcode(phonenumber, code);

        // 3. 此处应将验证码与手机号关联存储到redis或session，并设置过期时间，用于后续校验[citation:6]
        // redistemplate.opsforvalue().set("sms_code:" + phonenumber, code, 5, timeunit.minutes);

        if (issuccess) {
            return apiresponse.success("短信发送成功");
        } else {
            return apiresponse.fail("短信发送失败，请稍后重试");
        }
    }

    // 简单的响应封装类
    @data
    public static class apiresponse {
        private boolean success;
        private string message;
        private object data;

        public static apiresponse success(string message) {
            apiresponse response = new apiresponse();
            response.setsuccess(true);
            response.setmessage(message);
            return response;
        }

        public static apiresponse fail(string message) {
            apiresponse response = new apiresponse();
            response.setsuccess(false);
            response.setmessage(message);
            return response;
        }
    }
}