MyBatis 中的 SQL 映射文件如何配置结果映射

MyBatis 中的 SQL 映射文件如何配置结果映射

前言

MyBatis 是一款优秀的 ORM 框架，它提供了多种配置方式来定义 SQL 语句以及结果映射规则。其中，SQL 映射文件是 MyBatis 最常用的配置方式之一，它通过 XML 文件来定义 SQL 语句和结果映射规则，使用起来非常方便和灵活。本文将介绍 MyBatis 中的 SQL 映射文件如何配置结果映射，包括常规类型、集合类型等多种情况。

基本语法

在 MyBatis 的 SQL 映射文件中，我们可以使用 <resultMap> 标签来定义结果映射规则，例如：

<!-- 定义用户结果映射规则 -->
<resultMap id="userResultMap" type="com.example.model.User">
  <id property="id" column="id" />
  <result property="username" column="username" />
  <result property="password" column="password" />
</resultMap>

在上面的示例中，我们使用了 <resultMap> 标签来定义一个名为 userResultMap 的结果映射规则，其中 id 属性用于指定该规则的唯一标识符，type 属性用于指定该规则适用的 Java 类型，<id> 和 <result> 标签用于定义对象属性和数据库字段之间的映射关系。

其中，<id> 标签用于定义主键字段，property 属性用于指定 Java 对象的属性名，column 属性用于指定数据库表的字段名。<result> 标签用于定义普通字段，其属性和 <id> 标签相同，只不过不需要指定主键字段。

在定义结果映射规则后，我们可以在 SQL 语句中使用 <resultMap> 标签来引用该规则，例如：

<!-- 查询用户列表 -->
<select id="selectUsers" resultMap="userResultMap">
  SELECT * FROM users
</select>

在上面的示例中，我们使用了 resultMap 属性来指定返回结果的映射规则，该属性的值为之前定义的 userResultMap。

常规类型

当 SQL 语句返回的是常规类型（如字符串、整数、浮点数等）时，我们可以使用 resultType 属性来指定返回值的类型，例如：

<!-- 查询用户数量 -->
<select id="countUsers" resultType="int">
  SELECT COUNT(*) FROM users
</select>

在上面的示例中，我们使用了 resultType 属性来指定返回值的类型为 int，表示返回一个整数。

集合类型

当 SQL 语句返回的是集合类型时，我们可以使用 resultType 属性来指定集合中元素的类型，例如：

<!-- 查询用户列表 -->
<select id="selectUsers" resultType="com.example.model.User">
  SELECT * FROM users
</select>

在上面的示例中，我们使用了 resultType 属性来指定返回值的类型为 com.example.model.User，表示返回一个 User 对象列表。

除了使用 resultType 属性外，我们还可以使用 <collection> 标签来定义集合类型的映射规则，例如：

<!-- 定义用户结果映射规则 -->
<resultMap id="userResultMap" type="com.example.model.User">
  <id property="id" column="id" />
  <result property="username" column="username" />
  <result property="password" column="password" />
  <collection property="orders" ofType="com.example.model.Order">
    <id property="id" column="order_id" />
    <result property="name" column="order_name" />
  </collection>
</resultMap>

在上面的示例中，我们使用了 <collection> 标签来定义一个名为 orders 的订单列表，其中 property 属性用于指定 Java 对象的属性名，ofType 属性用于指定集合中元素的类型，<id> 和 <result> 标签用于定义对象属性和数据库字段之间的映射关系。

动态 SQL

在实际开发中，有时候我们需要根据不同的条件来生成不同的 SQL 语句，这时候就可以使用 MyBatis 提供的动态 SQL 功能。动态 SQL 可以根据条件来动态生成 SQL 语句，包括 if、choose、when、otherwise、trim、where、set、foreach 等标签。在动态 SQL 中，我们同样可以使用 <resultMap> 标签来定义结果映射规则，例如：

<!-- 根据用户名和密码查询用户 -->
<select id="selectUserByUsernameAndPassword" resultMap="userResultMap">
  SELECT * FROM users
  <where>
    <if test="username != null">
      AND username = #{username}
    </if>
    <if test="password != null">
      AND password = #{password}
    </if>
  </where>
</select>

在上面的示例中，我们使用了 <if> 标签来判断参数是否为空，如果不为空就生成相应的 SQL 语句，<where> 标签用于自动拼接 SQL 语句中的 WHERE 关键字，以及去除多余的 AND/OR 关键字。在 SQL 语句执行后，MyBatis 会根据之前定义的 userResultMap 来将查询结果映射成 User 对象。

结论

通过本文的介绍，我们学习了 MyBatis 中 SQL 映射文件如何配置结果映射规则。无论是常规类型、集合类型，还是动态 SQL，MyBatis 都提供了相应的标签和属性来支持结果映射的定义。在实际开发中，根据具体的业务需求和数据模型，我们可以通过定义不同的结果映射规则来将查询结果映射成相应的 Java 对象，从而方便地进行数据操作和业务处理。