gitee
/
roses
mirror of https://gitee.com/stylefeng/roses
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

【7.1.6】添加 @ChineseDescription 注解

pull/26/MERGE
lipengteng 2022-02-16 10:26:31 +08:00
parent 9de4b27ee1
commit f2bd7d0e6f
17 changed files with 86 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
kernel-d-ds-container/ds-container-api/src/main/java/cn/stylefeng/roses/kernel/dsctn/api/pojo/request/DatabaseInfoRequest.java
View File

@ -24,6 +24,7 @@
*/
package cn.stylefeng.roses.kernel.dsctn.api.pojo.request;
import cn.stylefeng.roses.kernel.rule.annotation.ChineseDescription;
import cn.stylefeng.roses.kernel.rule.pojo.request.BaseRequest;
import cn.stylefeng.roses.kernel.validator.api.validators.unique.TableUniqueValue;
import lombok.Data;
@ -48,6 +49,7 @@ public class DatabaseInfoRequest extends BaseRequest {
* 主键id
*/
@NotNull(message = "dbId不能为空", groups = {edit.class, delete.class, detail.class})
@ChineseDescription("主键id")
private Long dbId;
/**
@ -61,45 +63,53 @@ public class DatabaseInfoRequest extends BaseRequest {
columnName = "db_name",
idFieldName = "db_id",
excludeLogicDeleteItems = true)
@ChineseDescription("数据库名称（英文名称）")
private String dbName;
/**
* jdbc的驱动类型
*/
@NotBlank(message = "jdbc的驱动类型为空", groups = {add.class, edit.class})
@ChineseDescription("jdbc的驱动类型")
private String jdbcDriver;
/**
* jdbc的url
*/
@NotBlank(message = "jdbc的url", groups = {add.class, edit.class})
@ChineseDescription("jdbc的url")
private String jdbcUrl;
/**
* 数据库连接的账号
*/
@NotBlank(message = "数据库连接的账号", groups = {add.class, edit.class})
@ChineseDescription("数据库连接的账号")
private String username;
/**
* 数据库连接密码
*/
@NotBlank(message = "数据库连接密码", groups = {add.class, edit.class})
@ChineseDescription("数据库连接密码")
private String password;
/**
* 数据库schemaName，注意，每种数据库的schema意义不同
*/
@ChineseDescription("数据库schemaName，注意，每种数据库的schema意义不同")
private String schemaName;
/**
* 状态标识：1-正常，2-无法连接
*/
@ChineseDescription("状态标识：1-正常，2-无法连接")
private Integer statusFlag;
/**
* 备注，摘要
*/
@ChineseDescription("备注，摘要")
private String remarks;
}

12
kernel-d-file/file-api/src/main/java/cn/stylefeng/roses/kernel/file/api/pojo/request/SysFileInfoRequest.java
View File

@ -24,6 +24,7 @@
*/
package cn.stylefeng.roses.kernel.file.api.pojo.request;
import cn.stylefeng.roses.kernel.rule.annotation.ChineseDescription;
import cn.stylefeng.roses.kernel.rule.pojo.request.BaseRequest;
import lombok.Data;
import lombok.EqualsAndHashCode;
@ -48,6 +49,7 @@ public class SysFileInfoRequest extends BaseRequest {
* 文件ID
*/
@NotNull(message = "fileId不能为空", groups = {versionBack.class, detail.class})
@ChineseDescription("文件ID")
private Long fileId;
/**
@ -58,6 +60,7 @@ public class SysFileInfoRequest extends BaseRequest {
* 版本号升级的依据，code相同id不同视为同一个文件的不同版本
*/
@NotNull(message = "fileCode不能为空", groups = {edit.class, delete.class,})
@ChineseDescription("文件编码")
private Long fileCode;
/**
@ -66,48 +69,57 @@ public class SysFileInfoRequest extends BaseRequest {
* 机密文件为需要鉴权的文件，非机密文件则不需要任何权限（不登录也可以访问）
*/
@NotBlank(message = "是否是机密文件不能为空", groups = {add.class, edit.class})
@ChineseDescription("是否为机密文件")
private String secretFlag;
/**
* 文件名称（上传时候的文件全名，例如：开发文档.txt）
*/
@ChineseDescription("文件名称（上传时候的文件全名）")
private String fileOriginName;
/**
* 其他文件形式传参
*/
@ChineseDescription("其他文件形式传参")
private String token;
/**
* 文件存储位置：1-阿里云，2-腾讯云，3-minio，4-本地
*/
@ChineseDescription("文件存储位置：1-阿里云，2-腾讯云，3-minio，4-本地")
private Integer fileLocation;
/**
* 文件仓库（文件夹）
*/
@NotBlank(message = "fileBucket不能为空", groups = {previewByObjectName.class})
@ChineseDescription("文件仓库（文件夹）")
private String fileBucket;
/**
* 文件后缀
*/
@ChineseDescription("文件后缀")
private String fileSuffix;
/**
* 文件大小kb
*/
@ChineseDescription("文件大小kb")
private Long fileSizeKb;
/**
* 存储到bucket中的名称，主键id+.后缀
*/
@NotBlank(message = "fileObjectName不能为空", groups = {previewByObjectName.class})
@ChineseDescription("存储到bucket中的名称，主键id+.后缀")
private String fileObjectName;
/**
* 存储路径
*/
@ChineseDescription("存储路径")
private String filePath;
/**

2
kernel-d-file/file-business/src/main/java/cn/stylefeng/roses/kernel/file/modular/controller/SysFileInfoController.java
View File

@ -192,7 +192,7 @@ public class SysFileInfoController {
* @author majianguo
* @date 2020/12/16 15:34
*/
@PostResource(name = "替换文件", path = "/sysFileInfo/versionBack", requiredPermission = false)
@PostResource(name = "版本回退", path = "/sysFileInfo/versionBack", requiredPermission = false)
public ResponseData<SysFileInfoResponse> versionBack(@Validated(SysFileInfoRequest.versionBack.class) SysFileInfoRequest sysFileInfoRequest) {
SysFileInfoResponse fileUploadInfoResult = this.sysFileInfoService.versionBack(sysFileInfoRequest);
return new SuccessResponseData<>(fileUploadInfoResult);

7
kernel-d-i18n/i18n-api/src/main/java/cn/stylefeng/roses/kernel/i18n/api/pojo/request/TranslationRequest.java
View File

@ -24,6 +24,7 @@
*/
package cn.stylefeng.roses.kernel.i18n.api.pojo.request;
import cn.stylefeng.roses.kernel.rule.annotation.ChineseDescription;
import cn.stylefeng.roses.kernel.rule.pojo.request.BaseRequest;
import lombok.Data;
import lombok.EqualsAndHashCode;
@ -47,36 +48,42 @@ public class TranslationRequest extends BaseRequest {
* 主键id
*/
@NotNull(message = "tranId不能为空", groups = {edit.class, detail.class, delete.class})
@ChineseDescription("主键id")
private Long tranId;
/**
* 编码
*/
@NotBlank(message = "tranCode不能为空", groups = {add.class, edit.class})
@ChineseDescription("编码")
private String tranCode;
/**
* 多语言条例名称
*/
@NotBlank(message = "tranName不能为空", groups = {add.class, edit.class})
@ChineseDescription("多语言条例名称")
private String tranName;
/**
* 语种字典
*/
@NotBlank(message = "tranLanguageCode不能为空", groups = {add.class, edit.class, changeUserLanguage.class, deleteTranLanguage.class})
@ChineseDescription("语种字典")
private String tranLanguageCode;
/**
* 翻译的值
*/
@NotBlank(message = "tranValue不能为空", groups = {add.class, edit.class})
@ChineseDescription("翻译的值")
private String tranValue;
/**
* 字典id，用在删除语种
*/
@NotNull(message = "字典id", groups = {deleteTranLanguage.class})
@ChineseDescription("字典id，用在删除语种")
private Long dictId;
/**

5
kernel-d-scanner/scanner-api/src/main/java/cn/stylefeng/roses/kernel/scanner/api/pojo/devops/DevOpsReportResourceParam.java
View File

@ -24,6 +24,7 @@
*/
package cn.stylefeng.roses.kernel.scanner.api.pojo.devops;
import cn.stylefeng.roses.kernel.rule.annotation.ChineseDescription;
import cn.stylefeng.roses.kernel.rule.pojo.request.BaseRequest;
import cn.stylefeng.roses.kernel.scanner.api.pojo.resource.SysResourcePersistencePojo;
import lombok.Data;
@ -44,11 +45,13 @@ public class DevOpsReportResourceParam extends BaseRequest {
/**
* 项目唯一编码，在DevOps平台创建项目后会颁发
*/
@ChineseDescription("项目唯一编码，在DevOps平台创建项目后会颁发")
private String projectUniqueCode;
/**
* 向DevOps平台发送资源时候的令牌（通过jwt工具生成）
*/
@ChineseDescription("向DevOps平台发送资源时候的令牌（通过jwt工具生成）")
private String interactionToken;
/**
@ -56,11 +59,13 @@ public class DevOpsReportResourceParam extends BaseRequest {
* <p>
* 第二个key是资源的编码
*/
@ChineseDescription("第一个key是模块名称，是下划线分割的控制器名称，不带Controller结尾。第二个key是资源的编码")
private List<SysResourcePersistencePojo> sysResourcePersistencePojoList;
/**
* FieldMetadata类的全路径
*/
@ChineseDescription("FieldMetadata类的全路径")
private String fieldMetadataClassPath;
public DevOpsReportResourceParam(String projectUniqueCode, String interactionToken, List<SysResourcePersistencePojo> sysResourcePersistencePojoList, String fieldMetadataClassPath) {

1
kernel-d-scanner/scanner-api/src/main/java/cn/stylefeng/roses/kernel/scanner/api/pojo/resource/SysResourcePersistencePojo.java
View File

@ -156,6 +156,7 @@ public class SysResourcePersistencePojo {
/**
* 应用名称
*/
@ChineseDescription("应用名称")
private transient String appName;
}

9
kernel-d-timer/timer-business/src/main/java/cn/stylefeng/roses/kernel/timer/modular/param/SysTimersParam.java
View File

@ -24,6 +24,7 @@
*/
package cn.stylefeng.roses.kernel.timer.modular.param;
import cn.stylefeng.roses.kernel.rule.annotation.ChineseDescription;
import cn.stylefeng.roses.kernel.rule.pojo.request.BaseRequest;
import lombok.Data;
import lombok.EqualsAndHashCode;
@ -45,45 +46,53 @@ public class SysTimersParam extends BaseRequest {
* 定时器id
*/
@NotNull(message = "主键timerId不能为空", groups = {edit.class, detail.class, delete.class, startTimer.class, stopTimer.class})
@ChineseDescription("定时器id")
private Long timerId;
/**
* 任务名称
*/
@NotBlank(message = "任务名称不能为空", groups = {add.class, edit.class})
@ChineseDescription("任务名称")
private String timerName;
/**
* 执行任务的class的类名（实现了TimerTaskRunner接口的类的全称）
*/
@NotBlank(message = "任务的class的类名不能为空", groups = {add.class, edit.class})
@ChineseDescription("执行任务的class的类名")
private String actionClass;
/**
* 定时任务表达式
*/
@NotBlank(message = "定时任务表达式不能为空", groups = {add.class, edit.class})
@ChineseDescription("定时任务表达式")
private String cron;
/**
* 状态（字典 1运行 2停止）
*/
@NotNull(message = "任务状态不能为空", groups = {edit.class})
@ChineseDescription("状态（字典 1运行 2停止）")
private Integer jobStatus;
/**
* 参数
*/
@ChineseDescription("参数")
private String params;
/**
* 备注信息
*/
@ChineseDescription("备注信息")
private String remark;
/**
* 是否删除标记
*/
@ChineseDescription("是否删除标记")
private String delFlag;
/**

2
kernel-s-customer/customer-business/src/main/java/cn/stylefeng/roses/kernel/customer/modular/request/CustomerRequest.java
View File

@ -101,11 +101,13 @@ public class CustomerRequest extends BaseRequest {
/**
* 用在图形验证码或者拖拽验证码
*/
@ChineseDescription("用在图形验证码或者拖拽验证码")
private String verKey;
/**
* 用在图形验证码或者拖拽验证码
*/
@ChineseDescription("用在图形验证码或者拖拽验证码")
private String verCode;
/**

10
kernel-s-dict/dict-business/src/main/java/cn/stylefeng/roses/kernel/dict/modular/pojo/request/DictTypeRequest.java
View File

@ -24,6 +24,7 @@
*/
package cn.stylefeng.roses.kernel.dict.modular.pojo.request;
import cn.stylefeng.roses.kernel.rule.annotation.ChineseDescription;
import cn.stylefeng.roses.kernel.rule.pojo.request.BaseRequest;
import cn.stylefeng.roses.kernel.validator.api.validators.status.StatusValue;
import cn.stylefeng.roses.kernel.validator.api.validators.unique.TableUniqueValue;
@ -48,17 +49,20 @@ public class DictTypeRequest extends BaseRequest {
* 字典类型id
*/
@NotNull(message = "id不能为空", groups = {edit.class, delete.class, detail.class, updateStatus.class})
@ChineseDescription("字典类型id")
private Long dictTypeId;
/**
* 字典类型： 1-业务类型，2-系统类型，参考 DictTypeClassEnum
*/
@NotNull(message = "字典类型不能为空", groups = {add.class, edit.class})
@ChineseDescription("字典类型： 1-业务类型，2-系统类型")
private Integer dictTypeClass;
/**
* 字典类型业务编码
*/
@ChineseDescription("字典类型业务编码")
private String dictTypeBusCode;
/**
@ -72,22 +76,26 @@ public class DictTypeRequest extends BaseRequest {
columnName = "dict_type_code",
idFieldName = "dict_type_id",
excludeLogicDeleteItems = true)
@ChineseDescription("字典类型编码")
private String dictTypeCode;
/**
* 字典类型名称
*/
@NotBlank(message = "字典类型名称不能为空", groups = {add.class, edit.class})
@ChineseDescription("字典类型名称")
private String dictTypeName;
/**
* 字典类型名词拼音
*/
@ChineseDescription("字典类型名词拼音")
private String dictTypeNamePinYin;
/**
* 字典类型描述
*/
@ChineseDescription("字典类型描述")
private String dictTypeDesc;
/**
@ -95,12 +103,14 @@ public class DictTypeRequest extends BaseRequest {
*/
@NotNull(message = "状态不能为空", groups = {updateStatus.class})
@StatusValue(groups = updateStatus.class)
@ChineseDescription("字典类型的状态：1-启用，2-禁用")
private Integer statusFlag;
/**
* 排序，带小数
*/
@NotNull(message = "排序不能为空", groups = {add.class, edit.class})
@ChineseDescription("排序，带小数")
private BigDecimal dictTypeSort;
/**

3
kernel-s-migration/migration-api/src/main/java/cn/stylefeng/roses/kernel/migration/api/pojo/MigrationAggregationPOJO.java
View File

@ -1,5 +1,6 @@
package cn.stylefeng.roses.kernel.migration.api.pojo;
import cn.stylefeng.roses.kernel.rule.annotation.ChineseDescription;
import cn.stylefeng.roses.kernel.rule.pojo.request.BaseRequest;
import lombok.Data;
@ -20,12 +21,14 @@ public class MigrationAggregationPOJO extends BaseRequest {
* 应用和模块名称列表
*/
@NotNull(message = "模块名称不能为空", groups = {export.class, restore.class})
@ChineseDescription("应用和模块名称列表")
private List<String> appAndModuleNameList;
/**
* 数据集
*/
@NotNull(message = "数据集不能为空", groups = {restore.class})
@ChineseDescription("数据集")
private Map<String, MigrationInfo> data;
/**

4
kernel-s-system/system-api/src/main/java/cn/stylefeng/roses/kernel/system/api/pojo/role/request/SysRoleDataScopeRequest.java
View File

@ -24,6 +24,7 @@
*/
package cn.stylefeng.roses.kernel.system.api.pojo.role.request;
import cn.stylefeng.roses.kernel.rule.annotation.ChineseDescription;
import lombok.Data;
/**
@ -38,15 +39,18 @@ public class SysRoleDataScopeRequest {
/**
* 主键
*/
@ChineseDescription("主键")
private Long roleDataScopeId;
/**
* 角色id
*/
@ChineseDescription("角色id")
private Long roleId;
/**
* 机构id
*/
@ChineseDescription("机构id")
private Long organizationId;
}

3
kernel-s-system/system-api/src/main/java/cn/stylefeng/roses/kernel/system/api/pojo/role/request/SysRoleMenuButtonRequest.java
View File

@ -24,6 +24,7 @@
*/
package cn.stylefeng.roses.kernel.system.api.pojo.role.request;
import cn.stylefeng.roses.kernel.rule.annotation.ChineseDescription;
import lombok.Data;
/**
@ -38,11 +39,13 @@ public class SysRoleMenuButtonRequest {
/**
* 按钮id
*/
@ChineseDescription("按钮id")
private Long buttonId;
/**
* 按钮编码
*/
@ChineseDescription("按钮编码")
private String buttonCode;
}

4
kernel-s-system/system-api/src/main/java/cn/stylefeng/roses/kernel/system/api/pojo/role/request/SysRoleRequest.java
View File

@ -157,22 +157,26 @@ public class SysRoleRequest extends BaseRequest {
* 是否是新增绑定菜单，true-新增绑定菜单，false-取消绑定菜单
*/
@NotNull(message = "是否是新增绑定菜单", groups = {grantMenu.class})
@ChineseDescription("是否是新增绑定菜单，true-新增绑定菜单，false-取消绑定菜单")
private Boolean grantAddMenuFlag;
/**
* 绑定菜单的id
*/
@NotNull(message = "绑定菜单的id", groups = {grantMenu.class})
@ChineseDescription("绑定菜单的id")
private Long grantMenuId;
/**
* 模块下所有的按钮id
*/
@ChineseDescription("模块下所有的按钮id")
private List<Long> modularButtonIds;
/**
* 模块下选中的按钮id
*/
@ChineseDescription("模块下选中的按钮id")
private List<Long> selectedButtonIds;
/**

2
kernel-s-system/system-api/src/main/java/cn/stylefeng/roses/kernel/system/api/pojo/user/request/SysUserRequest.java
View File

@ -183,11 +183,13 @@ public class SysUserRequest extends BaseRequest {
/**
* 部门的数据范围集合
*/
@ChineseDescription("部门的数据范围集合")
private Set<Long> scopeOrgIds;
/**
* 用户id的数据范围集合
*/
@ChineseDescription("用户id的数据范围集合")
private Set<Long> userScopeIds;
/**

4
kernel-s-system/system-api/src/main/java/cn/stylefeng/roses/kernel/system/api/pojo/user/request/UserDataScopeRequest.java
View File

@ -25,6 +25,7 @@
package cn.stylefeng.roses.kernel.system.api.pojo.user.request;
import cn.stylefeng.roses.kernel.rule.annotation.ChineseDescription;
import lombok.Data;
/**
@ -39,15 +40,18 @@ public class UserDataScopeRequest {
/**
* 主键
*/
@ChineseDescription("主键")
private Long userDataScopeId;
/**
* 用户id
*/
@ChineseDescription("用户id")
private Long userId;
/**
* 机构id
*/
@ChineseDescription("机构id")
private Long orgId;
}

5
kernel-s-system/system-api/src/main/java/cn/stylefeng/roses/kernel/system/api/pojo/user/request/UserOrgRequest.java
View File

@ -24,6 +24,7 @@
*/
package cn.stylefeng.roses.kernel.system.api.pojo.user.request;
import cn.stylefeng.roses.kernel.rule.annotation.ChineseDescription;
import lombok.Data;
/**
@ -38,20 +39,24 @@ public class UserOrgRequest {
/**
* 主键
*/
@ChineseDescription("主键")
private Long userOrgId;
/**
* 用户id
*/
@ChineseDescription("用户id")
private Long userId;
/**
* 所属机构id
*/
@ChineseDescription("所属机构id")
private Long orgId;
/**
* 职位id
*/
@ChineseDescription("职位id")
private Long positionId;
}

4
kernel-s-system/system-api/src/main/java/cn/stylefeng/roses/kernel/system/api/pojo/user/request/UserRoleRequest.java
View File

@ -24,6 +24,7 @@
*/
package cn.stylefeng.roses.kernel.system.api.pojo.user.request;
import cn.stylefeng.roses.kernel.rule.annotation.ChineseDescription;
import lombok.Data;
/**
@ -38,16 +39,19 @@ public class UserRoleRequest {
/**
* 主键
*/
@ChineseDescription("主键")
private Long userRoleId;
/**
* 用户id
*/
@ChineseDescription("用户id")
private Long userId;
/**
* 角色id
*/
@ChineseDescription("角色id")
private Long roleId;
}