SpringBoot项目中快速集成腾讯云短信SDK实现手机验证码功能

<dependency>
     <groupId>com.tencentcloudapi</groupId>
     <artifactId>tencentcloud-sdk-java</artifactId>
     <version>3.1.270</version><!-- 注：这里只是示例版本号（可直接使用），可获取并替换为 最新的版本号，注意不要使用4.0.x版本（非最新版本） -->
</dependency>

import com.tencentcloudapi.common.Credential;
import com.tencentcloudapi.common.exception.TencentCloudSDKException;
//导入可选配置类

import com.tencentcloudapi.common.profile.ClientProfile;

import com.tencentcloudapi.common.profile.HttpProfile;
// 导入对应SMS模块的client

import com.tencentcloudapi.sms.v20210111.SmsClient;
// 导入要请求接口对应的request response类

import com.tencentcloudapi.sms.v20210111.models.SendSmsRequest;

import com.tencentcloudapi.sms.v20210111.models.SendSmsResponse;
/**

Tencent Cloud Sms Sendsms


/

public class SendSms

{

public static void main(String[] args)

{

try {

/ 必要步骤：

* 实例化一个认证对象，入参需要传入腾讯云账户密钥对secretId，secretKey。

* 这里采用的是从环境变量读取的方式，需要在环境变量中先设置这两个值。

* 你也可以直接在代码中写死密钥对，但是小心不要将代码复制、上传或者分享给他人，

* 以免泄露密钥对危及你的财产安全。

* CAM密匙查询: https://console.cloud.tencent.com/cam/capi*/

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

        /* 非必要步骤:
         * 实例化一个客户端配置对象，可以指定超时时间等配置 */
        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在 [短信控制台] 添加应用后生成的实际SdkAppId，示例如1400006666 */
        String sdkAppId = "1400009099";
        req.setSmsSdkAppId(sdkAppId);

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

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

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

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

        /* 模板 ID: 必须填写已审核通过的模板 ID。模板ID可登录 [短信控制台] 查看 */
        String templateId = "400000";
        req.setTemplateId(templateId);

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

        /* 模板参数: 若无模板参数，则设置为空 */
        String[] templateParamSet = {"5678"};
        req.setTemplateParamSet(templateParamSet);

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

        // 输出json格式的字符串回包
        System.out.println(SendSmsResponse.toJsonString(res));

        // 也可以取出单个值，你可以通过官网接口文档或跳转到response对象的定义处查看返回字段的定义
        System.out.println(res.getRequestId());

    } catch (TencentCloudSDKException e) {
        e.printStackTrace();
    }
}

}

<dependency>

<groupId>com.tencentcloudapi</groupId>

<artifactId>tencentcloud-sdk-java</artifactId>

<version>3.1.222</version>

</dependency>

<dependency>

<groupId>org.springframework.boot</groupId>

<artifactId>spring-boot-starter-data-redis</artifactId>

<exclusions>

<exclusion>

<groupId>io.lettuce</groupId>

<artifactId>lettuce-core</artifactId>

</exclusion>

</exclusions>

</dependency>

<dependency>

<groupId>redis.clients</groupId>

<artifactId>jedis</artifactId>

<version>3.1.0</version>

</dependency>

blog.sms.secretId=<你的腾讯云secretId>

blog.sms.secretKey=<你的腾讯云secretKey>

blog.sms.appid=<你的腾讯云appid>

blog.sms.signName=<短信签名内容>

blog.sms.endpoint=sms.tencentcloudapi.com

blog.sms.region=<服务器所在区域，广州为:ap-guangzhou>

@Configuration

@ConfigurationProperties(prefix = "blog.sms")

public class SmsProperty {

private String secretId;

private String secretKey;

private String appid;

private String signName;

private String endpoint;

private String region;
// 省略setter、getter方法

}

  <dependency>

<groupId>org.springframework.boot</groupId>

<artifactId>spring-boot-configuration-processor</artifactId>

<optional>true</optional>

</dependency>

@SpringBootApplication

@EnableScheduling//开启定时任务支持

@EnableConfigurationProperties

@MapperScan(basePackages={"org.sang.mapper"},annotationClass = Repository.class)

public class BlogserverApplication {

public static void main(String[] args) {
    SpringApplication.run(BlogserverApplication.class, args);
}

}

@Configuration

public class SmsConfig {

@Resource
private SmsProperty smsProperty;

@Bean
public SmsClient smsClient() {
    Credential cred = new Credential(smsProperty.getSecretId(), smsProperty.getSecretKey());
    // 实例化一个 http 选项，可选，无特殊需求时可以跳过
    HttpProfile httpProfile = new HttpProfile();
    httpProfile.setReqMethod("POST");
    httpProfile.setConnTimeout(60);
    /* SDK 默认使用 POST 方法。
     * 如需使用 GET 方法，可以在此处设置，但 GET 方法无法处理较大的请求 */
    httpProfile.setEndpoint(smsProperty.getEndpoint());
    /* 非必要步骤:
     * 实例化一个客户端配置对象，可以指定超时时间等配置 */
    ClientProfile clientProfile = new ClientProfile();
    /* SDK 默认用 TC3-HMAC-SHA256 进行签名
     * 非必要请不要修改该字段 */
    clientProfile.setSignMethod("HmacSHA256");
    clientProfile.setHttpProfile(httpProfile);
    SmsClient client = new SmsClient(cred, smsProperty.getRegion(),clientProfile);
    return client;
}

}

@Service

public class SmsService {

private static final Logger logger = LoggerFactory.getLogger(SmsService.class);
@Resource
private SmsProperty smsProperty;
@Resource
private SmsClient smsClient;
@Resource
private RedisTemplate<String, Object> redisTemplate;

public SendSmsResponse sendLoginVeryCodeMessage(String phoneNum) {
    logger.info("secretId={}, secretKey={}", smsProperty.getSecretId(), smsProperty.getSecretKey());
    SendSmsRequest req = new SendSmsRequest();
    req.setSenderId(null);
    req.setSessionContext(null);
    // 因从配置属性中获取中文内容出现乱码改为在代码中把签名内容写死
    req.setSign("阿福谈Java技术栈");
    req.setSmsSdkAppid(smsProperty.getAppid());
    req.setTemplateID(SmsEnum.PHONE_CODE_LOGIN.getTemplateId());
    req.setPhoneNumberSet(new String[]{phoneNum});
    String verifyCode = getCode();
    String[] params = new String[]{verifyCode, "10"};
    req.setTemplateParamSet(params);
    logger.info("req={}", JSON.toJSONString(req));
    try {
        SendSmsResponse res = smsClient.SendSms(req);
        if ("Ok".equals(res.getSendStatusSet()[0].getCode())) {
            // 发送短信验证码成功则将验证码保存到redis缓存中
            redisTemplate.opsForValue().set("loginVerifyCode:"+phoneNum, verifyCode, 10, TimeUnit.MINUTES);
        }
        return res;
    } catch (TencentCloudSDKException e) {
        logger.error("send message failed", e);
        throw new RuntimeException("send message failed, caused by " + e.getMessage());
    }
}

/**
 * 生成6位随机数字验证码
 * @return
 */
private String getCode() {
    String numbers = "1234567890";
    StringBuilder builder = new StringBuilder();
    Random random = new Random();
    for(int i=0; i<6; i++) {
        int index = random.nextInt(10);
        builder.append(numbers.charAt(index));
    }
    return builder.toString();
}

}

 @Resource

private SmsService smsService;

@RequestMapping(value="sendLoginVerifyCode", method = RequestMethod.POST)

@ApiOperation(value = "sendLoginVerifyCode", notes = "发送登录短信验证码")

@ApiImplicitParam(name="paramMap", value = "入参Map", required = true, paramType = "body", dataTypeClass=HashMap.class)

public RespBean<Map<String, Object>> sendLoginVerifyCode(@RequestBody Map<String, String> paramMap) {

String phoneNumber = paramMap.get("phoneNumber");

SendSmsResponse response = smsService.sendLoginVeryCodeMessage(phoneNumber);

SendStatus[] statuses = response.getSendStatusSet();

Map<String, Object> resultMap = new HashMap<>();

resultMap.put("code", statuses[0].getCode());

resultMap.put("message", statuses[0].getMessage());

resultMap.put("phoneNumber", statuses[0].getPhoneNumber());

resultMap.put("fee", statuses[0].getFee());

RespBean<Map<String, Object>> respBean = new RespBean<>(200, "success");

respBean.setData(resultMap);

return respBean;

}

 @Override

protected void configure(HttpSecurity http) throws Exception {

// 配置跨域

http.cors().configurationSource(corsConfigurationSource());

// 禁用spring security框架的退出登录，使用自定义退出登录

http.logout().disable();

http.authorizeRequests()

.antMatchers("/user/reg").anonymous()

.antMatchers("/sendLoginVerifyCode").anonymous()

//......省略其他代码

}

POST http://localhost:8081/blog/sendLoginVerifyCode

{

"phoneNumber": "+86-18682244076"

}

{

"status": 200,

"msg": "success",

"data": {

"code": "Ok",

"phoneNumber": "+8618682244076",

"fee": 1,

"message": "send success"

}

}