从零用java实现 小红书 springboot vue uniapp(14) 集成阿里云短信验证码
移动端演示 http://8.146.211.120:8081/#/
管理端演示 http://8.146.211.120:8088/#/
项目整体介绍及演示
前言
在现代应用中,手机号不仅是用户的唯一标识,更是保障账户安全的第一道防线。通过短信验证码进行登录或注册,已成为行业标准。它省去了用户记忆复杂密码的麻烦,同时提供了可靠的身份验证。在本文中,我们将为我们的小红书项目集成阿里云短信服务,实现一个完整、安全、且对开发者友好的手机验证码登录流程。
核心技术实现
整个流程分为后端和前端两部分。后端负责生成验证码、调用阿里云接口发送短信、以及校验验证码的有效性。前端则负责提供用户界面,引导用户输入手机号并完成验证。
1. 后端实现:从配置到接口
步骤一:引入阿里云SDK依赖
首先,我们需要在项目的 pom.xml
中加入阿里云短信服务的Java SDK。
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>dysmsapi20170525</artifactId>
<version>2.0.24</version> <!-- 请使用最新版本 -->
</dependency>
步骤二:参数化配置
为了代码的灵活性和安全性,我们将所有敏感信息和配置项都放入 application.yml
中。这样做的好处是,我们可以在不同环境(开发、测试、生产)中使用不同的配置,而无需修改代码。
# 阿里云短信服务
aliyun:
sms:
# 是否启用真实短信发送, false则为测试模式
enabled: false
# 阿里云账号的accessKeyId
access-key-id: YOUR_ACCESS_KEY_ID
# 阿里云账号的accessKeySecret
access-key-secret: YOUR_ACCESS_KEY_SECRET
# 短信签名名称 (需在阿里云控制台申请)
sign-name: 你的签名
# 短信模板CODE (需在阿里云控制台申请)
template-code: SMS_XXXXXX
# 短信验证码有效期(分钟)
expire-minutes: 1
enabled
: 这是一个非常有用的开关。当设为false
时,系统进入“测试模式”,验证码会直接在接口中返回,而不会真实发送,方便开发调试。access-key-id
&access-key-secret
: 你的阿里云账户凭证。sign-name
&template-code
: 在阿里云短信服务控制台创建的短信签名和模板。
步骤三:封装短信发送服务
接下来,我们创建一个 SmsServiceImpl
,它将负责所有与发送短信相关的逻辑。这种封装能让我们的业务代码(如登录逻辑)保持干净,只需调用一个简单的方法即可。
SmsServiceImpl.java
:
@Slf4j
@Service
public class SmsServiceImpl implements SmsService {
@Autowired
private SmsProperties smsProperties;
@Autowired
private AliyunSmsConfig aliyunSmsConfig;
@Autowired
private SystemSettingService systemSettingService; // 用于获取系统设置
@Override
public void sendMessage(String phoneNumber, String code) throws Exception {
// 从系统设置或配置中获取当前的模式
// String smsMode = systemSettingService.getSmsMode();
// 此处我们直接使用yml中的配置
boolean isRealMode = smsProperties.isEnabled();
if (!isRealMode) {
// 测试模式:只记录日志,不真实发送
log.info("【测试模式】短信发送 - 手机号: {}, 验证码: {}", phoneNumber, code);
return;
}
try {
log.info("【真实模式】开始发送短信 - 手机号: {}, 验证码: {}", phoneNumber, code);
Client client = aliyunSmsConfig.createClient();
Map<String, String> templateParamMap = new HashMap<>();
templateParamMap.put("code", code); // 模板参数,key必须与模板中的变量名一致
String templateParam = JSON.toJSONString(templateParamMap);
SendSmsRequest sendSmsRequest = new SendSmsRequest()
.setPhoneNumbers(phoneNumber)
.setSignName(smsProperties.getSignName())
.setTemplateCode(smsProperties.getTemplateCode())
.setTemplateParam(templateParam);
RuntimeOptions runtime = new RuntimeOptions();
SendSmsResponse sendSmsResponse = client.sendSmsWithOptions(sendSmsRequest, runtime);
log.info("短信发送结果: {}", sendSmsResponse.getBody().getMessage());
if (sendSmsResponse.getBody() == null || !"OK".equals(sendSmsResponse.getBody().getCode())) {
throw new ApiException("短信发送失败: " +
(sendSmsResponse.getBody() != null ? sendSmsResponse.getBody().getMessage() : "未知错误"));
}
} catch (Exception e) {
log.error("短信发送异常", e);
throw new ApiException("短信发送异常: " + e.getMessage());
}
}
}
该服务通过检查 aliyun.sms.enabled
的值来决定是打印日志(测试模式)还是调用阿里云API(真实模式)。
步骤四:创建登录接口
最后,我们在 LoginApi
中创建两个端点:一个用于获取验证码,另一个用于通过验证码登录。
LoginApi.java
:
@RestController
public class LoginApi {
@Autowired
LoginService loginService;
@Autowired
AuthorService authorService;
@Autowired
private JwtTokenUtil jwtTokenUtil;
@ApiOperation(value = "获取验证码")
@GetMapping("/api/getCode")
public ResultBean<String> getCode(String phoneNumber) {
// loginService 内部会生成验证码、存入Redis、并调用SmsService发送
String code = loginService.sendSmsCode(phoneNumber);
if (code == null) {
// 真实模式下,service层返回null,提示用户
return ResultBean.success("验证码已发送,请注意查收");
}
// 测试模式下,service层返回验证码,直接显示给前端
return ResultBean.success(code);
}
@ApiOperation(value = "验证码登陆")
@PostMapping("/api/checkCode")
@Transactional
public ResultBean<Author> checkCode(@RequestBody PhoneLoginDto phoneLoginDto) {
// 1. 校验验证码是否正确 (loginService会去Redis中比对)
loginService.checkCode(phoneLoginDto);
// 2. 验证通过,执行登录或注册逻辑
Author author = authorService.selectAuthorByPhoneNumber(phoneLoginDto.getPhoneNumber());
if(author == null){
// 用户不存在,创建新用户
author = authorService.createNewAuthor(phoneLoginDto.getPhoneNumber());
} else if(author.getDeleted().equals(1)){
throw new ApiException("当前用户状态异常~");
}
// 3. 生成Token并返回用户信息
final String token = jwtTokenUtil.generateTokenByUserId(author.getAuthorId());
author.setToken(token);
return ResultBean.success(author);
}
}
/api/getCode
: 这个接口的设计完美地结合了测试与真实模式。在开发阶段,我们能立刻看到验证码,极大提高了调试效率。/api/checkCode
: 它首先验证验证码的正确性,然后执行“查找或创建”用户的逻辑,最后签发JWT令牌,完成整个登录闭环。
主要逻辑是将验证码保存到redis 设置过期时间 到期重新发送 根据输入的值和redis数据库比较
2. 前端交互:Uniapp 实现
前端的实现相对直接,主要是在登录页面 login.vue
中完成。
- UI布局: 包含一个手机号输入框、一个“获取验证码”按钮和一个“登录”按钮。
- 获取验证码:
- 点击“获取验证码”按钮时,调用后端的
/api/getCode
接口。 - 接口调用成功后,启动一个60秒的倒计时,期间按钮变为不可点击状态,防止用户重复发送。
- 点击“获取验证码”按钮时,调用后端的
- 登录:
- 用户输入手机号和收到的验证码后,点击“登录”按钮。
- 调用后端的
/api/checkCode
接口,并传递手机号和验证码。 - 登录成功后,后端会返回用户信息和
Token
。前端需要将这些信息(特别是Token
)保存到本地存储(如uni.setStorageSync
),并跳转到应用主页。
通过前后端的紧密配合,我们就构建了一个完整且健壮的短信验证码登录功能。