Springboot整合腾讯云短信实现系统短信登录与注册

博客：https://www.mintimate.cn Mintimate’s Blog，只为与你分享

短信登录

一个登录模块，无非就是一个鉴权。现代社会，大家手机不离身，使用手机进行鉴权，并完成后续单点登录，无疑是一个不错的方法。

本次就使用Springboot配合腾讯云的SMS服务，完成后台短信登录逻辑。

准备工作

首先，我们看看准备工作：

腾讯云SMS：腾讯云提供短信分发接口，由我们进行调用。
Redis：我们生成的验证码，由Redis进行持久化。

当然，你想开通腾讯云的SMS服务，前置条件：

拥有一个备案的域名：https://cloud.tencent.com/document/product/243

否则，是无法使用腾讯云短信功能的哦(･_･;。

短信开通

首先，我们要进入SMS控制台，开通短信功能：

创建短信签名

其次，我们开通了短信服务功能后，需要创建短信签名，创建短信签名

比如，我有一个备案域名（flyinbug.cn），所以我创建的短信签名：

短信正文模板

现在，我们就可以创建正文模版：

可以看到，我这里创建一个短信登录的模版，其中{1}和Nginx的$1类似，用于后续Springboot使用时的传参。

创建提交后，就可以等审核了：

在等审核的过程中，你可以先去完善后台逻辑。

审核通过：

到此，你会得到：

signName：短信签名名；
templateId：短信正文模版id；

Maven依赖

我们使用腾讯云的SDK进行封装业务，所以需要引用：

代码语言：html

复制

<dependency>
    <groupId>com.tencentcloudapi</groupId>
    <artifactId>tencentcloud-sdk-java</artifactId>
    <version>4.0.11</version>
</dependency>

最新版本号参考：https://search.maven.org/artifact/com.tencentcloudapi/tencentcloud-sdk-java-sms

另外，还有Redis：

代码语言：html

复制

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>

到此，前期准备就完成了。我们可以进行Java逻辑部署了。

Springboot操作

Springboot内，我们肯定是需要写一个工具包，这个工具包实现方法很多；比如：IOC注入、static静态方法等。

为了方便，我这里使用static静态方法。

官方文档

首先查看官方文档：https://cloud.tencent.com/document/product/382/43194

观察可以看到，我们需要参数：

secretId：腾讯云账号机密id；
secretKey：腾讯云账号机密key；
signName：前文的短信签名名；
templateId：短信正文模版id；

其中：signName和templateId上文已经获取；而secretId和secretKey，我们可以在腾讯云控制台内获取：https://console.cloud.tencent.com/cam/capi

为此分离配置。

创建常量类

我们把在官方文档内看到的常量参数进行封装，定义一个constant常量类，进行存储：

代码语言：java

复制

/**
 * Desc 腾讯云短信服务常量
 *
 * @author Mintimate
 */
public class tencentSmsConst {
    public static final String secretId = "";
    public static final String secretKey = "";
    /* 短信应用ID: 短信SdkAppId在 [短信控制台] 添加应用后生成的实际SdkAppId，示例如1400006666 */
    public static final String sdkAppId = "";
    public static final String SignName = "";
}

本来想用IOC注入的，结果我的Springboot更新一下，有些问题…… 还没解决；索性就用constant类来实现。

创建枚举类

想想一下，我们还需要传templateId，也就是短信的模版ID，如果只有一个短信模版情况下，可以直接写为final static类型作为constant属性。可是，如果你有多个模版呢？

所以，我这里定义一个枚举类型，方便多模版切换：

代码语言：java

复制

/**
 * Desc 腾讯云短信模版枚举类型
 * @author Mintimate
 */
@Getter
@AllArgsConstructor
public enum SmsTemplateEnum {
    /**
     * 短信登录
     */
    LOGIN("1******4","短信登录模版"),
    private final String TemplateID;
    private final String TemplateDesc;
}

其中，使用TemplateDesc，方便我使用log4j2打印日志……

静态工具包

最后，我们就可以写这个静态工具包了：

代码语言：java

复制

/**
 * Tencent Cloud Sms Sendsms
 * 短信控制台: https://console.cloud.tencent.com/smsv2
 */
public class tencentSmsUtil {
/**
 * 使用腾讯云短信发生验证码
 * @param telephoneNumber 发送对象
 * @param TemplateID 短信模版ID（使用枚举类型）
 * @param templateParamSet 短信模版参数（这里一般为验证码）
 * @return 是否成功
 */
public static boolean sendMessage(String telephoneNumber, String TemplateID, String... templateParamSet) {
    /* 必要步骤：
     * 实例化一个认证对象，入参需要传入腾讯云账户密钥对secretId，secretKey。
     * 这里采用的是从环境变量读取的方式，需要在环境变量中先设置这两个值。
     * 你也可以直接在代码中写死密钥对，但是小心不要将代码复制、上传或者分享给他人，
     * 以免泄露密钥对危及你的财产安全。
     * CAM密匙查询: https://console.cloud.tencent.com/cam/capi*/
    Credential cred = new Credential(secretId, secretKey);
    SendSmsRequest req = new SendSmsRequest();
    SmsClient client = new SmsClient(cred, &#34;ap-guangzhou&#34;);

    /* 填充请求参数,这里request对象的成员变量即对应接口的入参
     * 你可以通过官网接口文档或跳转到request对象的定义处查看请求参数的定义
     * 基本类型的设置:
     * 帮助链接：
     * sms helper: https://cloud.tencent.com/document/product/382/3773 */
    req.setSmsSdkAppId(sdkAppId);

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

    /* 用户的 session 内容: 可以携带用户侧 ID 等上下文信息，server 会原样返回 */
    String sessionContext = &#34;xxx&#34;;
    req.setSessionContext(sessionContext);
    req.setTemplateId(TemplateID);
    req.setPhoneNumberSet(new String[]{&#34;+86&#34; + telephoneNumber});
    /* 模板参数: 若无模板参数，则设置为空 */
    req.setTemplateParamSet(templateParamSet);
    /* 通过 client 对象调用 SendSms 方法发起请求。注意请求方法名与请求对象是对应的
     * 返回的 res 是一个 SendSmsResponse 类的实例，与请求对象对应 */
    SendSmsResponse res = null;
    try {
        res = client.SendSms(req);
    } catch (TencentCloudSDKException ex) {
        ex.printStackTrace();
        return false;
    }
    // 输出json格式的字符串回包
    System.out.println(SendSmsResponse.toJsonString(res));
    // 也可以取出单个值，你可以通过官网接口文档或跳转到response对象的定义处查看返回字段的定义
    System.out.println(res.getRequestId());
    return true;
}

}

其实就是对官方的模版进行简单封装和简化。

演示使用

这里就进行简单的测试使用，设计的简单逻辑是：

Service层逻辑

首先，我写了一个Service层的调用代码来测试：

代码语言：java

复制

@Override

public boolean sendSMS(String teleNumber,SmsTemplateEnum smsTemplateEnum) {

// 随机六个数字

String flag = VerifyCodeUntil.getVerifyCodes(6);

// 存储到Redis内，并设置有效期5分钟

if (redisUtil.set(teleNumber + "_verifyCodesTest", flag, 300)) {

return tencentSmsUtil.sendMessage(teleNumber, smsTemplateEnum.getTemplateID(), flag);

}

return false;

}

其中VerifyCodeUntil为我自己的工具包，用来生成6位存数字验证码：

代码语言：java

复制

public class VerifyCodeUntil {

private final static String sources = "5678012349"; // 验证码可能出现的字符

public static String getVerifyCodes(int longSize){

Random rand = new Random();

StringBuffer flag = new StringBuffer();

for (int j = 0; j < 6; j++) {

flag.append(sources.charAt(rand.nextInt(9)) + "");

}

return String.valueOf(flag);

}

}

这样，就可以业务层发送测试代码了。不过，我的Redis还没完善，暂时使用这样的形式。

Controller层

之后，写个Controller测试代码：

代码语言：java

复制

/**

短信登录获取验证码
@param telephone 用户电话
@return 结果状态

*/

@GetMapping("/getVerifyCodesByTelephone")

public Result getVerifyCodesByTelephone(

@RequestParam(value = "telephone") String telephone) {

// 判断是否有用户绑定该电话号码

User user = userService.getOne(new LambdaQueryWrapper<User>()

.eq(User::getUserTele,telephone));

if (Objects.isNull(user)) {

return Result.fail();

}

if (userService.sendSMS(telephone,SmsTemplateEnum.LOGIN)){

return Result.ok();

}

return Result.fail();

}

/**

使用短信登录
@param telephone 用户电话
@param verifyCodes 验证码
@return UserDTO

*/

@PostMapping("/VerifyCodesByTelephone")

public Result VerifyCodesByTelephone(

@RequestParam(value = "telephone") String telephone,

@RequestParam(value = "verifyCodes") String verifyCodes) {

// Redis内查询验证码

Object redisCodes = redisUtil.get(telephone + "_verifyCodesTest");

if (redisCodes == null) {

return Result.fail();

}

if (redisCodes.equals(verifyCodes)) {

// 登录成功，返回UserDTO并封装成自定义Result结果集

return Result.ok(userService.loginByTelephone(telephone));

} else {

return Result.fail();

}

}