在 MyBatis-Plus 中,MetaObjectHandler 是一个用于处理实体对象的元对象的接口。
它允许我们在插入、更新、删除等操作之前或之后,对实体对象进行自定义处理。通过 MetaObjectHandler,我们可以实现如自动填充创建时间、更新时间、删除标记等功能。
一、MetaObjectHandler 原理
在 MyBatis-Plus 的全局配置中,我们可以注册一个或多个 MetaObjectHandler
实现类。这些实现类将会在执行插入、更新、删除等 CRUD 操作之前或之后进行拦截。我们可以在这些方法中对实体对象进行自定义处理。
在 MetaObjectHandler
的方法中,我们可以根据需要对实体对象的属性进行修改或赋值。例如,自动填充创建时间、更新时间、删除标记等。
二、MetaObjectHandler 使用方式
1. 创建 MetaObjectHandler 实现类
首先,我们需要创建一个实现 MetaObjectHandler 接口的类。在这个类中,我们可以根据需要重写其中的方法。
import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import com.frontyue.common.core.domain.LoginUser;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import java.time.LocalDateTime;
/**
* MyMetaObjectHandler
*/
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
@Autowired
private LoginUser loginUser;
@Override
public void insertFill(MetaObject metaObject) {
setFieldValByName("createTime", LocalDateTime.now(), metaObject);
setFieldValByName("createBy", loginUser.getUsername(), metaObject);
}
@Override
public void updateFill(MetaObject metaObject) {
setFieldValByName("updateTime", LocalDateTime.now(), metaObject);
setFieldValByName("updateBy", loginUser.getUsername(), metaObject);
}
}
在上面的示例中,我们使用了 @Component 注解, 让MyMetaObjectHandler
类被 Spring 管理。我们创建了一个名为MyMetaObjectHandler
的类,并实现了 MetaObjectHandler
接口。在insertFill
方法中,我们自动填充了创建人和创建时间。在 updateFill
方法中,我们自动更新数据库表中更新时间与更新人。
2. 使用 MetaObjectHandler
在实体类中,添加创建人、创建时间、更新人、更新时间字段:
import java.time.LocalDateTime;
public class User {
private static final long serialVersionUID = 1L;
@TableId(value = "user_id", type = IdType.AUTO)
private Integer userId;
@TableField("username")
private String username;
@TableField("nick_name")
private String nickName;
@TableField("password")
private String password;
/**
* 创建者
*/
@TableField(value = "create_by" , fill = FieldFill.INSERT)
private String createBy;
/**
* 创建时间
*/
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss" )
@TableField(value = "create_time" , fill = FieldFill.INSERT)
private LocalDateTime createTime;
/**
* 更新者
*/
@TableField(value = "update_by" , fill = FieldFill.INSERT_UPDATE)
private String updateBy;
/**
* 更新时间
*/
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss" )
@TableField(value = "update_time" , fill = FieldFill.INSERT_UPDATE)
private LocalDateTime updateTime;
/**
* 备注
*/
@TableField("remark" )
private String remark;
}
通过以上配置,我们在操作数据库时,就不用可以去处理这些字段。
网友评论