登录
一、登录接口
首先 new 了一个 AjaxResult 对象
调用 loginService 类的 login 方法 传入 username , password , code , uuid 四个参数,生成 token
将生成的 token ,放进 ajax 返回给前端
/**
* 登录方法
*
* @param loginBody 登录信息
* @return 结果
*/
@PostMapping("/login")
public AjaxResult login(@RequestBody LoginBody loginBody)
{
AjaxResult ajax = AjaxResult.success();
// 生成令牌
String token = loginService.login(
loginBody.getUsername(),
loginBody.getPassword(),
loginBody.getCode(),
loginBody.getUuid()
);
ajax.put(Constants.TOKEN, token);
return ajax;
}
1.1: login 方法
- 验证码的校验
- 登录的前置校验
- 用户验证
- 实现了用户登录认证的功能,并记录了详细的登录信息
/**
* 登录验证
*
* @param username 用户名
* @param password 密码
* @param code 验证码
* @param uuid 唯一标识
* @return 结果
*/
public String login(String username, String password, String code, String uuid)
{
// 验证码校验
validateCaptcha(username, code, uuid);
// 登录前置校验
loginPreCheck(username, password);
// 用户验证
Authentication authentication = null;
try
{
UsernamePasswordAuthenticationToken authenticationToken = new UsernamePasswordAuthenticationToken(username, password);
AuthenticationContextHolder.setContext(authenticationToken);
// 该方法会去调用UserDetailsServiceImpl.loadUserByUsername
authentication = authenticationManager.authenticate(authenticationToken);
}
catch (Exception e)
{
if (e instanceof BadCredentialsException)
{
AsyncManager.me().execute(AsyncFactory.recordLogininfor(username, Constants.LOGIN_FAIL, MessageUtils.message("user.password.not.match")));
throw new UserPasswordNotMatchException();
}
else
{
AsyncManager.me().execute(AsyncFactory.recordLogininfor(username, Constants.LOGIN_FAIL, e.getMessage()));
throw new ServiceException(e.getMessage());
}
}
finally
{
AuthenticationContextHolder.clearContext();
}
AsyncManager.me().execute(AsyncFactory.recordLogininfor(username, Constants.LOGIN_SUCCESS, MessageUtils.message("user.login.success")));
LoginUser loginUser = (LoginUser) authentication.getPrincipal();
recordLoginInfo(loginUser.getUserId());
// 生成token
return tokenService.createToken(loginUser);
}
1.1.1 验证码的校验
参数: 用户名 验证码 uuid
先通过 configService . selectCaptchaEnabled() 方法 获取到验证码的开关
然后从 redis 中获取相关 值 来查看验证码是否过期,是否 正确
/**
* 校验验证码
*
* @param username 用户名
* @param code 验证码
* @param uuid 唯一标识
* @return 结果
*/
public void validateCaptcha(String username, String code, String uuid)
{
boolean captchaEnabled = configService.selectCaptchaEnabled(); //true
if (captchaEnabled)
{
String verifyKey = CacheConstants.CAPTCHA_CODE_KEY + StringUtils.nvl(uuid, "");//captcha_codes:uuid
String captcha = redisCache.getCacheObject(verifyKey);//
if (captcha == null)
{
//user.jcaptcha.expire 验证码已失效
AsyncManager.me().execute(AsyncFactory.recordLogininfor(username, Constants.LOGIN_FAIL, MessageUtils.message("user.jcaptcha.expire")));
throw new CaptchaExpireException();
}
redisCache.deleteObject(verifyKey);
if (!code.equalsIgnoreCase(captcha))
{
//user.jcaptcha.error 验证码错误
AsyncManager.me().execute(AsyncFactory.recordLogininfor(username, Constants.LOGIN_FAIL, MessageUtils.message("user.jcaptcha.error")));
throw new CaptchaException();
}
}
}
1.1.2 登录前置校验
参数 : 用户名 密码
对用户名和密码的 长度,非空,黑名单进行校验
/**
* 登录前置校验
* @param username 用户名
* @param password 用户密码
*/
public void loginPreCheck(String username, String password)
{
// 用户名或密码为空 错误
if (StringUtils.isEmpty(username) || StringUtils.isEmpty(password))
{
AsyncManager.me().execute(AsyncFactory.recordLogininfor(username, Constants.LOGIN_FAIL, MessageUtils.message("not.null")));
throw new UserNotExistsException();
}
// 密码如果不在指定范围内 错误
if (password.length() < UserConstants.PASSWORD_MIN_LENGTH
|| password.length() > UserConstants.PASSWORD_MAX_LENGTH)
{
AsyncManager.me().execute(AsyncFactory.recordLogininfor(username, Constants.LOGIN_FAIL, MessageUtils.message("user.password.not.match")));
throw new UserPasswordNotMatchException();
}
// 用户名不在指定范围内 错误
if (username.length() < UserConstants.USERNAME_MIN_LENGTH
|| username.length() > UserConstants.USERNAME_MAX_LENGTH)
{
AsyncManager.me().execute(AsyncFactory.recordLogininfor(username, Constants.LOGIN_FAIL, MessageUtils.message("user.password.not.match")));
throw new UserPasswordNotMatchException();
}
// IP黑名单校验
String blackStr = configService.selectConfigByKey("sys.login.blackIPList");
if (IpUtils.isMatchedIp(blackStr, IpUtils.getIpAddr()))
{
AsyncManager.me().execute(AsyncFactory.recordLogininfor(username, Constants.LOGIN_FAIL, MessageUtils.message("login.blocked")));
throw new BlackListException();
}
}
1.1.3 用户认证功能
- 首先声明一个 Authentication 对象 ,用于存储认证结果
- 创建一个 UsernamePasswordAuthenticationToken 对象 , 来存储接收的用户名和密码, 作为认证的凭证
- 将创建的 authenticationToken 认证令牌 放到自定义的 容器中,这个同时也利用了 ThreadLocal 保证了上下文的一致性
- 利用 凭证 , 调用 authenticationManager.authenticate(authenticationToken) 方法 ,这个方法会调用 UserDetailsServiceImpl 的loadUserByUsername 方法来加载用户详细信息,并与用户输入的密码进行比对。如果认证成功,会返回一个包含认证信息的Authentication对象,赋值给authentication变量 。
// 用户验证
Authentication authentication = null;
try {
UsernamePasswordAuthenticationToken authenticationToken = new UsernamePasswordAuthenticationToken(username, password);
AuthenticationContextHolder.setContext(authenticationToken);
// 该方法会去调用UserDetailsServiceImpl.loadUserByUsername
authentication = authenticationManager.authenticate(authenticationToken);
}
catch (Exception e) {
if (e instanceof BadCredentialsException)
{
AsyncManager.me().execute(AsyncFactory.recordLogininfor(username, Constants.LOGIN_FAIL, MessageUtils.message("user.password.not.match")));
throw new UserPasswordNotMatchException();
}
else
{
AsyncManager.me().execute(AsyncFactory.recordLogininfor(username, Constants.LOGIN_FAIL, e.getMessage()));
throw new ServiceException(e.getMessage());
}
}
finally {
AuthenticationContextHolder.clearContext();
}
AsyncManager.me().execute(AsyncFactory.recordLogininfor(username, Constants.LOGIN_SUCCESS, MessageUtils.message("user.login.success")));
异常问题:
如果认证过程中抛出异常,会进入catch块。 if (e instanceof BadCredentialsException):检查异常是否为BadCredentialsException,如果是,说明用户输入的密码不正确。 AsyncManager . me() . execute(AsyncFactory.recordLogininfor(username,Constants . LOGIN_FAIL,MessageUtils . message("user.password.not.match")));:通过AsyncManager异步执行AsyncFactory的recordLogininfor方法,记录登录失败信息,包括用户名、失败状态和密码不匹配的提示信息。 throw new UserPasswordNotMatchException();:抛出UserPasswordNotMatchException自定义异常,通知上层调用者密码不匹配。 else:如果不是BadCredentialsException,说明是其他类型的异常。 AsyncManager.me().execute(AsyncFactory.recordLogininfor(username, Constants . LOGIN_FAIL, e.getMessage()));:同样通过异步方式记录登录失败信息,这次记录的是异常的具体消息。 throw new ServiceException(e.getMessage());:抛出ServiceException自定义异常,将异常消息传递给上层调用者。
**finally:**最后调用 AuthenticationContextHolder . clearContext(); 清楚线程 ,避免造成内存泄露或者安全问题
获取用户信息:
LoginUser loginUser = (LoginUser) authentication.getPrincipal();
authentication . getPrincipal():在 Spring Security 框架中,Authentication 对象的 getPrincipal() 方法用于获取与认证相关的主体信息。主体通常是代表已认证用户的对象,它可以包含用户的各种信息,如用户名、用户 ID、权限等。
1.1.4 记录登录信息
调用 recordLoginInfo () 方法,传入 user-id
- 通过得到当前登录用户的信息,拿到id之后,记录登录用户id
- 通过 IpUtils 类的 getIpAddr()方法 得到当前登录 ip
- 记录登录时间
- 更新用户
recordLoginInfo(loginUser.getUserId());
/**
* 记录登录信息
*
* @param userId 用户ID
*/
public void recordLoginInfo(Long userId)
{
SysUser sysUser = new SysUser();
sysUser.setUserId(userId);
sysUser.setLoginIp(IpUtils.getIpAddr());
sysUser.setLoginDate(DateUtils.getNowDate());
userService.updateUserProfile(sysUser);
}
1.1.5 返回 token
(代码中依赖了一些自定义的类和方法(如 IdUtils、ServletUtils、IpUtils、AddressUtils、redisCache 等),在实际应用中需要确保这些组件的正确性和完整性。)
通过 tokenService . createToken( loginUser ) ; 方法 传入 登录用户信息
// 生成token
return tokenService.createToken(loginUser);
首先通过 IdUtils . fastUUID(); 方法得到随机的uuid为token
将生成的令牌设置到 loginUser 当中
/**
* 创建令牌
*
* @param loginUser 用户信息
* @return 令牌
*/
public String createToken(LoginUser loginUser)
{
String token = IdUtils.fastUUID();
loginUser.setToken(token);
setUserAgent(loginUser);
refreshToken(loginUser);
Map<String, Object> claims = new HashMap<>();
claims.put(Constants.LOGIN_USER_KEY, token);
return createToken(claims);
}
1.1.5.1 设置代理信息
setUserAgent(loginUser);
/**
* 设置用户代理信息
*
* @param loginUser 登录信息
*/
public void setUserAgent(LoginUser loginUser)
{
UserAgent userAgent = UserAgent.parseUserAgentString(ServletUtils.getRequest().getHeader("User-Agent"));
String ip = IpUtils.getIpAddr();
loginUser.setIpaddr(ip);
loginUser.setLoginLocation(AddressUtils.getRealAddressByIP(ip));
loginUser.setBrowser(userAgent.getBrowser().getName());
loginUser.setOs(userAgent.getOperatingSystem().getName());
}
UserAgent . parseUserAgentString(ServletUtils.getRequest() . getHeader("User-Agent"));:使用 UserAgent 库解析 User - Agent 请求头,获取用户代理信息。ServletUtils . getRequest() 方法 是获取浏览器信息
给loginUser 设置 ip 、登录地点、浏览器类型 和 操作系统
1.1.5.2 刷新令牌有效期
refreshToken(loginUser);
/**
* 刷新令牌有效期
*
* @param loginUser 登录信息
*/
public void refreshToken(LoginUser loginUser)
{
loginUser.setLoginTime(System.currentTimeMillis());
loginUser.setExpireTime(loginUser.getLoginTime() + expireTime * MILLIS_MINUTE);
// 根据uuid将loginUser缓存
String userKey = getTokenKey(loginUser.getToken());
redisCache.setCacheObject(userKey, loginUser, expireTime, TimeUnit.MINUTES);
}
// 令牌有效期(默认30分钟)
@Value("${token.expireTime}")
private int expireTime;
通过 System.currentTimeMillis() 设置 当前时间 为登陆时间
设置过期时间,30 分钟
设置 redis 中的 键 将 loginUser 在 redis 中缓存
1.1.5.3 生成 token 返回
Map<String, Object> claims = new HashMap<>();
claims.put(Constants.LOGIN_USER_KEY, token); //login_user_key , token
return createToken(claims);
/**
* 从数据声明生成令牌
*
* @param claims 数据声明
* @return 令牌
*/
private String createToken(Map<String, Object> claims) ////login_user_key , token
{
String token = Jwts.builder()
.setClaims(claims)
.signWith(SignatureAlgorithm.HS512, secret).compact();
return token;
}
// 令牌秘钥
@Value("${token.secret}")
private String secret;
- String token = Jwts.builder():开始构建 JWT 令牌。
- .setClaims(claims):将传入的声明设置到 JWT 中。
- .signWith (SignatureAlgorithm.HS512, secret):使用 HS512 签名算法和一个密钥 secret(应该是在其他地方定义的常量)对 JWT 进行签名。
- .compact();:生成紧凑的 JWT 字符串。
- return token;:返回生成的 JWT 令牌。
2.1验证码图像生成
@Resource(name = "captchaProducer")
private Producer captchaProducer;
@Resource(name = "captchaProducerMath")
private Producer captchaProducerMath;
@Autowired
private RedisCache redisCache;
@Autowired
private ISysConfigService configService;
/**
* 生成验证码
*/
@GetMapping("/captchaImage")
public AjaxResult getCode(HttpServletResponse response) throws IOException
{
AjaxResult ajax = AjaxResult.success();
boolean captchaEnabled = configService.selectCaptchaEnabled(); // 是否开启验证码开关 true/false
ajax.put("captchaEnabled", captchaEnabled);
if (!captchaEnabled)
{
return ajax;
}
// 保存验证码信息
String uuid = IdUtils.simpleUUID();
String verifyKey = CacheConstants.CAPTCHA_CODE_KEY + uuid;
String capStr = null,
code = null;
BufferedImage image = null;
// 生成验证码
String captchaType = RuoYiConfig.getCaptchaType();
if ("math".equals(captchaType))
{
String capText = captchaProducerMath.createText();
capStr = capText.substring(0, capText.lastIndexOf("@"));
code = capText.substring(capText.lastIndexOf("@") + 1);
image = captchaProducerMath.createImage(capStr);
}
else if ("char".equals(captchaType))
{
capStr = code = captchaProducer.createText();
image = captchaProducer.createImage(capStr);
}
redisCache.setCacheObject(verifyKey, code, Constants.CAPTCHA_EXPIRATION, TimeUnit.MINUTES);
// 转换流信息写出
FastByteArrayOutputStream os = new FastByteArrayOutputStream();
try
{
ImageIO.write(image, "jpg", os);
}
catch (IOException e)
{
return AjaxResult.error(e.getMessage());
}
ajax.put("uuid", uuid);
ajax.put("img", Base64.encode(os.toByteArray()));
return ajax;
}
2.1.1 生成返回 结果对象
AjaxResult ajax = AjaxResult.success();
2.1.2 验证验证码开关是否开启
- 通过 configService . selectCaptchaEnabled(); 方法 获取验证码开关
- 将 结果放进 结果对象中
- 如果是关的 , 直接 返回 ajax
boolean captchaEnabled = configService.selectCaptchaEnabled(); // 是否开启验证码开关 true/false
ajax.put("captchaEnabled", captchaEnabled);
if (!captchaEnabled)
{
return ajax;
}
2.1.3 保存验证码信息
- 利用 IdUtils . simpleUUID(); 生成 uuid
- verifyKey 是用于在缓存中存储验证码的键,由固定前缀 CacheConstants . CAPTCHA _CODE_KEY 和 uuid 组成。
- 声明了用于存储验证码字符串部分(capStr)、验证码答案(code)和验证码图片(BufferedImage类型的image)的变量。
// 保存验证码信息
String uuid = IdUtils.simpleUUID();
String verifyKey = CacheConstants.CAPTCHA_CODE_KEY + uuid; //captcha_codes: uuid
String capStr = null , code = null;
BufferedImage image = null;
2.1.4 生成验证码并写入缓存之中
// 生成验证码
String captchaType = RuoYiConfig.getCaptchaType(); //math 数字计算 char 字符验证
if ("math".equals(captchaType))
{
String capText = captchaProducerMath.createText();
capStr = capText.substring(0, capText.lastIndexOf("@"));
code = capText.substring(capText.lastIndexOf("@") + 1);
image = captchaProducerMath.createImage(capStr);
}
else if ("char".equals(captchaType))
{
capStr = code = captchaProducer.createText();
image = captchaProducer.createImage(capStr);
}
redisCache.setCacheObject(verifyKey, code, Constants.CAPTCHA_EXPIRATION, TimeUnit.MINUTES);
# 项目相关配置
ruoyi:
# 名称
name: RuoYi
# 版本
version: 3.8.9
# 版权年份
copyrightYear: 2025
# 文件路径 示例( Windows配置D:/ruoyi/uploadPath,Linux配置 /home/ruoyi/uploadPath)
profile: D:/ruoyi/uploadPath
# 获取ip地址开关
addressEnabled: false
# 验证码类型 math 数字计算 char 字符验证
captchaType: math
RuoYiConfig
@Component
@ConfigurationProperties(prefix = "ruoyi")
public class RuoYiConfig
{
/** 项目名称 */
private String name;
/** 版本 */
private String version;
/** 版权年份 */
private String copyrightYear;
/** 上传路径 */
private static String profile;
/** 获取地址开关 */
private static boolean addressEnabled;
/** 验证码类型 */
private static String captchaType;
}
2.1.4.1 数字类型验证码
调用 captchaProducerMath.createText() 生成包含数学运算和答案的文本,将运算部分截取到capStr,答案部分截取到code,然后使用captchaProducerMath . createImage(capStr)生成对应的验证码图片。
if ("math".equals(captchaType))
{
String capText = captchaProducerMath.createText();
capStr = capText.substring(0, capText.lastIndexOf("@"));
code = capText.substring(capText.lastIndexOf("@") + 1);
image = captchaProducerMath.createImage(capStr);
}
2.1.4.2 字符类型验证码
调用captchaProducer . createText()生成字符验证码字符串,同时赋值给capStr和code,再使用captchaProducer . createImage(capStr)生成验证码图片。
else if ("char".equals(captchaType))
{
capStr = code = captchaProducer.createText();
image = captchaProducer.createImage(capStr);
}
2.1.4.3 缓存验证码
键为 verifyKey 值为 code 过期时间为 2 分钟
redisCache.setCacheObject(verifyKey, code, Constants.CAPTCHA_EXPIRATION, TimeUnit.MINUTES);
/**
* 验证码有效期(分钟)
*/
public static final Integer CAPTCHA_EXPIRATION = 2;
2.1.5 转换流 写出
- 使用FastByteArrayOutputStream将验证码图片以 jpg 格式写入字节流。
- 将uuid和字节流的 Base64 编码(代表验证码图片)放入ajax对象中并返回。
- 客户端可以使用uuid和 Base64 编码的图片数据进行验证码验证。
// 转换流信息写出
FastByteArrayOutputStream os = new FastByteArrayOutputStream();
try
{
ImageIO.write(image, "jpg", os);
}
catch (IOException e)
{
return AjaxResult.error(e.getMessage());
}
ajax.put("uuid", uuid);
ajax.put("img", Base64.encode(os.toByteArray()));
return ajax;
这里使用 FastByteArrayOutputStream 是为了将生成的验证码图片(BufferedImage 类型的 image)以 JPEG 格式写入到字节数组中。后续通过 os.toByteArray() 获取字节数组,并将其进行 Base64 编码后返回给前端,用于在网页上显示验证码图片。其高效的数据写入特性有助于快速生成和处理验证码图片数据。
2.1.5 验证码配置
只要这个配置类在 Spring 的扫描路径下,它所定义的 Bean 及其配置就会在应用运行过程中对验证码的生成起到作用。
/**
* 验证码配置
*
* @author ruoyi
*/
@Configuration
public class CaptchaConfig
{
@Bean(name = "captchaProducer")
public DefaultKaptcha getKaptchaBean()
{
DefaultKaptcha defaultKaptcha = new DefaultKaptcha();
Properties properties = new Properties();
// 是否有边框 默认为true 我们可以自己设置yes,no
properties.setProperty(KAPTCHA_BORDER, "yes");
// 验证码文本字符颜色 默认为Color.BLACK
properties.setProperty(KAPTCHA_TEXTPRODUCER_FONT_COLOR, "black");
// 验证码图片宽度 默认为200
properties.setProperty(KAPTCHA_IMAGE_WIDTH, "160");
// 验证码图片高度 默认为50
properties.setProperty(KAPTCHA_IMAGE_HEIGHT, "60");
// 验证码文本字符大小 默认为40
properties.setProperty(KAPTCHA_TEXTPRODUCER_FONT_SIZE, "38");
// KAPTCHA_SESSION_KEY
properties.setProperty(KAPTCHA_SESSION_CONFIG_KEY, "kaptchaCode");
// 验证码文本字符长度 默认为5
properties.setProperty(KAPTCHA_TEXTPRODUCER_CHAR_LENGTH, "4");
// 验证码文本字体样式 默认为new Font("Arial", 1, fontSize), new Font("Courier", 1, fontSize)
properties.setProperty(KAPTCHA_TEXTPRODUCER_FONT_NAMES, "Arial,Courier");
// 图片样式 水纹com.google.code.kaptcha.impl.WaterRipple 鱼眼com.google.code.kaptcha.impl.FishEyeGimpy 阴影com.google.code.kaptcha.impl.ShadowGimpy
properties.setProperty(KAPTCHA_OBSCURIFICATOR_IMPL, "com.google.code.kaptcha.impl.ShadowGimpy");
Config config = new Config(properties);
defaultKaptcha.setConfig(config);
return defaultKaptcha;
}
@Bean(name = "captchaProducerMath")
public DefaultKaptcha getKaptchaBeanMath()
{
DefaultKaptcha defaultKaptcha = new DefaultKaptcha();
Properties properties = new Properties();
// 是否有边框 默认为true 我们可以自己设置yes,no
properties.setProperty(KAPTCHA_BORDER, "yes");
// 边框颜色 默认为Color.BLACK
properties.setProperty(KAPTCHA_BORDER_COLOR, "105,179,90");
// 验证码文本字符颜色 默认为Color.BLACK
properties.setProperty(KAPTCHA_TEXTPRODUCER_FONT_COLOR, "blue");
// 验证码图片宽度 默认为200
properties.setProperty(KAPTCHA_IMAGE_WIDTH, "160");
// 验证码图片高度 默认为50
properties.setProperty(KAPTCHA_IMAGE_HEIGHT, "60");
// 验证码文本字符大小 默认为40
properties.setProperty(KAPTCHA_TEXTPRODUCER_FONT_SIZE, "35");
// KAPTCHA_SESSION_KEY
properties.setProperty(KAPTCHA_SESSION_CONFIG_KEY, "kaptchaCodeMath");
// 验证码文本生成器
properties.setProperty(KAPTCHA_TEXTPRODUCER_IMPL, "com.ruoyi.framework.config.KaptchaTextCreator");
// 验证码文本字符间距 默认为2
properties.setProperty(KAPTCHA_TEXTPRODUCER_CHAR_SPACE, "3");
// 验证码文本字符长度 默认为5
properties.setProperty(KAPTCHA_TEXTPRODUCER_CHAR_LENGTH, "6");
// 验证码文本字体样式 默认为new Font("Arial", 1, fontSize), new Font("Courier", 1, fontSize)
properties.setProperty(KAPTCHA_TEXTPRODUCER_FONT_NAMES, "Arial,Courier");
// 验证码噪点颜色 默认为Color.BLACK
properties.setProperty(KAPTCHA_NOISE_COLOR, "white");
// 干扰实现类
properties.setProperty(KAPTCHA_NOISE_IMPL, "com.google.code.kaptcha.impl.NoNoise");
// 图片样式 水纹com.google.code.kaptcha.impl.WaterRipple 鱼眼com.google.code.kaptcha.impl.FishEyeGimpy 阴影com.google.code.kaptcha.impl.ShadowGimpy
properties.setProperty(KAPTCHA_OBSCURIFICATOR_IMPL, "com.google.code.kaptcha.impl.ShadowGimpy");
Config config = new Config(properties);
defaultKaptcha.setConfig(config);
return defaultKaptcha;
}
}