fix: 优化代码注释与导入规范

This commit is contained in:
Ray.Hao
2026-06-26 00:33:39 +08:00
parent 6943f12d79
commit 2d249e449d
9 changed files with 36 additions and 15 deletions

View File

@@ -7,6 +7,12 @@ import lombok.Data;
import java.io.Serial; import java.io.Serial;
import java.io.Serializable; import java.io.Serializable;
/**
* 查询参数基类
*
* @author Ray.Hao
* @since 0.0.1
*/
@Data @Data
@Schema @Schema
public class BaseQuery implements Serializable { public class BaseQuery implements Serializable {

View File

@@ -7,13 +7,13 @@ import org.slf4j.helpers.MessageFormatter;
/** /**
* 自定义业务异常 * 自定义业务异常
* *
* @author Ray * @author Ray.Hao
* @since 2022/7/31 * @since 0.0.1
*/ */
@Getter @Getter
public class BusinessException extends RuntimeException { public class BusinessException extends RuntimeException {
public IResultCode resultCode; private IResultCode resultCode;
public BusinessException(IResultCode errorCode) { public BusinessException(IResultCode errorCode) {
super(errorCode.getMsg()); super(errorCode.getMsg());
@@ -21,7 +21,7 @@ public class BusinessException extends RuntimeException {
} }
public BusinessException(IResultCode errorCode,String message) { public BusinessException(IResultCode errorCode, String message) {
super(message); super(message);
this.resultCode = errorCode; this.resultCode = errorCode;
} }

View File

@@ -1,8 +1,8 @@
package com.youlai.boot.framework.security.config; package com.youlai.boot.framework.security.config;
import cn.binarywang.wx.miniapp.api.WxMaService; import cn.binarywang.wx.miniapp.api.WxMaService;
import com.youlai.boot.framework.captcha.service.CaptchaService;
import cn.hutool.core.util.ArrayUtil; import cn.hutool.core.util.ArrayUtil;
import com.youlai.boot.framework.captcha.service.CaptchaService;
import com.youlai.boot.framework.security.filter.CaptchaValidationFilter; import com.youlai.boot.framework.security.filter.CaptchaValidationFilter;
import com.youlai.boot.framework.security.filter.TokenAuthenticationFilter; import com.youlai.boot.framework.security.filter.TokenAuthenticationFilter;
import com.youlai.boot.framework.security.handler.MyAccessDeniedHandler; import com.youlai.boot.framework.security.handler.MyAccessDeniedHandler;

View File

@@ -28,6 +28,9 @@ import java.util.concurrent.Executor;
/** /**
* 操作日志切面 * 操作日志切面
* <p>@Log 标注的方法执行后异步写入 sys_log 表</p> * <p>@Log 标注的方法执行后异步写入 sys_log 表</p>
*
* @author Ray.Hao
* @since 0.0.1
*/ */
@Aspect @Aspect
@Component @Component
@@ -125,9 +128,17 @@ public class LogAspect {
return new IpRegion(StrUtil.blankToDefault(parts[2], null), StrUtil.blankToDefault(parts[3], null)); return new IpRegion(StrUtil.blankToDefault(parts[2], null), StrUtil.blankToDefault(parts[3], null));
} }
private String getOs(UserAgent ua) { return Optional.ofNullable(ua).map(UserAgent::getOs).map(os -> os.getName()).orElse(null); } private String getOs(UserAgent ua) {
private String getDevice(UserAgent ua) { return Optional.ofNullable(ua).map(UserAgent::getPlatform).map(p -> p.getName()).orElse(null); } return Optional.ofNullable(ua).map(UserAgent::getOs).map(os -> os.getName()).orElse(null);
private String getBrowser(UserAgent ua) { return Optional.ofNullable(ua).map(UserAgent::getBrowser).map(b -> b.getName()).orElse(null); } }
private String getDevice(UserAgent ua) {
return Optional.ofNullable(ua).map(UserAgent::getPlatform).map(p -> p.getName()).orElse(null);
}
private String getBrowser(UserAgent ua) {
return Optional.ofNullable(ua).map(UserAgent::getBrowser).map(b -> b.getName()).orElse(null);
}
private record IpRegion(String province, String city) { private record IpRegion(String province, String city) {
static final IpRegion EMPTY = new IpRegion(null, null); static final IpRegion EMPTY = new IpRegion(null, null);

View File

@@ -9,6 +9,11 @@ import java.util.concurrent.ThreadPoolExecutor;
/** /**
* 操作日志线程池 * 操作日志线程池
* <p>core=1 确保日志按序写入max=2 峰值扩容queue=1000 缓冲突发流量,
* CallerRunsPolicy 保证满载时由调用线程兜底执行不丢数据。</p>
*
* @author Ray.Hao
* @since 0.0.1
*/ */
@Configuration @Configuration
public class OperationLogExecutorConfig { public class OperationLogExecutorConfig {

View File

@@ -14,10 +14,9 @@ import com.youlai.boot.common.result.PageResult;
import com.youlai.boot.common.result.Result; import com.youlai.boot.common.result.Result;
import com.youlai.boot.common.util.ExcelUtils; import com.youlai.boot.common.util.ExcelUtils;
import com.youlai.boot.system.listener.UserImportListener; import com.youlai.boot.system.listener.UserImportListener;
import com.youlai.boot.system.model.vo.UserExportVO;
import com.youlai.boot.system.model.form.UserImportForm;
import com.youlai.boot.system.model.entity.SysUser;
import com.youlai.boot.system.model.form.*; import com.youlai.boot.system.model.form.*;
import com.youlai.boot.system.model.vo.UserExportVO;
import com.youlai.boot.system.model.entity.SysUser;
import com.youlai.boot.system.model.query.UserQuery; import com.youlai.boot.system.model.query.UserQuery;
import com.youlai.boot.system.model.vo.CurrentUserVO; import com.youlai.boot.system.model.vo.CurrentUserVO;
import com.youlai.boot.system.model.vo.UserPageVO; import com.youlai.boot.system.model.vo.UserPageVO;

View File

@@ -24,7 +24,7 @@ public class SysUser extends BaseEntity {
private String nickname; private String nickname;
/** /**
* 性别((1-男 2-女 0-保密) * 性别(1-男 2-女 0-保密)
*/ */
private Integer gender; private Integer gender;
@@ -49,7 +49,7 @@ public class SysUser extends BaseEntity {
private String mobile; private String mobile;
/** /**
* 状态((1-正常 0-禁用) * 状态(1-正常 0-禁用)
*/ */
private Integer status; private Integer status;

View File

@@ -22,13 +22,13 @@ import com.youlai.boot.framework.security.util.SecurityUtils;
import com.youlai.boot.system.converter.UserConverter; import com.youlai.boot.system.converter.UserConverter;
import com.youlai.boot.system.enums.DictCodeEnum; import com.youlai.boot.system.enums.DictCodeEnum;
import com.youlai.boot.system.mapper.UserMapper; import com.youlai.boot.system.mapper.UserMapper;
import com.youlai.boot.system.model.form.*;
import com.youlai.boot.system.model.vo.CurrentUserVO; import com.youlai.boot.system.model.vo.CurrentUserVO;
import com.youlai.boot.system.model.vo.UserExportVO; import com.youlai.boot.system.model.vo.UserExportVO;
import com.youlai.boot.system.model.entity.Dept; import com.youlai.boot.system.model.entity.Dept;
import com.youlai.boot.system.model.entity.DictItem; import com.youlai.boot.system.model.entity.DictItem;
import com.youlai.boot.system.model.entity.Role; import com.youlai.boot.system.model.entity.Role;
import com.youlai.boot.system.model.entity.SysUser; import com.youlai.boot.system.model.entity.SysUser;
import com.youlai.boot.system.model.form.*;
import com.youlai.boot.system.model.query.UserQuery; import com.youlai.boot.system.model.query.UserQuery;
import com.youlai.boot.system.model.vo.UserPageVO; import com.youlai.boot.system.model.vo.UserPageVO;
import com.youlai.boot.system.model.vo.UserProfileVO; import com.youlai.boot.system.model.vo.UserProfileVO;

View File

@@ -38,7 +38,7 @@
<maxFileSize>10MB</maxFileSize> <maxFileSize>10MB</maxFileSize>
<!-- 最大保留30天的日志 --> <!-- 最大保留30天的日志 -->
<maxHistory>30</maxHistory> <maxHistory>30</maxHistory>
<!-- 总日志文件大小不超过3GB --> <!-- 总日志文件大小不超过1GB -->
<totalSizeCap>1GB</totalSizeCap> <totalSizeCap>1GB</totalSizeCap>
</rollingPolicy> </rollingPolicy>
<!-- 临界值过滤器输出大于INFO级别日志 --> <!-- 临界值过滤器输出大于INFO级别日志 -->