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 | 177 ++++++++++++++++++++++++++++------------------------------- 1 files changed, 84 insertions(+), 93 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 a371039..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,169 +1,160 @@ package com.ruoyi.common.core.domain.entity; import com.baomidou.mybatisplus.annotation.*; -import com.fasterxml.jackson.annotation.JsonFormat; -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.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 */ - @Excel(name = "鐢ㄦ埛搴忓彿", cellType = ColumnType.NUMERIC, prompt = "鐢ㄦ埛缂栧彿") - @TableId(value = "user_id",type = IdType.AUTO) + /** + * 鐢ㄦ埛ID + */ + @TableId(value = "user_id") private Long userId; - /** 閮ㄩ棬ID */ - @Excel(name = "閮ㄩ棬缂栧彿", type = Type.IMPORT) + /** + * 閮ㄩ棬ID + */ private Long deptId; - /** 鐢ㄦ埛璐﹀彿 */ + /** + * 鐢ㄦ埛璐﹀彿 + */ + @Xss(message = "鐢ㄦ埛璐﹀彿涓嶈兘鍖呭惈鑴氭湰瀛楃") @NotBlank(message = "鐢ㄦ埛璐﹀彿涓嶈兘涓虹┖") @Size(min = 0, max = 30, message = "鐢ㄦ埛璐﹀彿闀垮害涓嶈兘瓒呰繃30涓瓧绗�") - @Excel(name = "鐧诲綍鍚嶇О") private String userName; - /** 鐢ㄦ埛鏄电О */ + /** + * 鐢ㄦ埛鏄电О + */ + @Xss(message = "鐢ㄦ埛鏄电О涓嶈兘鍖呭惈鑴氭湰瀛楃") @Size(min = 0, max = 30, message = "鐢ㄦ埛鏄电О闀垮害涓嶈兘瓒呰繃30涓瓧绗�") - @Excel(name = "鐢ㄦ埛鍚嶇О") private String nickName; - /** 鐢ㄦ埛閭 */ + /** + * 鐢ㄦ埛绫诲瀷锛坰ys_user绯荤粺鐢ㄦ埛锛� + */ + private String userType; + + /** + * 鐢ㄦ埛閭 + */ + @Sensitive(strategy = SensitiveStrategy.EMAIL) @Email(message = "閭鏍煎紡涓嶆纭�") @Size(min = 0, max = 50, message = "閭闀垮害涓嶈兘瓒呰繃50涓瓧绗�") - @Excel(name = "鐢ㄦ埛閭") private String email; - /** 鎵嬫満鍙风爜 */ - @Excel(name = "鎵嬫満鍙风爜") + /** + * 鎵嬫満鍙风爜 + */ + @Sensitive(strategy = SensitiveStrategy.PHONE) private String phonenumber; - /** 鐢ㄦ埛鎬у埆 */ - @Excel(name = "鐢ㄦ埛鎬у埆", readConverterExp = "0=鐢�,1=濂�,2=鏈煡") + /** + * 鐢ㄦ埛鎬у埆 + */ private String sex; - /** 鐢ㄦ埛澶村儚 */ + /** + * 鐢ㄦ埛澶村儚 + */ private String avatar; - /** 瀵嗙爜 */ + /** + * 瀵嗙爜 + */ + @TableField( + insertStrategy = FieldStrategy.NOT_EMPTY, + updateStrategy = FieldStrategy.NOT_EMPTY, + whereStrategy = FieldStrategy.NOT_EMPTY + ) private String password; - @JsonIgnore - @JsonProperty - public String getPassword() { - return password; - } - - /** 鐩愬姞瀵� */ - private String salt; - - /** 甯愬彿鐘舵�侊紙0姝e父 1鍋滅敤锛� */ - @Excel(name = "甯愬彿鐘舵��", readConverterExp = "0=姝e父,1=鍋滅敤") + /** + * 甯愬彿鐘舵�侊紙0姝e父 1鍋滅敤锛� + */ private String status; - /** 鍒犻櫎鏍囧織锛�0浠h〃瀛樺湪 2浠h〃鍒犻櫎锛� */ + /** + * 鍒犻櫎鏍囧織锛�0浠h〃瀛樺湪 2浠h〃鍒犻櫎锛� + */ @TableLogic private String delFlag; - /** 鏈�鍚庣櫥褰旾P */ - @Excel(name = "鏈�鍚庣櫥褰旾P", type = Type.EXPORT) + /** + * 鏈�鍚庣櫥褰旾P + */ private String loginIp; - /** 鏈�鍚庣櫥褰曟椂闂� */ - @Excel(name = "鏈�鍚庣櫥褰曟椂闂�", width = 30, dateFormat = "yyyy-MM-dd HH:mm:ss", type = Type.EXPORT) + /** + * 鏈�鍚庣櫥褰曟椂闂� + */ private Date loginDate; - /** 鍒涘缓鑰� */ - @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; - - /** 澶囨敞 */ + /** + * 澶囨敞 + */ private String remark; /** - * 璇锋眰鍙傛暟 + * 閮ㄩ棬瀵硅薄 */ - @TableField(exist = false) - private Map<String, Object> params = new HashMap<>(); - - /** 閮ㄩ棬瀵硅薄 */ - @Excels({ - @Excel(name = "閮ㄩ棬鍚嶇О", targetAttr = "deptName", type = Type.EXPORT), - @Excel(name = "閮ㄩ棬璐熻矗浜�", targetAttr = "leader", type = Type.EXPORT) - }) @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; + /** + * 鏁版嵁鏉冮檺 褰撳墠瑙掕壊ID + */ + @TableField(exist = false) + private Long roleId; - public SysUser(Long userId) - { + 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