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 | 269 +++++++++++++++++++++++------------------------------
1 files changed, 116 insertions(+), 153 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 6e44a3b..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,197 +1,160 @@
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.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 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
-@Accessors(chain = true)
+@EqualsAndHashCode(callSuper = true)
@TableName("sys_user")
-public class SysUser implements Serializable {
- private static final long serialVersionUID = 1L;
+public class SysUser extends BaseEntity {
- /**
- * 鐢ㄦ埛ID
- */
- @TableId(value = "user_id", type = IdType.AUTO)
- private Long userId;
+ /**
+ * 鐢ㄦ埛ID
+ */
+ @TableId(value = "user_id")
+ private Long userId;
- /**
- * 閮ㄩ棬ID
- */
- private Long deptId;
+ /**
+ * 閮ㄩ棬ID
+ */
+ private Long deptId;
- /**
- * 鐢ㄦ埛璐﹀彿
- */
- @NotBlank(message = "鐢ㄦ埛璐﹀彿涓嶈兘涓虹┖")
- @Size(min = 0, max = 30, message = "鐢ㄦ埛璐﹀彿闀垮害涓嶈兘瓒呰繃30涓瓧绗�")
- private String userName;
+ /**
+ * 鐢ㄦ埛璐﹀彿
+ */
+ @Xss(message = "鐢ㄦ埛璐﹀彿涓嶈兘鍖呭惈鑴氭湰瀛楃")
+ @NotBlank(message = "鐢ㄦ埛璐﹀彿涓嶈兘涓虹┖")
+ @Size(min = 0, max = 30, message = "鐢ㄦ埛璐﹀彿闀垮害涓嶈兘瓒呰繃30涓瓧绗�")
+ private String userName;
- /**
- * 鐢ㄦ埛鏄电О
- */
- @Size(min = 0, max = 30, message = "鐢ㄦ埛鏄电О闀垮害涓嶈兘瓒呰繃30涓瓧绗�")
- private String nickName;
+ /**
+ * 鐢ㄦ埛鏄电О
+ */
+ @Xss(message = "鐢ㄦ埛鏄电О涓嶈兘鍖呭惈鑴氭湰瀛楃")
+ @Size(min = 0, max = 30, message = "鐢ㄦ埛鏄电О闀垮害涓嶈兘瓒呰繃30涓瓧绗�")
+ private String nickName;
- /**
- * 鐢ㄦ埛閭
- */
- @Email(message = "閭鏍煎紡涓嶆纭�")
- @Size(min = 0, max = 50, message = "閭闀垮害涓嶈兘瓒呰繃50涓瓧绗�")
- private String email;
+ /**
+ * 鐢ㄦ埛绫诲瀷锛坰ys_user绯荤粺鐢ㄦ埛锛�
+ */
+ private String userType;
- /**
- * 鎵嬫満鍙风爜
- */
- private String phonenumber;
+ /**
+ * 鐢ㄦ埛閭
+ */
+ @Sensitive(strategy = SensitiveStrategy.EMAIL)
+ @Email(message = "閭鏍煎紡涓嶆纭�")
+ @Size(min = 0, max = 50, message = "閭闀垮害涓嶈兘瓒呰繃50涓瓧绗�")
+ private String email;
- /**
- * 鐢ㄦ埛鎬у埆
- */
- private String sex;
+ /**
+ * 鎵嬫満鍙风爜
+ */
+ @Sensitive(strategy = SensitiveStrategy.PHONE)
+ private String phonenumber;
- /**
- * 鐢ㄦ埛澶村儚
- */
- private String avatar;
+ /**
+ * 鐢ㄦ埛鎬у埆
+ */
+ private String sex;
- /**
- * 瀵嗙爜
- */
- @TableField(
- insertStrategy = FieldStrategy.NOT_EMPTY,
- updateStrategy = FieldStrategy.NOT_EMPTY,
- whereStrategy = FieldStrategy.NOT_EMPTY
- )
- private String password;
+ /**
+ * 鐢ㄦ埛澶村儚
+ */
+ private String avatar;
- @JsonIgnore
- @JsonProperty
- public String getPassword() {
- return password;
- }
+ /**
+ * 瀵嗙爜
+ */
+ @TableField(
+ insertStrategy = FieldStrategy.NOT_EMPTY,
+ updateStrategy = FieldStrategy.NOT_EMPTY,
+ whereStrategy = FieldStrategy.NOT_EMPTY
+ )
+ private String password;
- /**
- * 鐩愬姞瀵�
- */
- private String salt;
+ /**
+ * 甯愬彿鐘舵�侊紙0姝ｅ父 1鍋滅敤锛�
+ */
+ private String status;
- /**
- * 甯愬彿鐘舵�侊紙0姝ｅ父 1鍋滅敤锛�
- */
- private String status;
+ /**
+ * 鍒犻櫎鏍囧織锛�0浠ｈ〃瀛樺湪 2浠ｈ〃鍒犻櫎锛�
+ */
+ @TableLogic
+ private String delFlag;
- /**
- * 鍒犻櫎鏍囧織锛�0浠ｈ〃瀛樺湪 2浠ｈ〃鍒犻櫎锛�
- */
- @TableLogic
- private String delFlag;
+ /**
+ * 鏈�鍚庣櫥褰旾P
+ */
+ private String loginIp;
- /**
- * 鏈�鍚庣櫥褰旾P
- */
- private String loginIp;
+ /**
+ * 鏈�鍚庣櫥褰曟椂闂�
+ */
+ private Date loginDate;
- /**
- * 鏈�鍚庣櫥褰曟椂闂�
- */
- private Date loginDate;
+ /**
+ * 澶囨敞
+ */
+ private String remark;
- /**
- * 鍒涘缓鑰�
- */
- @TableField(fill = FieldFill.INSERT)
- private String createBy;
+ /**
+ * 閮ㄩ棬瀵硅薄
+ */
+ @TableField(exist = false)
+ private SysDept dept;
- /**
- * 鍒涘缓鏃堕棿
- */
- @TableField(fill = FieldFill.INSERT)
- private Date createTime;
+ /**
+ * 瑙掕壊瀵硅薄
+ */
+ @TableField(exist = false)
+ private List<SysRole> roles;
- /**
- * 鏇存柊鑰�
- */
- @TableField(fill = FieldFill.INSERT_UPDATE)
- private String updateBy;
+ /**
+ * 瑙掕壊缁�
+ */
+ @TableField(exist = false)
+ private Long[] roleIds;
- /**
- * 鏇存柊鏃堕棿
- */
- @TableField(fill = FieldFill.INSERT_UPDATE)
- private Date updateTime;
+ /**
+ * 宀椾綅缁�
+ */
+ @TableField(exist = false)
+ private Long[] postIds;
- /**
- * 澶囨敞
- */
- private String remark;
+ /**
+ * 鏁版嵁鏉冮檺 褰撳墠瑙掕壊ID
+ */
+ @TableField(exist = false)
+ private Long roleId;
- /**
- * 璇锋眰鍙傛暟
- */
- @TableField(exist = false)
- private Map<String, Object> params = new HashMap<>();
+ public SysUser(Long userId) {
+ this.userId = userId;
+ }
- /**
- * 閮ㄩ棬瀵硅薄
- */
- @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 boolean isAdmin() {
- return isAdmin(this.userId);
- }
-
- public static boolean isAdmin(Long userId) {
- return userId != null && 1L == userId;
- }
+ public boolean isAdmin() {
+ return UserConstants.ADMIN_ID.equals(this.userId);
+ }
}
--
Gitblit v1.9.3