MyBatis拦截器+自定义注解实现新增保存操作字段值自动填充

一、实现该功能的动机

以作者本人有限的开发经验看来，MyBatisPlus作为一个应用广泛的MyBatis增强工具，在开发效率上，给予了广大开发者巨大的便利，以其强大的功能，获得了无数开发者的青睐，当然事物总是具有两面性，仁者见仁。经过我对MyBatisPlus一段时间的使用和从其他开发者对其的评价出发，我认为MyBatisPlus在代码中常常存在条件构造器滥用，如：在ServiceImpl甚至Controller类中随意的拼接SQL语句，魔法值泛滥，在开发时期固然效率很高，但是从长远的代码维护来看，实是不妥；再如大量的SQL不需要通过规范的管理和定义，导致其不利于优化，迭代和升级，凡此种种，都可能导致有些开发者从搭建项目基础架构时便不想使用Plus。

作者本人自然是其中一员，即使如此，Plus中某些功能对于开发效率的提升显著，例如在执行sql时，对某些字段按照一定的填充规则进行自动填充，于是便有了自己实现这个功能的想法，话不多说，上干货。

二、整体思路构建

实现字段按照一定规则自动填充的功能，主要的思路如下：

首先，定义一个填充规则类，每个字段的填充规则对应该类中一个方法，通过自定义注解说明该方法要填充的字段名，在系统初始化时(该时机可以是启动类中执行方法，也可以将此类交于SpringIOC管理)，通过反射维护一个Map集合，以注解标识的字段名为key，对应的Method为value，这是灵活实现该功能的基础。

其次，自定义一个字段填充注解，说明该字段的名称，与填充规则方法注解上的字段名称一直，并说明该字段要在什么场景下进行自动填充(Update or Insert)。

最后，通过对MybatisInterceptor拦截器的自定义实现，按照既定的规则对字段进行填充。

三、关键代码实现

1.自定义填充规则注解@ColumnFillRule

/**
 * @author ghCode
 * @since 2023-09-14 20:35
 * 自定义字段填充规则注解，标注与填充规则的方法上
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
public @interface ColumnFillRule {
  /**
   * 标注该注解的方法要填充的对应字段
   *
   * @return 字段名(驼峰, 与ColumnFill注解的name值一致)
   */
  String name();
}

2.字段填充规则类MybatisFillRuleUtil

/**
 * @author ghCode
 * @since 2023-08-27 18:38
 * mybatis 填充字段规则类
 */
public class MybatisFillRuleUtil {
  /**
   * 获取填充ID值
   *
   * @return 由雪花算法生成的ID
   */
  @ColumnFillRule(name = "id")
  public Long fillId() {
    return IdUtil.getSnowflakeNextId();
  }

  /**
   * 获取填充创建者Id值
   *
   * @return 当前登录用户Id
   */
  @ColumnFillRule(name = "creator")
  public Long fillCreator() {
    return UserSecurity.getCustomerId();
  }

  /**
   * 填充更新时间
   *
   * @return 当前时间
   */
  @ColumnFillRule(name = "createDate")
  public Date fillCreateDate() {
    return new Date();
  }

}

3.填充规则与对应字段Map维护类MybatisInterceptorVariable

/**
 * @author ghCode
 * @since 2023-09-14 20:11
 * mybatis拦截器变量类——用于维护系统启动时，拦截器所需要的相关配置
 */
public class MybatisInterceptorVariable {
  /**
   * 字段填充规则集合,系统启动时初始化
   */
  private static Map<String, Method> fillRuleMap;

  /**
   * 设置填充规则集合
   *
   * @param fillRuleMap 规则集合
   */
  public static void setFillRuleMap(Map<String, Method> fillRuleMap) {
    MybatisInterceptorVariable.fillRuleMap = fillRuleMap;
  }

  /**
   * 获取填充规则集合
   *
   * @return 规则集合
   */
  public static Map<String, Method> getFillRuleMap() {
    return MybatisInterceptorVariable.fillRuleMap;
  }

  /**
   * 初始化填充规则集合
   */
  public static void initFillRuleMap() {
    //定义字段与方法映射的集合
    Map<String, Method> map = new HashMap<>();
    //获取字段填充规则类
    Class<MybatisFillRuleUtil> rule = MybatisFillRuleUtil.class;
    //获取类中的方法
    Method[] ruleMethods = rule.getMethods();
    if (ruleMethods.length > 0) {
      //维护map映射
      for (Method ruleMethod : ruleMethods) {
        //关闭安全检查,使属性可操作
        ruleMethod.setAccessible(true);
        ColumnFillRule annotation = ruleMethod.getAnnotation(ColumnFillRule.class);
        if (annotation != null) {
          map.put(annotation.name(), ruleMethod);
        }
      }
      setFillRuleMap(map);
    }
  }
}

4.自定义字段填充注解@ColumnFill

/**
 * @author ghCode
 * @since 2023-08-27 16:58
 * 自定义字段填充注解
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD})
public @interface ColumnFill {
  /**
   * 值，默认为空，无用
   *
   * @return value
   */
  String value() default "";

  /**
   * 填充的字段名
   *
   * @return 字段名(驼峰)
   */
  String name();

  /**
   * 填充场景 插入/更新/默认
   *
   * @return SqlCommandType
   */
  SqlCommandType fillType() default SqlCommandType.UNKNOWN;
}

5.Mybatis拦截器实现

/**
 * @author ghCode
 * @since 2023-08-27 12:43
 * 自定义mybatis拦截器
 */
@Component
@Intercepts({
  @Signature(type = Executor.class, method = "update", args = {MappedStatement.class, Object.class})
})
public class MybatisInterceptor implements Interceptor {

  private Properties properties;

  @Override
  public Object intercept(Invocation invocation) throws Throwable {
    //获取参数
    MappedStatement mappedStatement = (MappedStatement) invocation.getArgs()[0];
    Object object = invocation.getArgs()[1];

    //获取sql类型 ：insert/update
    SqlCommandType sqlCommandType = mappedStatement.getSqlCommandType();

    //获取填充规则集合
    Map<String, Method> fillRuleMap = MybatisInterceptorVariable.getFillRuleMap();

    //存在ColumnFill注解的字段进行填充
    //无法直接获取父类，getDeclaredFields只能获取本类的字段列表,所以要先获取父类字段
    Field[] superFields = object.getClass().getSuperclass().getDeclaredFields();
    Field[] subFields = object.getClass().getDeclaredFields();
    Field[] allFields = ArrayUtil.addAll(superFields, subFields);

    for (Field field : allFields) {
      //获取标记ColumnFill自定义注解的字段
      ColumnFill columnFill = field.getAnnotation(ColumnFill.class);
      if (columnFill != null) {
        //存在注解则执行以下内容
        //获取注解属性值,判断拦截的类型insert/update
        if (sqlCommandType.equals(columnFill.fillType())) {
          field.setAccessible(true);
          //填充规则匹配
          if (fillRuleMap.containsKey(columnFill.name())) {
            field.set(object, fillRuleMap.get(columnFill.name()).invoke(MybatisFillRuleUtil.class.newInstance(), null));
          }
        }
      }
    }
    return invocation.proceed();
  }

  @Override
  public Object plugin(Object target) {
    // 读取@Signature中的配置，判断是否需要生成代理类
    if (target instanceof Executor) {
      return Plugin.wrap(target, this);
    } else {
      return target;
    }
  }

  @Override
  public void setProperties(Properties properties) {
    this.properties = properties;
  }
}

四、总结

以上是作者实现字段自动填充的方式，由于作者本人经验技术有限，代码不尽完善，希望看完此文的同行可以不吝惜自己的宝贵意见，对文中有误的地方耐心指出，有更好的方式与大家分享，众人拾柴火焰高，希望大家共同进步！