easymybatis中字段自动填充

原创
2017/10/17 14:05
阅读数 636

假设数据库表里面有两个时间字段gmt_create,gmt_update。

当进行insert操作时gmt_create,gmt_update字段需要更新。当update时,gmt_update字段需要更新。

通常的做法是通过Entity手动设置:

User user = new User();
user.setGmtCreate(new Date());
user.setGmtUpdate(new Date());

因为表设计的时候大部分都有这两个字段,所以对每张表都进行手动设置的话很容易错加、漏加。 easymybatis提供了两个辅助类DateFillInsert和DateFillUpdate,用来处理添加修改时的时间字段自动填充。配置了这两个类之后,时间字段将会自动设置。

配置方式如下:

EasymybatisConfig config = new EasymybatisConfig();

    config.setFills(Arrays.asList(
			new DateFillInsert()
			,new DateFillUpdate()
			));

如果要指定字段名,可以写成:

new DateFillInsert("add_time")

自定义填充器

除了使用easymybatis默认提供的填充之外,我们还可以自定义填充。

自定义填充类要继承FillHandler<T>类。 <T> 表示填充字段类型,如Date,String,BigDecimal,Boolean。

实战

现在有个remark字段,需要在insert时初始化为“备注默认内容”,新建一个StringRemarkFill类如下:

public class StringRemarkFill extends FillHandler<String> {

	@Override
	public String getColumnName() {
		return "remark";
	}

	@Override
	public FillType getFillType() {
		return FillType.INSERT;
	}

	@Override
	protected Object getFillValue(String defaultValue) {
		return "备注默认内容";
	}

}

StringRemarkFill类中有三个重写方法:

  • getColumnName() : 指定表字段名
  • getFillType() : 填充方式,FillType.INSERT:仅insert时填充;FillType.INSERT:insert,update时填充
  • getFillValue(String defaultValue) :返回填充内容。

然后在easymybatisConfig中添加

config.setFills(Arrays.asList(
			new DateFillInsert()
			,new DateFillUpdate()
			,new StringRemarkFill()
			));

这样就配置完毕了,调用dao.save(user);时会自动填充remark字段。

指定目标类

上面说到StringRemarkFill填充器,它作用在所有实体类上,也就是说实体类如果有remark字段都会自动填充。这样显然是不合理的,解决办法是指定特定的实体类。只要重写FillHandler类的getTargetEntityClasses()方法即可。

@Override
public Class<?>[] getTargetEntityClasses() {
	return new Class<?>[] { TUser.class };
}

这样就表示作用在TUser类上,多个类可以追加。最终代码如下:

public class StringRemarkFill extends FillHandler<String> {

	@Override
	public String getColumnName() {
		return "remark";
	}

	@Override
	public Class<?>[] getTargetEntityClasses() {
		return new Class<?>[] { TUser.class }; // 只作用在TUser类上
	}

	@Override
	public FillType getFillType() {
		return FillType.INSERT;
	}

	@Override
	protected Object getFillValue(String defaultValue) {
		return "备注默认内容"; // insert时填充的内容
	}

}

关于自动填充的原理是基于mybatis的TypeHandler实现的,这里就不多做介绍了。感兴趣的同学可以查看FillHandler<T>源码。

展开阅读全文
加载中
点击引领话题📣 发布并加入讨论🔥
打赏
0 评论
0 收藏
0
分享
返回顶部
顶部