mybatis的＜resultMap＞标签使用

我会带着你远行 2024-04-23 01:43 24阅读 0赞

**记录**：420

**场景**：使用MyBatis的<resultMap></resultMap>的手动指定查询结果对象属性、类型和数据库表字段属性、类型一一对应。使用 <result></result>的属性property、javaType、jdbcType、column完成对应关系。使用<select>等标签的resultMap属性引用。

**版本**：JDK 1.8,Spring Boot 2.6.3,mybatis-3.5.9。

**1.基础知识**

**1.1MyBatis的标签**

(1)查看MyBatis支持的标签

地址：http://mybatis.org/dtd/mybatis-3-mapper.dtd

(2)查看标签使用

以<mapper></mapper>标签元素为例，在mybatis-3-mapper.dtd中如下：

<!ELEMENT mapper(...)+>，表示这是一个标签元素mapper.

(..| insert\*| update\* | delete\* | select\*),表示在mapper元素中可以嵌套使用的元素清单。

<!ATTLIST mapper>，表示这是一个元素标签的支持的属性。

**1.2MyBatis的使用**

(1)在application.yml配置文件配置mybatis映射的xml文件位置。

mybatis:
      mapper-locations: classpath*:mapper/**/*.xml

(2)创建一个Java接口。在接口中添加方法。

(3)创建一个Java接口映射的xml文件。在xml中使用<mapper></mapper>标签的namespace属性指定Java接口的全路径。Java接口和xml映射文件就完成了绑定关系。

(4)在<mapper></mapper>标签内，使用<insert><update><delete><select>等标签的id属性指定Java的方法名称。Java接口的方法和xml映射文件的<mapper></mapper>内部的标签就完成了绑定关系。

**2.使用****<resultMap></resultMap>标签元素**

**场景**：<resultMap></resultMap>标签元素在<mapper></mapper>中定义。在<insert><update><delete><select>等标签元素内使用resultMap属性引用。

**2.1Java接口**

@Repository
    public interface Label05ResultMapMapper {
      List<CityLabelPO> queryCity01(CityLabelPO cityPO);
      List<CityLabelPO> queryCity02(CityLabelPO cityPO);
    }

**2.2Java接口映射的xml文件**

<?xml version="1.0" encoding="UTF-8" ?>
    <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
    <mapper namespace="com.hub.example.mapper.Label05ResultMapMapper">
      <resultMap id="poResult" type="com.hub.example.domain.CityLabelPO">
          <result property="cityId" javaType="java.lang.Long" jdbcType="BIGINT" column="CITY_ID"></result>
          <result property="cityName" javaType="java.lang.String" jdbcType="VARCHAR" column="CITY_NAME"></result>
          <result property="landArea" javaType="java.lang.Double" jdbcType="DOUBLE" column="LAND_AREA"></result>
          <result property="population" javaType="java.lang.Long" jdbcType="BIGINT" column="POPULATION"></result>
          <result property="gross" javaType="java.lang.Double" jdbcType="DOUBLE" column="GROSS"></result>
          <result property="cityDescribe" javaType="java.lang.String" jdbcType="VARCHAR" column="CITY_DESCRIBE"></result>
          <result property="dataYear" javaType="java.lang.String" jdbcType="VARCHAR" column="DATA_YEAR"></result>
          <result property="updateTime" javaType="java.util.Date" jdbcType="TIMESTAMP" column="UPDATE_TIME"></result>
      </resultMap>
      
      <select id="queryCity01" resultMap="poResult">
          select aa.*
          from t_city aa
          where aa.CITY_ID = #{cityId}
      </select>
      
      <select id="queryCity02" resultType="com.hub.example.domain.CityLabelPO">
          select CITY_ID       AS "cityId",
                 CITY_NAME     AS "cityName",
                 LAND_AREA     AS "landArea",
                 POPULATION    AS "population",
                 GROSS         AS "gross",
                 CITY_DESCRIBE AS "cityDescribe",
                 DATA_YEAR     AS "dataYear",
                 UPDATE_TIME   AS "updateTime"
          from t_city aa
          where aa.CITY_ID = #{cityId}
      </select>
    </mapper>

**2.3使用resultMap类型匹配**

使用<resultMap></resultMap>时，需要手动匹配属性与类。

(1)数据库中类型，可以使用以下SQL查询

在MySQL中：

SELECT
      aa.column_name,
      aa.data_type
    FROM
      INFORMATION_SCHEMA.COLUMNS aa
    WHERE aa.TABLE_NAME = 't_city'
    在Oracle中：
    SELECT
      aa.COLUMN_NAME,
      aa.DATA_TYPE
    FROM
      user_tab_columns aa
    WHERE aa.table_name = 'T_CITY'

在Oracle中：

SELECT
      aa.COLUMN_NAME,
      aa.DATA_TYPE
    FROM
      user_tab_columns aa
    WHERE aa.table_name = 'T_CITY'

(2)在MyBatis中类型

MyBatis中类型：org.apache.ibatis.type.JdbcType。

public enum JdbcType {
        ARRAY(2003),
        BIT(-7),
        TINYINT(-6),
        SMALLINT(5),
        INTEGER(4),
        BIGINT(-5),
        FLOAT(6),
        REAL(7),
        DOUBLE(8),
        NUMERIC(2),
        DECIMAL(3),
        CHAR(1),
        VARCHAR(12),
        LONGVARCHAR(-1),
        DATE(91),
        TIME(92),
        TIMESTAMP(93),
        BINARY(-2),
        VARBINARY(-3),
        LONGVARBINARY(-4),
        NULL(0),
        OTHER(1111),
        BLOB(2004),
        CLOB(2005),
        BOOLEAN(16),
        CURSOR(-10),
        UNDEFINED(-2147482648),
        NVARCHAR(-9),
        NCHAR(-15),
        NCLOB(2011),
        STRUCT(2002),
        JAVA_OBJECT(2000),
        DISTINCT(2001),
        REF(2006),
        DATALINK(70),
        ROWID(-8),
        LONGNVARCHAR(-16),
        SQLXML(2009),
        DATETIMEOFFSET(-155),
        TIME_WITH_TIMEZONE(2013),
        TIMESTAMP_WITH_TIMEZONE(2014);
        public final int TYPE_CODE;
        private static Map<Integer, JdbcType> codeLookup = new HashMap();
        private JdbcType(int code) {
            this.TYPE_CODE = code;
        }
        public static JdbcType forCode(int code) {
            return (JdbcType)codeLookup.get(code);
        }
        static {
            JdbcType[] var0 = values();
            int var1 = var0.length;
            for(int var2 = 0; var2 < var1; ++var2) {
                JdbcType type = var0[var2];
                codeLookup.put(type.TYPE_CODE, type);
            }
        }
    }

(3)在Java实体类中类型

在Java实体类中类型，就直接在定义对象中看。比如：

java.lang.Integer
    java.lang.Long
    java.lang.Double
    java.lang.String
    java.lang.String
    java.util.Date
    java.lang.Boolean

**3.测试**

**3.1测试代码**

@Slf4j
    @RestController
    @RequestMapping("/hub/example/cityLabel")
    public class CityLabelController {
      @Autowired
      private Label05ResultMapMapper label05ResultMapMapper;
      @GetMapping("/load05")
      public Object load05() {
        log.info("测试开始...");
        CityLabelPO cityPO = CityLabelPO.builder().cityId(3L).build();
        // 示例一 
        List<CityLabelPO> list01 = label05ResultMapMapper.queryCity01(cityPO);
        // 示例二 
        List<CityLabelPO> list02 = label05ResultMapMapper.queryCity02(cityPO);
        log.info("测试结束...");
        return "执行成功";
      }
    }

**3.2测试请求**

URL：http://127.0.0.1:18080/hub-example/hub/example/cityLabel/load05

**3.3执行SQL**

示例使用<resultMap></resultMap>标签后，根据不同条件组装不同查询的SQL，适配不同业务场景。

示例一：

select aa.* from t_city aa where aa.CITY_ID = ?

示例二：

SELECT
      CITY_ID AS "cityId",
      CITY_NAME AS "cityName",
      LAND_AREA AS "landArea",
      POPULATION AS "population",
      GROSS AS "gross",
      CITY_DESCRIBE AS "cityDescribe",
      DATA_YEAR AS "dataYear",
      UPDATE_TIME AS "updateTime"
    FROM
      t_city aa
    WHERE aa.CITY_ID = ?

**4.支撑**

**4.1实体对象**

(1)封装结果对象CityLabelPO

@Data
    @Builder
    @NoArgsConstructor
    @AllArgsConstructor
    public class CityLabelPO {
      private Long cityId;
      private String cityName;
      private Double landArea;
      private Long population;
      private Double gross;
      private String cityDescribe;
      private String dataYear;
      private Date updateTime;
    }

**4.2建表语句**

CREATE TABLE t_city (
      CITY_ID BIGINT(16) NOT NULL COMMENT '唯一标识',
      CITY_NAME VARCHAR(64) COLLATE utf8_bin NOT NULL COMMENT '城市名',
      LAND_AREA DOUBLE DEFAULT NULL COMMENT '城市面积',
      POPULATION BIGINT(16) DEFAULT NULL COMMENT '城市人口',
      GROSS DOUBLE DEFAULT NULL COMMENT '生产总值',
      CITY_DESCRIBE VARCHAR(512) COLLATE utf8_bin DEFAULT NULL COMMENT '城市描述',
      DATA_YEAR VARCHAR(16) COLLATE utf8_bin DEFAULT NULL COMMENT '数据年份',
      UPDATE_TIME DATETIME DEFAULT NULL COMMENT '更新时间'
    ) ENGINE=INNODB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='城市信息表';

以上，感谢。

2023年4月23日