当前位置：首页 > news >正文

RuoYi前后端分离框架集成手机短信验证码（一）之后端篇

news 来源：原创 2025/5/30 7:57:23

一、背景

本项目基于RuoYi 3.8.9前后端分离框架构建，采用Spring Security实现系统权限管理。作为企业级应用架构的子模块，系统需要与顶层项目实现用户数据无缝对接（以手机号作为统一用户标识），同时承担用户信息采集的重要职能。为此，我们在保留原有账号密码登录方式的基础上，创新性地集成了手机号验证码登录/注册功能，既满足了企业级用户管理的标准化需求，又优化了终端用户的使用体验。

二、短信集成

短信集成可以直接使用短信供应商的SDK，公司目前采购的阿里云短信，短信集成可以直接参照阿里云短信官方文档。当然也可以采用其他更通用一点的集成方式，本人秉持着不重复造轮子同时方便后期短信供应商的变更不再次添加供应商代码，直接采用开源的短信集成工具SM4J，需要了解的可以查看SMS4J官方文档，集成过程如下：

1.添加maven依赖，直接上最新的发布版本：

            <dependency><groupId>org.dromara.sms4j</groupId><artifactId>sms4j-spring-boot-starter</artifactId><version>3.3.5</version></dependency>

2.添加短信配置：

#短信配置
sms:# 标注从yml读取配置config-type: yamlHttpLog: truecorePoolSize: 2maxPoolSize: 6queueCapacity: 200blends:# 自定义的标识，也就是configId这里可以是任意值（最好不要是中文）alibaba:#框架定义的厂商名称标识supplier: alibaba#有些称为accessKey有些称之为apiKey，也有称为sdkKey或者appId。access-key-id: #称为accessSecret有些称之为apiSecret。access-key-secret:#您的短信签名signature: #模板ID 如果不需要简化的sendMessage方法可以不配置template-id: # 随机权重，负载均衡的权重值依赖于此，默认为1，如不需要负载均衡可不进行配置weight: 1#配置标识名称 如果你使用的yml进行配置，则blends下层配置的就是这个，可为空，如果你使用的接口类配置，则需要设置值#需要注意的是，不同的配置之间config-id不能重复，否则会发生配置丢失的问题config-id: alibaba#短信自动重试间隔时间  默认五秒retry-interval: 10# 短信重试次数，默认0次不重试，如果你需要短信重试则根据自己的需求修改值即可max-retries: 2

3.短信发送工具：

package com.book.framework.sms;import com.book.common.constant.CacheConstants;
import com.book.common.core.redis.RedisCache;
import lombok.extern.slf4j.Slf4j;
import org.dromara.sms4j.api.entity.SmsResponse;
import org.dromara.sms4j.core.factory.SmsFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;import java.util.LinkedHashMap;
import java.util.concurrent.ThreadLocalRandom;
import java.util.concurrent.TimeUnit;/*** @className: SmsService* @author: liuyh* @date: 2025/5/21 17:57* @Version: 1.0*/
@Slf4j
@Service
public class SmsService {/*** 短信服务提供商* {@value CONFIG_ID}*/private static final String CONFIG_ID = "alibaba";@Autowiredprivate RedisCache redisCache;/*** 发送短信** @param phoneNumber* @param message* @return*/public boolean sendSms(String phoneNumber, String message) {SmsResponse smsResponse = SmsFactory.getSmsBlend(CONFIG_ID).sendMessage(phoneNumber, message);boolean beSent = smsResponse.isSuccess();if (!beSent) {log.info("短信服务商错误响应原始消息体: {}", smsResponse.getData());}return beSent;}/*** 发送短信** @param phoneNumber* @param messages* @return*/public boolean sendSms(String phoneNumber, LinkedHashMap<String, String> messages) {SmsResponse smsResponse = SmsFactory.getSmsBlend(CONFIG_ID).sendMessage(phoneNumber, messages);boolean beSent = smsResponse.isSuccess();if (!beSent) {log.info("短信服务商错误响应原始消息体: {}", smsResponse.getData());}return smsResponse.isSuccess();}/*** 发送手机验证方法** @param phoneNumber* @return*/public boolean sendVerificationCode(String phoneNumber) {String code = this.generateAndStoreCode(phoneNumber);LinkedHashMap<String, String> messages = new LinkedHashMap<>();messages.put("code", code);return this.sendSms(phoneNumber, messages);}/*** 生成6位随机验证码并存入Redis* <br>* <b>默认5分钟过期</b>** @param phoneNumber 手机号* @return 生成的验证码*/private String generateAndStoreCode(Str