admin/mms
1
0
Fork 0
mirror of https://gitee.com/mmsAdmin/mms synced 2025-12-06 08:58:55 +08:00
Code Issues Packages Projects Releases Wiki Activity

优化doc

Browse Source
This commit is contained in:
MMS 2025-08-30 21:56:27 +08:00
parent eb1f00701e
commit 56fb568eaf
21 changed files with 53 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
mms-admin/src/main/java/com/sxpcwlkj/system/controller/AuthController.java
View File

@ -35,7 +35,7 @@ import java.util.Map;
* @author mmsAdmin
* @Doc <a href='https://www.mmsadmin.com'>MMS文档</a>
*/
@Tag(name = "系统登录",description = "系统登录,鉴权")
@Tag(name = "系统管理模块-登录,鉴权",description = "系统管理模块-登录,鉴权")
@Slf4j
@Validated
@RequiredArgsConstructor

3
mms-admin/src/main/java/com/sxpcwlkj/system/controller/CaptchaController.java
View File

@ -8,6 +8,7 @@ import com.sxpcwlkj.common.utils.DataUtil;
import com.sxpcwlkj.common.utils.R;
import com.sxpcwlkj.system.service.CaptchaService;
import com.sxpcwlkj.system.service.SysTenantService;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
@ -26,7 +27,7 @@ import java.util.Map;
* @author mmsAdmin
* @Doc <a href='https://www.mmsadmin.com'>MMS文档</a>
*/
@Tag(name = "系统管理模块-验证码处理",description = "系统管理模块-验证码处理")
@Slf4j
@Validated
@RequiredArgsConstructor

4
mms-admin/src/main/java/com/sxpcwlkj/system/controller/CommonController.java
View File

@ -33,6 +33,7 @@ import com.sxpcwlkj.system.service.SysDictService;
import com.sxpcwlkj.system.service.SysLoginService;
import com.sxpcwlkj.system.service.SysUserService;
import com.sxpcwlkj.wx.service.WxCodeService;
import io.swagger.v3.oas.annotations.tags.Tag;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import lombok.RequiredArgsConstructor;
@ -50,6 +51,7 @@ import java.util.*;
* @author mmsAdmin
* @Doc <a href='https://www.mmsadmin.com'>MMS文档</a>
*/
@Tag(name = "系统管理模块-公共接口",description = "系统管理模块-公共接口")
@RestController
@RequiredArgsConstructor
@Slf4j
@ -97,7 +99,7 @@ public class CommonController extends BaseController {
map.put("loginType", DataUtil.getStringToList(smsConfigEntity.getConfigValue()));
}
if("sys_base_tenant_state".equals(smsConfigEntity.getConfigKey())){
map.put("tenantState", Convert.toInt(smsConfigEntity.getConfigValue()) == 1);
map.put("tenantState", Convert.toInt(smsConfigEntity.getConfigValue()).equals(SystemCommonEnum.SYS_COMMON_STATE_OPEN.getValue()));
}
if("sys_base_login_bg".equals(smsConfigEntity.getConfigKey())){
map.put("loginBg",smsConfigEntity.getConfigValue());

2
mms-admin/src/main/java/com/sxpcwlkj/system/controller/HomeController.java
View File

@ -15,6 +15,7 @@ import com.sxpcwlkj.system.service.SysConfigService;
import com.sxpcwlkj.system.service.SysFunctionService;
import com.sxpcwlkj.system.service.SysNoticeService;
import com.sxpcwlkj.system.service.SysUserService;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
@ -29,6 +30,7 @@ import java.util.*;
* @author mmsAdmin
* @Doc <a href='https://www.mmsadmin.com'>MMS文档</a>
*/
@Tag(name = "系统管理模块-首页控制台",description = "系统管理模块-首页控制台")
@RestController
@RequiredArgsConstructor
@RequestMapping("system/home")

2
mms-admin/src/main/java/com/sxpcwlkj/system/controller/SysConfigController.java
View File

@ -12,6 +12,7 @@ import com.sxpcwlkj.sms.service.SmsService;
import com.sxpcwlkj.system.entity.bo.SysConfigBo;
import com.sxpcwlkj.system.entity.vo.SysConfigVo;
import com.sxpcwlkj.system.service.SysConfigService;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.validation.annotation.Validated;
@ -26,6 +27,7 @@ import java.util.List;
* @author mmsAdmin
* @Doc <a href='https://www.mmsadmin.com'>MMS文档</a>
*/
@Tag(name = "系统管理模块-系统配置",description = "系统管理模块-系统配置")
@Slf4j
@Validated
@RequiredArgsConstructor

2
mms-admin/src/main/java/com/sxpcwlkj/system/controller/SysDeptController.java
View File

@ -13,6 +13,7 @@ import com.sxpcwlkj.system.entity.bo.SysDeptBo;
import com.sxpcwlkj.system.entity.export.SysDeptExport;
import com.sxpcwlkj.system.entity.vo.SysDeptVo;
import com.sxpcwlkj.system.service.SysDeptService;
import io.swagger.v3.oas.annotations.tags.Tag;
import jakarta.servlet.http.HttpServletResponse;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
@ -31,6 +32,7 @@ import java.util.Set;
* @author mmsAdmin
* @Doc <a href='https://www.mmsadmin.com'>MMS文档</a>
*/
@Tag(name = "系统管理模块-系统部门",description = "系统管理模块-系统部门")
@Slf4j
@Validated
@RequiredArgsConstructor

3
mms-admin/src/main/java/com/sxpcwlkj/system/controller/SysDictController.java
View File

@ -9,6 +9,7 @@ import com.sxpcwlkj.framework.config.ValidatedGroupConfig;
import com.sxpcwlkj.system.entity.bo.SysDictBo;
import com.sxpcwlkj.system.entity.vo.SysDictVo;
import com.sxpcwlkj.system.service.SysDictService;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;
@ -19,6 +20,7 @@ import org.springframework.web.bind.annotation.*;
* @author mmsAdmin
* @Doc <a href='https://www.mmsadmin.com'>MMS文档</a>
*/
@Tag(name = "系统管理模块-系统字典",description = "系统管理模块-系统字典")
@RequestMapping("system/dict")
@RestController
@RequiredArgsConstructor
@ -30,7 +32,6 @@ public class SysDictController extends BaseController {
* 分页查询字典列表
*
* @param bo 查询条件
* @param pageQuery 分页条件
* @return 分页结果
*/
@MssSafety

2
mms-admin/src/main/java/com/sxpcwlkj/system/controller/SysFunctionController.java
View File

@ -9,6 +9,7 @@ import com.sxpcwlkj.system.entity.AdminMenuTree;
import com.sxpcwlkj.system.entity.bo.SysFunctionBo;
import com.sxpcwlkj.system.entity.vo.SysFunctionVo;
import com.sxpcwlkj.system.service.SysFunctionService;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import org.springframework.transaction.annotation.Transactional;
import org.springframework.validation.annotation.Validated;
@ -22,6 +23,7 @@ import java.util.List;
* @author mmsAdmin
* @Doc <a href='https://www.mmsadmin.com'>MMS文档</a>
*/
@Tag(name = "系统管理模块-系统资源",description = "系统管理模块-系统资源")
@RequestMapping("system/function")
@RestController
@RequiredArgsConstructor

2
mms-admin/src/main/java/com/sxpcwlkj/system/controller/SysNoticeController.java
View File

@ -13,6 +13,7 @@ import com.sxpcwlkj.system.entity.bo.SysNoticeBo;
import com.sxpcwlkj.system.entity.export.SysNoticeExport;
import com.sxpcwlkj.system.entity.vo.SysNoticeVo;
import com.sxpcwlkj.system.service.SysNoticeService;
import io.swagger.v3.oas.annotations.tags.Tag;
import jakarta.servlet.http.HttpServletResponse;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
@ -31,6 +32,7 @@ import java.util.Set;
* @author mmsAdmin
* @Doc <a href='https://www.mmsadmin.com'>MMS文档</a>
*/
@Tag(name = "系统管理模块-系统公告",description = "系统管理模块-系统公告")
@Slf4j
@Validated
@RequiredArgsConstructor

5
mms-admin/src/main/java/com/sxpcwlkj/system/controller/SysOssController.java
View File

@ -5,6 +5,7 @@ import cn.dev33.satoken.annotation.SaCheckPermission;
import cn.dev33.satoken.annotation.SaCheckRole;
import com.sxpcwlkj.common.annotation.MssSafety;
import com.sxpcwlkj.common.code.controller.BaseController;
import com.sxpcwlkj.common.enums.SystemCommonEnum;
import com.sxpcwlkj.common.utils.R;
import com.sxpcwlkj.datasource.entity.page.TableDataInfo;
import com.sxpcwlkj.framework.config.ValidatedGroupConfig;
@ -15,6 +16,7 @@ import com.sxpcwlkj.system.entity.vo.SysOssConfigVo;
import com.sxpcwlkj.system.entity.vo.SysOssVo;
import com.sxpcwlkj.system.service.SysOssConfigService;
import com.sxpcwlkj.system.service.SysOssService;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import org.dromara.x.file.storage.core.FileInfo;
import org.dromara.x.file.storage.core.FileStorageService;
@ -28,6 +30,7 @@ import org.springframework.web.multipart.MultipartFile;
* @author mmsAdmin
* @Doc <a href='https://www.mmsadmin.com'>MMS文档</a>
*/
@Tag(name = "系统管理模块-对象存储",description = "系统管理模块-对象存储")
@RequestMapping("system/oss")
@RestController
@RequiredArgsConstructor
@ -87,7 +90,7 @@ public class SysOssController extends BaseController {
sysOssBo.setPlatform(fileInfo.getPlatform());
sysOssBo.setContentType(fileInfo.getContentType());
sysOssBo.setBasePath(fileInfo.getBasePath());
sysOssBo.setStatus(0);
sysOssBo.setStatus(SystemCommonEnum.SYS_COMMON_STATE_OPEN.getValue());
sysOssBo.setSort(0);
return success(baseService.insert(sysOssBo));
}

2
mms-admin/src/main/java/com/sxpcwlkj/system/controller/SysRoleController.java
View File

@ -9,6 +9,7 @@ import com.sxpcwlkj.framework.config.ValidatedGroupConfig;
import com.sxpcwlkj.system.entity.bo.SysRoleBo;
import com.sxpcwlkj.system.entity.vo.SysRoleVo;
import com.sxpcwlkj.system.service.SysRoleService;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor;
import org.springframework.transaction.annotation.Transactional;
import org.springframework.validation.annotation.Validated;
@ -20,6 +21,7 @@ import org.springframework.web.bind.annotation.*;
* @author mmsAdmin
* @Doc <a href='https://www.mmsadmin.com'>MMS文档</a>
*/
@Tag(name = "系统管理模块-系统角色",description = "系统管理模块-系统角色")
@RequestMapping("system/role")
@RestController
@RequiredArgsConstructor

2
mms-admin/src/main/java/com/sxpcwlkj/system/controller/SysUserController.java
View File

@ -21,6 +21,7 @@ import com.sxpcwlkj.system.entity.export.SysUserExportVo;
import com.sxpcwlkj.system.entity.vo.SysUserVo;
import com.sxpcwlkj.system.service.SysUserService;
import com.sxpcwlkj.wx.service.WxCodeService;
import io.swagger.v3.oas.annotations.tags.Tag;
import jakarta.servlet.http.HttpServletResponse;
import jakarta.validation.constraints.NotBlank;
import lombok.RequiredArgsConstructor;
@ -42,6 +43,7 @@ import java.util.Set;
* @author mmsAdmin
* @Doc <a href='https://www.mmsadmin.com'>MMS文档</a>
*/
@Tag(name = "系统管理模块-系统用户",description = "系统管理模块-系统用户")
@Slf4j
@Validated
@RequiredArgsConstructor

4
mms-admin/src/main/java/com/sxpcwlkj/system/service/impl/CaptchaServiceImpl.java
View File

@ -41,7 +41,7 @@ public class CaptchaServiceImpl implements CaptchaService {
// msg：验证码未开启
List<ConfigEntity> convert = RedisUtil.getCacheList(ConfigKeyNum.config_base.getKey());
AtomicBoolean isOpen= new AtomicBoolean(false);
Map<String, Object> map = new HashMap<>();
if(convert.isEmpty()){
return data;
}
@ -72,7 +72,7 @@ public class CaptchaServiceImpl implements CaptchaService {
//初始化验证码背景
if (!code.equals("000000")) {
if (!"000000".equals(code)) {
switch (captchaProperties.getType()) {
case "LINE":

5
mms-admin/src/main/java/com/sxpcwlkj/system/service/impl/SysDictServiceImpl.java
View File

@ -7,6 +7,7 @@ import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.core.toolkit.Wrappers;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.sxpcwlkj.common.constant.CacheConstants;
import com.sxpcwlkj.common.enums.SystemCommonEnum;
import com.sxpcwlkj.common.utils.MapstructUtil;
import com.sxpcwlkj.datasource.entity.page.PageQuery;
import com.sxpcwlkj.datasource.entity.page.TableDataInfo;
@ -128,7 +129,7 @@ public class SysDictServiceImpl implements SysDictService {
for (SysDict d : dicts) {
List<SysDictData> data = sysDictDataMapper.selectList(new LambdaQueryWrapper<SysDictData>()
.eq(SysDictData::getFieldName, d.getFieldName())
.eq(SysDictData::getStatus, 0)
.eq(SysDictData::getStatus, SystemCommonEnum.SYS_COMMON_STATE_OPEN.getValue())
.orderByAsc(SysDictData::getSort)
);
RedisUtil.deleteObject(CacheConstants.SYS_DICT_KEY + d.getFieldName());
@ -145,7 +146,7 @@ public class SysDictServiceImpl implements SysDictService {
@Override
public List<SysDictDataVo> getSysDictByCode(String code) {
return sysDictDataMapper.selectVoList(new LambdaQueryWrapper<SysDictData>().eq(SysDictData::getFieldName, code)
.eq(SysDictData::getStatus, 0).orderByAsc(SysDictData::getSort));
.eq(SysDictData::getStatus, SystemCommonEnum.SYS_COMMON_STATE_OPEN.getValue()).orderByAsc(SysDictData::getSort));
}
@Override

10
mms-admin/src/main/java/com/sxpcwlkj/system/service/impl/SysLoginServiceImpl.java
View File

@ -5,6 +5,7 @@ import com.baomidou.mybatisplus.core.toolkit.ObjectUtils;
import com.sxpcwlkj.authority.LoginObject;
import com.sxpcwlkj.common.code.entity.CaptchaEntity;
import com.sxpcwlkj.common.enums.DeviceEnum;
import com.sxpcwlkj.common.enums.SystemCommonEnum;
import com.sxpcwlkj.common.exception.LoginException;
import com.sxpcwlkj.common.exception.MmsException;
import com.sxpcwlkj.common.exception.TenantException;
@ -30,8 +31,7 @@ import java.util.Date;
import java.util.Map;
/**
* @ClassName SysLoginServiceImpl
* @Description TODO
* 系统登录
* @Author mmsAdmin
* @Date 2022/12/25 12:06
*/
@ -62,7 +62,7 @@ public class SysLoginServiceImpl implements SysLoginService {
throw new LoginException("账号不存在!");
}
// 账号是否禁用
if (sysUser.getStatus() != 0) {
if (!sysUser.getStatus().equals(SystemCommonEnum.SYS_COMMON_STATE_OPEN.getValue())) {
throw new LoginException("账号已禁用!");
}
//解密数据库的密码
@ -121,7 +121,7 @@ public class SysLoginServiceImpl implements SysLoginService {
/**
* 验证租户
*
* @param sysUser
* @param sysUser 用户
*/
@Override
public void verfyTenement(SysUser sysUser) {
@ -132,7 +132,7 @@ public class SysLoginServiceImpl implements SysLoginService {
log.info("登录用户ID：{} 租户不存在.", sysUser.getUserId());
throw new TenantException("tenant.not.exists");
}
if (sysTenant.getStatus() != 0) {
if (!sysTenant.getStatus().equals(SystemCommonEnum.SYS_COMMON_STATE_OPEN.getValue())) {
log.info("登录用户ID：{} 租户状态为禁用.", sysUser.getUserId());
throw new TenantException("tenant off state");
}

4
mms-admin/src/main/java/com/sxpcwlkj/system/service/impl/SysRoleServiceImpl.java
View File

@ -103,7 +103,7 @@ public class SysRoleServiceImpl implements SysRoleService {
SysRoleFunction roleFunction = new SysRoleFunction();
roleFunction.setRoleId(bo.getId());
roleFunction.setFunctionId(aLong);
roleFunction.setStatus(1);
roleFunction.setStatus(SystemCommonEnum.SYS_COMMON_STATE_OPEN.getValue());
sysRoleFunctionMapper.insert(roleFunction);
}
}
@ -129,7 +129,7 @@ public class SysRoleServiceImpl implements SysRoleService {
SysRoleFunction role = new SysRoleFunction();
role.setRoleId(roleId);
role.setFunctionId(sysRoleFunction.getParentId());
role.setStatus(0);
role.setStatus(SystemCommonEnum.SYS_COMMON_STATE_OPEN.getValue());
sysRoleFunctionMapper.insert(role);
checkFunction(sysRoleFunction.getParentId(), roleId);
}

2
mms-admin/src/main/java/com/sxpcwlkj/system/service/impl/SysUserServiceImpl.java
View File

@ -258,7 +258,7 @@ public class SysUserServiceImpl implements SysUserService {
//资源集
userVo.setButCodes(list.toArray(String[]::new));
//===================超级管理员拥有所有==========================
if (userVo.getUserId().toString().equals(SystemCommonEnum.SUPER_ADMIN.getValue().toString())) {
if (userVo.getUserId().equals(SystemCommonEnum.SUPER_ADMIN.getValue().toString())) {
sysRoles = sysRoleMapper.selectList(new LambdaQueryWrapper<SysRole>().eq(SysRole::getCode, SystemCommonEnum.SYS_COMMON_STATE_OPEN.getValue()).like(SysRole::getCode, SystemCommonEnum.SUPER_ADMIN.getCode()).orderByAsc(SysRole::getSort).last("LIMIT 1"));
sysRoleVos = BeanCopyUtil.convert(sysRoles, SysRoleVo.class);

4
mms-admin/src/main/resources/template/gen/vue/api.ts.ftl
View File

@ -3,14 +3,14 @@ import {getEnv} from "/@/utils/mms";
import {AxiosPromise} from "axios";
import {SysEnum} from "/@/enums/SysEnum";
import {EncryptTypeEnum} from "/@/enums/EncryptTypeEnum";
import {${FunctionName}Bo,${FunctionName}Vo,${FunctionName}Table } from '/@/views/${moduleName}/${functionName}/type';
import {${FunctionName}Bo,${FunctionName}Vo} from '/@/views/${moduleName}/${functionName}/type';
/**
* ${tableComment}-Api
* ${FunctionName}
*/
export function ${functionName}Api() {
return {
list: (params?: object): AxiosPromise<${FunctionName}Vo[]> => {
list: (params?: object): AxiosPromise<Array<${FunctionName}Vo>> => {
return request({
url: getEnv()+'/${moduleName}/${functionName}/list',
method: 'post',

8
mms-admin/src/main/resources/template/gen/vue/dialog.vue.ftl
View File

@ -135,17 +135,23 @@
<script setup lang="ts" name="${moduleName}${FunctionName}Dialog">
import {nextTick, reactive, ref} from "vue";
import {CURDEnum} from '/@/enums/CURDEnum';
import {${FunctionName}Bo, ${FunctionName}Vo} from '/@/views/';
import {${FunctionName}Bo, ${FunctionName}Vo} from '/@/views/${moduleName}/${functionName}/type';
const dialogWidth = ref('50vw');
<#list fastList as field>
<#if field == 'editor'>
dialogWidth.value = '75vw';
import FastEditor from '/@/components/fast-editor/src/fast-editor.vue';
<#elseif field == 'select'>
import FastSelect from '/@/components/fast-select/src/fast-select.vue';
<#elseif field == 'file'>
import FastFile from "/@/components/fast-upload/file.vue"
<#elseif field == 'image'>
import FastImg from "/@/components/fast-upload/img.vue"
<#elseif field == 'images'>
import FastImgs from "/@/components/fast-upload/imgs.vue"
<#elseif field == 'radio'>
import FastSwitch from "/@/components/fast-switch/src/fast-switch.vue";
</#if>
</#list>
// 定义子组件向父组件传值/事件

4
mms-admin/src/main/resources/template/gen/vue/index.vue.ftl
View File

@ -189,9 +189,11 @@
import {CURDEnum} from "/@/enums/CURDEnum";
import {generateUUID, isEmpty} from "/@/utils/mms";
import {NextLoading} from "/@/utils/loading";
import {${functionName}Api, ${FunctionName}Bo, ${FunctionName}Vo} from '/@/views/';
import {${FunctionName}Bo, ${FunctionName}Vo} from '/@/views/${moduleName}/${functionName}/type';
import {${functionName}Api} from '/@/views/${moduleName}/${functionName}';
const baseApi = ${functionName}Api();
<#list formList as field>
<#if field.formDict??>
<#break>

4
mms-admin/src/main/resources/template/gen/vue/type.ts.ftl
View File

@ -15,7 +15,7 @@ export declare interface ${FunctionName}Vo extends BaseEntity {
||field.attrName == 'createdTime'
||field.attrName == 'updatedBy'
||field.attrName == 'updatedTime')>
${field.attrName}: string|number<#sep>; </#sep>
${field.attrName}: <#if field.attrType=='Integer'>number</#if><#if field.attrType!='Integer'>string</#if><#sep>; </#sep>
</#if>
</#list>
<#if formLayout==2 >
@ -39,7 +39,7 @@ export declare interface ${FunctionName}Bo extends BaseEntity {
||field.attrName == 'createdTime'
||field.attrName == 'updatedBy'
||field.attrName == 'updatedTime')>
${field.attrName}: string|number<#sep>; </#sep>
${field.attrName}: <#if field.attrType=='Integer'>number</#if><#if field.attrType!='Integer'>string</#if><#sep>; </#sep>
</#if>
</#list>
<#if formLayout==2 >