查漏补缺16--实体类上的注解整理

于 2019-10-21 14:32:36 发布
阅读量404 收藏
点赞数
CC 4.0 BY-SA版权
分类专栏： 查漏补缺系列
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/shawnyang2019/article/details/102660510
本文深入解析了实体类设计的关键要素，包括字段注解的作用、数据验证、前后端交互及数据库映射，为开发者提供全面的指导。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

package io.crm.common.entity;

import com.baomidou.mybatisplus.annotations.TableField;
import com.baomidou.mybatisplus.enums.FieldFill;
import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.JsonFormat;
import com.fasterxml.jackson.annotation.JsonIgnore;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import org.springframework.format.annotation.DateTimeFormat;

import java.io.Serializable;
import java.util.Date;

/**
 * Created by IDEA 18.1.2
 *  数据库公共字段，自动填充
 * @author zly
 * @date: 2019/3/28
 * @time: 8:50
 * @description:
 */

public class BaseEntity{

    //  swagger注解，表示 该属性在前端swagger上会隐藏，但是查询的返回字段不受此注解影响
    @ApiModelProperty(value = "创建人",hidden = true)
//    MP注解：公共字段填充，使用公共字段填充是搭配@JsonIgnore 对当前属性不进行序列化和反序列化
    @TableField(fill = FieldFill.INSERT)
    @JsonIgnore
    private Long creator;


    @ApiModelProperty(value = "创建时间",hidden = true)
    @TableField(fill = FieldFill.INSERT)
    @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    @JsonFormat(pattern="yyyy-MM-dd HH:mm:ss",timezone="GMT+8")
    private Date createDate;

    @ApiModelProperty(value = "更新人员", hidden = true)
    @TableField(fill = FieldFill.INSERT_UPDATE)
    @JsonIgnore
    private Long updater;

    @ApiModelProperty(value = "更新时间", hidden = true)
    @TableField(fill = FieldFill.INSERT_UPDATE)
    @JsonIgnore
    private Date updateDate;

    @ApiModelProperty(value = "是否删除", hidden = true)
    @TableField(fill = FieldFill.INSERT)
    @JsonIgnore
    private Integer isDel;

    public Long getCreator() {
        return creator;
    }

    public void setCreator(Long creator) {
        this.creator = creator;
    }

    public Date getCreateDate() {
        return createDate;
    }

    public void setCreateDate(Date createDate) {
        this.createDate = createDate;
    }

    public Long getUpdater() {
        return updater;
    }

    public void setUpdater(Long updater) {
        this.updater = updater;
    }

    public Date getUpdateDate() {
        return updateDate;
    }

    public void setUpdateDate(Date updateDate) {
        this.updateDate = updateDate;
    }

    public Integer getIsDel() {
        return isDel;
    }

    public void setIsDel(Integer isDel) {
        this.isDel = isDel;
    }
}

/**
 * Copyright 2018 耘林养老 http://www.crm.cn
 * <p>
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 * <p>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p>
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

package io.crm.common.entity.sys;


import com.baomidou.mybatisplus.annotations.TableField;
import com.baomidou.mybatisplus.annotations.TableId;
import com.baomidou.mybatisplus.annotations.TableName;
import com.fasterxml.jackson.annotation.JsonFormat;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonProperty;
import io.crm.common.validator.group.AddGroup;
import io.crm.common.validator.group.UpdateGroup;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;

import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotNull;
import java.io.Serializable;
import java.util.Date;
import java.util.List;

/**
 * 系统用户
 * 
 * @author zsh
 * @email zoushaohua@sportsii.cn
 * @date 2016年9月18日 上午9:28:55
 */
@ApiModel(description = "系统用户表")
@TableName("sys_user")
public class SysUserEntity implements Serializable {
	private static final long serialVersionUID = 1L;

	public static final Integer USABLE = 1;
	public static final Integer UN_USABLE = 0;

//	Swagger注解，表示此属性可以为空（应为主键默认递增）,默认的值为example的值
	@ApiModelProperty(value = "用户主键ID", allowEmptyValue = true)
//	MP注解：表示该属性对应表用户主键
	@TableId
	private Long userId;

	@ApiModelProperty(value = "用户名", example = "admin")
//	validator注解：表示属性不能为空（在增加和更新的操作中），对于String数据类型，前端传过来的数据可能为null，所以这里
// 如需要可以做一下判定，swagger前端
	@NotBlank(message="用户名不能为空", groups = {AddGroup.class, UpdateGroup.class})
	private String username;

	@ApiModelProperty(value = "密码", example = "000")
	@NotBlank(message="密码不能为空", groups = AddGroup.class)
//	Json注解：表示只有在写入操作时，才会接受前端的值，进行序列化，读取操作时不会反序列化给前端传值
	@JsonProperty(access = JsonProperty.Access.WRITE_ONLY)
	private String password;

//  swagger注解，表示 该属性在前端swagger上会隐藏，但是查询的返回字段不受此注解影响
	@ApiModelProperty(value = "盐", example = "abcde", hidden = true)
//	Json注解：表示读写操作，序列化和反序列化操作都会忽略该属性，前端保存输入，从后端查询返回都不会有此属性名和属性值显示
//	前端的这个属性能否显示，受这两个注解的同时影响，满足其一就会隐藏，返回的数据只受@JsonIgnore的影响
	@JsonIgnore
	private String salt;

	@ApiModelProperty(value = "邮箱", example = "a@a.com")
	private String email;

	@ApiModelProperty(value = "手机号", example = "13000000000")
	private String mobile;

	@ApiModelProperty(value = "状态 0：禁用 1：正常", example = "0")
	private Integer status;

	@ApiModelProperty(value = "角色ID列表")
//	MP注解：表示该属性在表中不存在该字段，主要用于联表查询时作为一个字段返回给前端
	@TableField(exist=false)
	private List<Long> roleIdList;

	@ApiModelProperty(value = "创建时间", example = "2018-11-11 11:11:11")
//	Json注解：把Date类型的属性，按照格式反序列化给前端
	@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss",timezone="GMT+8")
	private Date createTime;

	@ApiModelProperty(value = "部门ID")
	@NotNull(message="部门不能为空", groups = {AddGroup.class, UpdateGroup.class})
	private Long deptId;

//	swagger注解 表示下面的属性只能读取，不能写入
	@ApiModelProperty(value = "部门名称", example = "研发部",readOnly = true)
	@TableField(exist=false)
	private String deptName;

	@ApiModelProperty(value = "账号类型", example = "0")
	private byte usetype;

	@ApiModelProperty(value = "类型名称")
	@TableField(exist = false)
	private String usetypeName;

	@ApiModelProperty(value = "扩展信息表id", allowEmptyValue = true)
	private Long extid;

	public String getUsetypeName() {
		return usetypeName;
	}

	public void setUsetypeName(String usetypeName) {
		this.usetypeName = usetypeName;
	}

	/**
	 * 设置：
	 * @param userId 
	 */
	public void setUserId(Long userId) {
		this.userId = userId;
	}

	/**
	 * 获取：
	 * @return Long
	 */
	public Long getUserId() {
		return userId;
	}
	
	/**
	 * 设置：用户名
	 * @param username 用户名
	 */
	public void setUsername(String username) {
		this.username = username;
	}

	/**
	 * 获取：用户名
	 * @return String
	 */
	public String getUsername() {
		return username;
	}
	
	/**
	 * 设置：密码
	 * @param password 密码
	 */
	public void setPassword(String password) {
		this.password = password;
	}

	/**
	 * 获取：密码
	 * @return String
	 */
	public String getPassword() {
		return password;
	}
	
	/**
	 * 设置：邮箱
	 * @param email 邮箱
	 */
	public void setEmail(String email) {
		this.email = email;
	}

	/**
	 * 获取：邮箱
	 * @return String
	 */
	public String getEmail() {
		return email;
	}
	
	/**
	 * 设置：手机号
	 * @param mobile 手机号
	 */
	public void setMobile(String mobile) {
		this.mobile = mobile;
	}

	/**
	 * 获取：手机号
	 * @return String
	 */
	public String getMobile() {
		return mobile;
	}
	
	/**
	 * 设置：状态  0：禁用   1：正常
	 * @param status 状态  0：禁用   1：正常
	 */
	public void setStatus(Integer status) {
		this.status = status;
	}

	/**
	 * 获取：状态  0：禁用   1：正常
	 * @return Integer
	 */
	public Integer getStatus() {
		return status;
	}

	/**
	 * 设置：创建时间
	 * @param createTime 创建时间
	 */
	public void setCreateTime(Date createTime) {
		this.createTime = createTime;
	}

	/**
	 * 获取：创建时间
	 * @return Date
	 */
	public Date getCreateTime() {
		return createTime;
	}

	public List<Long> getRoleIdList() {
		return roleIdList;
	}

	public void setRoleIdList(List<Long> roleIdList) {
		this.roleIdList = roleIdList;
	}

	public String getSalt() {
		return salt;
	}

	public void setSalt(String salt) {
		this.salt = salt;
	}

	public Long getDeptId() {
		return deptId;
	}

	public void setDeptId(Long deptId) {
		this.deptId = deptId;
	}

	public String getDeptName() {
		return deptName;
	}

	public void setDeptName(String deptName) {
		this.deptName = deptName;
	}

	public byte getUsetype() {
		return usetype;
	}

	public void setUsetype(byte usetype) {
		this.usetype = usetype;
	}

	public Long getExtid() {
		return extid;
	}

	public void setExtid(Long extid) {
		this.extid = extid;
	}
}


package io.crm.common.entity.crm;

import com.baomidou.mybatisplus.annotations.TableField;
import com.baomidou.mybatisplus.annotations.TableId;
import com.baomidou.mybatisplus.annotations.TableName;
import com.fasterxml.jackson.annotation.JsonProperty;
import io.crm.common.entity.BaseEntity;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;

import java.io.Serializable;
import java.util.Date;

/**
 * 项目信息表
 *
 * @author ${author}
 * @email ${email}
 * @date 2019-10-10 15:47:52
 */
@ApiModel(description = "项目信息表")
@TableName("crm_project")
public class CrmProjectEntity extends BaseEntity implements Serializable {
	private static final long serialVersionUID = 1L;

	@TableId
    @ApiModelProperty(value = "主键Id")
	private Long id;

	@ApiModelProperty(value = "项目名称")
	private String name;

	@ApiModelProperty(value = "项目详情")
	private String detail;

	@ApiModelProperty(value = "项目简介")
	private String briefIntroduction;

	@ApiModelProperty(value = "项目地点")
	private String address;

	@ApiModelProperty(value = "项目状态:0、关；1、开")
	private Integer status = 1;

	@ApiModelProperty(value = "街道编码")
	private String streetCode;

	@ApiModelProperty(value = "部门id")
	private Long deptId;

	@ApiModelProperty(value = "部门名称",hidden = true)
	@TableField(exist = false)
//	前端写入时:@ApiModelProperty(value = "部门名称",hidden = false) 留出了输入接口，填写了也会被@JsonProperty过滤掉
//	所有一般只读操作时，会使用@ApiModelProperty(value = "部门名称",hidden = true)进行接口隐藏
	@JsonProperty(access = JsonProperty.Access.READ_ONLY)
	private String deptName;

	public String getDeptName() {
		return deptName;
	}

	public void setDeptName(String deptName) {
		this.deptName = deptName;
	}

	public void setId(Long id) {
		this.id = id;
	}

	public Long getId() {
		return id;
	}

	public Integer getStatus() {
		return status;
	}

	public void setStatus(Integer status) {
		this.status = status;
	}

	public String getStreetCode() {
		return streetCode;
	}

	public void setStreetCode(String streetCode) {
		this.streetCode = streetCode;
	}

	public Long getDeptId() {
		return deptId;
	}

	public void setDeptId(Long deptId) {
		this.deptId = deptId;
	}

	public void setName(String name) {
		this.name = name;
	}

	public String getName() {
		return name;
	}

	public void setDetail(String detail) {
		this.detail = detail;
	}

	public String getDetail() {
		return detail;
	}

	public void setBriefIntroduction(String briefIntroduction) {
		this.briefIntroduction = briefIntroduction;
	}

	public String getBriefIntroduction() {
		return briefIntroduction;
	}

	public void setAddress(String address) {
		this.address = address;
	}

	public String getAddress() {
		return address;
	}
}

@Api 注解主要表示 前端的显示问题
@Json 相关注解 表示是否序列化到数据库和反序列化给前端的问题
@Table 相关注解主要表示实体和表字段的对应关系问题
@NotBlank 相关注解用于数据验证

评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值