5.9 mybatis之callSettersOnNulls作用

在mybatis的settings配置参数中有个callSettersOnNulls参数，官方解释为：指定当结果集中值为 null 的时候是否调用映射对象的 setter（map 对象时为 put）方法，这在依赖于 Map.keySet() 或 null 值进行初始化时比较有用。注意基本类型（int、boolean 等）是不能设置成 null 的。什么意思呢？

我们先看下面一段解释，不理解没关系，等看完下面的代码示例后再回来看一定会理解。

我们假设要把数据库中一条数据映射到java中Map类型的对象上，库表字段名为Map中的key，库表字段值为Map的value，假如库表中某字段为null，映射到Map中的key和value是什么样的呢？当callSettersOnNulls=true时，会把这个字段名映射到key上，把null值put到value上；当callSettersOnNulls=false时，就不会把这个字段名映射到key上，也即Map中根本就不存在这个key，当遍历这个Map时就会少了这个key。所以说，对于返回类型Map的场景，如果在java代码中对于库表字段值为null的也要输出或者处理，就要把空的字段也要映射到Map的key和value中。
但是当返回类型为Bean类型时，库表中某字段为null，当callSettersOnNulls=true，会把null值set到Bean对象对应的字段属性上，那么该属性值为null；当callSettersOnNulls=false时，就不会调set方法就不会把null值set到Bean对象对应的字段属性上，那么该字段属性由于没有set内容，默认还是null。所以对于返回类型为Bean的场景，callSettersOnNulls配置true还是false无所谓。

如果没有理解上面一段话我们看一下下面的案例，假设要把库表PERSON中一条数据映射到java的Map对象中。

库表PERSON如下所示

1. 当callSettersOnNulls=true时

mybatis配置如下所示

<settings>
    <setting name="logImpl" value="STDOUT_LOGGING"/>
    <setting name="callSettersOnNulls" value="false"/>
</settings>

mapper中SQL如下所示，假设查询PERSON_ID=13的一条数据，该条数据的PERSON_SEX列值为NULL。

<select id="select2" resultType="Map">
    select * from PERSON where PERSON_ID = #{personId}
</select>

测试案例如下所示，查询到数据映射到map后，然后打印出所有的key和value

public void sqlSessionTest3(){
    SqlSessionFactory factory = mybatisUtil.getFactory();
    SqlSession sqlSession = factory.openSession(true);  //true表示自动提交
    Map<String, Object> map = sqlSession.selectOne("com.lzj.dao.PersonDao.select2", 13);
    for (String key : map.keySet()){
        System.out.println("key=" + key);
        System.out.println("value=" + map.get(key));
        System.out.println("================");
    }
    sqlSession.close();
}

执行结果如下所示，发现即使person_sex列为空，但map中依然有key为person_sex，但value为null，说明当callSettersOnNulls=true时，把person_sex字段名映射到了key上，把null值put到value上。

Logging initialized using 'class org.apache.ibatis.logging.stdout.StdOutImpl' adapter.
PooledDataSource forcefully closed/removed all connections.
PooledDataSource forcefully closed/removed all connections.
PooledDataSource forcefully closed/removed all connections.
Opening JDBC Connection
Created connection 2259527.
==>  Preparing: select * from PERSON where PERSON_ID = ? 
==> Parameters: 13(Integer)
<==    Columns: person_id, person_name, person_age, person_sex
<==        Row: 13, Jerry, 20, null
<==      Total: 1
key=person_sex
value=null
================
key=person_name
value=Jerry
================
key=person_age
value=20
================
key=person_id
value=13
================
Closing JDBC Connection [com.mysql.cj.jdbc.ConnectionImpl@227a47]

2. 当callSettersOnNulls=false时

还是以上面的案例所示，只不过把配置文件修改成如下所示

<settings>
    <setting name="logImpl" value="STDOUT_LOGGING"/>
    <setting name="callSettersOnNulls" value="false"/>
</settings>

重新运行上面的测试案例，输出如下所示，输出的map中不再含有名字为person_sex的key，说明当callSettersOnNulls=false时，就不会把person_sex字段名映射到key上，也即Map中根本就不存在这个key。

Logging initialized using 'class org.apache.ibatis.logging.stdout.StdOutImpl' adapter.
PooledDataSource forcefully closed/removed all connections.
PooledDataSource forcefully closed/removed all connections.
PooledDataSource forcefully closed/removed all connections.
Opening JDBC Connection
Created connection 219192399.
==>  Preparing: select * from PERSON where PERSON_ID = ? 
==> Parameters: 13(Integer)
<==    Columns: person_id, person_name, person_age, person_sex
<==        Row: 13, Jerry, 20, null
<==      Total: 1
key=person_name
value=Jerry
================
key=person_age
value=20
================
key=person_id
value=13
================
Closing JDBC Connection [com.mysql.cj.jdbc.ConnectionImpl@d109c4f]

注意：如果在java应用中，如果要遍历库表列对应的所有key时，只能配置callSettersOnNulls=true，因为如果配置callSettersOnNulls=false时，map中不存在库表列值为NULL对应的key。