SpringBoot - @TableName / @TableField / @TableId 注解使用详解
·
@TableName的作用
在实体类上指定,指定实体类和数据库表的映射关系。当实体类的类名在转成小写后和数据库表名相同时,可以不指定该注解。
@TableField的作用
在mybatis-plus中通过@TableField注解可以指定非主键的字段的一些属性,主要解决以下两个问题:
①. 解决数据库表跟实体类属性不对应的问题,对象中的属性名和表中的字段名不一致的情况(成员属性为非驼峰命名)
②. 排除非表字段,实体的一个成员属性但是表中没有对应字段的情况
③. 不查询指定字段属性,指定某些表字段不在查询结果中出现
④. 指定字段的填充策略
⑤. 指定字段验证策略,通过insertStrategy,updateStrategy,whereStrategy属性进行配置,可以控制在实体对象进行插入,更新,或作为WHERE条件时,对象中的字段如何组装到SQL语句中。
// 指定实体类和数据库表的映射关系, AdminDO 与 表 mallx_admin进行映射
@TableName("mallx_admin")
@Data
public class AdminDO extends BaseDO {
// 无需指定,自动解析
private String userName;
// 指明该属性在查询结果中不出现
@TableField(select = false)
private String password;
private String phone;
// 指明该实体的属性和数据库表字段不一致, 进行关联
@TableField("nick_name")
private String nick;
// 指明该属性在数据库表的字段中不存在,表示当前属性不是数据库的字段,但在实际项目中必须使用,指定后不会报错,如果不指定会报错
@TableField(exist = false)
private String salary;
// 当构造QueryWrapper时,可以如下设置
// AdminDO admin = new AdminDO();
// admin.setAddress("丈八六路");
// QueryWrapper<AdminDO> queryWrapper = new QueryWrapper<>(admin);
// 则SQL的解析为: WHERE address LIKE ('%', ?, '%')
// 当某些属性会进行模糊查询时,可以进行如下设置
@TableField(condition = SqlCondition.LIKE)
private String address;
}
@Tableld的作用
用于指定实体类的某个属性为对应的主键,类型主要有以下几种:
public enum IdType {
// 数据库ID自增
AUTO(0),
// 该类型为未设置主键类型(默认)
NONE(1),
// 用户输入ID,该类型可以通过自己注册自动填充插件进行填充
INPUT(2),
// 分配 ID(主键类型为 Number(Long 和 Integer)或 String)(since 3.3.0),使用接口IdentifierGenerator的方法nextId(默认实现类为DefaultIdentifierGenerator雪花算法),该策略会使用雪花算法自动生成主键 ID,主键类型为 Long 或 String(分别对应 MySQL 的表字段为 BIGINT 和 VARCHAR)
ASSIGN_ID(3),
// 分配 UUID,主键类型为 String(since 3.3.0),使用接口IdentifierGenerator的方法nextUUID(默认 default 方法),如果使用 IdType.ASSIGN_UUID 策略,则会自动生成不含中划线的 UUID 作为主键。主键类型为 String,对应 MySQL 的表字段为 VARCHAR(32)
ASSIGN_UUID(4),
// 以下3种类型不推荐使用
/** @deprecated */
@Deprecated
ID_WORKER(3),
/** @deprecated */
@Deprecated
ID_WORKER_STR(3),
/** @deprecated */
@Deprecated
UUID(4);
private final int key;
private IdType(int key) {
this.key = key;
}
public int getKey() {
return this.key;
}
}
如果默认全部都使用 AUTO 策略(数据库 ID 自增),那么可以在 application.properties 中添加如下配置进行修改:
mybatis-plus.global-config.db-config.id-type=auto
字段验证策略
数据库全局配置策略有三种,分别是查询策略,更新策略,和添加策略,可以进行全局配置。
public enum FieldStrategy {
// 忽略判断,不管值是什么直接进行更新和插入
// update table_a set column=#{columnProperty}
IGNORED,
// 当执行更新或者插入操作时,只更或插入非NULL的值(也就是说不允许将NULL值插入到数据库中)
// 也就是说当对象的某个成员属性为NULL时,该值不会进行set更新,如果某个成员属性为空字符串就会进行set更新操作
// insert into table_a(<if test="columnProperty != null">column</if>) values (<if test="columnProperty != null">#{columnProperty}</if>)
NOT_NULL,
// 当执行更新或者插入操作时,只更新和插入非NULL值且非空字符串(也就是说不允许将NULL值和空字符串插入到数据库中)
// where <if test="columnProperty != null and columnProperty!=''">column=#{columnProperty}</if>
NOT_EMPTY,
// 默认NOT_NULL
DEFAULT,
// 不管值是什么,永远不进行更新和插入
NEVER;
private FieldStrategy() {
}
}
字段填充策略
更多推荐
已为社区贡献7条内容
所有评论(0)