SpringBoot2.x 集成腾讯云短信的详细流程

也想出现在这里？点击联系我~

一、腾讯云短信简介

腾讯云短信（Short Message Service，SMS）沉淀腾讯十多年短信服务技术和经验，为QQ、微信等亿级平台和10万+客户提供快速灵活接入的高质量的国内短信与国际/港澳台短信服务。

• 国内短信验证秒级触达，99%到达率。
• 国际/港澳台短信覆盖全球200+国家/地区，稳定可靠。

单次短信的业务请求流程如下所示：

短信由签名和正文内容组成，发送短信前需要申请短信签名和正文内容模板。短信签名是位于短信正文前【】中的署名，用于标识公司或业务。短信签名需要审核通过后才可使用。短信模板即具体发送的短信正文内容，短信模板支持验证码模板、通知类短信模板和营销短信模板。短信内容可以通过模板参数实现个性化定制。短信模板申请前需要先申请短信签名，短信模板需要审核通过后才可使用。

二、准备工作

1.开通短信服务

如果没有腾讯云账号，需要注册腾讯云账号，并完成实名认证，可以个人认证和企业认证，不能进行企业认证的话也可以进行个人认证。然后进入腾讯云短信控制台，开通短信服务，开通短信和个人认证之后分别都会赠送包含100条短信的国内套餐包，用来测试足够：

2.创建签名

这里创建国内短信签名，创建完成后等到状态变为已通过就可以使用了：

创建签名时签名类型可以选网站、APP、公众号和小程序，可以根据需要创建：

3.创建正文模板

创建模板，创建完成之后状态变为已通过就可以使用了：

模板内容可以使用标准模板也可以自定义：

4.创建短信应用

在应用列表下可以创建短信应用，获取短信应用的SDKAppID：

点击应用可以查看应用信息：

5.腾讯云API密钥

在访问管理菜单的访问密钥下的API密钥管理中可以新建和查看API密钥，在请求腾讯云短信服务发送短信时需要传入该密钥：

三、集成腾讯云短信

通过Maven新建一个名为springboot-tencent-sms的项目。

1.引入依赖

1. <dependency>
2. <groupId>org.springframework.boot</groupId>
3. <artifactId>spring-boot-starter-web</artifactId>
4. </dependency>
5. <!– 腾讯云 Java SDK 依赖 –>
6. <dependency>
7. <groupId>com.tencentcloudapi</groupId>
8. <artifactId>tencentcloud-sdk-java</artifactId>
9. <version>3.1.297</version>
10. </dependency>
11. <!– Spring Data Redis 起步依赖 –>
12. <dependency>
13. <groupId>org.springframework.boot</groupId>
14. <artifactId>spring-boot-starter-data-redis</artifactId>
15. </dependency>
16. <!– lombok插件 –>
17. <dependency>
18. <groupId>org.projectlombok</groupId>
19. <artifactId>lombok</artifactId>
20. <version>1.18.8</version>
21. </dependency>

2.编写配置类

用于读取配置文件中的自定义腾讯云短信配置的配置类：

1. package com.rtxtitanv.config;
3. import lombok.Data;
4. import org.springframework.boot.context.properties.ConfigurationProperties;
5. import org.springframework.context.annotation.Configuration;
7. /**
8. * @author rtxtitanv
9. * @version 1.0.0
10. * @name com.rtxtitanv.config.SmsConfig
11. * @description 腾讯云短信配置类
12. * @date 2021/6/25 16:21
13. */
14. @ConfigurationProperties(prefix = "tencent.sms")
15. @Configuration
16. @Data
17. public class SmsConfig {
18. /**
19. * 腾讯云API密钥的SecretId
20. */
21. private String secretId;
22. /**
23. * 腾讯云API密钥的SecretKey
24. */
25. private String secretKey;
26. /**
27. * 短信应用的SDKAppID
28. */
29. private String appId;
30. /**
31. * 签名内容
32. */
33. private String sign;
34. /**
35. * 模板ID
36. */
37. private String templateId;
38. /**
39. * 过期时间
40. */
41. private String expireTime;
42. /**
43. * redis存储的key的前缀
44. */
45. private String phonePrefix;
46. }

Redis配置类：

1. package com.rtxtitanv.config;
3. import org.springframework.context.annotation.Bean;
4. import org.springframework.context.annotation.Configuration;
5. import org.springframework.data.redis.connection.RedisConnectionFactory;
6. import org.springframework.data.redis.core.RedisTemplate;
7. import org.springframework.data.redis.serializer.GenericJackson2JsonRedisSerializer;
8. import org.springframework.data.redis.serializer.StringRedisSerializer;
10. import javax.annotation.Resource;
12. /**
13. * @author rtxtitanv
14. * @version 1.0.0
15. * @name com.rtxtitanv.config.RedisConfig
16. * @description Redis配置类
17. * @date 2021/6/26 12:24
18. */
19. @Configuration
20. public class RedisConfig {
22. @Resource
23. private RedisConnectionFactory redisConnectionFactory;
25. /**
26. * RedisTemplate实例
27. *
28. * @return RedisTemplate实例
29. */
30. @Bean
31. public RedisTemplate<String, Object> redisTemplate() {
32. RedisTemplate<String, Object> redisTemplate = new RedisTemplate<>();
33. initRedisTemplate(redisTemplate, redisConnectionFactory);
34. return redisTemplate;
35. }
37. /**
38. * 设置数据存入redis的序列化方式
39. *
40. * @param redisTemplate RedisTemplate对象
41. * @param factory RedisConnectionFactory对象
42. */
43. private void initRedisTemplate(RedisTemplate<String, Object> redisTemplate, RedisConnectionFactory factory) {
44. redisTemplate.setKeySerializer(new StringRedisSerializer());
45. redisTemplate.setValueSerializer(new StringRedisSerializer());
46. redisTemplate.setHashKeySerializer(new GenericJackson2JsonRedisSerializer());
47. redisTemplate.setHashValueSerializer(new GenericJackson2JsonRedisSerializer());
48. redisTemplate.setConnectionFactory(factory);
49. }
50. }

3.编写配置文件

1. spring:
2. redis:
3. host: 127.0.0.1
4. port: 6379
6. # 自定义腾讯云短信配置
7. tencent:
8. sms:
9. # 配置腾讯云API密钥的SecretId
10. secretId: 这里填腾讯云API密钥的SecretId
11. # 配置腾讯云API密钥的SecretKey
12. secretKey: 这里填腾讯云API密钥的SecretKey
13. # 配置短信应用的SDKAppID
14. appId: 这里填短信应用的SDKAppID
15. # 配置签名内容
16. sign: "这里填签名内容"
17. # 配置模板ID
18. templateId: 这里填模板ID
19. # 配置过期时间
20. expireTime: 5
21. # 配置redis存储的key的前缀
22. phonePrefix: REGIST

4.编写工具类

腾讯云短信工具类：

1. package com.rtxtitanv.util;
3. import com.rtxtitanv.config.SmsConfig;
4. import com.tencentcloudapi.common.Credential;
5. import com.tencentcloudapi.common.exception.TencentCloudSDKException;
6. import com.tencentcloudapi.common.profile.ClientProfile;
7. import com.tencentcloudapi.common.profile.HttpProfile;
8. import com.tencentcloudapi.sms.v20210111.SmsClient;
9. import com.tencentcloudapi.sms.v20210111.models.SendSmsRequest;
10. import com.tencentcloudapi.sms.v20210111.models.SendSmsResponse;
11. import com.tencentcloudapi.sms.v20210111.models.SendStatus;
12. import org.slf4j.Logger;
13. import org.slf4j.LoggerFactory;
15. /**
16. * @author rtxtitanv
17. * @version 1.0.0
18. * @name com.rtxtitanv.util.SmsUtil
19. * @description 腾讯云短信工具类
20. * @date 2021/6/25 16:21
21. */
22. public class SmsUtil {
24. private static final Logger LOGGER = LoggerFactory.getLogger(SmsUtil.class);
26. /**
27. * 发送短信
28. *
29. * @param smsConfig 腾讯云短信配置对象
30. * @param templateParams 模板参数
31. * @param phoneNumbers 手机号数组
32. * @return SendStatus[]，短信发送状态
33. */
34. public static SendStatus[] sendSms(SmsConfig smsConfig, String[] templateParams, String[] phoneNumbers) {
35. try {
36. // 实例化一个认证对象，入参需要传入腾讯云账户密钥对secretId，secretKey。
37. Credential cred = new Credential(smsConfig.getSecretId(), smsConfig.getSecretKey());
38. // 实例化一个http选项，可选，没有特殊需求可以跳过
39. HttpProfile httpProfile = new HttpProfile();
40. // SDK默认使用POST方法
41. httpProfile.setReqMethod("POST");
42. // SDK有默认的超时时间，非必要请不要进行调整
43. httpProfile.setConnTimeout(60);
44. // 非必要步骤：实例化一个客户端配置对象，可以指定超时时间等配置
45. ClientProfile clientProfile = new ClientProfile();
46. // SDK默认用TC3-HMAC-SHA256进行签名，非必要请不要修改这个字段
47. clientProfile.setSignMethod("HmacSHA256");
48. clientProfile.setHttpProfile(httpProfile);
49. // 实例化要请求产品(以sms为例)的client对象，第二个参数是地域信息，可以直接填写字符串ap-guangzhou，或者引用预设的常量
50. SmsClient smsClient = new SmsClient(cred, "ap-guangzhou", clientProfile);
51. // 实例化一个请求对象
52. SendSmsRequest req = new SendSmsRequest();
53. // 设置短信应用ID：短信SdkAppId在[短信控制台]添加应用后生成的实际SdkAppId
54. req.setSmsSdkAppId(smsConfig.getAppId());
55. // 设置短信签名内容：使用UTF-8编码，必须填写已审核通过的签名，签名信息可登录[短信控制台]查看
56. req.setSignName(smsConfig.getSign());
57. // 设置国际/港澳台短信SenderId：国内短信填空，默认未开通
58. req.setSenderId("");
59. // 设置模板ID：必须填写已审核通过的模板ID。模板ID可登录[短信控制台]查看
60. req.setTemplateId(smsConfig.getTemplateId());
61. // 设置下发手机号码，采用E.164标准，+[国家或地区码][手机号]
62. req.setPhoneNumberSet(phoneNumbers);
63. // 设置模板参数：若无模板参数，则设置为空
64. req.setTemplateParamSet(templateParams);
65. // 通过client对象调用SendSms方法发起请求。注意请求方法名与请求对象是对应的，返回的res是一个SendSmsResponse类的实例，与请求对象对应
66. SendSmsResponse res = smsClient.SendSms(req);
67. // 控制台打印日志输出json格式的字符串回包
68. LOGGER.info(SendSmsResponse.toJsonString(res));
69. return res.getSendStatusSet();
70. } catch (TencentCloudSDKException e) {
71. e.printStackTrace();
72. throw new RuntimeException(e.getMessage());
73. }
74. }
75. }

Redis工具类：

1. package com.rtxtitanv.util;
3. import org.springframework.data.redis.core.RedisTemplate;
4. import org.springframework.stereotype.Component;
6. import javax.annotation.Resource;
7. import java.util.concurrent.TimeUnit;
9. /**
10. * @author rtxtitanv
11. * @version 1.0.0
12. * @name com.rtxtitanv.util.RedisUtil
13. * @description Redis工具类
14. * @date 2021/6/26 12:24
15. */
16. @Component
17. public class RedisUtil {
19. @Resource
20. private RedisTemplate<String, Object> redisTemplate;
22. /**
23. * 缓存基本对象
24. *
25. * @param key 键
26. * @param value 值
27. * @param expire 键的过期时间
28. */
29. public void setCacheObject(String key, Object value, long expire) {
30. redisTemplate.opsForValue().set(key, value);
31. if (expire > 0) {
32. redisTemplate.expire(key, expire, TimeUnit.MINUTES);
33. }
34. }
36. /**
37. * 获取指定键的缓存对象
38. *
39. * @param key 键
40. * @return 缓存对象
41. */
42. public Object getCacheObject(String key) {
43. return redisTemplate.opsForValue().get(key);
44. }
46. /**
47. * 判断键是否存在并且未过期
48. *
49. * @param key 键
50. * @return true，键存在并且未过期；false，键不存在或存在但过期
51. */
52. public boolean hasKey(String key) {
53. return redisTemplate.hasKey(key) && getExpire(key) > 0 ? true : false;
54. }
56. /**
57. * 获取键的过期时间
58. *
59. * @param key 键
60. * @return 过期时间
61. */
62. public long getExpire(String key) {
63. return redisTemplate.getExpire(key, TimeUnit.MINUTES);
64. }
66. /**
67. * 删除指定键的缓存
68. *
69. * @param key 键
70. */
71. public void delete(String key) {
72. redisTemplate.delete(key);
73. }
75. /**
76. * 创建缓存的键
77. *
78. * @param prefix 前缀
79. * @param phoneNumber 手机号
80. * @return 键
81. */
82. public static String createCacheKey(String prefix, String phoneNumber) {
83. return prefix + phoneNumber;
84. }
85. }

用于生成随机验证码的工具类：

1. package com.rtxtitanv.util;
3. import java.util.Random;
5. /**
6. * @author rtxtitanv
7. * @version 1.0.0
8. * @name com.rtxtitanv.util.RandomUtil
9. * @description Random工具类
10. * @date 2021/6/26 11:39
11. */
12. public class RandomUtil {
14. private static final Random RANDOM = new Random();
16. /**
17. * 生成指定位数的随机数字字符串
18. *
19. * @param length 字符串长度
20. * @return 随机数字字符串
21. */
22. public static String randomNumbers(int length) {
23. StringBuilder randomNumbers = new StringBuilder();
24. for (int i = 0; i < length; i++) {
25. randomNumbers.append(RANDOM.nextInt(10));
26. }
27. return randomNumbers.toString();
28. }
29. }

5.Controller层

1. package com.rtxtitanv.controller;
3. import com.rtxtitanv.service.SmsService;
4. import org.springframework.web.bind.annotation.PostMapping;
5. import org.springframework.web.bind.annotation.RequestMapping;
6. import org.springframework.web.bind.annotation.RequestParam;
7. import org.springframework.web.bind.annotation.RestController;
9. import javax.annotation.Resource;
11. /**
12. * @author rtxtitanv
13. * @version 1.0.0
14. * @name com.rtxtitanv.controller.SmsController
15. * @description SmsController
16. * @date 2021/6/25 16:20
17. */
18. @RequestMapping("/sms")
19. @RestController
20. public class SmsController {
22. @Resource
23. private SmsService smsService;
25. @PostMapping("/send")
26. public String sendSmsCode(@RequestParam(value = "phoneNumber") String phoneNumber) {
27. return smsService.sendSmsCode(phoneNumber);
28. }
30. @PostMapping("/verify")
31. public String verifySmsCode(@RequestParam(value = "phoneNumber") String phoneNumber,
32. @RequestParam(value = "smsCode") String smsCode) {
33. return smsService.verifySmsCode(phoneNumber, smsCode);
34. }
35. }

6.Service层

1. package com.rtxtitanv.service;
3. /**
4. * @author rtxtitanv
5. * @version 1.0.0
6. * @name com.rtxtitanv.service.SmsService
7. * @description SmsService
8. * @date 2021/6/25 16:20
9. */
10. public interface SmsService {
12. /**
13. * 发送短信验证码
14. *
15. * @param phoneNumber 手机号
16. * @return
17. */
18. String sendSmsCode(String phoneNumber);
20. /**
21. * 验证短信验证码
22. *
23. * @param phoneNumber 手机号
24. * @param smsCode 短信验证码
25. * @return
26. */
27. String verifySmsCode(String phoneNumber, String smsCode);
28. }

1. package com.rtxtitanv.service.impl;
3. import com.rtxtitanv.config.SmsConfig;
4. import com.rtxtitanv.service.SmsService;
5. import com.rtxtitanv.util.RandomUtil;
6. import com.rtxtitanv.util.RedisUtil;
7. import com.rtxtitanv.util.SmsUtil;
8. import com.tencentcloudapi.sms.v20210111.models.SendStatus;
9. import org.springframework.stereotype.Service;
11. import javax.annotation.Resource;
13. /**
14. * @author rtxtitanv
15. * @version 1.0.0
16. * @name com.rtxtitanv.service.impl.SmsServiceImpl
17. * @description SmsService实现类
18. * @date 2021/6/25 16:20
19. */
20. @Service
21. public class SmsServiceImpl implements SmsService {
23. @Resource
24. private SmsConfig smsConfig;
25. @Resource
26. private RedisUtil redisUtil;
28. @Override
29. public String sendSmsCode(String phoneNumber) {
30. // 下发手机号码，采用e.164标准，+[国家或地区码][手机号]
31. String[] phoneNumbers = {"+86" + phoneNumber};
32. // 生成6位随机数字字符串
33. String smsCode = RandomUtil.randomNumbers(6);
34. // 模板参数：若无模板参数，则设置为空（参数1为随机验证码，参数2为有效时间）
35. String[] templateParams = {smsCode, smsConfig.getExpireTime()};
36. // 发送短信验证码
37. SendStatus[] sendStatuses = SmsUtil.sendSms(smsConfig, templateParams, phoneNumbers);
38. if ("Ok".equals(sendStatuses[0].getCode())) {
39. // 创建缓存的key
40. String key = RedisUtil.createCacheKey(smsConfig.getPhonePrefix(), phoneNumber);
41. // 将验证码缓存到redis并设置过期时间
42. redisUtil.setCacheObject(key, smsCode, Long.parseLong(smsConfig.getExpireTime()));
43. return "验证码发送成功";
44. } else {
45. return "验证码发送失败：" + sendStatuses[0].getMessage();
46. }
47. }
49. @Override
50. public String verifySmsCode(String phoneNumber, String smsCode) {
51. // 创建key
52. String key = RedisUtil.createCacheKey(smsConfig.getPhonePrefix(), phoneNumber);
53. // 判断指定key是否存在并且未过期
54. if (redisUtil.hasKey(key)) {
55. // 验证输入的验证码是否正确
56. if (smsCode.equals(redisUtil.getCacheObject(key))) {
57. // 验证成功后删除验证码缓存
58. redisUtil.delete(key);
59. return "验证成功";
60. } else {
61. return "验证码错误";
62. }
63. } else {
64. return "验证码已失效";
65. }
66. }
67. }

四、腾讯云短信测试

运行项目，使用Postman进行接口测试。

1.发送短信验证码

发送如下POST请求以请求腾讯云短信服务向指定手机号发送短信验证码，请求地址为http://localhost:8080/sms/send：

Redis客户端查看发现验证码已经存到了Redis中：

手机上也成功收到了验证码，说明发送短信成功：

2.验证短信验证码

发送如下POST请求验证短信验证码，请求地址为http://localhost:8080/sms/verify，这里将验证码参数smscode设为不同于之前发送到手机的验证码来模拟验证码输入错误：

再次发送如下POST请求验证短信验证码，这里输入正确的验证码：

Redis客户端刷新发现验证码缓存已经删除：

再次发送如下POST请求验证短信验证码，发现验证码已失效，满足短信验证码验证成功后就失效的业务需求：

代码示例

Github：https://github.com/RtxTitanV/springboot-learning/tree/master/springboot2.x-learning/springboot-tencent-sms
Gitee：https://gitee.com/RtxTitanV/springboot-learning/tree/master/springboot2.x-learning/springboot-tencent-sms

到此这篇关于SpringBoot2.x 集成腾讯云短信的文章就介绍到这了,更多相关SpringBoot腾讯云短信内容请搜索快网idc以前的文章或继续浏览下面的相关文章希望大家以后多多支持快网idc！

原文链接：https://blog.csdn.net/RtxTitanV/article/details/118275639