Mybatis-Plus中update()和updateById()将字段更新为null

目录

• 简介
• 问题描述
• 原因
• 概述
• 源码分析
• 所有策略
• 设置为null的方案
• 方案1：使用UpdateWrapper更新
• 方案2：设置全局的field-strategy（不推荐）
• 方案3：设置某个字段的field-strategy
• 参考文章

简介

说明

本文介绍Mybatis-Plus无法将字段更新为null的原因及解决方法。

问题描述

用Mybatis-Plus的update()或者updateById()来更新数据时，无法将字段设置为null值（更新后数据还是原来的值）。

原因

概述

默认情况下，Mybatis-Plus在更新时会判断字段是否为null，如果是null，则不设值（不将这个字段拼接为SQL的SET语句）。

源码分析

字段策略的源码：com.baomidou.mybatisplus.annotation.FieldStrategy

package com.baomidou.mybatisplus.annotation;

/**
 * 字段策略枚举类
 */
public enum FieldStrategy {
    /**
     * 忽略判断
     */
    IGNORED,

    /**
     * 非NULL判断
     */
    NOT_NULL,

    /**
     * 非空判断(只对字符串类型字段,其他类型字段依然为非NULL判断)
     */
    NOT_EMPTY,

    /**
     * 默认的,一般只用于注解里
     * <p>1. 在全局里代表 NOT_NULL</p>
     * <p>2. 在注解里代表 跟随全局</p>
     */
    DEFAULT,

    /**
     * 不加入 SQL
     */
    NEVER
}

可以看到，FieldStrategy.DEFAULT：默认等于FieldStrategy.NOT_NULL，也就是：字段不为Null时才拼接SQL。

所有策略

实际上，Mybatis-Plus在增删改查时默认对Null等情况都进行了判断。

源码里的注释已经很清楚了，本处不再赘述。源码位置：com.baomidou.mybatisplus.annotation.TableField

package com.baomidou.mybatisplus.annotation;

import org.apache.ibatis.mapping.ParameterMapping;
import org.apache.ibatis.mapping.ResultMapping;
import org.apache.ibatis.type.JdbcType;
import org.apache.ibatis.type.TypeHandler;
import org.apache.ibatis.type.UnknownTypeHandler;

import java.lang.annotation.*;

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.ANNOTATION_TYPE})
public @interface TableField {

    // 其他代码

    /**
     * 字段验证策略之 insert: 当insert操作时，该字段拼接insert语句时的策略
     * <p>
     * IGNORED: 直接拼接 insert into table_a(column) values (#{columnProperty});
     * NOT_NULL: insert into table_a(<if test="columnProperty != null">column</if>) values (<if test="columnProperty != null">#{columnProperty}</if>)
     * NOT_EMPTY: insert into table_a(<if test="columnProperty != null and columnProperty!=''">column</if>) values (<if test="columnProperty != null and columnProperty!=''">#{columnProperty}</if>)
     * NOT_EMPTY 如果针对的是非 CharSequence 类型的字段则效果等于 NOT_NULL
     *
     * @since 3.1.2
     */
    FieldStrategy insertStrategy() default FieldStrategy.DEFAULT;

    /**
     * 字段验证策略之 update: 当更新操作时，该字段拼接set语句时的策略
     * <p>
     * IGNORED: 直接拼接 update table_a set column=#{columnProperty}, 属性为null/空string都会被set进去
     * NOT_NULL: update table_a set <if test="columnProperty != null">column=#{columnProperty}</if>
     * NOT_EMPTY: update table_a set <if test="columnProperty != null and columnProperty!=''">column=#{columnProperty}</if>
     * NOT_EMPTY 如果针对的是非 CharSequence 类型的字段则效果等于 NOT_NULL
     *
     * @since 3.1.2
     */
    FieldStrategy updateStrategy() default FieldStrategy.DEFAULT;

    /**
     * 字段验证策略之 where: 表示该字段在拼接where条件时的策略
     * <p>
     * IGNORED: 直接拼接 column=#{columnProperty}
     * NOT_NULL: <if test="columnProperty != null">column=#{columnProperty}</if>
     * NOT_EMPTY: <if test="columnProperty != null and columnProperty!=''">column=#{columnProperty}</if>
     * NOT_EMPTY 如果针对的是非 CharSequence 类型的字段则效果等于 NOT_NULL
     *
     * @since 3.1.2
     */
    FieldStrategy whereStrategy() default FieldStrategy.DEFAULT;
}

设置为null的方案

需求：根据用户id，设置userName（用户名），并将nickName（昵称）设置为null。

方案1：使用UpdateWrapper更新

@Autowired
private UserService userService;

@ApiOperation("修改")
@PostMapping("/edit")
public void edit(User user) {
    userService.lambdaUpdate()
            .eq(User::getId, user.getId())
            .set(User::getUserName, user.getUserName())
            .set(User::getNickName, null)
            .update();
}

方案2：设置全局的field-strategy（不推荐）

application.yml

mybatis-plus:
  global-config:
      # 字段策略 0：忽略判断，直接拼SQL, 1:非NULL, 2：非空，3：默认；4：永远不加入SQL
    field-strategy: 0

注意

这是全局配置，会对所有的字段都忽略判断，如果一些字段不想要修改，但是传值的时候没有传递过来，就会被更新为null，可能会影响其他业务数据的正确性。

所以，尽量不要用此法。

方案3：设置某个字段的field-strategy

方法

只在需要更新为null的字段上，设置忽略策略，如下：

/**
 * 昵称
 */
@TableField(strategy = FieldStrategy.IGNORED)
private String nickName;

更新的方法：

@Autowired
private UserService;

@ApiOperation("修改")
@PostMapping("/edit")
public void edit(Long id) {
    User user = new User();
    user.setId(id);
    user.setNickName(null);

    userService.lambdaUpdate()
            .eq(User::getId, user.getId())
            .update(user);
}

注意

不同的业务对字段的需求可能不一样，将字段指定为忽略判断（直接拼SQL）可能会影响其他业务。

所以，此方法也不推荐。

参考文章

【Mybatis-Plus】使用updateById()、update()将字段更新为null

mybatis-plus更新字段的时候设置为null，忽略实体null判断

到此这篇关于Mybatis-Plus中update()和updateById()将字段更新为null的文章就介绍到这了,更多相关Mybatis-Plus 字段更新为null内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们！