java+redis实现腾讯云短信SDK3.0验证+过期时间验证

向右看齐 2023-01-23 11:54 144阅读 0赞

其实都是腾讯云官方的sdk 总结一下

[JAVA SDK 3.0跳转链接][JAVA SDK 3.0]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDM1MzUwNw_size_16_color_FFFFFF_t_70]

引入maven依赖

<dependency>
                <groupId>com.tencentcloudapi</groupId>
                <artifactId>tencentcloud-sdk-java</artifactId>
                <version>3.1.313</version>
            </dependency>
            
     		<dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-data-redis</artifactId>
            </dependency>
            
            <dependency>
                <groupId>org.apache.commons</groupId>
                <artifactId>commons-pool2</artifactId>
            </dependency>

配置文件 redis的不要忘记配置哦

#redis相关
    spring.redis.database=0
    spring.redis.host=xxxx
    spring.redis.port=6379
    spring.redis.password=xxxx
    
    #短信服务
    tx.sms.secretId=xxxx
    tx.sms.secretKey=xxx
    #sdk
    tx.sms.sdkAppId=xxx
    #模板id
    tx.sms.templateId=xxx

@Service
    @Slf4j
    public class SmsService { 
    
        @Autowired
        private StringRedisTemplate redisTemplate;
        @Value("${tx.sms.secretId}")
        private String secretId;
        @Value("${tx.sms.secretKey}")
        private String secretKey;
        @Value("${tx.sms.sdkAppId}")
        private String sdkAppId;
        @Value("${tx.sms.templateId}")
        String templateId;
    
        public SendSmsResponse sendMsg(String phoneNum) { 
            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 */
                req.setSmsSdkAppId(sdkAppId);
                /* 短信签名内容: 使用 UTF-8 编码，必须填写已审核通过的签名，签名信息可登录 [短信控制台] 查看 */
                String signName = "xxxx";
                req.setSignName(signName);
                /* 用户的 session 内容: 可以携带用户侧 ID 等上下文信息，server 会原样返回 */
                //可以携带unionid或者userid
                String sessionContext = "xxxxxxxxx";
                req.setSessionContext(sessionContext);
                /* 模板 ID: 必须填写已审核通过的模板 ID。模板ID可登录 [短信控制台] 查看 */
                req.setTemplateId(templateId);
                /* 下发手机号码，采用 E.164 标准，+[国家或地区码][手机号] * 示例如：+8613711112222， 其中前面有一个+号 ，86为国家码，13711112222为手机号，最多不要超过200个手机号 */
                //这里参数是可变的
                String[] phoneNumberSet = new String[]{ "+86" + phoneNum};
                req.setPhoneNumberSet(phoneNumberSet);
                //生成随机code
                String code = RandomUtil.randomNumbers(4);
                /* 模板参数: 若无模板参数，则设置为空 */
                String[] templateParamSet = { code,"10"};
                req.setTemplateParamSet(templateParamSet);
                /* 通过 client 对象调用 SendSms 方法发起请求。注意请求方法名与请求对象是对应的 * 返回的 res 是一个 SendSmsResponse 类的实例，与请求对象对应 */
                SendSmsResponse res = client.SendSms(req);
                //redis中存入code 到时候比对一下 我们需要每次传入一个随机码 用于标识不同的短信 如 key= rand:6666-phone:1506213135 value=1365
                // 可以用过期时间+当前时间组成一个时间戳 然后校验的时候比对 如果比当前时间戳小 说明过期了
                double expireTime = System.currentTimeMillis() / 1000 + 10 * 60;
                //第三个参数是double类型的分值
                redisTemplate.opsForZSet().add("phone:" + phoneNum,code,expireTime);
                redisTemplate.expire("phone:" + phoneNum, 30, TimeUnit.MINUTES);
                // 输出json格式的字符串回包
                log.info(SendSmsResponse.toJsonString(res));
                // 也可以取出单个值，你可以通过官网接口文档或跳转到response对象的定义处查看返回字段的定义
                return res;
            } catch (TencentCloudSDKException e) { 
                e.printStackTrace();
            }
            return null;
        }
    }

有几点需要注意  
1.签名内容不是id 基本上是汉字 UTF-8编码的 idea一般都用UTF-8 所以不需要改变什么  
2.模版参数 我试了下参数似乎都要数字 中文似乎会转化错误  
3. 手机号要加 “+86“

# 重点内容： #

短信验证码的时效是10分钟 你以为单单使用redis的字符串 设置个过期时间就好了？

太天真了

当用户发第二 第三次验证码的时候 这几个验证码只要不过期 应该都是能使用的

那么 即需要保持相同的key 如phone:150xxxxxxx 但code不同 且需要每个code都会过期 那该怎么办呢？

可以使用zset 里面的score供我们使用 虽然不能使用expire让对应的value在不同时间内过期

但我们能使用取巧的办法

代码单独拉出来

// 设置code 10分钟后过期
     			double expireTime = System.currentTimeMillis() / 1000 + 10 * 60;
                //第三个参数是double类型的分值
                redisTemplate.opsForZSet().add("phone:" + phoneNum,code,expireTime);
                //每请求一次短信 给这个key续期 别code没过期 key先过期了
                redisTemplate.expire("phone:" + phoneNum, 30, TimeUnit.MINUTES);

看一下这个方法

`opsForZSet().add(key,value,score)`

第一个参数为String类型的key

第二个参数为String类型的value

第三个参数为double类型的score

按上面的方法存入即可

再看看短信验证的方法

controller层的方法

@RestController
    @Slf4j
    @Api(value = "SmsController", tags = "短信服务")
    public class SmsController extends BaseController { 
    
    
        @Autowired
        private SmsService smsService;
        @Autowired
        private StringRedisTemplate redisTemplate;
    
        @PostMapping("/sendMsg")
        @ApiOperation("发送短信验证码")
        public Result sendMsg(String phone) { 
            SendSmsResponse res = smsService.sendMsg(phone);
            //getSendStatusSet()会返回数组 我们一个手机号就使用索引0
            if (Objects.equals("Ok", res.getSendStatusSet()[0].getCode())) { 
                return Result.ok();
            } else { 
                return Result.fail().message("短信发送失败");
            }
        }
    
    
    
    
        @PostMapping("/confirm-sms")
        @ApiOperation("短信验证码验证")
        public Result confirmSms(String phone, String code) { 
            //获取当前时间的秒数
            double curTime = System.currentTimeMillis() / 1000;
            // 获取给定时间区间的集合 当前时间到未来2000年的区间 只要当时插入的时间戳在该范围内 就没有过期
            Set<String> codeSet = redisTemplate.opsForZSet().rangeByScore("phone:" + phone, curTime, Double.MAX_VALUE);
            //只要在这个区间内 说明验证码没有过期 随便一个验证码都能使用
            if (codeSet.contains(code)) { 
                return Result.ok().message("校验成功");
            }
            return Result.fail().code(444).message("校验失败");
        }
    }

验证的时候前端传手机号和验证码。只要验证码没有过期 都是能在集合内取到的 给他验证通过即可

[JAVA SDK 3.0]: https://cloud.tencent.com/document/product/382/43194
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NDM1MzUwNw_size_16_color_FFFFFF_t_70]: /images/20221004/84b68f3a26cb4c8ca274050778c295f2.png