MyBatis的@MapKey的使用

@MapKey的作用

在MyBatis中，@MapKey注解用于指定返回结果集是一个Map的集合时，映射结果集中的某列或字段作为Map的键（key）。

使用@MapKey注解前

如果没有使用@MapKey注解，MyBatis会将查询结果集映射为一个Map，其中Map的键是列名，值是对应的字段值。每条记录都是一个独立的Map条目，但没有特定的键来标识它们。

Mapper.java

public interface UserMapper {
    List<Map<String, Object>> getUser();
}

Mapper.xml

<select id="getUser" resultType="java.util.Map">
    SELECT id, name, age FROM user
</select>

结果

[
    {
        "id": 1,
        "name": "Alice",
        "age": 25
    },
    {
        "id": 2,
        "name": "Bob",
        "age": 30
    }
]

使用@MapKey注解后

使用@MapKey注解后，可以指定返回的List中的每个Map都有一个特定的键，该键对应于选择的列值。这在处理一对多或多对多关系时非常有用，可以快速通过键值访问特定的记录。

Mapper.java

public interface UserMapper {
    @MapKey("id")
    List<Map<Long, Object>> getUser();
}

Mapper.xml

<select id="getUser" resultType="java.util.Map">
    SELECT id, name, age FROM user
</select>

结果

[
    {
        "1": {
            "id": 1,
            "name": "Alice",
            "age": 25
        }
    },
    {
        "2": {
            "id": 2,
            "name": "Bob",
            "age": 30
        }
    }
]

差异对比

使用前：返回的List 中每个元素是一个Map，其中键是列名，值是字段值。无法直接通过某个特定的字段值快速访问记录。
使用后：返回的List中每个元素变成了一个嵌套的Map，外层Map的键是指定的字段，值是另一个包含列名和字段值的Map。这样可以通过指定字段值快速访问到具体的信息。