描述
@TableField是MyBatis-Plus中的一个常用注解,用于指定实体类属性与数据库表字段的映射关系。通过使用@TableField注解,可以自定义属性名和数据库表字段名的映射规则,从而实现更加灵活的数据库操作。
关联数据库表字段示例
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableName;
import java.util.Date;
@TableName("user") // 指定对应的表名
public class User {
private Long id;
@TableField("username") // 指定属性名与字段名的映射关系
private String name;
@TableField("password")
private String password;
@TableField("create_time")
private Date createTime;
// getter和setter方法省略
}
注解相关属性说明
使用@TableField注解非常简单,只需要在实体类的属性上添加该注解,并设置相应的属性值即可。下面是@TableField注解的常用属性及其说明:
value:指定属性对应的数据库表字段名。如果属性名与表字段名一致,可以不用设置该属性。
exist:设置属性是否为数据库表字段,默认为true。如果设置为false,则表示该属性不对应任何数据库字段。
select:设置查询时是否查询该属性,默认为true。如果设置为false,则表示查询时不查询该属性。
insert:设置插入时是否插入该属性,默认为true。如果设置为false,则表示插入时不插入该属性。
update:设置更新时是否更新该属性,默认为true。如果设置为false,则表示更新时不更新该属性。
keepGlobalFormat:设置是否保持全局的命名规则,默认为false。如果设置为true,则属性名将按照全局的命名规则进行转换。
condition:设置查询条件,只有满足条件的数据才会查询到该属性。
MetaObjectHandler使用
MetaObjectHandler接口是mybatisPlus为我们提供的的一个扩展接口,我们可以利用这个接口在我们插入或者更新数据的时候,为一些字段指定默认值。比如:
insertFill(MetaObject metaObject):在执行插入操作时自动填充实体对象的属性值。
updateFill(MetaObject metaObject):在执行更新操作时自动填充实体对象的属性值。
@Data
@TableName("user")
public class User {
/**
* 创建时间
*/
@TableField(fill = FieldFill.INSERT)
private LocalDateTime creationDate;
/**
* 创建人名称
*/
@TableField(fill = FieldFill.INSERT)
private String createdBy;
/**
* 最后更新时间
*/
@TableField(fill = FieldFill.INSERT_UPDATE)
private LocalDateTime lastUpdateDate;
/**
* 最后更新人名称
*/
@TableField(fill = FieldFill.INSERT_UPDATE)
private String lastUpdatedBy;
}
自定义类DbFieldFillHandler实现接口MetaObjectHandler
package com.skytech.smcp.handler;
import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import com.skytech.seed.core.security.authenticate.AuthenticationTools;
import lombok.extern.slf4j.Slf4j;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.context.annotation.Primary;
import org.springframework.stereotype.Component;
import javax.annotation.Resource;
import java.time.LocalDateTime;
@Slf4j
@Component("myMetaObjectHandler")
@Primary
public class MyMetaObjectHandler implements MetaObjectHandler {
private String CREATE_TIME = "createTime";
private String UPDATE_TIME = "updateTime";
@Override
public void insertFill(MetaObject metaObject) {
if (metaObject.hasSetter(CREATE_TIME)) {
if (metaObject.getValue(CREATE_TIME) == null) {
metaObject.setValue(CREATE_TIME, LocalDateTime.now());
}
}
if (metaObject.hasSetter(UPDATE_TIME)) {
if (metaObject.getValue(UPDATE_TIME) == null) {
metaObject.setValue(UPDATE_TIME, LocalDateTime.now());
}
}
}
@Override
public void updateFill(MetaObject metaObject) {
if (metaObject.hasSetter(UPDATE_TIME)) {
if (metaObject.getValue(UPDATE_TIME) == null) {
metaObject.setValue(UPDATE_TIME, LocalDateTime.now());
}
}
}