可配置验证码功能
功能简介
可配置验证码功能允许您通过简单的配置文件设置来控制系统中验证码的使用。支持图片验证码和短信验证码的独立开关控制，满足不同环境和安全需求。
主要特性
- 🔧 灵活配置 - 通过配置文件控制验证码开关，无需修改代码
- 🔀 独立控制 - 图片验证码和短信验证码可以独立配置
- 🎯 默认友好 - 默认配置减少用户操作负担
- 🔄 实时生效 - 配置修改后刷新页面即可生效
- 📱 多场景支持 - 适用于登录、手机验证、密码重置等多个场景
支持的验证码类型
图片验证码
- 应用场景: 用户名密码登录
- 配置项:
enableImageCaptcha - 默认状态: 关闭
- 作用: 防止暴力破解，提高账户安全性
短信验证码
- 应用场景: 手机号登录、找回密码
- 配置项:
enableSmsCaptcha - 默认状态: 开启
- 作用: 验证手机号归属，增强身份验证
快速开始
1. 配置验证码开关
在 apps/admin/public/platform-config.json 文件中添加配置：
基础配置示例
json
{
"CaptchaConfig": {
"isImageCaptchaEnabled": false, // 是否启用图片验证码，默认false
"isSmsCaptchaEnabled": true, // 是否启用短信验证码，默认true
"isSystemCaptchaEnabled": true // 是否启用系统自带的前端验证码，默认true
}
}2. 刷新页面
修改配置后，刷新登录页面即可看到配置生效。
配置选项
| 配置项 | 类型 | 默认值 | 说明 |
|---|---|---|---|
enableImageCaptcha | boolean | false | 是否启用图片验证码 |
enableSmsCaptcha | boolean | true | 是否启用短信验证码 |
使用场景
开发环境
开发环境配置
json
{
"CaptchaConfig": {
"enableImageCaptcha": false,
"enableSmsCaptcha": false
}
}适用于开发调试，免去验证码输入的繁琐步骤。
测试环境
测试环境配置
json
{
"CaptchaConfig": {
"enableImageCaptcha": false,
"enableSmsCaptcha": true
}
}关闭图片验证码，保留短信验证码进行功能测试。
生产环境
生产环境配置
json
{
"CaptchaConfig": {
"enableImageCaptcha": true,
"enableSmsCaptcha": true
}
}开启全部验证码功能，保障系统安全。
内网部署
内网部署配置
json
{
"CaptchaConfig": {
"enableImageCaptcha": false,
"enableSmsCaptcha": false
}
}内网环境相对安全，可关闭验证码提升用户体验。
注意事项
配置生效
配置修改后需要刷新页面才能生效，建议在维护窗口进行配置调整。
安全考虑
在生产环境中，建议至少启用一种验证码功能以提高系统安全性。
兼容性
如果配置文件中没有相关配置项，系统将自动使用默认值，确保向前兼容。
技术实现
该功能基于组合式 API useConfigurableVerifyCode 实现，详细的技术文档和 API 说明请参考：
常见问题
Q: 修改配置后没有生效怎么办？
A: 请刷新页面，配置是在页面加载时读取的。
Q: 可以只在某个页面启用验证码吗？
A: 目前支持按验证码类型配置，如果需要更细粒度的控制，可以扩展配置选项。
Q: 验证码配置错误会影响系统运行吗？
A: 不会，系统具有完善的默认值机制，配置错误时会自动降级到默认配置。
贡献者
ruan-cat