update [重大更新]全业务 增加 接口文档注解 格式化代码

ruoyi-common/src/main/java/com/ruoyi/common/config/RuoYiConfig.java

@@ -2,7 +2,6 @@ package com.ruoyi.common.config;
 
 import lombok.Data;
 import lombok.Getter;
-import lombok.NoArgsConstructor;
 import lombok.experimental.Accessors;
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.stereotype.Component;
@@ -10,34 +9,42 @@ import org.springframework.stereotype.Component;
 /**
  * 读取项目相关配置
  *
- * @author ruoyi
+ * @author Lion Li
  */
 
 @Data
-@NoArgsConstructor
 @Accessors(chain = true)
 @Component
 @ConfigurationProperties(prefix = "ruoyi")
-public class RuoYiConfig
-{
-    /** 项目名称 */
+public class RuoYiConfig {
+
+    /**
+     * 项目名称
+     */
     private String name;
 
-    /** 版本 */
+    /**
+     * 版本
+     */
     private String version;
 
-    /** 版权年份 */
+    /**
+     * 版权年份
+     */
     private String copyrightYear;
 
-    /** 实例演示开关 */
+    /**
+     * 实例演示开关
+     */
     private boolean demoEnabled;
 
-    /** 获取地址开关 */
+    /**
+     * 获取地址开关
+     */
     @Getter
     private static boolean addressEnabled;
 
-    public void setAddressEnabled(boolean addressEnabled)
-    {
+    public void setAddressEnabled(boolean addressEnabled) {
         RuoYiConfig.addressEnabled = addressEnabled;
     }
 

ruoyi-common/src/main/java/com/ruoyi/common/constant/GenConstants.java

@@ -61,10 +61,10 @@ public class GenConstants
             "update_time", "remark", "version" };
 
     /** Entity基类字段 */
-    public static final String[] BASE_ENTITY = { "createBy", "createTime", "updateBy", "updateTime", "remark" };
+    public static final String[] BASE_ENTITY = { "createBy", "createTime", "updateBy", "updateTime" };
 
     /** Tree基类字段 */
-    public static final String[] TREE_ENTITY = { "parentName", "parentId", "orderNum", "ancestors", "children" };
+    public static final String[] TREE_ENTITY = { "parentName", "parentId", "orderNum", "children" };
 
     /** 文本框 */
     public static final String HTML_INPUT = "input";

ruoyi-common/src/main/java/com/ruoyi/common/core/domain/BaseEntity.java

@@ -1,9 +1,10 @@
 package com.ruoyi.common.core.domain;
 
+import com.baomidou.mybatisplus.annotation.FieldFill;
+import com.baomidou.mybatisplus.annotation.TableField;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
-import lombok.NoArgsConstructor;
 import lombok.experimental.Accessors;
 
 import java.io.Serializable;
@@ -14,11 +15,10 @@ import java.util.Map;
 /**
  * Entity基类
  *
- * @author ruoyi
+ * @author Lion Li
  */
 
 @Data
-@NoArgsConstructor
 @Accessors(chain = true)
 public class BaseEntity implements Serializable {
 
@@ -28,43 +28,43 @@ public class BaseEntity implements Serializable {
 	 * 搜索值
 	 */
 	@ApiModelProperty(value = "搜索值")
+	@TableField(exist = false)
 	private String searchValue;
 
 	/**
 	 * 创建者
 	 */
 	@ApiModelProperty(value = "创建者")
+	@TableField(fill = FieldFill.INSERT)
 	private String createBy;
 
 	/**
 	 * 创建时间
 	 */
 	@ApiModelProperty(value = "创建时间")
+	@TableField(fill = FieldFill.INSERT)
 	private Date createTime;
 
 	/**
 	 * 更新者
 	 */
 	@ApiModelProperty(value = "更新者")
+	@TableField(fill = FieldFill.INSERT_UPDATE)
 	private String updateBy;
 
 	/**
 	 * 更新时间
 	 */
 	@ApiModelProperty(value = "更新时间")
+	@TableField(fill = FieldFill.INSERT_UPDATE)
 	private Date updateTime;
 
-	/**
-	 * 备注
-	 */
-	@ApiModelProperty(value = "备注")
-	private String remark;
-
 	/**
 	 * 请求参数
 	 */
 	@JsonIgnore
 	@ApiModelProperty(value = "请求参数")
+	@TableField(exist = false)
 	private Map<String, Object> params = new HashMap<>();
 
 }

ruoyi-common/src/main/java/com/ruoyi/common/core/domain/TreeEntity.java

@@ -1,9 +1,9 @@
 package com.ruoyi.common.core.domain;
 
+import com.baomidou.mybatisplus.annotation.TableField;
 import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 import lombok.EqualsAndHashCode;
-import lombok.NoArgsConstructor;
 import lombok.experimental.Accessors;
 
 import java.util.ArrayList;
@@ -12,12 +12,11 @@ import java.util.List;
 /**
  * Tree基类
  *
- * @author ruoyi
+ * @author Lion Li
  */
 
-@EqualsAndHashCode(callSuper = true)
 @Data
-@NoArgsConstructor
+@EqualsAndHashCode(callSuper = true)
 @Accessors(chain = true)
 public class TreeEntity extends BaseEntity {
 
@@ -26,6 +25,7 @@ public class TreeEntity extends BaseEntity {
 	/**
 	 * 父菜单名称
 	 */
+	@TableField(exist = false)
 	@ApiModelProperty(value = "父菜单名称")
 	private String parentName;
 
@@ -39,17 +39,12 @@ public class TreeEntity extends BaseEntity {
 	 * 显示顺序
 	 */
 	@ApiModelProperty(value = "显示顺序")
-	private Integer orderNum;
-
-	/**
-	 * 祖级列表
-	 */
-	@ApiModelProperty(value = "祖级列表")
-	private String ancestors;
+	private String orderNum;
 
 	/**
 	 * 子部门
 	 */
+	@TableField(exist = false)
 	@ApiModelProperty(value = "子部门")
 	private List<?> children = new ArrayList<>();
 

ruoyi-common/src/main/java/com/ruoyi/common/core/domain/TreeSelect.java

@@ -3,7 +3,10 @@ package com.ruoyi.common.core.domain;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.ruoyi.common.core.domain.entity.SysDept;
 import com.ruoyi.common.core.domain.entity.SysMenu;
-import lombok.*;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
+import lombok.Data;
+import lombok.NoArgsConstructor;
 import lombok.experimental.Accessors;
 
 import java.io.Serializable;
@@ -12,39 +15,53 @@ import java.util.stream.Collectors;
 
 /**
  * Treeselect树结构实体类
- * 
- * @author ruoyi
+ *
+ * @author Lion Li
  */
 
 @Data
 @NoArgsConstructor
 @Accessors(chain = true)
-public class TreeSelect implements Serializable
-{
+@ApiModel("树结构实体类")
+public class TreeSelect implements Serializable {
+
     private static final long serialVersionUID = 1L;
 
-    /** 节点ID */
+    /**
+     * 节点ID
+     */
+    @ApiModelProperty(value = "节点ID")
     private Long id;
 
-    /** 节点名称 */
+    /**
+     * 节点名称
+     */
+    @ApiModelProperty(value = "节点名称")
     private String label;
 
-    /** 子节点 */
+    /**
+     * 子节点
+     */
+    @ApiModelProperty(value = "子节点")
     @JsonInclude(JsonInclude.Include.NON_EMPTY)
     private List<TreeSelect> children;
 
-    public TreeSelect(SysDept dept)
-    {
+    public TreeSelect(SysDept dept) {
         this.id = dept.getDeptId();
         this.label = dept.getDeptName();
-        this.children = dept.getChildren().stream().map(TreeSelect::new).collect(Collectors.toList());
+        this.children = dept.getChildren()
+                .stream()
+                .map(d -> new TreeSelect((SysDept) d))
+                .collect(Collectors.toList());
     }
 
-    public TreeSelect(SysMenu menu)
-    {
+    public TreeSelect(SysMenu menu) {
         this.id = menu.getMenuId();
         this.label = menu.getMenuName();
-        this.children = menu.getChildren().stream().map(TreeSelect::new).collect(Collectors.toList());
+        this.children = menu.getChildren()
+                .stream()
+                .map(d -> new TreeSelect((SysMenu) d))
+                .collect(Collectors.toList());
     }
 
 }

ruoyi-common/src/main/java/com/ruoyi/common/core/domain/dto/OperLogDTO.java

@@ -8,15 +8,16 @@ import java.io.Serializable;
 import java.util.Date;
 
 /**
- * 操作日志记录表 oper_log
+ * 通用操作日志实体
  *
- * @author ruoyi
+ * @author Lion Li
  */
 
 @Data
 @NoArgsConstructor
 @Accessors(chain = true)
 public class OperLogDTO implements Serializable {
+
     private static final long serialVersionUID = 1L;
 
     /**

ruoyi-common/src/main/java/com/ruoyi/common/core/domain/entity/SysDept.java

@@ -1,48 +1,44 @@
 package com.ruoyi.common.core.domain.entity;
 
-import com.baomidou.mybatisplus.annotation.*;
+import com.baomidou.mybatisplus.annotation.TableId;
+import com.baomidou.mybatisplus.annotation.TableLogic;
+import com.baomidou.mybatisplus.annotation.TableName;
+import com.ruoyi.common.core.domain.TreeEntity;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
-import lombok.NoArgsConstructor;
+import lombok.EqualsAndHashCode;
 import lombok.experimental.Accessors;
 
 import javax.validation.constraints.Email;
 import javax.validation.constraints.NotBlank;
 import javax.validation.constraints.Size;
-import java.io.Serializable;
-import java.util.*;
 
 /**
  * 部门表 sys_dept
  *
- * @author ruoyi
+ * @author Lion Li
  */
 
 @Data
-@NoArgsConstructor
+@EqualsAndHashCode(callSuper = true)
 @Accessors(chain = true)
 @TableName("sys_dept")
-public class SysDept implements Serializable {
+@ApiModel("部门业务对象")
+public class SysDept extends TreeEntity {
 	private static final long serialVersionUID = 1L;
 
 	/**
 	 * 部门ID
 	 */
-	@TableId(value = "dept_id", type = IdType.AUTO)
+	@ApiModelProperty(value = "部门id")
+	@TableId(value = "dept_id")
 	private Long deptId;
 
-	/**
-	 * 父部门ID
-	 */
-	private Long parentId;
-
-	/**
-	 * 祖级列表
-	 */
-	private String ancestors;
-
 	/**
 	 * 部门名称
 	 */
+	@ApiModelProperty(value = "部门名称")
 	@NotBlank(message = "部门名称不能为空")
 	@Size(min = 0, max = 30, message = "部门名称长度不能超过30个字符")
 	private String deptName;
@@ -50,23 +46,27 @@ public class SysDept implements Serializable {
 	/**
 	 * 显示顺序
 	 */
+	@ApiModelProperty(value = "显示顺序")
 	@NotBlank(message = "显示顺序不能为空")
 	private String orderNum;
 
 	/**
 	 * 负责人
 	 */
+	@ApiModelProperty(value = "负责人")
 	private String leader;
 
 	/**
 	 * 联系电话
 	 */
+	@ApiModelProperty(value = "联系电话")
 	@Size(min = 0, max = 11, message = "联系电话长度不能超过11个字符")
 	private String phone;
 
 	/**
 	 * 邮箱
 	 */
+	@ApiModelProperty(value = "邮箱")
 	@Email(message = "邮箱格式不正确")
 	@Size(min = 0, max = 50, message = "邮箱长度不能超过50个字符")
 	private String email;
@@ -74,54 +74,20 @@ public class SysDept implements Serializable {
 	/**
 	 * 部门状态:0正常,1停用
 	 */
+	@ApiModelProperty(value = "部门状态:0正常,1停用")
 	private String status;
 
 	/**
 	 * 删除标志（0代表存在 2代表删除）
 	 */
+	@ApiModelProperty(value = "删除标志（0代表存在 2代表删除）")
 	@TableLogic
 	private String delFlag;
 
 	/**
-	 * 父部门名称
+	 * 祖级列表
 	 */
-	@TableField(exist = false)
-	private String parentName;
-
-	/**
-	 * 创建者
-	 */
-	@TableField(fill = FieldFill.INSERT)
-	private String createBy;
-
-	/**
-	 * 创建时间
-	 */
-	@TableField(fill = FieldFill.INSERT)
-	private Date createTime;
-
-	/**
-	 * 更新者
-	 */
-	@TableField(fill = FieldFill.INSERT_UPDATE)
-	private String updateBy;
-
-	/**
-	 * 更新时间
-	 */
-	@TableField(fill = FieldFill.INSERT_UPDATE)
-	private Date updateTime;
-
-	/**
-	 * 子部门
-	 */
-	@TableField(exist = false)
-	private List<SysDept> children = new ArrayList<SysDept>();
-
-	/**
-	 * 请求参数
-	 */
-	@TableField(exist = false)
-	private Map<String, Object> params = new HashMap<>();
+	@ApiModelProperty(value = "祖级列表")
+	private String ancestors;
 
 }

ruoyi-common/src/main/java/com/ruoyi/common/core/domain/entity/SysDictData.java

@@ -2,51 +2,54 @@ package com.ruoyi.common.core.domain.entity;
 
 import com.alibaba.excel.annotation.ExcelIgnoreUnannotated;
 import com.alibaba.excel.annotation.ExcelProperty;
-import com.baomidou.mybatisplus.annotation.*;
+import com.baomidou.mybatisplus.annotation.TableId;
+import com.baomidou.mybatisplus.annotation.TableName;
 import com.ruoyi.common.annotation.ExcelDictFormat;
 import com.ruoyi.common.constant.UserConstants;
 import com.ruoyi.common.convert.ExcelDictConvert;
+import com.ruoyi.common.core.domain.BaseEntity;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
-import lombok.NoArgsConstructor;
+import lombok.EqualsAndHashCode;
 import lombok.experimental.Accessors;
 
 import javax.validation.constraints.NotBlank;
 import javax.validation.constraints.Size;
-import java.io.Serializable;
-import java.util.Date;
-import java.util.HashMap;
-import java.util.Map;
 
 /**
  * 字典数据表 sys_dict_data
  *
- * @author ruoyi
+ * @author Lion Li
  */
 
 @Data
-@NoArgsConstructor
+@EqualsAndHashCode(callSuper = true)
 @Accessors(chain = true)
 @TableName("sys_dict_data")
 @ExcelIgnoreUnannotated
-public class SysDictData implements Serializable {
-	private static final long serialVersionUID = 1L;
+@ApiModel("字典数据业务对象")
+public class SysDictData extends BaseEntity {
 
 	/**
 	 * 字典编码
 	 */
+	@ApiModelProperty(value = "字典编码")
 	@ExcelProperty(value = "字典编码")
-	@TableId(value = "dict_code", type = IdType.AUTO)
+	@TableId(value = "dict_code")
 	private Long dictCode;
 
 	/**
 	 * 字典排序
 	 */
+	@ApiModelProperty(value = "字典排序")
 	@ExcelProperty(value = "字典排序")
 	private Long dictSort;
 
 	/**
 	 * 字典标签
 	 */
+	@ApiModelProperty(value = "字典标签")
 	@ExcelProperty(value = "字典标签")
 	@NotBlank(message = "字典标签不能为空")
 	@Size(min = 0, max = 100, message = "字典标签长度不能超过100个字符")
@@ -55,6 +58,7 @@ public class SysDictData implements Serializable {
 	/**
 	 * 字典键值
 	 */
+	@ApiModelProperty(value = "字典键值")
 	@ExcelProperty(value = "字典键值")
 	@NotBlank(message = "字典键值不能为空")
 	@Size(min = 0, max = 100, message = "字典键值长度不能超过100个字符")
@@ -63,6 +67,7 @@ public class SysDictData implements Serializable {
 	/**
 	 * 字典类型
 	 */
+	@ApiModelProperty(value = "字典类型")
 	@ExcelProperty(value = "字典类型")
 	@NotBlank(message = "字典类型不能为空")
 	@Size(min = 0, max = 100, message = "字典类型长度不能超过100个字符")
@@ -71,17 +76,20 @@ public class SysDictData implements Serializable {
 	/**
 	 * 样式属性（其他样式扩展）
 	 */
+	@ApiModelProperty(value = "样式属性（其他样式扩展）")
 	@Size(min = 0, max = 100, message = "样式属性长度不能超过100个字符")
 	private String cssClass;
 
 	/**
 	 * 表格字典样式
 	 */
+	@ApiModelProperty(value = "表格字典样式")
 	private String listClass;
 
 	/**
 	 * 是否默认（Y是 N否）
 	 */
+	@ApiModelProperty(value = "是否默认（Y是 N否）")
 	@ExcelProperty(value = "是否默认", converter = ExcelDictConvert.class)
 	@ExcelDictFormat(dictType = "sys_yes_no")
 	private String isDefault;
@@ -89,47 +97,19 @@ public class SysDictData implements Serializable {
 	/**
 	 * 状态（0正常 1停用）
 	 */
+	@ApiModelProperty(value = "状态（0正常 1停用）")
 	@ExcelProperty(value = "状态", converter = ExcelDictConvert.class)
 	@ExcelDictFormat(dictType = "sys_normal_disable")
 	private String status;
 
-	/**
-	 * 创建者
-	 */
-	@TableField(fill = FieldFill.INSERT)
-	private String createBy;
-
-	/**
-	 * 创建时间
-	 */
-	@TableField(fill = FieldFill.INSERT)
-	private Date createTime;
-
-	/**
-	 * 更新者
-	 */
-	@TableField(fill = FieldFill.INSERT_UPDATE)
-	private String updateBy;
-
-	/**
-	 * 更新时间
-	 */
-	@TableField(fill = FieldFill.INSERT_UPDATE)
-	private Date updateTime;
-
 	/**
 	 * 备注
 	 */
+	@ApiModelProperty(value = "备注")
 	private String remark;
 
-	/**
-	 * 请求参数
-	 */
-	@TableField(exist = false)
-	private Map<String, Object> params = new HashMap<>();
-
 	public boolean getDefault() {
-		return UserConstants.YES.equals(this.isDefault) ? true : false;
+		return UserConstants.YES.equals(this.isDefault);
 	}
 
 }

ruoyi-common/src/main/java/com/ruoyi/common/core/domain/entity/SysDictType.java

@@ -2,44 +2,46 @@ package com.ruoyi.common.core.domain.entity;
 
 import com.alibaba.excel.annotation.ExcelIgnoreUnannotated;
 import com.alibaba.excel.annotation.ExcelProperty;
-import com.baomidou.mybatisplus.annotation.*;
+import com.baomidou.mybatisplus.annotation.TableId;
+import com.baomidou.mybatisplus.annotation.TableName;
 import com.ruoyi.common.annotation.ExcelDictFormat;
 import com.ruoyi.common.convert.ExcelDictConvert;
+import com.ruoyi.common.core.domain.BaseEntity;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
-import lombok.NoArgsConstructor;
+import lombok.EqualsAndHashCode;
 import lombok.experimental.Accessors;
 
 import javax.validation.constraints.NotBlank;
 import javax.validation.constraints.Size;
-import java.io.Serializable;
-import java.util.Date;
-import java.util.HashMap;
-import java.util.Map;
 
 /**
  * 字典类型表 sys_dict_type
  *
- * @author ruoyi
+ * @author Lion Li
  */
 
 @Data
-@NoArgsConstructor
+@EqualsAndHashCode(callSuper = true)
 @Accessors(chain = true)
 @TableName("sys_dict_type")
 @ExcelIgnoreUnannotated
-public class SysDictType implements Serializable {
-	private static final long serialVersionUID = 1L;
+@ApiModel("字典类型业务对象")
+public class SysDictType extends BaseEntity {
 
 	/**
 	 * 字典主键
 	 */
+	@ApiModelProperty(value = "字典主键")
 	@ExcelProperty(value = "字典主键")
-	@TableId(value = "dict_id", type = IdType.AUTO)
+	@TableId(value = "dict_id")
 	private Long dictId;
 
 	/**
 	 * 字典名称
 	 */
+	@ApiModelProperty(value = "字典名称")
 	@ExcelProperty(value = "字典名称")
 	@NotBlank(message = "字典名称不能为空")
 	@Size(min = 0, max = 100, message = "字典类型名称长度不能超过100个字符")
@@ -48,6 +50,7 @@ public class SysDictType implements Serializable {
 	/**
 	 * 字典类型
 	 */
+	@ApiModelProperty(value = "字典类型")
 	@ExcelProperty(value = "字典类型")
 	@NotBlank(message = "字典类型不能为空")
 	@Size(min = 0, max = 100, message = "字典类型类型长度不能超过100个字符")
@@ -56,43 +59,15 @@ public class SysDictType implements Serializable {
 	/**
 	 * 状态（0正常 1停用）
 	 */
+	@ApiModelProperty(value = "状态（0正常 1停用）")
 	@ExcelProperty(value = "状态", converter = ExcelDictConvert.class)
 	@ExcelDictFormat(dictType = "sys_normal_disable")
 	private String status;
 
-	/**
-	 * 创建者
-	 */
-	@TableField(fill = FieldFill.INSERT)
-	private String createBy;
-
-	/**
-	 * 创建时间
-	 */
-	@TableField(fill = FieldFill.INSERT)
-	private Date createTime;
-
-	/**
-	 * 更新者
-	 */
-	@TableField(fill = FieldFill.INSERT_UPDATE)
-	private String updateBy;
-
-	/**
-	 * 更新时间
-	 */
-	@TableField(fill = FieldFill.INSERT_UPDATE)
-	private Date updateTime;
-
 	/**
 	 * 备注
 	 */
+	@ApiModelProperty(value = "备注")
 	private String remark;
 
-	/**
-	 * 请求参数
-	 */
-	@TableField(exist = false)
-	private Map<String, Object> params = new HashMap<>();
-
 }

ruoyi-common/src/main/java/com/ruoyi/common/core/domain/entity/SysMenu.java

@@ -1,154 +1,120 @@
 package com.ruoyi.common.core.domain.entity;
 
-import com.baomidou.mybatisplus.annotation.*;
-import com.fasterxml.jackson.annotation.JsonFormat;
+import com.baomidou.mybatisplus.annotation.TableId;
+import com.baomidou.mybatisplus.annotation.TableName;
+import com.ruoyi.common.core.domain.TreeEntity;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
-import lombok.NoArgsConstructor;
+import lombok.EqualsAndHashCode;
 import lombok.experimental.Accessors;
 
 import javax.validation.constraints.NotBlank;
 import javax.validation.constraints.Size;
-import java.io.Serializable;
-import java.util.*;
 
 /**
  * 菜单权限表 sys_menu
  *
- * @author ruoyi
+ * @author Lion Li
  */
 
 @Data
-@NoArgsConstructor
+@EqualsAndHashCode(callSuper = true)
 @Accessors(chain = true)
 @TableName("sys_menu")
-public class SysMenu implements Serializable {
-	private static final long serialVersionUID = 1L;
+@ApiModel("菜单权限业务对象")
+public class SysMenu extends TreeEntity {
 
 	/**
 	 * 菜单ID
 	 */
-	@TableId(value = "menu_id", type = IdType.AUTO)
+	@ApiModelProperty(value = "菜单ID")
+	@TableId(value = "menu_id")
 	private Long menuId;
 
 	/**
 	 * 菜单名称
 	 */
+	@ApiModelProperty(value = "菜单名称")
 	@NotBlank(message = "菜单名称不能为空")
 	@Size(min = 0, max = 50, message = "菜单名称长度不能超过50个字符")
 	private String menuName;
 
-	/**
-	 * 父菜单名称
-	 */
-	@TableField(exist = false)
-	private String parentName;
-
-	/**
-	 * 父菜单ID
-	 */
-	private Long parentId;
-
 	/**
 	 * 显示顺序
 	 */
+	@ApiModelProperty(value = "显示顺序")
 	@NotBlank(message = "显示顺序不能为空")
 	private String orderNum;
 
 	/**
 	 * 路由地址
 	 */
+	@ApiModelProperty(value = "路由地址")
 	@Size(min = 0, max = 200, message = "路由地址不能超过200个字符")
 	private String path;
 
 	/**
 	 * 组件路径
 	 */
+	@ApiModelProperty(value = "组件路径")
 	@Size(min = 0, max = 200, message = "组件路径不能超过255个字符")
 	private String component;
 
     /**
      * 路由参数
      */
+	@ApiModelProperty(value = "路由参数")
     private String query;
 
 	/**
 	 * 是否为外链（0是 1否）
 	 */
+	@ApiModelProperty(value = "是否为外链（0是 1否）")
 	private String isFrame;
 
 	/**
 	 * 是否缓存（0缓存 1不缓存）
 	 */
+	@ApiModelProperty(value = "是否缓存（0缓存 1不缓存）")
 	private String isCache;
 
 	/**
 	 * 类型（M目录 C菜单 F按钮）
 	 */
+	@ApiModelProperty(value = "类型（M目录 C菜单 F按钮）")
 	@NotBlank(message = "菜单类型不能为空")
 	private String menuType;
 
 	/**
 	 * 显示状态（0显示 1隐藏）
 	 */
+	@ApiModelProperty(value = "显示状态（0显示 1隐藏）")
 	private String visible;
 
 	/**
 	 * 菜单状态（0显示 1隐藏）
 	 */
+	@ApiModelProperty(value = "菜单状态（0显示 1隐藏）")
 	private String status;
 
 	/**
 	 * 权限字符串
 	 */
+	@ApiModelProperty(value = "权限字符串")
 	@Size(min = 0, max = 100, message = "权限标识长度不能超过100个字符")
 	private String perms;
 
 	/**
 	 * 菜单图标
 	 */
+	@ApiModelProperty(value = "菜单图标")
 	private String icon;
 
-	/**
-	 * 创建者
-	 */
-	@TableField(fill = FieldFill.INSERT)
-	private String createBy;
-
-	/**
-	 * 创建时间
-	 */
-	@TableField(fill = FieldFill.INSERT)
-	@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
-	private Date createTime;
-
-	/**
-	 * 更新者
-	 */
-	@TableField(fill = FieldFill.INSERT_UPDATE)
-	private String updateBy;
-
-	/**
-	 * 更新时间
-	 */
-	@TableField(fill = FieldFill.INSERT_UPDATE)
-	@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
-	private Date updateTime;
-
 	/**
 	 * 备注
 	 */
+	@ApiModelProperty(value = "备注")
 	private String remark;
 
-	/**
-	 * 请求参数
-	 */
-	@TableField(exist = false)
-	private Map<String, Object> params = new HashMap<>();
-
-	/**
-	 * 子菜单
-	 */
-	@TableField(exist = false)
-	private List<SysMenu> children = new ArrayList<SysMenu>();
-
 }

ruoyi-common/src/main/java/com/ruoyi/common/core/domain/entity/SysRole.java

@@ -2,44 +2,48 @@ package com.ruoyi.common.core.domain.entity;
 
 import com.alibaba.excel.annotation.ExcelIgnoreUnannotated;
 import com.alibaba.excel.annotation.ExcelProperty;
-import com.baomidou.mybatisplus.annotation.*;
+import com.baomidou.mybatisplus.annotation.TableField;
+import com.baomidou.mybatisplus.annotation.TableId;
+import com.baomidou.mybatisplus.annotation.TableLogic;
+import com.baomidou.mybatisplus.annotation.TableName;
 import com.ruoyi.common.annotation.ExcelDictFormat;
 import com.ruoyi.common.convert.ExcelDictConvert;
+import com.ruoyi.common.core.domain.BaseEntity;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
+import lombok.EqualsAndHashCode;
 import lombok.NoArgsConstructor;
 import lombok.experimental.Accessors;
 
 import javax.validation.constraints.NotBlank;
 import javax.validation.constraints.Size;
-import java.io.Serializable;
-import java.util.Date;
-import java.util.HashMap;
-import java.util.Map;
 
 /**
  * 角色表 sys_role
  *
- * @author ruoyi
+ * @author Lion Li
  */
 
 @Data
 @NoArgsConstructor
+@EqualsAndHashCode(callSuper = true)
 @Accessors(chain = true)
 @TableName("sys_role")
 @ExcelIgnoreUnannotated
-public class SysRole implements Serializable {
-	private static final long serialVersionUID = 1L;
+public class SysRole extends BaseEntity {
 
 	/**
 	 * 角色ID
 	 */
+	@ApiModelProperty(value = "角色ID")
 	@ExcelProperty(value = "角色序号")
-	@TableId(value = "role_id", type = IdType.AUTO)
+	@TableId(value = "role_id")
 	private Long roleId;
 
 	/**
 	 * 角色名称
 	 */
+	@ApiModelProperty(value = "角色名称")
 	@ExcelProperty(value = "角色名称")
 	@NotBlank(message = "角色名称不能为空")
 	@Size(min = 0, max = 30, message = "角色名称长度不能超过30个字符")
@@ -48,6 +52,7 @@ public class SysRole implements Serializable {
 	/**
 	 * 角色权限
 	 */
+	@ApiModelProperty(value = "角色权限")
 	@ExcelProperty(value = "角色权限")
 	@NotBlank(message = "权限字符不能为空")
 	@Size(min = 0, max = 100, message = "权限字符长度不能超过100个字符")
@@ -56,6 +61,7 @@ public class SysRole implements Serializable {
 	/**
 	 * 角色排序
 	 */
+	@ApiModelProperty(value = "角色排序")
 	@ExcelProperty(value = "角色排序")
 	@NotBlank(message = "显示顺序不能为空")
 	private String roleSort;
@@ -63,6 +69,7 @@ public class SysRole implements Serializable {
 	/**
 	 * 数据范围（1：所有数据权限；2：自定义数据权限；3：本部门数据权限；4：本部门及以下数据权限；5：仅本人数据权限）
 	 */
+	@ApiModelProperty(value = "数据范围（1：所有数据权限；2：自定义数据权限；3：本部门数据权限；4：本部门及以下数据权限；5：仅本人数据权限）")
 	@ExcelProperty(value = "数据范围", converter = ExcelDictConvert.class)
 	@ExcelDictFormat(readConverterExp = "1=所有数据权限,2=自定义数据权限,3=本部门数据权限,4=本部门及以下数据权限,5=仅本人数据权限")
 	private String dataScope;
@@ -70,16 +77,19 @@ public class SysRole implements Serializable {
 	/**
 	 * 菜单树选择项是否关联显示（ 0：父子不互相关联显示 1：父子互相关联显示）
 	 */
+	@ApiModelProperty(value = "菜单树选择项是否关联显示（ 0：父子不互相关联显示 1：父子互相关联显示）")
 	private boolean menuCheckStrictly;
 
 	/**
 	 * 部门树选择项是否关联显示（0：父子不互相关联显示 1：父子互相关联显示 ）
 	 */
+	@ApiModelProperty(value = "部门树选择项是否关联显示（0：父子不互相关联显示 1：父子互相关联显示 ）")
 	private boolean deptCheckStrictly;
 
 	/**
 	 * 角色状态（0正常 1停用）
 	 */
+	@ApiModelProperty(value = "角色状态（0正常 1停用）")
 	@ExcelProperty(value = "角色状态", converter = ExcelDictConvert.class)
 	@ExcelDictFormat(dictType = "sys_common_status")
 	private String status;
@@ -87,59 +97,34 @@ public class SysRole implements Serializable {
 	/**
 	 * 删除标志（0代表存在 2代表删除）
 	 */
+	@ApiModelProperty(value = "删除标志（0代表存在 2代表删除）")
 	@TableLogic
 	private String delFlag;
 
-	/**
-	 * 创建者
-	 */
-	@TableField(fill = FieldFill.INSERT)
-	private String createBy;
-
-	/**
-	 * 创建时间
-	 */
-	@TableField(fill = FieldFill.INSERT)
-	private Date createTime;
-
-	/**
-	 * 更新者
-	 */
-	@TableField(fill = FieldFill.INSERT_UPDATE)
-	private String updateBy;
-
-	/**
-	 * 更新时间
-	 */
-	@TableField(fill = FieldFill.INSERT_UPDATE)
-	private Date updateTime;
-
 	/**
 	 * 备注
 	 */
+	@ApiModelProperty(value = "备注")
 	private String remark;
 
-	/**
-	 * 请求参数
-	 */
-	@TableField(exist = false)
-	private Map<String, Object> params = new HashMap<>();
-
 	/**
 	 * 用户是否存在此角色标识 默认不存在
 	 */
+	@ApiModelProperty(value = "用户是否存在此角色标识 默认不存在")
 	@TableField(exist = false)
 	private boolean flag = false;
 
 	/**
 	 * 菜单组
 	 */
+	@ApiModelProperty(value = "菜单组")
 	@TableField(exist = false)
 	private Long[] menuIds;
 
 	/**
 	 * 部门组（数据权限）
 	 */
+	@ApiModelProperty(value = "部门组（数据权限）")
 	@TableField(exist = false)
 	private Long[] deptIds;
 
@@ -147,6 +132,7 @@ public class SysRole implements Serializable {
 		this.roleId = roleId;
 	}
 
+	@ApiModelProperty(value = "是否管理员")
 	public boolean isAdmin() {
 		return isAdmin(this.roleId);
 	}

ruoyi-common/src/main/java/com/ruoyi/common/core/domain/entity/SysUser.java

@@ -3,46 +3,51 @@ package com.ruoyi.common.core.domain.entity;
 import com.baomidou.mybatisplus.annotation.*;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
+import com.ruoyi.common.core.domain.BaseEntity;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
+import lombok.EqualsAndHashCode;
 import lombok.NoArgsConstructor;
 import lombok.experimental.Accessors;
 
 import javax.validation.constraints.Email;
 import javax.validation.constraints.NotBlank;
 import javax.validation.constraints.Size;
-import java.io.Serializable;
 import java.util.Date;
-import java.util.HashMap;
 import java.util.List;
-import java.util.Map;
 
 /**
  * 用户对象 sys_user
  *
- * @author ruoyi
+ * @author Lion Li
  */
 
 @Data
 @NoArgsConstructor
+@EqualsAndHashCode(callSuper = true)
 @Accessors(chain = true)
 @TableName("sys_user")
-public class SysUser implements Serializable {
-	private static final long serialVersionUID = 1L;
+@ApiModel("用户信息业务对象")
+public class SysUser extends BaseEntity {
 
 	/**
 	 * 用户ID
 	 */
-	@TableId(value = "user_id", type = IdType.AUTO)
+	@ApiModelProperty(value = "用户ID")
+	@TableId(value = "user_id")
 	private Long userId;
 
 	/**
 	 * 部门ID
 	 */
+	@ApiModelProperty(value = "部门ID")
 	private Long deptId;
 
 	/**
 	 * 用户账号
 	 */
+	@ApiModelProperty(value = "用户账号")
 	@NotBlank(message = "用户账号不能为空")
 	@Size(min = 0, max = 30, message = "用户账号长度不能超过30个字符")
 	private String userName;
@@ -50,12 +55,14 @@ public class SysUser implements Serializable {
 	/**
 	 * 用户昵称
 	 */
+	@ApiModelProperty(value = "用户昵称")
 	@Size(min = 0, max = 30, message = "用户昵称长度不能超过30个字符")
 	private String nickName;
 
 	/**
 	 * 用户邮箱
 	 */
+	@ApiModelProperty(value = "用户邮箱")
 	@Email(message = "邮箱格式不正确")
 	@Size(min = 0, max = 50, message = "邮箱长度不能超过50个字符")
 	private String email;
@@ -63,21 +70,25 @@ public class SysUser implements Serializable {
 	/**
 	 * 手机号码
 	 */
+	@ApiModelProperty(value = "手机号码")
 	private String phonenumber;
 
 	/**
 	 * 用户性别
 	 */
+	@ApiModelProperty(value = "用户性别")
 	private String sex;
 
 	/**
 	 * 用户头像
 	 */
+	@ApiModelProperty(value = "用户头像")
 	private String avatar;
 
 	/**
 	 * 密码
 	 */
+	@ApiModelProperty(value = "密码")
 	@TableField(
 			insertStrategy = FieldStrategy.NOT_EMPTY,
 			updateStrategy = FieldStrategy.NOT_EMPTY,
@@ -94,86 +105,66 @@ public class SysUser implements Serializable {
 	/**
 	 * 帐号状态（0正常 1停用）
 	 */
+	@ApiModelProperty(value = "帐号状态（0正常 1停用）")
 	private String status;
 
 	/**
 	 * 删除标志（0代表存在 2代表删除）
 	 */
+	@ApiModelProperty(value = "删除标志（0代表存在 2代表删除）")
 	@TableLogic
 	private String delFlag;
 
 	/**
 	 * 最后登录IP
 	 */
+	@ApiModelProperty(value = "最后登录IP")
 	private String loginIp;
 
 	/**
 	 * 最后登录时间
 	 */
+	@ApiModelProperty(value = "最后登录时间")
 	private Date loginDate;
 
-	/**
-	 * 创建者
-	 */
-	@TableField(fill = FieldFill.INSERT)
-	private String createBy;
-
-	/**
-	 * 创建时间
-	 */
-	@TableField(fill = FieldFill.INSERT)
-	private Date createTime;
-
-	/**
-	 * 更新者
-	 */
-	@TableField(fill = FieldFill.INSERT_UPDATE)
-	private String updateBy;
-
-	/**
-	 * 更新时间
-	 */
-	@TableField(fill = FieldFill.INSERT_UPDATE)
-	private Date updateTime;
-
 	/**
 	 * 备注
 	 */
+	@ApiModelProperty(value = "备注")
 	private String remark;
 
-	/**
-	 * 请求参数
-	 */
-	@TableField(exist = false)
-	private Map<String, Object> params = new HashMap<>();
-
 	/**
 	 * 部门对象
 	 */
+	@ApiModelProperty(value = "部门对象")
 	@TableField(exist = false)
 	private SysDept dept;
 
 	/**
 	 * 角色对象
 	 */
+	@ApiModelProperty(value = "角色对象")
 	@TableField(exist = false)
 	private List<SysRole> roles;
 
 	/**
 	 * 角色组
 	 */
+	@ApiModelProperty(value = "角色组")
 	@TableField(exist = false)
 	private Long[] roleIds;
 
 	/**
 	 * 岗位组
 	 */
+	@ApiModelProperty(value = "岗位组")
 	@TableField(exist = false)
 	private Long[] postIds;
 
 	/**
 	 * 角色ID
 	 */
+	@ApiModelProperty(value = "角色ID")
 	@TableField(exist = false)
 	private Long roleId;
 
@@ -181,6 +172,7 @@ public class SysUser implements Serializable {
 		this.userId = userId;
 	}
 
+	@ApiModelProperty(value = "是否管理员")
 	public boolean isAdmin() {
 		return isAdmin(this.userId);
 	}

ruoyi-common/src/main/java/com/ruoyi/common/core/domain/model/LoginBody.java

@@ -1,37 +1,43 @@
 package com.ruoyi.common.core.domain.model;
 
-import lombok.*;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
+import lombok.Data;
 import lombok.experimental.Accessors;
 
 /**
  * 用户登录对象
- * 
- * @author ruoyi
+ *
+ * @author Lion Li
  */
 
 @Data
-@NoArgsConstructor
 @Accessors(chain = true)
-public class LoginBody
-{
+@ApiModel("用户登录对象")
+public class LoginBody {
+
     /**
      * 用户名
      */
+    @ApiModelProperty(value = "用户名")
     private String username;
 
     /**
      * 用户密码
      */
+    @ApiModelProperty(value = "用户密码")
     private String password;
 
     /**
      * 验证码
      */
+    @ApiModelProperty(value = "验证码")
     private String code;
 
     /**
      * 唯一标识
      */
+    @ApiModelProperty(value = "唯一标识")
     private String uuid = "";
 
 }

ruoyi-common/src/main/java/com/ruoyi/common/core/domain/model/LoginUser.java

@@ -2,7 +2,8 @@ package com.ruoyi.common.core.domain.model;
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.ruoyi.common.core.domain.entity.SysUser;
-import lombok.*;
+import lombok.Data;
+import lombok.NoArgsConstructor;
 import lombok.experimental.Accessors;
 import org.springframework.security.core.GrantedAuthority;
 import org.springframework.security.core.userdetails.UserDetails;
@@ -13,14 +14,14 @@ import java.util.Set;
 /**
  * 登录用户身份权限
  *
- * @author ruoyi
+ * @author Lion Li
  */
 
 @Data
 @NoArgsConstructor
 @Accessors(chain = true)
-public class LoginUser implements UserDetails
-{
+public class LoginUser implements UserDetails {
+
     private static final long serialVersionUID = 1L;
 
     /**
@@ -78,14 +79,12 @@ public class LoginUser implements UserDetails
      */
     private SysUser user;
 
-    public LoginUser(SysUser user, Set<String> permissions)
-    {
+    public LoginUser(SysUser user, Set<String> permissions) {
         this.user = user;
         this.permissions = permissions;
     }
 
-    public LoginUser(Long userId, Long deptId, SysUser user, Set<String> permissions)
-    {
+    public LoginUser(Long userId, Long deptId, SysUser user, Set<String> permissions) {
         this.userId = userId;
         this.deptId = deptId;
         this.user = user;
@@ -94,14 +93,12 @@ public class LoginUser implements UserDetails
 
     @JsonIgnore
     @Override
-    public String getPassword()
-    {
+    public String getPassword() {
         return user.getPassword();
     }
 
     @Override
-    public String getUsername()
-    {
+    public String getUsername() {
         return user.getUserName();
     }
 
@@ -110,50 +107,39 @@ public class LoginUser implements UserDetails
      */
     @JsonIgnore
     @Override
-    public boolean isAccountNonExpired()
-    {
+    public boolean isAccountNonExpired() {
         return true;
     }
 
     /**
      * 指定用户是否解锁,锁定的用户无法进行身份验证
-     *
-     * @return
      */
     @JsonIgnore
     @Override
-    public boolean isAccountNonLocked()
-    {
+    public boolean isAccountNonLocked() {
         return true;
     }
 
     /**
      * 指示是否已过期的用户的凭据(密码),过期的凭据防止认证
-     *
-     * @return
      */
     @JsonIgnore
     @Override
-    public boolean isCredentialsNonExpired()
-    {
+    public boolean isCredentialsNonExpired() {
         return true;
     }
 
     /**
      * 是否可用 ,禁用的用户不能身份验证
-     *
-     * @return
      */
     @JsonIgnore
     @Override
-    public boolean isEnabled()
-    {
+    public boolean isEnabled() {
         return true;
     }
 
     @Override
-    public Collection<? extends GrantedAuthority> getAuthorities()
-    {
+    public Collection<? extends GrantedAuthority> getAuthorities() {
         return null;
     }
 }

ruoyi-common/src/main/java/com/ruoyi/common/core/domain/model/RegisterBody.java

@@ -1,11 +1,13 @@
 package com.ruoyi.common.core.domain.model;
 
+import io.swagger.annotations.ApiModel;
+
 /**
  * 用户注册对象
- * 
- * @author ruoyi
+ *
+ * @author Lion Li
  */
-public class RegisterBody extends LoginBody
-{
+@ApiModel("用户注册对象")
+public class RegisterBody extends LoginBody {
 
 }