字段自动填充

本篇介绍easymybatis的字段填充功能。数据库表中的一些日期字段需要自动更新，如果手动赋值难免会有遗漏的情况。

填充器设置

假设数据库表里面有两个时间字段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，用来处理添加修改时的时间字段自动填充。配置了这两个类之后，时间字段将会自动设置。

springboot项目配置方式如下：

在application.properties中添加

mybatis.fill.net.oschina.durcframework.easymybatis.support.DateFillInsert=
mybatis.fill.net.oschina.durcframework.easymybatis.support.DateFillUpdate=

如果要指定字段名，可以写成：

mybatis.fill.net.oschina.durcframework.easymybatis.support.DateFillInsert=add_time

在springmvc的xml中配置如下:

<bean id="sqlSessionFactory"
        class="net.oschina.durcframework.easymybatis.ext.SqlSessionFactoryBeanExt">
        <property name="dataSource" ref="dataSource" />
        <property name="configLocation">
            <value>classpath:mybatis/mybatisConfig.xml</value>
        </property>
        <property name="mapperLocations">
            <list>
                <value>classpath:mybatis/mapper/*.xml</value>
            </list>
        </property>

        <!-- 以下是附加属性 -->

        <!-- dao所在的包名,跟MapperScannerConfigurer的basePackage一致 
            多个用;隔开
        -->
        <property name="basePackage" value="com.myapp.dao" />
        <property name="config">
            <bean class="net.oschina.durcframework.easymybatis.EasymybatisConfig">
                                <!-- 定义填充器 -->
                <property name="fills">
                    <list>
                                        <bean class="net.oschina.durcframework.easymybatis.support.DateFillInsert"/>
                                        <bean class="net.oschina.durcframework.easymybatis.support.DateFillUpdate"/>
                    </list>
                </property>
            </bean>
        </property>
    </bean>

自定义填充器

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

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

实战(springboot)

现在有个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.UPDATE：insert，update时填充
• getFillValue(String defaultValue) ：返回填充内容

然后在application.properties中添加

mybatis.fill.com.xx.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时填充的内容
    }

}

高级匹配

覆盖FillHandler类中的match方法可以让填充器做更高级的匹配，match方法如下

/**
 * 是否能够作用到指定字段
 * @param entityClass 实体类class
 * @param field 字段信息
 * @param columnName 给定的数据库字段名
 * @return
 */
public boolean match(Class<?> entityClass, Field field, String columnName)

这个方法返回的是一个boolean，返回true则代表作用到该属性上。例如下面的代码：

• 匹配出含有@Id和@GeneratedValue(strategy=GenerationType.AUTO)的字段

public boolean match(Class<?> entityClass, Field field, String columnName) {
        boolean isPk = field.getAnnotation(Id.class) != null; // 是否有@Id注解

        GeneratedValue gv = field.getAnnotation(GeneratedValue.class);
        boolean isAuto = gv != null && gv.strategy() == GenerationType.AUTO; // 是否有@GeneratedValue注解，并且策略是AUTO

        return isPk && isAuto;
    }

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