使用背景:
针对项目中有新增时间,修改时间,新增人,修改人等字段;
最笨的办法是:新增时,new Date()或者是java8的LocalDateTime.now()来设置到新增时间上;修改时,再new Date()设置到修改字段上;只要是有这两个字段的地方都这么干,每一块都写一次。
再进一步,可以再sql中直接写入mysql的内置函数,比如:update_time=now();不过针对新增人,修改人却用不用了内置函数,添加不了默认值了。
最终,我们可以使用MP提供的自动填充功能。
自动填充方案:
public enum FieldFill {
//默认不填充
DEFAULT,
//插入时填充字段
INSERT,
//修改时填充字段
UPDATE,
//插入和更新时填充字段
INSERT_UPDATE
}
实现步骤:
- 在实体字段中添加注解@TableField(fill=FieldFill.INSERT)等注解
@TableField(fill = FieldFill.INSERT)
private Date createTime;
@TableField(fill = FieldFill.UPDATE)
private Date updateTime;
- 建立一个填充处理器,它需要实现mp提供的原对象处理器接口:
①先建一个包component;
②再建一个自定义的原对象处理器类MyMetaObjectHandler.java,并且实现原对象处理器接口MetaObjectHandler;
③给自定义类加上@Component注解,表示他是一个在spring管理下的bean。
package com.mp.first.component;
import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;
import java.util.Date;
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
//定义插入时如何填充
@Override
public void insertFill(MetaObject metaObject) {
//注意这里填充的数据类型要和实体类定义的数据类型保持一致,否则填充不进去或者会报错
//插入和更新通用,但当字段已存在值时不进行填充
this.fillStrategy(metaObject, "createTime", new Date());
// setFieldValByName("createTime", new Date(), metaObject);
//insert时使用,插入时强制填充
// this.strictInsertFill(metaObject, "createTime", Date.class, new Date());
// setInsertFieldValByName("createTime", new Date(), metaObject);
}
//定义修改时如果填充
@Override
public void updateFill(MetaObject metaObject) {
//注意这里填充的数据类型要和实体类定义的数据类型保持一致,所以不能使用LocalDateTime.now()(返回LocalDateTime类型),否则填充不进去或者会报错
// setFieldValByName("updateTime", LocalDateTime.now(), metaObject);
setFieldValByName("updateTime", new Date(), metaObject);
}
}
注1(避坑):这里填充的数据类型要和实体类定义的数据类型保持一致,LocalDateTime.now()返回的是LocalDateTime类型,不是Date类型;如有疑问可参考下链接:https://blog.csdn.net/m0_37628958/article/details/106633132
有的可能插入中文后,数据库中是乱码;解决办法是在yml的url中添加characterEncoding=UTF-8,添加后可以解决乱码问题:
spring:
datasource:
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://localhost:3306/mp?useSSL=false&characterEncoding=UTF-8&serverTimezone=GMT%2B8
username: root
password: root
- 进行测试
package com.mp.first;
import com.mp.first.dao.UserMapper;
import com.mp.first.entity.User;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;
@RunWith(SpringRunner.class)
@SpringBootTest
public class FillTest {
@Autowired
private UserMapper userMapper;
// INSERT INTO user ( id, name, age, email, manager_id, create_time, version, deleted ) VALUES ( ?, ?, ?, ?, ?, ?, ?, ? )
// 1324388805003751426(Long), 刘明超(String), 31(Integer), [email protected](String), 2(Long), 2020-11-06 00:31:11.757(Timestamp), 0(Integer), 0(Integer)
@Test
public void insert(){
User user = new User();
user.setName("刘明超");
user.setAge(31);
user.setEmail("[email protected]");
user.setManagerId(2L);
int rows = userMapper.insert(user);
System.out.println("影响行数:"+rows);
}
// UPDATE user SET age=?, update_time=?, version=? WHERE id=? AND deleted=0
// 33(Integer), 2020-11-06 00:51:12.482(Timestamp), 0(Integer), 1324388805003751426(Long)
@Test
public void updateById(){
User user = new User();
user.setAge(33);
user.setId(1324388805003751426L);
int rows = userMapper.updateById(user);
System.out.println("影响行数:"+rows);
}
}
自动填充优化
- 场景一:有时需要填充的值需要进行很多方法调用才能拿到,这些方法可能会有一定开销的。就是上面的new Date()处的逻辑可能很复杂,需要经过方法abcde等等才能拿到。
我们希望,有这个属性的实体才调用自动填充的方法;而没有这个属性的实体,就不调用自动填充的方法。而默认情况下:它是每次都会调,而不管你有没有这个属性,这样比较浪费性能。
如何解决呢?
- 在插入时先调用metaObject的hasSetter("属性名")方法来判断是否有这个属性,有的话再去调自动填充方法:
@Override
public void insertFill(MetaObject metaObject) {
/**
* 调用hasSetter方法判断是否有这个属性,有的话再调用自动填充方法,没有就不执行,这样就不会浪费性能
*/
boolean hasSetter = metaObject.hasSetter("createTime");
if (hasSetter) {
//注意这里填充的数据类型要和实体类定义的数据类型保持一致,否则填充不进去或者会报错
//插入和更新通用,但当字段已存在值时不进行填充
this.fillStrategy(metaObject, "createTime", new Date());
// setFieldValByName("createTime", new Date(), metaObject);
//insert时使用,插入时强制填充
// this.strictInsertFill(metaObject, "createTime", Date.class, new Date());
// setInsertFieldValByName("createTime", new Date(), metaObject);
}
}
- 场景二:我们希望当我们自己设置了更新时间时,就不需要自动填充了;当我们没有设置更新时间时,就给我们进行自动填充。
怎么实现呢?
- 先通过getFieldValByName取想要进行自动填充的属性的值,看有没有设置好,如果没有设置好返回了空,我们再进行自动填充:
@Override
public void updateFill(MetaObject metaObject) {
/**
* 先取该属性的值,看是否为null,为null的时候才给它进行自动填充
*/
Object val = getFieldValByName("updateTime", metaObject);
if (val == null) {
//注意这里填充的数据类型要和实体类定义的数据类型保持一致,所以不能使用LocalDateTime.now()(返回LocalDateTime类型),否则填充不进去或者会报错
// setFieldValByName("updateTime", LocalDateTime.now(), metaObject);
setFieldValByName("updateTime", new Date(), metaObject);
}
}