From d9e54388e7fde2462e8b7e0165c5e7da3f202593 Mon Sep 17 00:00:00 2001
From: 疯狂的狮子li <15040126243@163.com>
Date: 星期四, 07 七月 2022 19:07:59 +0800
Subject: [PATCH] add 整合 springdoc-openapi-javadoc 基于代码注释生成文档
---
ruoyi-common/src/main/java/com/ruoyi/common/core/domain/entity/SysUser.java | 438 ++++++++++++++++-------------------------------------
1 files changed, 135 insertions(+), 303 deletions(-)
diff --git a/ruoyi-common/src/main/java/com/ruoyi/common/core/domain/entity/SysUser.java b/ruoyi-common/src/main/java/com/ruoyi/common/core/domain/entity/SysUser.java
index d857e4e..f2d961b 100644
--- a/ruoyi-common/src/main/java/com/ruoyi/common/core/domain/entity/SysUser.java
+++ b/ruoyi-common/src/main/java/com/ruoyi/common/core/domain/entity/SysUser.java
@@ -1,328 +1,160 @@
package com.ruoyi.common.core.domain.entity;
-import java.util.Date;
-import java.util.List;
+import com.baomidou.mybatisplus.annotation.*;
+import com.ruoyi.common.annotation.Sensitive;
+import com.ruoyi.common.constant.UserConstants;
+import com.ruoyi.common.core.domain.BaseEntity;
+import com.ruoyi.common.enums.SensitiveStrategy;
+import com.ruoyi.common.xss.Xss;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.NoArgsConstructor;
+
import javax.validation.constraints.Email;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.Size;
-import org.apache.commons.lang3.builder.ToStringBuilder;
-import org.apache.commons.lang3.builder.ToStringStyle;
-import com.fasterxml.jackson.annotation.JsonIgnore;
-import com.fasterxml.jackson.annotation.JsonProperty;
-import com.ruoyi.common.annotation.Excel;
-import com.ruoyi.common.annotation.Excel.ColumnType;
-import com.ruoyi.common.annotation.Excel.Type;
-import com.ruoyi.common.annotation.Excels;
-import com.ruoyi.common.core.domain.BaseEntity;
+import java.util.Date;
+import java.util.List;
/**
* 鐢ㄦ埛瀵硅薄 sys_user
- *
- * @author ruoyi
+ *
+ * @author Lion Li
*/
-public class SysUser extends BaseEntity
-{
- private static final long serialVersionUID = 1L;
- /** 鐢ㄦ埛ID */
- @Excel(name = "鐢ㄦ埛搴忓彿", cellType = ColumnType.NUMERIC, prompt = "鐢ㄦ埛缂栧彿")
+@Data
+@NoArgsConstructor
+@EqualsAndHashCode(callSuper = true)
+@TableName("sys_user")
+public class SysUser extends BaseEntity {
+
+ /**
+ * 鐢ㄦ埛ID
+ */
+ @TableId(value = "user_id")
private Long userId;
- /** 閮ㄩ棬ID */
- @Excel(name = "閮ㄩ棬缂栧彿", type = Type.IMPORT)
+ /**
+ * 閮ㄩ棬ID
+ */
private Long deptId;
- /** 鐢ㄦ埛璐﹀彿 */
- @Excel(name = "鐧诲綍鍚嶇О")
- private String userName;
-
- /** 鐢ㄦ埛鏄电О */
- @Excel(name = "鐢ㄦ埛鍚嶇О")
- private String nickName;
-
- /** 鐢ㄦ埛閭 */
- @Excel(name = "鐢ㄦ埛閭")
- private String email;
-
- /** 鎵嬫満鍙风爜 */
- @Excel(name = "鎵嬫満鍙风爜")
- private String phonenumber;
-
- /** 鐢ㄦ埛鎬у埆 */
- @Excel(name = "鐢ㄦ埛鎬у埆", readConverterExp = "0=鐢�,1=濂�,2=鏈煡")
- private String sex;
-
- /** 鐢ㄦ埛澶村儚 */
- private String avatar;
-
- /** 瀵嗙爜 */
- private String password;
-
- /** 鐩愬姞瀵� */
- private String salt;
-
- /** 甯愬彿鐘舵�侊紙0姝ｅ父 1鍋滅敤锛� */
- @Excel(name = "甯愬彿鐘舵��", readConverterExp = "0=姝ｅ父,1=鍋滅敤")
- private String status;
-
- /** 鍒犻櫎鏍囧織锛�0浠ｈ〃瀛樺湪 2浠ｈ〃鍒犻櫎锛� */
- private String delFlag;
-
- /** 鏈�鍚庣櫥闄咺P */
- @Excel(name = "鏈�鍚庣櫥闄咺P", type = Type.EXPORT)
- private String loginIp;
-
- /** 鏈�鍚庣櫥闄嗘椂闂� */
- @Excel(name = "鏈�鍚庣櫥闄嗘椂闂�", width = 30, dateFormat = "yyyy-MM-dd HH:mm:ss", type = Type.EXPORT)
- private Date loginDate;
-
- /** 閮ㄩ棬瀵硅薄 */
- @Excels({
- @Excel(name = "閮ㄩ棬鍚嶇О", targetAttr = "deptName", type = Type.EXPORT),
- @Excel(name = "閮ㄩ棬璐熻矗浜�", targetAttr = "leader", type = Type.EXPORT)
- })
- private SysDept dept;
-
- /** 瑙掕壊瀵硅薄 */
- private List<SysRole> roles;
-
- /** 瑙掕壊缁� */
- private Long[] roleIds;
-
- /** 宀椾綅缁� */
- private Long[] postIds;
-
- public SysUser()
- {
-
- }
-
- public SysUser(Long userId)
- {
- this.userId = userId;
- }
-
- public Long getUserId()
- {
- return userId;
- }
-
- public void setUserId(Long userId)
- {
- this.userId = userId;
- }
-
- public boolean isAdmin()
- {
- return isAdmin(this.userId);
- }
-
- public static boolean isAdmin(Long userId)
- {
- return userId != null && 1L == userId;
- }
-
- public Long getDeptId()
- {
- return deptId;
- }
-
- public void setDeptId(Long deptId)
- {
- this.deptId = deptId;
- }
-
- @Size(min = 0, max = 30, message = "鐢ㄦ埛鏄电О闀垮害涓嶈兘瓒呰繃30涓瓧绗�")
- public String getNickName()
- {
- return nickName;
- }
-
- public void setNickName(String nickName)
- {
- this.nickName = nickName;
- }
-
+ /**
+ * 鐢ㄦ埛璐﹀彿
+ */
+ @Xss(message = "鐢ㄦ埛璐﹀彿涓嶈兘鍖呭惈鑴氭湰瀛楃")
@NotBlank(message = "鐢ㄦ埛璐﹀彿涓嶈兘涓虹┖")
@Size(min = 0, max = 30, message = "鐢ㄦ埛璐﹀彿闀垮害涓嶈兘瓒呰繃30涓瓧绗�")
- public String getUserName()
- {
- return userName;
- }
+ private String userName;
- public void setUserName(String userName)
- {
- this.userName = userName;
- }
+ /**
+ * 鐢ㄦ埛鏄电О
+ */
+ @Xss(message = "鐢ㄦ埛鏄电О涓嶈兘鍖呭惈鑴氭湰瀛楃")
+ @Size(min = 0, max = 30, message = "鐢ㄦ埛鏄电О闀垮害涓嶈兘瓒呰繃30涓瓧绗�")
+ private String nickName;
+ /**
+ * 鐢ㄦ埛绫诲瀷锛坰ys_user绯荤粺鐢ㄦ埛锛�
+ */
+ private String userType;
+
+ /**
+ * 鐢ㄦ埛閭
+ */
+ @Sensitive(strategy = SensitiveStrategy.EMAIL)
@Email(message = "閭鏍煎紡涓嶆纭�")
@Size(min = 0, max = 50, message = "閭闀垮害涓嶈兘瓒呰繃50涓瓧绗�")
- public String getEmail()
- {
- return email;
+ private String email;
+
+ /**
+ * 鎵嬫満鍙风爜
+ */
+ @Sensitive(strategy = SensitiveStrategy.PHONE)
+ private String phonenumber;
+
+ /**
+ * 鐢ㄦ埛鎬у埆
+ */
+ private String sex;
+
+ /**
+ * 鐢ㄦ埛澶村儚
+ */
+ private String avatar;
+
+ /**
+ * 瀵嗙爜
+ */
+ @TableField(
+ insertStrategy = FieldStrategy.NOT_EMPTY,
+ updateStrategy = FieldStrategy.NOT_EMPTY,
+ whereStrategy = FieldStrategy.NOT_EMPTY
+ )
+ private String password;
+
+ /**
+ * 甯愬彿鐘舵�侊紙0姝ｅ父 1鍋滅敤锛�
+ */
+ private String status;
+
+ /**
+ * 鍒犻櫎鏍囧織锛�0浠ｈ〃瀛樺湪 2浠ｈ〃鍒犻櫎锛�
+ */
+ @TableLogic
+ private String delFlag;
+
+ /**
+ * 鏈�鍚庣櫥褰旾P
+ */
+ private String loginIp;
+
+ /**
+ * 鏈�鍚庣櫥褰曟椂闂�
+ */
+ private Date loginDate;
+
+ /**
+ * 澶囨敞
+ */
+ private String remark;
+
+ /**
+ * 閮ㄩ棬瀵硅薄
+ */
+ @TableField(exist = false)
+ private SysDept dept;
+
+ /**
+ * 瑙掕壊瀵硅薄
+ */
+ @TableField(exist = false)
+ private List<SysRole> roles;
+
+ /**
+ * 瑙掕壊缁�
+ */
+ @TableField(exist = false)
+ private Long[] roleIds;
+
+ /**
+ * 宀椾綅缁�
+ */
+ @TableField(exist = false)
+ private Long[] postIds;
+
+ /**
+ * 鏁版嵁鏉冮檺 褰撳墠瑙掕壊ID
+ */
+ @TableField(exist = false)
+ private Long roleId;
+
+ public SysUser(Long userId) {
+ this.userId = userId;
}
- public void setEmail(String email)
- {
- this.email = email;
+ public boolean isAdmin() {
+ return UserConstants.ADMIN_ID.equals(this.userId);
}
- @Size(min = 0, max = 11, message = "鎵嬫満鍙风爜闀垮害涓嶈兘瓒呰繃11涓瓧绗�")
- public String getPhonenumber()
- {
- return phonenumber;
- }
-
- public void setPhonenumber(String phonenumber)
- {
- this.phonenumber = phonenumber;
- }
-
- public String getSex()
- {
- return sex;
- }
-
- public void setSex(String sex)
- {
- this.sex = sex;
- }
-
- public String getAvatar()
- {
- return avatar;
- }
-
- public void setAvatar(String avatar)
- {
- this.avatar = avatar;
- }
-
- @JsonIgnore
- @JsonProperty
- public String getPassword()
- {
- return password;
- }
-
- public void setPassword(String password)
- {
- this.password = password;
- }
-
- public String getSalt()
- {
- return salt;
- }
-
- public void setSalt(String salt)
- {
- this.salt = salt;
- }
-
- public String getStatus()
- {
- return status;
- }
-
- public void setStatus(String status)
- {
- this.status = status;
- }
-
- public String getDelFlag()
- {
- return delFlag;
- }
-
- public void setDelFlag(String delFlag)
- {
- this.delFlag = delFlag;
- }
-
- public String getLoginIp()
- {
- return loginIp;
- }
-
- public void setLoginIp(String loginIp)
- {
- this.loginIp = loginIp;
- }
-
- public Date getLoginDate()
- {
- return loginDate;
- }
-
- public void setLoginDate(Date loginDate)
- {
- this.loginDate = loginDate;
- }
-
- public SysDept getDept()
- {
- return dept;
- }
-
- public void setDept(SysDept dept)
- {
- this.dept = dept;
- }
-
- public List<SysRole> getRoles()
- {
- return roles;
- }
-
- public void setRoles(List<SysRole> roles)
- {
- this.roles = roles;
- }
-
- public Long[] getRoleIds()
- {
- return roleIds;
- }
-
- public void setRoleIds(Long[] roleIds)
- {
- this.roleIds = roleIds;
- }
-
- public Long[] getPostIds()
- {
- return postIds;
- }
-
- public void setPostIds(Long[] postIds)
- {
- this.postIds = postIds;
- }
-
- @Override
- public String toString() {
- return new ToStringBuilder(this,ToStringStyle.MULTI_LINE_STYLE)
- .append("userId", getUserId())
- .append("deptId", getDeptId())
- .append("userName", getUserName())
- .append("nickName", getNickName())
- .append("email", getEmail())
- .append("phonenumber", getPhonenumber())
- .append("sex", getSex())
- .append("avatar", getAvatar())
- .append("password", getPassword())
- .append("salt", getSalt())
- .append("status", getStatus())
- .append("delFlag", getDelFlag())
- .append("loginIp", getLoginIp())
- .append("loginDate", getLoginDate())
- .append("createBy", getCreateBy())
- .append("createTime", getCreateTime())
- .append("updateBy", getUpdateBy())
- .append("updateTime", getUpdateTime())
- .append("remark", getRemark())
- .append("dept", getDept())
- .toString();
- }
}
--
Gitblit v1.9.3