java 实现短信验证码

Posted on 2022-11-24 21:20  梦中千秋  阅读(855)  评论(0编辑  收藏  举报

短信验证码
1、短信接口平台

首先需要一个短信接口平台,才能进行发短信的操作,网上一搜有很多,但是很多只送了几条免费的次数,根本不够使用。然后发现腾讯云也有这个服务,一下送了200条,用完了还是得自己买。不过现在测试,200条够用了。

短信接口平台需要实名,验证什么的,需要申请短信的签名和模板,也就是发送的标题和内容,需要审核。腾讯云短信地址。请注意写的要求,并不是你想发送什么都可以。审核不能过。

创建签名需要有个人实名的网站,或已发布的小程序/公众号,或已上线的APP,请注意!

2、依赖引入

参考官方 java SDK文档

以maven方式引入依赖jar包

com.qcloud cmq-http-client 1.0.7 com.tencentcloudapi tencentcloud-sdk-java 3.1.390

3、常量类

  • 号内容都需要替换为自己对应的,在腾讯云中找到这些常量,写入

SMSSECREID与SMSSECREKEY查询地址:CAM密匙查询

注意这些的填写,一个错了将会导致发送不成功,官方文档对于每个参数都有详细的解释,告诉你在哪里找 到 它。

/**

  • 短信常量类
    */
    public class Constants {

    /**

    • 短信 appid
      */
      public static final String SMSAPPID="******";
      /
    • 腾讯云账户密钥对: secretId
      */
      public static final String SMSSECREID="******";
      /
    • 腾讯云账户密钥对: secretKey
      */
      public static final String SMSSECREKEY="******";
      /
    • SmsSdkAppid
      */
      public static final String SMSSDKAPPID="******";
      /
    • sms sign : sms签名
      */
      public static final String SMSSIGN="******";
      /
    • sms 短信模板id:
      */
      public static final String SMSTEMPLATEID="********";

}

4、Service类

短信发送实现

返回 是否发送成功的提示

package com.example.service;

import com.example.pojo.Constants;
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;
import org.springframework.stereotype.Service;

/**

  • Tencent Cloud Sms Sendsms
    /
    @Service
    public class SendSmsService {
    public String sendSms(String valcode, String[] phoneNumbers) {
    try {
    /
    必要步骤:
    * 实例化一个认证对象,入参需要传入腾讯云账户密钥对secretId,secretKey。
    * 这里采用的是从环境变量读取的方式,需要在环境变量中先设置这两个值。
    * 你也可以直接在代码中写死密钥对,但是小心不要将代码复制、上传或者分享给他人,
    * 以免泄露密钥对危及你的财产安全。
    * CAM密匙查询: https://console.cloud.tencent.com/cam/capi*/
    Credential cred = new Credential(Constants.SMSSECREID, Constants.SMSSECREKEY);

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

// httpProfile.setProxyHost(“host”);
// httpProfile.setProxyPort(port);
/* 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/sms/smslist
         * sms helper: https://cloud.tencent.com/document/product/382/3773 */

        /* 短信应用ID: 短信SdkAppid在 [短信控制台] 添加应用后生成的实际SdkAppid,示例如1400006666 */
        String appid = Constants.SMSAPPID;
        req.setSmsSdkAppId(appid);

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

        /* 国际/港澳台短信 senderid: 国内短信填空,默认未开通,如需开通请联系 [sms helper] */

// String senderid = “xxx”;
// req.setSenderId(senderid);

        /* 用户的 session 内容: 可以携带用户侧 ID 等上下文信息,server 会原样返回 */

// String session = “xxx”;
// req.setSessionContext(session);

        /* 短信码号扩展号: 默认未开通,如需开通请联系 [sms helper] */

// String extendcode = “xxx”;
// req.setExtendCode(extendcode);

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

        /* 下发手机号码,采用 e.164 标准,+[国家或地区码][手机号]
         * 示例如:+8613711112222, 其中前面有一个+号 ,86为国家码,13711112222为手机号,最多不要超过200个手机号*/

// String[] phoneNumbers = {"+8621212313123", “+8612345678902”, “+8612345678903”};
req.setPhoneNumberSet(phoneNumbers);

        /* 模板参数: 若无模板参数,则设置为空*/
        String[] templateParams = {valcode};
        req.setTemplateParamSet(templateParams);

        /* 通过 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();
        return "发送出了点问题";
    }
    return "短信发送成功!请注意接收";
}

}

5、测试

输入自己的手机号测试,

测试正常,成功收到短信

/*
*短信测试类
*/

@Autowired
private SendSmsService sendSmsService;

@Test
void sendSms(){
sendSmsService.sendSms(“666666”, new String[] {“86***********”});
}

6、控制类

整合页面和控制类,发送短信

从页面输入手机号,获取短信

再对验证码进行验证、提示

/*
短信验证码
*/
@Autowired
private SendSmsService sendSmsService;

@RequestMapping("/getSmsCode")
public String getSmsCode(HttpSession session, String tel, Model model) {
String SmsCode = RondomCode.randomCode();
session.setAttribute(“SmsCode”,SmsCode);
String tip = sendSmsService.sendSms(SmsCode, new String[] {tel});
model.addAttribute(“tel”,tel);
model.addAttribute(“tip”,tip);
return “login”;
}

@RequestMapping("/doRegister")
public String doRegister(HttpSession session,String InputSmsCode,Model model) {
String SmsCode = (String) session.getAttribute(“SmsCode”);
//限制用户必须先输入验证码,才能提交请求
if (!InputSmsCode.equals(SmsCode)){
System.out.println(“验证码有误”);
model.addAttribute(“tip”,“验证码有误”);
return “login”;
}
return “index”;
}

7、登录页

添加js增加优化体验,限制用户每60秒才能点击一次发送验证码请求和对手机号格式以正则表达式效验

/短信按钮JS/
c = 60;
function SmsTiming() {
$("#getSmsCode").text(c + “秒后重新获取”);
//console.log©;
// 1秒延时调用自己
myVar = setTimeout(function () {
SmsTiming()
}, 1000);
c -= 1;
//设定条件跳出
if (c == -1) {
clearTimeout(myVar); //停止
$("#getSmsCode").removeAttr(“disabled”); //移除禁用属性
$("#getSmsCode").text(“获取验证码”); //重新显示按钮
c = 60; //重新初始化 倒计时时间
}
};

//点击按钮调用,添加属性禁用按钮
//调用 SmsTiming()
$("#getSmsCode").click(function () {
var SmsInput = $(“input[name=‘tel’]”).val();

var smsRegExp = new RegExp("^((13[0-9])|(17[0-1,6-8])|(15[^4,\\\\D])|(18[0-9]))\\d{8}$");
if (SmsInput == null || SmsInput == ' ') {
    alert("请先填写手机号!");
    return false;
} else if (!smsRegExp.test(SmsInput)) {
    alert("请检查你的手机格式!");
    return false;
}
$("#getSmsCode").attr("disabled", "disabled");
SmsTiming();
return true;

});

电话: 获取验证码 验证码:

8、效果演示