docs 补充项目注释

This commit is contained in:
AprilWind
2026-06-01 13:58:13 +08:00
parent 107d3326b4
commit e49f3b2260
94 changed files with 2328 additions and 68 deletions
@@ -37,23 +37,51 @@ public class MetaVo {
*/
private String activeMenu;
/**
* 构造路由显示信息。
*
* @param title 路由标题
* @param icon 路由图标
*/
public MetaVo(String title, String icon) {
this.title = title;
this.icon = icon;
}
/**
* 构造路由显示信息。
*
* @param title 路由标题
* @param icon 路由图标
* @param noCache 是否不缓存
*/
public MetaVo(String title, String icon, Boolean noCache) {
this.title = title;
this.icon = icon;
this.noCache = noCache;
}
/**
* 构造带内链地址的路由显示信息。
*
* @param title 路由标题
* @param icon 路由图标
* @param link 内链地址
*/
public MetaVo(String title, String icon, String link) {
this.title = title;
this.icon = icon;
this.link = link;
}
/**
* 构造带缓存配置和内链地址的路由显示信息。
*
* @param title 路由标题
* @param icon 路由图标
* @param noCache 是否不缓存
* @param link 内链地址
*/
public MetaVo(String title, String icon, Boolean noCache, String link) {
this.title = title;
this.icon = icon;
@@ -63,6 +91,15 @@ public class MetaVo {
}
}
/**
* 构造带激活菜单的路由显示信息。
*
* @param title 路由标题
* @param icon 路由图标
* @param noCache 是否不缓存
* @param link 内链地址
* @param activeMenu 激活菜单路径
*/
public MetaVo(String title, String icon, Boolean noCache, String link, String activeMenu) {
this.title = title;
this.icon = icon;
@@ -37,6 +37,11 @@ public class DeptExcelConverter implements Converter<Long> {
.expireAfterWrite(30, TimeUnit.SECONDS)
.build();
/**
* 获取部门导入导出映射缓存。
*
* @return 部门 ID 与部门路径名称互转映射
*/
private DeptMaps getDeptMaps() {
ISysDeptService deptService = SpringUtils.getBean(ISysDeptService.class);
return DEPT_CACHE.get(CACHE_KEY, k -> {
@@ -47,6 +47,11 @@ public class SysUserImportListener extends AnalysisEventListener<SysUserImportVo
private final StringBuilder successMsg = new StringBuilder();
private final StringBuilder failureMsg = new StringBuilder();
/**
* 构造用户导入监听器。
*
* @param isUpdateSupport 是否允许更新已存在用户
*/
public SysUserImportListener(Boolean isUpdateSupport) {
String initPassword = SpringUtils.getBean(ISysConfigService.class).selectConfigByKey("sys.user.initPassword");
this.userService = SpringUtils.getBean(ISysUserService.class);
@@ -55,6 +60,12 @@ public class SysUserImportListener extends AnalysisEventListener<SysUserImportVo
this.operUserId = LoginHelper.getUserId();
}
/**
* 逐行处理用户导入数据。
*
* @param userVo 导入用户数据
* @param context Excel 解析上下文
*/
@Override
public void invoke(SysUserImportVo userVo, AnalysisContext context) {
SysUserVo sysUser = this.userService.selectUserByUserName(userVo.getUserName());
@@ -95,15 +106,30 @@ public class SysUserImportListener extends AnalysisEventListener<SysUserImportVo
}
}
/**
* 所有数据解析完成后的回调。
*
* @param context Excel 解析上下文
*/
@Override
public void doAfterAllAnalysed(AnalysisContext context) {
}
/**
* 获取用户导入结果。
*
* @return Excel 导入结果
*/
@Override
public ExcelResult<SysUserImportVo> getExcelResult() {
return new ExcelResult<>() {
/**
* 获取导入结果分析消息。
*
* @return 导入结果消息
*/
@Override
public String getAnalysis() {
if (failureNum > 0) {
@@ -115,11 +141,21 @@ public class SysUserImportListener extends AnalysisEventListener<SysUserImportVo
return successMsg.toString();
}
/**
* 获取导入成功数据列表。
*
* @return 导入成功数据列表
*/
@Override
public List<SysUserImportVo> getList() {
return null;
}
/**
* 获取导入错误信息列表。
*
* @return 导入错误信息列表
*/
@Override
public List<String> getErrorList() {
return null;