mybatisPlus3.5.2在NOT_NULL更新策略下自定义Mapper实现更新null值

Posted 2023-01-11 好大的月亮

版本

当前使用的mybatis plus版本如下
mybatis-plus-3.5.2.jar

默认更新配置

在这个更新策略下，调用mybatis基础的updateById等更新方法的时候会因为xml中的判断条件而更新不了null值，此时又不想修改全局的配置策略。

mybatis plus提供了
com.baomidou.mybatisplus.core.injector.AbstractMethod
和
com.baomidou.mybatisplus.core.injector.DefaultSqlInjector
让我们自定义mapper，在不影响全局更新策略的前提下，实现更新null值的需求。

其实本质就是在生成xml sql语句的时候把外面的if test判断给拿掉，这样在更新set时字段的值就能更新成和传入实体类相同的值。

后续只需要让我们的业务XXXBaseMapper继承我们自定义的mapper，然后调用我们制定的方法就行了。

mybatis-plus:
  global-config:
    db-config:
      insert-strategy: NOT_NULL
      update-strategy: NOT_NULL

代码demo

自定义mapper

package com.xxx.xxx;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.baomidou.mybatisplus.core.toolkit.Constants;
import org.apache.ibatis.annotations.Param;


public interface MyBaseMapper<T> extends BaseMapper<T> 
    
    //更新null值
    Integer myUpdateById(@Param(Constants.ENTITY) T entity);

定义生成的sql语句，去掉包裹的if条件

package com.xxx.xxx;

import com.baomidou.mybatisplus.core.enums.SqlMethod;
import com.baomidou.mybatisplus.core.injector.AbstractMethod;
import com.baomidou.mybatisplus.core.metadata.TableFieldInfo;
import com.baomidou.mybatisplus.core.metadata.TableInfo;
import com.baomidou.mybatisplus.core.toolkit.sql.SqlScriptUtils;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.mapping.SqlSource;

import java.util.*;

import static java.util.stream.Collectors.joining;

public class MyUpdateById extends AbstractMethod 


    public MyUpdateById(String methodName) 
        super(methodName);
    

    @Override
    public MappedStatement injectMappedStatement(Class<?> mapperClass, Class<?> modelClass, TableInfo tableInfo) 
        SqlMethod sqlMethod = SqlMethod.UPDATE_BY_ID;

        final String additional = optlockVersion(tableInfo) + tableInfo.getLogicDeleteSql(true, true);

        String sql = String.format(
                sqlMethod.getSql(),
                tableInfo.getTableName(),
                sqlSet(
                        tableInfo.isWithLogicDelete(),
                        false,
                        tableInfo,
                        false,
                        ENTITY,
                        ENTITY_DOT
                ),
                tableInfo.getKeyColumn(),
                ENTITY_DOT + tableInfo.getKeyProperty(),
                additional
        );

        SqlSource sqlSource = languageDriver.createSqlSource(configuration, sql, modelClass);
        return addUpdateMappedStatement(mapperClass, modelClass, getMethod(sqlMethod), sqlSource);
    


    protected String sqlSet(boolean logic, boolean ew, TableInfo table, boolean judgeAliasNull, final String alias,
                            final String prefix) 
        String sqlScript = this.getAllSqlSet(table, logic, prefix);
        if (judgeAliasNull) 
            sqlScript = SqlScriptUtils.convertIf(sqlScript, String.format("%s != null", alias), true);
        
        if (ew) 
            sqlScript += NEWLINE;
            sqlScript += convertIfEwParam(U_WRAPPER_SQL_SET, false);
        
        sqlScript = SqlScriptUtils.convertSet(sqlScript);
        return sqlScript;
    


    public String getAllSqlSet(TableInfo tableInfo, boolean ignoreLogicDelFiled, final String prefix) 
        final String newPrefix = prefix == null ? EMPTY : prefix;

        List<String> ignoreList = Arrays.asList("update_time", "create_time", "create_by", "update_by");

        return tableInfo.getFieldList().stream()
                .filter(i -> 
                    if (ignoreLogicDelFiled) 
                        return !(tableInfo.isWithLogicDelete() && i.isLogicDelete());
                    
                    return true;
                ).map(i -> 
                    //ignoreList集合中的字段的更新策略还是按照配置来
                    //不在ignoreList集合中的字段则去掉xml的if条件
                    return i.getSqlSet(!ignoreList.contains(i.getColumn()), newPrefix);
                )
                .filter(Objects::nonNull)
                .collect(joining(NEWLINE));
    

增加自定义的方法

package com.xxx.xxx;


import com.baomidou.mybatisplus.core.injector.AbstractMethod;
import com.baomidou.mybatisplus.core.injector.DefaultSqlInjector;
import com.baomidou.mybatisplus.core.metadata.TableInfo;
import org.springframework.stereotype.Component;

import java.util.List;

@Component
public class mysqlInjector extends DefaultSqlInjector 


    @Override
    public List<AbstractMethod> getMethodList(Class<?> mapperClass, TableInfo tableInfo) 
        List<AbstractMethod> methodList = super.getMethodList(mapperClass, tableInfo);
        //在原先的基础上加上自定义的方法
        methodList.add(new MyUpdateById("myUpdateById"));
        return methodList;
    

然后我们自己的业务mapper继承MyBaseMapper，再调用myUpdateById既可以实现更新null值了。

查看方法生成的xml语句

原先生成xml是按照更新策略，更新的时候不能为null的。

我们自定义mapper中经过修改后生成的xml