Spring Boot整合Mybatis查询结果封装为Map类型

使用Mybatis查询时候，将返回类型resultType设置为map，但是当查询结果中为null的字段不会被封装到map对象中，在网上看到的答案要么对我的项目无效，要么就需要配置mybatis-config.xml文件，但是我的项目没有这个文件。于是就自己追踪Mybatis源码执行过程，最后终于找到了解决办法。

解决办法就是在@Configuration配置类中配置SqlSessionFactory的@Bean方法内加入如下代码

//当查询结果封装为map对象时候, 让值为null的字段也放到map中
org.apache.ibatis.session.Configuration configuration = new org.apache.ibatis.session.Configuration();
configuration.setCallSettersOnNulls(true);
sessionFactoryBean.setConfiguration(configuration);

下面大致记录一下追踪源码过程
1、首先是在mybatis入口方法处打断点，然后请求执行方法。

public RespData selectList(DataMap param) {
        RespData data = new RespData();
        Page<XXXExample> page = new Page<>();
        page.setMap(param);
        page.setOrderBy("sequenceNo");
        List<DataMap> list = this.XXXMapperExt.selectList(page);//在该行代码打断点，然后按F5进入方法，经过一系列的反射之后会进入到Mybatis的核心类核心方法中
        data.setData(list);
        data.setTotal(list.size());
        return data;
}

2、追踪代码的目标是为了找到将数据封装到Map中的源码，具体过程不细述，下面是最终找到的源码

下面的方法所在类：org.apache.ibatis.executor.resultset.DefaultResultSetHandler

private boolean applyAutomaticMappings(ResultSetWrapper rsw, ResultMap resultMap, MetaObject metaObject, String columnPrefix) throws SQLException {
    List<UnMappedColumnAutoMapping> autoMapping = createAutomaticMappings(rsw, resultMap, metaObject, columnPrefix);
    boolean foundValues = false;
    if (autoMapping.size() > 0) {
      for (UnMappedColumnAutoMapping mapping : autoMapping) {
        final Object value = mapping.typeHandler.getResult(rsw.getResultSet(), mapping.column);
        if (value != null) {
          foundValues = true;
        }

        //此处是最关键的代码，当字段value不为null，或者isCallSettersOnNulls为true且value对象不是原始数据类型时候，才会以字段为key，value为值放入map中
        if (value != null || (configuration.isCallSettersOnNulls() && !mapping.primitive)) {
          // gcode issue #377, call setter on nulls (value is not 'found')
          metaObject.setValue(mapping.property, value);
        }
      }
    }
    return foundValues;
  }

从上面代码中可以看到，我们如果能够让configuration.isCallSettersOnNulls()返回的结果是true，那么值为null的字段也会被放入map对象中了，下面就该找到初始化configuration对象的地方。

3、接下来从上，上面类org.apache.ibatis.executor.resultset.DefaultResultSetHandler中的成员变量configuration入手，通过追踪其所有可能的被赋值的方法的上级调用关系，最终找到configuration对象的最初来源，就在下面的类中

所在类：org.apache.ibatis.session.defaults.DefaultSqlSessionFactory

private final Configuration configuration;
public DefaultSqlSessionFactory(Configuration configuration) {
    this.configuration = configuration;
}
private SqlSession openSessionFromDataSource(ExecutorType execType, TransactionIsolationLevel level, boolean autoCommit) {
    Transaction tx = null;
    try {
      final Environment environment = configuration.getEnvironment();
      final TransactionFactory transactionFactory = getTransactionFactoryFromEnvironment(environment);
      tx = transactionFactory.newTransaction(environment.getDataSource(), level, autoCommit);
      final Executor executor = configuration.newExecutor(tx, execType);
      return new DefaultSqlSession(configuration, executor, autoCommit);
    } catch (Exception e) {
      closeTransaction(tx); // may have fetched a connection so lets call close()
      throw ExceptionFactory.wrapException("Error opening session.  Cause: " + e, e);
    } finally {
      ErrorContext.instance().reset();
    }
  }

4、找到了configuration对象的最初来源，接下来就是找到程序启动时候初始化这个对象的地方，通过上面3的代码可以看到DefaultSqlSessionFactory类中的有一个有参构造方法，通过追踪这个方法被调用的上级代码，最终找到SqlSessionFactoryBean这个类，其部分代码如下：

类：org.mybatis.spring.SqlSessionFactoryBean

private Configuration configuration;
protected SqlSessionFactory buildSqlSessionFactory() throws IOException {

    Configuration configuration;
    。。。
    XMLConfigBuilder xmlConfigBuilder = null;
    if (this.configuration != null) {
      configuration = this.configuration;
      。。。。
    } 
    。。。。

    //这个方法下面的调用中有初始化第3部中的configuration的代码
    return this.sqlSessionFactoryBuilder.build(configuration);
  }

5、由此可见上面就是最初初始化configuration的代码所在，而我们的配置类中定义@Bean SqlSessionFactory的方法中就创建SqlSessionFactoryBean对象，SqlSessionFactoryBean类中有设置configuration的方法，下面是最终解决办法，其中前文提到解决办法所需要加入的代码就在下面中文注释的下方

    @Bean
    SqlSessionFactory sqlSessionFactory(@Qualifier("masterDataSource") DataSource masterDataSource,
                                        @Qualifier("slaverDataSource") DataSource slaverDataSource) {
        SqlSessionFactory factory = null;
        try {
            SqlSessionFactoryBean sessionFactoryBean = new SqlSessionFactoryBean();
            sessionFactoryBean.setDataSource(dynamicDataSource(masterDataSource, slaverDataSource));

            PathMatchingResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();

            org.springframework.core.io.Resource[] resources = resolver.getResources("classpath*:/*/mybatis/**/*.xml");
            List<org.springframework.core.io.Resource> filterResourceList = new ArrayList<org.springframework.core.io.Resource>();
            List<String> fileNameList = new ArrayList<String>();
            for (int i = 0; i < resources.length; i++) {
                org.springframework.core.io.Resource resource = resources[i];
                if (!fileNameList.contains(resource.getFilename())) {
                    filterResourceList.add(resource);
                    fileNameList.add(resource.getFilename());
                }
            }

            org.springframework.core.io.Resource[] result = new org.springframework.core.io.Resource[filterResourceList.size()];
            sessionFactoryBean.setMapperLocations(filterResourceList.toArray(result));
            
            //当查询结果封装为map对象时候, 让值为null的字段也放到map中
            org.apache.ibatis.session.Configuration configuration = new org.apache.ibatis.session.Configuration();
            configuration.setCallSettersOnNulls(true);
            sessionFactoryBean.setConfiguration(configuration);
            
            factory = (SqlSessionFactory) sessionFactoryBean.getObject();
        } catch (Exception e) {
            e.printStackTrace();
        }
        return factory;
    }

6、最附上两张调试过程打断点的截图

image.png image.png