短信验证码实践

使用场景及具体过程分析

场景：短信登录

过程分析：首先我们在登录表单中填写手机号，然后点击获取验证码，发送请求到后端服务，后端服务调用我们自己封装好的发送短信方法，向方法中传入前端传来的手机号和使用随机数工具类生成验证码，该方法会将调用短信厂商的模板方法将验证码发送给指定的手机号码。发送成功后将验证码临时存储在Redis，用户收到验证码并填写后点击登录，该登录过程会发请求去验证Redis是否存在用户输入的验证码，有就登陆成功，反之失败。

短信生成工具类：

public class RandomUtil {

    private static final Random random = new Random();

    public static String generalFourRandom() {
        StringBuilder four = new StringBuilder(4);
        for (int i = 0; i < 4; i++) {
            String number = String.valueOf(random.nextInt(10));
            four.append(number);
        }
        return four.toString();
    }

    public static String generalSixRandom() {
        StringBuilder six = new StringBuilder(6);
        for (int i = 0; i < 6; i++) {
            String number = String.valueOf(random.nextInt(10));
            six.append(number);
        }
        return six.toString();
    }

}

发短信必要参数动态配置化：

@Getter
@Setter
@Component
@ConfigurationProperties(prefix = "tencent.sms")
public class TencentSmsProperties {

    /**
     * 腾讯云账户ID
     */
    private String secretId;

    /**
     * 腾讯云账户密钥
     */
    private String secretKey;

    /**
     * 短信应用ID
     */
    private String sdkAppId;

    /**
     * 短信签名内容
     */
    private String signName;

    /**
     * 短信模板ID
     */
    private String templateId;

    /**
     * 短信有效时长，单位分钟
     */
    private String timeout;
}

tencent:
  sms:
    secret-id: AKIDay6xfgffyfdrtdhrdds    # 记得填自己的，我这里是虚假的
    secret-key: at0cfjdrdrewjhbjjytcHMBl47wVoreC
    sdk-app-id: 1403246526
    sign-name: 龙茶清欢
    template-id: 12245461
    timeout: 2

发送短信逻辑代码及测试

@SpringBootTest
public class TencentSmsTest {

    @SneakyThrows
    public static void sendSms(String phone, String code, TencentSmsProperties properties) {

        /* 必要步骤：
         * 实例化一个认证对象，入参需要传入腾讯云账户密钥对secretId，secretKey。
         * 这里采用的是从环境变量读取的方式，需要在环境变量中先设置这两个值。
         * 你也可以直接在代码中写死密钥对，但是小心不要将代码复制、上传或者分享给他人，
         * 以免泄露密钥对危及你的财产安全。
         * SecretId、SecretKey 查询: https://console.cloud.tencent.com/cam/capi */
        Credential cred = new Credential(properties.getSecretId(), properties.getSecretKey());

        // 实例化一个http选项，可选，没有特殊需求可以跳过
        HttpProfile httpProfile = new HttpProfile();

        /* SDK默认使用POST方法。
         * 如果你一定要使用GET方法，可以在这里设置。GET方法无法处理一些较大的请求 */
        httpProfile.setReqMethod("POST");
        /* SDK有默认的超时时间，非必要请不要进行调整
         * 如有需要请在代码中查阅以获取最新的默认值 */
        httpProfile.setConnTimeout(60);
        /* 指定接入地域域名，默认就近地域接入域名为 sms.tencentcloudapi.com ，也支持指定地域域名访问，例如广州地域的域名为 sms.ap-guangzhou.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，支持的地域列表参考 https://cloud.tencent.com/document/api/382/52071#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8 */
        SmsClient client = new SmsClient(cred, "ap-guangzhou", clientProfile);
        /* 实例化一个请求对象，根据调用的接口和实际情况，可以进一步设置请求参数
         * 你可以直接查询SDK源码确定接口有哪些属性可以设置
         * 属性可能是基本类型，也可能引用了另一个数据结构
         * 推荐使用IDE进行开发，可以方便的跳转查阅各个接口和数据结构的文档说明 */
        SendSmsRequest request = new SendSmsRequest();

        /* 短信应用ID: 短信SdkAppId在 [短信控制台] 添加应用后生成的实际SdkAppId，示例如1400006666 */
        // 应用 ID 可前往 [短信控制台](https://console.cloud.tencent.com/smsv2/app-manage) 查看
        request.setSmsSdkAppId(properties.getSdkAppId());

        /* 短信签名内容: 使用 UTF-8 编码，必须填写已审核通过的签名 */
        // 签名信息可前往 [国内短信](https://console.cloud.tencent.com/smsv2/csms-sign) 或 [际/            港澳台短信](https://console.cloud.tencent.com/smsv2/isms-sign) 的签名管理查看
        request.setSignName(properties.getSignName());

        /* 模板 ID: 必须填写已审核通过的模板 ID */
        // 模板 ID 可前往 [国内短信](https://console.cloud.tencent.com/smsv2/csms-template) 或           [国际/港澳台短信](https://console.cloud.tencent.com/smsv2/isms-template) 的正文模板管理查看
        request.setTemplateId(properties.getTemplateId());

        /* 模板参数: 模板参数的个数需要与 TemplateId 对应模板的变量个数保持一致，若无模板参数，则设置为空*/
        String[] templateParamSet = {code, properties.getTimeout()};
        request.setTemplateParamSet(templateParamSet);

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

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

    }

    @Autowired
    private TencentSmsProperties properties;

    @Test
    public void testdemo() {
        sendSms("13296846381", RandomUtil.generalSixRandom(), properties);
    }

}

开通短信和简单实用参考：https://blog.csdn.net/python15397/article/details/121988503

官方使用的相关文档参考：https://cloud.tencent.com/document/product/382/43194

后续将继续完善短信验证码和Redis整合，以及结合具体业务场景