MyBatis 输入映射配置详解

Posted 2021-04-16 发哥微课堂

0x00：输入映射

在增、删、改、查配置标签中，有许多 sql 配置是需要传递参数的。在 MyBatis 的 sql 映射配置文件 Mapper.xml 中，输入参数属性配置在 paramterType 中。

对于 paramterType 属性，可以配置的基本数据类型有 int、double、float、short、long、byte、char、boolean，基本数据包装类有 Byte、Short、Integer、Long、Float、Double、Boolean、Character，还有 Java 复杂数据类型 JavaBean 或其他自定义的封装类。

0x01：配置示例

parameterType 属性映射基本数据类型、基本数据包装类以及自定义包装类示例代码如下：

<delete id="deleteUser" parameterType="int">
    delete from user where id=#{id}</delete><delete id="deleteUser" parameterType="java.lang.Integer">
    delete from user where id=#{id}</delete><delete id="deleteUser" parameterType="cn.com.mybatis.pojo.User">
    delete from user where username=#{username}</delete>

其中 int 和 Integer 映射对应的是 Java 数据类型参数。最后一个映射的是 Java 封装类 User 的一个成员属性 username。

0x02：拓展知识

当需要为传输参数指定一个特殊的数据库类型时，可以在 #{} 中添加对该类型对应的数据库 JDBC 类型的描述，以便 MyBatis 在映射时进行相应的转换。例如以下代码：

#{number,javaType=int,jdbcType=NUMERIC}

其中，number 表示需要配置的字段，javaType 表示字段 number 对应的类型为 int，jdbcType 对应的数据库 JDBC 类型为 NUMERIC。

当类型对应的某列为空时，需要设置处理这种类型参数的 Handler，也就是类型处理器，示例代码如下：

#{age,javaType=int,jdbcType=NUMERIC,typeHandler=AgeTypeHandler}

对于一些需要保留精度的数值类型参数，可以为其添加保留小数点位数的设置，可以添加 numericScale 属性，为该参数设置小数点保留的位数，例如以下保留两位的示例：

#{price,javaType=double,jdbcType=DECIMAL,numericScale=2}

0x03：存储过程

MyBatis 也支持存储过程的配置。当使用存储过程时，需要设置一个参数 mode，其值有 IN（输入参数）、OUT（输出参数）、INOUT（输入 / 输出参数）。一个存储过程可以有多个 IN 参数，至多有一个 OUT 或 INOUT 参数，示例如下：

<select id="selectSomeThing" statementType="CALLABLE" parameterType="hashmap">
    <![CDATA[ {call proc_for_input(#{information,mode=IN,jdbcType=VARCHAR})} ]]></select>

0x04：总结

MyBatis 输入映射，通过 parameterType 参数来配置需要映射的类型为基本数据类型还是基本的数据包装类型或者是自定义的 JavaBean。然后映射到 sql 语句中的参数。当需要配置特殊的数据类型或者是为空时的默认处理器和小数点等设置，都可以在 #{} 中进行相应的配置。