refactor: 优化登录验证码开关代码

This commit is contained in:
2024-12-05 19:29:29 +08:00
parent f3936fa198
commit 61fe39d439
8 changed files with 72 additions and 60 deletions

View File

@@ -18,9 +18,7 @@ package top.continew.admin.auth.model.req;
import io.swagger.v3.oas.annotations.media.Schema;
import jakarta.validation.constraints.NotBlank;
import jakarta.validation.constraints.NotNull;
import lombok.Data;
import org.checkerframework.checker.units.qual.N;
import java.io.Serial;
import java.io.Serializable;
@@ -52,20 +50,15 @@ public class AccountLoginReq implements Serializable {
@NotBlank(message = "密码不能为空")
private String password;
@Schema(description = "是否开启验证码", example = "true")
private Boolean unCaptcha;
/**
* 验证码
*/
@Schema(description = "验证码", example = "ABCD")
// @NotBlank(message = "验证码不能为空")
private String captcha;
/**
* 验证码标识
*/
@Schema(description = "验证码标识", example = "090b9a2c-1691-4fca-99db-e4ed0cff362f")
// @NotBlank(message = "验证码标识不能为空")
private String uuid;
}

View File

@@ -54,4 +54,22 @@ public class CaptchaResp implements Serializable {
*/
@Schema(description = "过期时间戳", example = "1714376969409")
private Long expireTime;
/**
* 是否启用
*/
@Schema(description = "是否启用", example = "true")
private Boolean isEnabled;
/**
* 构建验证码信息
*
* @param uuid 验证码标识
* @param img 验证码图片Base64编码带图片格式data:image/gif;base64
* @param expireTime 过期时间戳
* @return 验证码信息
*/
public static CaptchaResp of(String uuid, String img, Long expireTime) {
return CaptchaResp.builder().uuid(uuid).img(img).expireTime(expireTime).isEnabled(true).build();
}
}

View File

@@ -40,7 +40,7 @@ public enum OptionCategoryEnum {
MAIL,
/**
* 验证码配置
* 登录配置
*/
CAPTCHA,
LOGIN,
}

View File

@@ -117,6 +117,7 @@ public class FileDO extends BaseDO {
* 例如:
* http://domain.cn/bucketName/2024/11/27/6746ec3b2907f0de80afdd70.png => 2024/11/27/
* http://bucketName.domain.cn/2024/11/27/6746ec3b2907f0de80afdd70.png => 2024/11/27/
*
* @param url 文件路径
* @param storageDO 存储桶信息
* @return
@@ -130,9 +131,7 @@ public class FileDO extends BaseDO {
// 提取 URL 中的路径部分
String fullPath = new URL(url).getPath();
// 移除开头的斜杠
String relativePath = fullPath.startsWith(StringConstants.SLASH)
? fullPath.substring(1)
: fullPath;
String relativePath = fullPath.startsWith(StringConstants.SLASH) ? fullPath.substring(1) : fullPath;
// 如果路径以 bucketName 开头,则移除 bucketName 例如: bucketName/2024/11/27/ -> 2024/11/27/
if (relativePath.startsWith(storageDO.getBucketName())) {
return StrUtil.split(relativePath, storageDO.getBucketName()).get(1);

View File

@@ -35,10 +35,12 @@ import top.continew.admin.auth.model.resp.RouteResp;
import top.continew.admin.auth.model.resp.UserInfoResp;
import top.continew.admin.auth.service.LoginService;
import top.continew.admin.common.constant.CacheConstants;
import top.continew.admin.common.constant.SysConstants;
import top.continew.admin.common.context.UserContext;
import top.continew.admin.common.context.UserContextHolder;
import top.continew.admin.common.util.SecureUtils;
import top.continew.admin.system.model.resp.user.UserDetailResp;
import top.continew.admin.system.service.OptionService;
import top.continew.admin.system.service.UserService;
import top.continew.starter.cache.redisson.util.RedisUtils;
import top.continew.starter.core.util.ExceptionUtils;
@@ -62,6 +64,7 @@ public class AuthController {
private static final String CAPTCHA_EXPIRED = "验证码已失效";
private static final String CAPTCHA_ERROR = "验证码错误";
private final OptionService optionService;
private final LoginService loginService;
private final UserService userService;
@@ -69,7 +72,11 @@ public class AuthController {
@Operation(summary = "账号登录", description = "根据账号和密码进行登录认证")
@PostMapping("/account")
public LoginResp accountLogin(@Validated @RequestBody AccountLoginReq loginReq, HttpServletRequest request) {
if (!loginReq.getUnCaptcha()) {
// 校验验证码
int loginCaptchaEnabled = optionService.getValueByCode2Int("LOGIN_CAPTCHA_ENABLED");
if (SysConstants.YES.equals(loginCaptchaEnabled)) {
ValidationUtils.throwIfBlank(loginReq.getCaptcha(), "验证码不能为空");
ValidationUtils.throwIfBlank(loginReq.getUuid(), "验证码标识不能为空");
String captchaKey = CacheConstants.CAPTCHA_KEY_PREFIX + loginReq.getUuid();
String captcha = RedisUtils.get(captchaKey);
ValidationUtils.throwIfBlank(captcha, CAPTCHA_EXPIRED);

View File

@@ -45,9 +45,10 @@ import org.redisson.api.RateIntervalUnit;
import org.springframework.http.HttpHeaders;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;
import top.continew.admin.auth.model.resp.CaptchaResp;
import top.continew.admin.common.config.properties.CaptchaProperties;
import top.continew.admin.common.constant.CacheConstants;
import top.continew.admin.auth.model.resp.CaptchaResp;
import top.continew.admin.common.constant.SysConstants;
import top.continew.admin.system.enums.OptionCategoryEnum;
import top.continew.admin.system.service.OptionService;
import top.continew.starter.cache.redisson.util.RedisUtils;
@@ -88,15 +89,6 @@ public class CaptchaController {
private final GraphicCaptchaService graphicCaptchaService;
private final OptionService optionService;
@Log(ignore = true)
@Operation(summary = "获取验证码配置", description = "获取验证码配置(预留后续扩展多种验证码)")
@GetMapping("/config")
public R getCaptchaConfig() {
Map<String, String> captchaConfig = optionService.getByCategory(OptionCategoryEnum.CAPTCHA);
return R.ok(captchaConfig);
}
@Log(ignore = true)
@Operation(summary = "获取行为验证码", description = "获取行为验证码Base64编码")
@GetMapping("/behavior")
@@ -120,13 +112,17 @@ public class CaptchaController {
@Operation(summary = "获取图片验证码", description = "获取图片验证码Base64编码带图片格式data:image/gif;base64")
@GetMapping("/image")
public CaptchaResp getImageCaptcha() {
int loginCaptchaEnabled = optionService.getValueByCode2Int("LOGIN_CAPTCHA_ENABLED");
if (SysConstants.NO.equals(loginCaptchaEnabled)) {
return CaptchaResp.builder().isEnabled(false).build();
}
String uuid = IdUtil.fastUUID();
String captchaKey = CacheConstants.CAPTCHA_KEY_PREFIX + uuid;
Captcha captcha = graphicCaptchaService.getCaptcha();
long expireTime = LocalDateTimeUtil.toEpochMilli(LocalDateTime.now()
.plusMinutes(captchaProperties.getExpirationInMinutes()));
RedisUtils.set(captchaKey, captcha.text(), Duration.ofMinutes(captchaProperties.getExpirationInMinutes()));
return CaptchaResp.builder().uuid(uuid).img(captcha.toBase64()).expireTime(expireTime).build();
return CaptchaResp.of(uuid, captcha.toBase64(), expireTime);
}
/**

View File

@@ -142,9 +142,8 @@ VALUES
(18, 'MAIL', '用户名', 'MAIL_USERNAME', NULL, 'charles7c@126.com', NULL, NULL, NULL),
(19, 'MAIL', '密码', 'MAIL_PASSWORD', NULL, NULL, NULL, NULL, NULL),
(20, 'MAIL', '是否启用SSL', 'MAIL_SSL_ENABLED', NULL, '1', NULL, NULL, NULL),
(21, 'MAIL', 'SSL端口', 'MAIL_SSL_PORT', NULL, '465', NULL, NULL, NULL);
(22, 'CAPTCHA', '是否启验证码', 'NEED_CAPTCHA', '1', '1', '是否启验证码1开启 0关闭', 1, '2024-12-04 16:19:58');
(21, 'MAIL', 'SSL端口', 'MAIL_SSL_PORT', NULL, '465', NULL, NULL, NULL),
(22, 'LOGIN', '是否启验证码', 'LOGIN_CAPTCHA_ENABLED', NULL, '1', '是否启验证码10', NULL, NULL);
-- 初始化默认字典
INSERT INTO `sys_dict`

View File

@@ -142,8 +142,8 @@ VALUES
(18, 'MAIL', '用户名', 'MAIL_USERNAME', NULL, 'charles7c@126.com', NULL, NULL, NULL),
(19, 'MAIL', '密码', 'MAIL_PASSWORD', NULL, NULL, NULL, NULL, NULL),
(20, 'MAIL', '是否启用SSL', 'MAIL_SSL_ENABLED', NULL, '1', NULL, NULL, NULL),
(21, 'MAIL', 'SSL端口', 'MAIL_SSL_PORT', NULL, '465', NULL, NULL, NULL);
(22, 'CAPTCHA', '是否启验证码', 'NEED_CAPTCHA', '1', '1', '是否启验证码1开启 0关闭', 1, '2024-12-04 16:19:58');
(21, 'MAIL', 'SSL端口', 'MAIL_SSL_PORT', NULL, '465', NULL, NULL, NULL),
(22, 'LOGIN', '是否启验证码', 'LOGIN_CAPTCHA_ENABLED', NULL, '1', '是否启验证码10', NULL, NULL);
-- 初始化默认字典
INSERT INTO "sys_dict"