@TableField
是 MyBatis Plus 提供的一个注解,用于指定实体类字段与数据库表字段的映射关系,并可以设置字段的特殊属性。以下是 @TableField
的具体使用场景、用法和参数说明:
使用场景
- 字段名映射:当实体类的字段名与数据库表的字段名不一致时,可以使用
@TableField
注解进行映射。 - 字段填充策略:在插入或更新数据时,可以自动填充某些字段的值。
- 逻辑删除:标记一个字段用于逻辑删除,而不是物理删除。
- 乐观锁:标记一个字段用于乐观锁版本控制。
- 字段忽略:标记一个字段不映射到数据库表字段。
用法
@TableField
注解可以应用于实体类的字段上,通过设置不同的参数来实现不同的功能。
参数说明
@TableField
注解提供了多个参数,以下是一些常用的参数:
- value:指定数据库表字段名。
- exist:指定该字段是否为数据库表字段,默认为
true
。 - fill:指定字段填充策略,常用的有
FieldFill.INSERT
、FieldFill.UPDATE
、FieldFill.INSERT_UPDATE
。 - select:指定查询时是否查询该字段,默认为
true
。 - update:指定更新时是否更新该字段,默认为
true
。 - condition:指定查询时的条件,如
Condition.LIKE
。 - el:指定动态 SQL 中的表达式。
示例
1. 字段名映射
假设实体类的字段名 userName
对应数据库表的字段名 user_name
:
import com.baomidou.mybatisplus.annotation.TableField;
public class User {
@TableField("user_name")
private String userName;
// 其他字段和方法
}
2. 字段填充策略
假设在插入和更新数据时,自动填充 createTime
和 updateTime
字段:
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.FieldFill;
public class User {
@TableField(value = "create_time", fill = FieldFill.INSERT)
private Date createTime;
@TableField(value = "update_time", fill = FieldFill.INSERT_UPDATE)
private Date updateTime;
// 其他字段和方法
}
3. 逻辑删除
假设使用 deleted
字段进行逻辑删除:
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableLogic;
public class User {
@TableField("deleted")
@TableLogic
private Integer deleted;
// 其他字段和方法
}
4. 乐观锁
假设使用 version
字段进行乐观锁版本控制:
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.Version;
public class User {
@TableField("version")
@Version
private Integer version;
// 其他字段和方法
}
5. 字段忽略
假设 temp
字段不映射到数据库表字段:
import com.baomidou.mybatisplus.annotation.TableField;
public class User {
@TableField(exist = false)
private String temp;
// 其他字段和方法
}
综合示例
以下是一个综合示例,展示了如何使用 @TableField
注解的不同参数:
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.TableLogic;
import com.baomidou.mybatisplus.annotation.Version;
public class User {
@TableField("user_name")
private String userName;
@TableField(value = "create_time", fill = FieldFill.INSERT)
private Date createTime;
@TableField(value = "update_time", fill = FieldFill.INSERT_UPDATE)
private Date updateTime;
@TableField("deleted")
@TableLogic
private Integer deleted;
@TableField("version")
@Version
private Integer version;
@TableField(exist = false)
private String temp;
// getters and setters
}
总结
@TableField
注解提供了丰富的参数,用于指定实体类字段与数据库表字段的映射关系,并可以设置字段的特殊属性。通过使用这些参数,开发者可以更灵活地进行字段映射和数据操作,从而简化开发过程,提高开发效率。MyBatis Plus 是一个功能强大且易于使用的 MyBatis 增强工具,适用于各种规模的 Java Web 项目。