spring boot3登录开发-2(2短信验证码接口实现）

2024-03-21 22:44
文章标签 java 实现 接口 登录 开发 spring 验证码 短信 boot3

本文主要是介绍spring boot3登录开发-2(2短信验证码接口实现），希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

 

⛰️个人主页:     蒾酒

🔥系列专栏：《spring boot实战》

🌊山高路远，行路漫漫，终有归途

目录

写在前面

上文衔接

内容简介

短信验证码接口实现

1.依赖导入

2.接口分析

3.实现思路

3.功能实现

创建发送短信工具类

配置阿里云短信服务

接口代码实现

4.功能测试

写在最后

写在前面

本文介绍了springboot开发后端服务中，短信验证码接口功能的设计与实现，坚持看完相信对你有帮助。

同时欢迎订阅springboot系列专栏，持续分享spring boot的使用经验。

上文衔接

本文衔接上文，可以看一下：

spring boot3登录开发-2(1图形验证码接口实现)_用户登录验证码接口设计-CSDN博客文章浏览阅读5.2k次，点赞146次，收藏109次。上文我们已经整合好了jwt,本文我们开始实现图形验证码接口的实现。通过糊涂工具包的图形验证码工具完成获取验证码接口通过redis缓存key(验证码id)-value(验证码内容)_用户登录验证码接口设计https://blog.csdn.net/qq_62262918/article/details/136064820?spm=1001.2014.3001.5502

内容简介

上文我们已经整合好了jwt,本文我们开始实现短信验证码接口的实现。这里我选用阿里云的短信服务。本文侧重点在于设计思路，阿里云控制台开通短信服务，你跟着流程走一遍就可以。个人也是可以申请的。

短信验证码接口实现

1.依赖导入

导入阿里云短信服务SDK

pom.xml:

 <dependency><groupId>com.aliyun</groupId><artifactId>dysmsapi20170525</artifactId><version>2.0.24</version></dependency>

2.接口分析

关键点：

  1. 60s发送间隔
  2. 连发多次封禁24H

3.实现思路

接口接收一个手机号参数，先去redis查询该手机是否有未过期的验证码，如果有先判断发送次数，超过5次，先修改过期时间为24H,再抛发送次数过多异常，少于五次，就再判断发送频率，距离上次发送间隔少于60s，就抛出发送频繁异常，  如果没有未过期的验证码，代表这是第一次发送就直接生成验证码发送短信，接着redis存入一个哈希，key通过手机号生成，value就是，三个键值对，验证码，上次发送时间戳，发送次数(初始为1)，默认过期时间5分钟

  1. 接收手机号参数。
  2. 查询 Redis 中该手机号是否有未过期的验证码。
  3. 如果有未过期的验证码：
    • 判断发送次数是否超过5次，如果超过5次，修改过期时间为24小时并抛出发送次数过多异常。
    • 如果发送次数未超过5次，再判断距离上次发送时间间隔是否少于60秒，如果少于60秒，抛出发送频繁异常。
  4. 如果没有未过期的验证码，代表第一次发送：
    • 生成验证码并发送短信。
    • 将验证码信息存入 Redis，包括验证码、上次发送时间戳和发送次数（初始为1），设置过期时间为5分钟。

注意事项：

考虑到验证码本身的敏感性，虽然存入Redis是临时的，但考虑安全建议对验证码内容进行加密存储，增强数据的安全性。

考虑对接口调用方进行身份验证，确保只有合法的客户端可以请求发送验证码。

整合redis:

Spring Boot3整合Redis_springboot 3 集成redis-CSDN博客文章浏览阅读5.4k次，点赞101次，收藏105次。spring boot整合redis简单四步即可。_springboot 3 集成redishttps://blog.csdn.net/qq_62262918/article/details/136067550?spm=1001.2014.3001.5501

3.功能实现

创建发送短信工具类

import com.aliyun.dysmsapi20170525.Client;
import com.aliyun.dysmsapi20170525.models.SendSmsRequest;
import com.aliyun.dysmsapi20170525.models.SendSmsResponse;
import com.aliyun.teaopenapi.models.Config;
import com.aliyun.teautil.models.RuntimeOptions;
import lombok.Data;
import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;/*** @author mijiupro*/
@Data
@Component
@ConfigurationProperties(prefix = "aliyun.sms")
@Slf4j
public class SmsUtil {private String accessKeyId;// 访问密钥idprivate String accessKeySecret;// 访问密钥secretprivate String endpoint;// 短信 API 的访问域名private String signName;// 短信签名private String templateCode;// 短信模板ID// 发送短信public Boolean sendSms(String phone, String code) {// 创建阿里云客户端Config config = new Config().setAccessKeyId(accessKeyId)// 配置访问密钥 ID.setAccessKeySecret(accessKeySecret);// 配置密钥config.endpoint = endpoint;// 配置访问端点Client client;try {client = new Client(config);} catch (Exception e) {log.error("阿里云短信服务初始化失败", e);return false;}// 构建发送请求SendSmsRequest sendSmsRequest = new SendSmsRequest().setSignName(signName) // 设置签名.setTemplateCode(templateCode) // 设置模板.setPhoneNumbers(phone) // 设置手机号为参数传入的值.setTemplateParam("{\"code\":\"" + code + "\"}"); // 设置模板参数为传入的验证码RuntimeOptions runtime = new RuntimeOptions();// 运行时选择，可以设置不同的属性来配置运行时环境的参数。try {// 复制代码运行请自行打印 API 的返回值SendSmsResponse sendSmsResponse = client.sendSmsWithOptions(sendSmsRequest, runtime);if (!"OK".equals(sendSmsResponse.getBody().getCode())) {log.error("短信发送失败:{}", sendSmsResponse.getBody().getMessage());return false;}log.info("短信发送成功");return true;} catch (Exception error) {log.error("短信发送失败:{}", error.getMessage());return false;}}
}

配置阿里云短信服务

application.yml：

此处修改为你的信息，这里我乱写的

aliyun:sms:access-key-id: Lih5disdjisdidaccess-key-secret: sdisajfdisf6s7d88sdendpoint: dysmsapi.aliyuncs.comsignName: mijiutemplateCode: SMS_46544097

接口代码实现

接口

public interface CaptchaService {/***  获取短信验证码* @param phone*/void getSmsCaptcha(String phone);}

实现类


import com.mijiu.commom.exception.GeneralBusinessException;
import com.mijiu.commom.util.SmsUtil;
import com.mijiu.service.CaptchaService;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.RandomStringUtils;
import org.apache.commons.lang3.StringUtils;
import org.springframework.data.redis.core.BoundHashOperations;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.stereotype.Service;
import java.util.concurrent.TimeUnit;/*** @author mijiupro*/
@Service
@Slf4j
public class CaptchaServiceImpl implements CaptchaService {private final StringRedisTemplate stringRedisTemplate;private final SmsUtil smsUtil;public CaptchaServiceImpl(StringRedisTemplate stringRedisTemplate, SmsUtil smsUtil) {this.stringRedisTemplate = stringRedisTemplate;this.smsUtil = smsUtil;}@Overridepublic void getSmsCaptcha(String phone) {String hashKey = "login:sms:captcha:" + phone;BoundHashOperations<String, String, String> hashOps = stringRedisTemplate.boundHashOps(hashKey);// 初始检查String lastSendTimestamp = hashOps.get("lastSendTimestamp");String sendCount = hashOps.get("sendCount");String captcha = hashOps.get("captcha");hashOps.expire(5, TimeUnit.MINUTES); // 设置过期时间为5分钟// 判断发送次数是否超过限制if (StringUtils.isNotBlank(sendCount) && Integer.parseInt(sendCount) >= 5) {hashOps.expire(24, TimeUnit.HOURS); // 重新设置过期时间为24Hthrow new GeneralBusinessException("发送次数过多，请24H后再试");}// 判断发送频率是否过高if (StringUtils.isNotBlank(lastSendTimestamp)) {long lastSendTime = Long.parseLong(lastSendTimestamp);long currentTime = System.currentTimeMillis();long elapsedTime = currentTime - lastSendTime;long interval = 60 * 1000; // 60秒if (elapsedTime < interval) {throw new GeneralBusinessException("发送短信过于频繁，请稍后再试");}}// 更新发送次数int newSendCount = StringUtils.isNotBlank(sendCount) ? Integer.parseInt(sendCount) + 1 : 1;// 生成新验证码if (StringUtils.isBlank(captcha)) {captcha = RandomStringUtils.randomNumeric(6);}// 发送短信if (!smsUtil.sendSms(phone, captcha)) {throw new GeneralBusinessException("发送短信失败");}// 更新 Redis 中的信息hashOps.put("captcha", captcha);hashOps.put("lastSendTimestamp", String.valueOf(System.currentTimeMillis()));hashOps.put("sendCount", String.valueOf(newSendCount));}}

控制器


import com.mijiu.service.CaptchaService;
import io.swagger.v3.oas.annotations.Operation;import io.swagger.v3.oas.annotations.tags.Tag;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;/*** @author mijiupro*/
@RestController
@RequestMapping("/captcha")
@Tag(name = "验证码接口", description = "验证码接口相关操作")
public class CaptchaController {private final CaptchaService captchaService;public CaptchaController(CaptchaService captchaService) {this.captchaService = captchaService;}@GetMapping("/sms-captcha/{phone}")@Operation(summary = "获取短信验证码")public void getSmsCaptcha(@PathVariable String phone) {captchaService.getSmsCaptcha(phone);}
}

说明：

代码里面我直接返回void是因为我做了全局响应结果拦截统一封装，实际应用为了考虑防盗刷等因素并不会返回空。

4.功能测试

我这里是整合了swagger3的，相关文章在本专栏：

Spring Boot3整合knife4j(swagger3)_springboot3 knife4j-CSDN博客icon-default.png?t=N7T8https://blog.csdn.net/qq_62262918/article/details/135761392?spm=1001.2014.3001.5502

 直接发一次

 

 60内重复发送

连发5次

写在最后

对接阿里云短信服务实现短信验证码接口到这里就结束了，接口设计我尽可能简单并有一定安全性考虑。希望看完对你有帮助。后面我会出一篇仿百度云短信验证接口的设计实现（考虑更多防盗刷策略），欢迎大家订阅本专栏。任何问题评论区或私信讨论，欢迎指正。

这篇关于spring boot3登录开发-2(2短信验证码接口实现）的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！

原文地址:
本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.chinasem.cn/article/834025。

相关文章

Java如何根据word模板导出数据

Java如何根据word模板导出数据

《Java如何根据word模板导出数据》这篇文章主要为大家详细介绍了Java如何实现根据word模板导出数据,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... pom.XML文件导入依赖 <dependency> <groupId>cn.afterturn</groupId>
阅读更多...
利用Python实现可回滚方案的示例代码

利用Python实现可回滚方案的示例代码

《利用Python实现可回滚方案的示例代码》很多项目翻车不是因为不会做,而是走错了方向却没法回头,技术选型失败的风险我们都清楚,但真正能提前规划“回滚方案”的人不多,本文从实际项目出发,教你如何用Py... 目录描述题解答案（核心思路）题解代码分析第一步：抽象缓存接口第二步：实现两个版本第三步：根据 Fea
阅读更多...
Java应用如何防止恶意文件上传

Java应用如何防止恶意文件上传

《Java应用如何防止恶意文件上传》恶意文件上传可能导致服务器被入侵,数据泄露甚至服务瘫痪,因此我们必须采取全面且有效的防范措施来保护Java应用的安全,下面我们就来看看具体的实现方法吧... 目录恶意文件上传的潜在风险常见的恶意文件上传手段防范恶意文件上传的关键策略严格验证文件类型检查文件内容控制文件存储
阅读更多...
Go语言使用slices包轻松实现排序功能

Go语言使用slices包轻松实现排序功能

《Go语言使用slices包轻松实现排序功能》在Go语言开发中,对数据进行排序是常见的需求,Go1.18版本引入的slices包提供了简洁高效的排序解决方案,支持内置类型和用户自定义类型的排序操作,本... 目录一、内置类型排序：字符串与整数的应用1. 字符串切片排序2. 整数切片排序二、检查切片排序状态：
阅读更多...
浅析Java如何保护敏感数据

浅析Java如何保护敏感数据

《浅析Java如何保护敏感数据》在当今数字化时代,数据安全成为了软件开发中至关重要的课题,本文将深入探讨Java安全领域,聚焦于敏感数据保护的策略与实践,感兴趣的小伙伴可以了解下... 目录一、Java 安全的重要性二、敏感数据加密技术（一）对称加密（二）非对称加密三、敏感数据的访问控制（一）基于角色的访问
阅读更多...
python利用backoff实现异常自动重试详解

python利用backoff实现异常自动重试详解

《python利用backoff实现异常自动重试详解》backoff是一个用于实现重试机制的Python库,通过指数退避或其他策略自动重试失败的操作,下面小编就来和大家详细讲讲如何利用backoff实... 目录1. backoff 库简介2. on_exception 装饰器的原理2.1 核心逻辑2.2
阅读更多...
Java计算经纬度距离的示例代码

Java计算经纬度距离的示例代码

《Java计算经纬度距离的示例代码》在Java中计算两个经纬度之间的距离,可以使用多种方法（代码示例均返回米为单位）,文中整理了常用的5种方法,感兴趣的小伙伴可以了解一下... 目录1. Haversine公式（中等精度，推荐通用场景）2. 球面余弦定理（简单但精度较低）3. Vincenty公式（高精度，
阅读更多...
使用Java将实体类转换为JSON并输出到控制台的完整过程

使用Java将实体类转换为JSON并输出到控制台的完整过程

《使用Java将实体类转换为JSON并输出到控制台的完整过程》在软件开发的过程中,Java是一种广泛使用的编程语言,而在众多应用中,数据的传输和存储经常需要使用JSON格式,用Java将实体类转换为J... 在软件开发的过程中，Java是一种广泛使用的编程语言，而在众多应用中，数据的传输和存储经常需要使用j
阅读更多...
Java实现视频格式转换的完整指南

Java实现视频格式转换的完整指南

《Java实现视频格式转换的完整指南》在Java中实现视频格式的转换,通常需要借助第三方工具或库,因为视频的编解码操作复杂且性能需求较高,以下是实现视频格式转换的常用方法和步骤,需要的朋友可以参考下... 目录核心思路方法一：通过调用 FFmpeg 命令步骤示例代码说明优点方法二：使用 Jaffree（FF
阅读更多...
基于C#实现MQTT通信实战

基于C#实现MQTT通信实战

《基于C#实现MQTT通信实战》MQTT消息队列遥测传输,在物联网领域应用的很广泛,它是基于Publish/Subscribe模式,具有简单易用,支持QoS,传输效率高的特点,下面我们就来看看C#实现... 目录1、连接主机2、订阅消息3、发布消息MQTT(Message Queueing Telemetr
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2