Mybatis Plus 字段为空值时执行更新方法未更新解决方案

问题描述

系统测试过程中，同事测试出使用Mybatis Plus提供的封装方法UpdateById()时，字段从前台传入的数据为空值，但是执行方法后该字段未得到更新。

问题重现

因涉及到公司层面的模型、数据，本文都为测试模型和例子。

实体类：

@Data
@TableName("shop_item")
public class ShopItem implements Serializable {

   private static final long serialVersionUID = 1L;

  /**
   * 编号
   */
  @TableId(type= IdType.INPUT)
  private String id;

  /**
   * 物品名称
   */
  private String itemName;

  /**
   * 物品价格
   */
  private Double itemPrice;

  /**
  *  添加人编号
  */
  private String addUserId;

  /**
  *  添加时间
  */
  private Date addTime;

}

前端提交的JSON数据：

<script>

var submitData = {
  "id":"361E8C48-6699-4ED5-83C4-7C9D98747C2C",
  "itemName":"iPhone 8 Plus"
  "itemPrice":""
};

</script>

Service 实现类 更新方法：

@Service
@Slf4j
public class ShopItemServiceImpl extends ServiceImpl<ShopItemMapper, ShopItem> implements IShopItemService {

  @Override
  public ResultVO updateShopItemData(ShopItem shopItem) {
    try {
      this.baseMapper.updateById(shopItem);
    } catch (Exception e) {
      log.error("修改商品数据时异常:{}",e.getMessage());
      return ResultVO.builder().success(false).build();
    }
    return ResultVO.builder().success(true).build();
  }

}

在执行 updateShopItemData()方法时，通过Mybatis Log插件控制台可以看见日志如下：

update 
  shop_item 
set 
  item_name = 'iPhone 8 Plus' 
where 
id = '361E8C48-6699-4ED5-83C4-7C9D98747C2C';

发现itemPrice字段未加入SQL语句的set关键字后！Σ(⊙▽⊙"a

沉思了几分钟，想起以前使用原生Mybatis生成的Update方法，是有对值是否为空的判断，如果为空就不加入到update table set语句内，于是将问题重心移到Mybatis Plus文档内，看看是不是会有类似于@TableField、@TableId这样的注解，能解决该问题呢？

解决方案

先放链接：点我进入官方文档@TableField

查阅文档的思路是，我们项目内的这个列是字段，而非主键，所以首先排除@TableId注解，直接进入@TableField注解的相关内容。

在该注解的属性描述内，有这样一个字段——“fill”，字段自动填充策略。

他决定了在执行新增或修改方法时，有这个注解的字段需要怎样将数据进行填充，FieldFill的相关的属性，官方描述如下：

默认值是DEFAULT，默认不处理，即上文出现的问题——新增、修改该字段为空时，将不自动填充即不列入语句，如：

insert into shop_item(shop_price) values(xxxx);

update shop_item set shop_price = xxxx;

OK，解决方案找到了，让我们来修改实体类吧！

@Data
@TableName("shop_item")
public class ShopItem implements Serializable {


   private static final long serialVersionUID = 1L;

  /**
   * 编号
   */
  @TableId(type= IdType.INPUT)
  private String id;

  /**
   * 物品名称
   */
  private String itemName;

  /**
   * 物品价格
   */
  @TableField(fill = FieldFill.UPDATE)
  private Double itemPrice;

  /**
  *  添加人编号
  */
  private String addUserId;

  /**
  *  添加时间
  */
  private Date addTime;

}

我们在itemPrice属性的顶上加上@TableField(fill = FieldFill.UPDATE)后，在执行一遍修改方法看看！

update 
  shop_item 
set 
  item_name = 'iPhone 8 Plus',

  item_price = ''
where 
id = '361E8C48-6699-4ED5-83C4-7C9D98747C2C';

bingo，成功！