Mybatis 玩转 java.util.Map 类型

2024-07-23

java.util.Map 类型在 Java 中有广泛的应用，在数据持久层用好 Map，同样能起到事半功倍的效果，以下是一些使用场景，可能有你平时没注意到的，快来看看吧。

Case 1 简化代码

如果实体类的属性过多，则可以考虑使用万能的 Map，查询和新增数据时都可以用 java.util.Map 类型，可极大地简化代码。如果数据库中的字段为 NULL，则在查询时不会被放进 Map；更新时，也会根据 Map 中存在的属性有选择性地更新，很方便。

1 查询数据

查询 SQL：

<select id="queryOrgInfo" resultType="map" parameterType="string">
    SELECT
        org_id,
        org_name,
        org_level,
        org_parent_id,
        org_type,
        org_status,
        address,
        org_desc
    FROM tb_org WHERE 1 = 0
    <if test="orgId != null and orgId != ''">
        OR org_id = #{orgId}
    </if>
</select>

对应的 Mapper 类：

import com.github.yulichang.base.MPJBaseMapper;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Param;

import java.util.Map;

@Mapper
public interface OrgMapper extends MPJBaseMapper<Org> {

    Map queryOrgInfo(@Param("orgId") String orgId);
}

在上面的 SQL 中，可以发现 resultType 和 parameterType 的数据类型首字母用的都是小写，而不是全限定类名。原因是 Mybatis 在加载时已经给常用的数据类型注册了别名，所以可以用小写（具体的对应关系可参考：Mybatis 的参数处理详解）。

查询到数据后，服务层将其转换为 JSON 字符串并进行后续处理，可以发现，Map 中元素的 Key 为数据库表的字段名：

Map map = orgMapper.queryOrgInfo(orgId);
LOGGER.info("Sync org info json: {}", JSON.toJSONString(map));
// Sync org info json: {"org_parent_id":"3","org_status":1,"org_type":"3","org_id":"001","org_level":3,"org_desc":"默认组织","org_name":"go"}
orgInfoMessage = GrpcUtil.getOrgMessage(clientId, JSON.toJSONString(map));
onNext(orgInfoMessage);

2 新增数据

首先在服务层对 JSON 字符串进行解析：

import com.alibaba.fastjson.JSON;

@Override
public Integer syncOrgInfo(String jsonOrgInfo) {
    if (StringUtils.isBlank(jsonOrgInfo)) {
        return 1;
    }
    Map param = JSON.parseObject(jsonOrgInfo, Map.class);
    if (CollectionUtils.isEmpty(param)) {
        LOGGER.info("fetch org info is empty");
        return 1;
    }
    LOGGER.info("Org info with Map: {}", param.toString());
    // Org info with Map: {org_parent_id=3, org_status=1, org_id=001, org_type=3, org_level=3, org_desc=默认组织, org_name=go}
    String syncOrgId = param.get("org_id").toString();
    String syncOrgName = param.get("org_name").toString();
    return orgMapper.addOrUpdateOrg(param);
}

编写 Mapper 类：

import com.github.yulichang.base.MPJBaseMapper;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Param;

import java.io.Serializable;
import java.util.Map;

@Mapper
public interface OrgMapper extends MPJBaseMapper<Org> {

    Integer addOrUpdateOrg(@Param("map") Map<String, Serializable> map);
}

编写对应的新增 SQL：（其中的 map 含义不同，应该能看懂吧）

<insert id="addOrUpdateOrg" parameterType="map">
    INSERT INTO tb_org
	(
		org_id,
		org_name,
		org_level,
		org_parent_id,
		org_type,
		org_status,
		org_desc,
		address
	)
	VALUES
	(
		#{map.org_id},
		#{map.org_name},
		#{map.org_level},
		#{map.org_parent_id},
		#{map.org_type},
		#{map.org_status},
		#{map.org_desc},
		#{map.address}
	)
	ON DUPLICATE KEY UPDATE 
    org_name = IFNULL(VALUES(org_name), org_name),
    org_level = IFNULL(VALUES(org_level), org_level),
    org_parent_id = IFNULL(VALUES(org_parent_id), org_parent_id),
    org_type = IFNULL(VALUES(org_type), org_type),
    org_status = IFNULL(VALUES(org_status), org_status),
    org_desc = IFNULL(VALUES(org_desc), org_desc),
    address = IFNULL(VALUES(address), address)
</insert>

Case 2 传递参数

关联查询，传多个参数时要用 java.util.Map 类型。

1 传多个参数

<resultMap id="testMap" type="XXX" >
    <id property="id" column="T_ID" jdbcType="DECIMAL"/>
    <result property="startDateStr" column="START_DATE" jdbcType="VARCHAR"/>
    <result property="endDateStr" column="END_DATE" jdbcType="VARCHAR"/>
    <!-- 关联查询传入多值，column 当 java.util.Map 使用 -->
    <association property="actualWorkTime" column="{reqId=T_ID, startDate=START_DATE, endDate=END_DATE}" select="selectById"/>
</resultMap>

<!-- 说明: reqId 为 key, column="T_ID" 为 value; 注意类型为 java.util.Map -->
<select id="selectById" parameterType="java.util.Map" resultType="java.lang.Double">
    select * from Table_XXX where reqId=#{reqId}
    and DATE_FORMAT(endDate,'%Y-%m-%d') <= DATE_FORMAT(#{endDate},'%Y-%m-%d')
    and DATE_FORMAT(startDate,'%Y-%m-%d') >= DATE_FORMAT(#{startDate},'%Y-%m-%d')
</select>

2 传单个参数

<resultMap id="PathMap" type="com.test.entity.po.Path">
    <id property="pathId" column="PATH_ID"/>
    <result property="bidirectional" column="BIDIRECTIONAL"/>
    <association property="point1" javaType="com.test.entity.Point" select="findPointById" column="POINT1_ID"/>
    <association property="point2" javaType="com.test.entity.Point" select="findPointById" column="POINT2_ID"/>
</resultMap>

<!-- 注意类型为 java.util.String -->
<select id="findPointById" parameterType="String" resultMap="PointMap">
	SELECT POSITION_X, POSITION_Y, POSITION_Z FROM tb_point
	WHERE POINT_ID = #{pointId}
</select>

（完）