原因
因为 MyBatis-Plus 自带的更新方法,都有对对象空值进行判空。只有不为空的字段才会进行数据更新
所以像updateById等方法,在更新时会自动忽略为null的字段,只更新非null字段值
但在某些情况下,我们的需求就是将数据库中的值设为null
此时mybatis-plus的原生方法将不生效,需要我们手动写set的wrapper或则在xml中写set null的sql
但如果表字段非常多则需要写一段又臭又长的东西,还非常耗时
解决方式一
在实体类对应的字段上加注解@TableField(strategy=FieldStrategy.IGNORED),忽略null值的判断,例如:
@TableField(updateStrategy = FieldStrategy.IGNORED)
private String address;
如果使用了这个注解,在address为null时,使用updateById等方法进行修改,则生成的sql将是 set address = null
这里有一个问题是,使用该注解后这个属性就会全局忽略null值的判断
但可能在某些场景下我们想忽略,某些场景下不忽略使用,该注解就不能满足要求了。如果想实现这种效果,可以使用方式二
解决方式二
方式二的思路很简单,使用UpdateWrapper 在UpdateWrapper中我们可以判断属性为null则
UpdateWrapper.set("address", null);
当字段非常多时,如果手动拼写则代码又臭又长,还很耗时。于是我写了一个工具类来帮助我自动生成UpdateWrapper
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.core.conditions.update.UpdateWrapper;
import java.lang.reflect.Field;
/**
* @author: tanghaizhi
* @CreateTime: 2023/3/14 15:04
* @Description:
*/
public class UpdateWrapperUtils {
/**
* 传入一个实体对象,返回他的UpdateWrapper对象,入股属性未null,在修改数据库时会set null
* @param r
* @param key where字段
* @param <R>
* @return
* @throws Exception
*/
public static <R> UpdateWrapper<R> generateUpdateWrapperByKey(R r, String key) throws Exception {
UpdateWrapper<R> updateWrapper = new UpdateWrapper<>();
//获取类中所有的非继承自父类的字段(Field) 如果需要获取全部(包括继承自父类的)使用FieldUtils.getAllFields(r.getClass())
Field[] field = r.getClass().getDeclaredFields();
for (Field f:field){
f.setAccessible(true);
if(key.equals(f.getName())){
updateWrapper.eq(camelToUnderline(key),f.get(r));
} else{
TableField annotation = f.getAnnotation(TableField.class);
//先判断没带有注解@TableField(exist = false)
if(annotation == null || annotation.exist() != false){
if(f.get(r) == null){
updateWrapper.set(camelToUnderline(f.getName()),null);
} else {
updateWrapper.set(camelToUnderline(f.getName()),f.get(r));
}
}
}
}
return updateWrapper;
}
/**
* 这个方法接受一个字符串参数,返回一个字符串,将 Java 风格的字符串转换为数据库风格的字符串。例如,将 "userName" 转换为 "user_name"。
* @param param
* @return
*/
public static String camelToUnderline(String param) {
if (param == null || param.isEmpty()) {
return "";
}
StringBuilder sb = new StringBuilder();
char[] charArray = param.toCharArray();
for (int i = 0; i < charArray.length; i++) {
char c = charArray[i];
if (Character.isUpperCase(c)) {
sb.append("_");
}
sb.append(Character.toLowerCase(c));
}
return sb.toString();
}
}
工具类使用方法如下
@RequestMapping(value = "/test")
public void test() throws Exception {
User user = new User();
user.setId(73850189L);
user.setPhone("12346789");
UpdateWrapper<User> updateWrapper = UpdateWrapperUtils.generateUpdateWrapperByKey(user,"id");
userMapper.update(null,updateWrapper);
}
我们新new的实例user除了id和phone其他属性都为null,我们期望的效果是除了这两个字段,其他的字段都被set为null
可以看到测试效果和预期效果一致
另注:使用该方法需要mybatis-plus-boot-starter的版本在3.1.0及以上
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.1.0</version>
</dependency>