mybatis返回的map结果怎么设置有序

# MyBatis返回的Map结果怎么设置有序

## 引言

在使用MyBatis进行数据库查询时，返回`Map`类型的结果是一种常见操作。但默认情况下，MyBatis返回的`HashMap`是无序的，这可能导致某些场景下（如需要保持字段插入顺序或按特定顺序处理数据）出现问题。本文将详细介绍如何让MyBatis返回有序的`Map`结果。

---

## 一、问题背景

### 1.1 默认行为分析
MyBatis的查询结果映射为`Map`时，默认实现是`HashMap`：
```java
// 默认返回无序HashMap
Map<String, Object> result = sqlSession.selectMap("queryUserById", "id");

1.2 有序性需求场景

以下情况需要有序Map： - 前端展示要求字段顺序固定 - 导出Excel时需要保持列顺序 - 需要按SQL查询字段顺序处理数据

二、解决方案

2.1 使用LinkedHashMap（推荐）

方法一：全局配置

在MyBatis配置文件中指定默认Map类型：

<settings>
    <!-- 设置默认Map类型为LinkedHashMap -->
    <setting name="defaultMapType" value="java.util.LinkedHashMap"/>
</settings>

方法二：注解指定

在Mapper接口中使用@MapKey注解：

@MapType(LinkedHashMap.class)
@MapKey("id")
LinkedHashMap<String, Object> selectUserAsLinkedMap();

2.2 自定义ResultHandler

public class OrderedMapResultHandler implements ResultHandler<Map<String, Object>> {
    private final Map<String, Object> mappedResults = new LinkedHashMap<>();
    
    @Override
    public void handleResult(ResultContext<?> context) {
        Object resultObject = context.getResultObject();
        // 转换逻辑...
        mappedResults.put(key, value);
    }
}

// 使用示例
OrderedMapResultHandler handler = new OrderedMapResultHandler();
sqlSession.select("queryUsers", handler);

2.3 XML映射文件配置

<resultMap id="orderedResultMap" type="java.util.LinkedHashMap">
    <id property="id" column="user_id"/>
    <result property="name" column="user_name"/>
    <!-- 字段顺序即为Map插入顺序 -->
</resultMap>

三、实现原理

3.1 LinkedHashMap的有序性

• 插入顺序：默认按put顺序维护
• 访问顺序：通过构造参数accessOrder=true可实现LRU顺序

3.2 MyBatis的类型处理器

DefaultResultSetHandler中创建Map实例的代码逻辑：

protected Object createResultObject(...) {
    if (resultType == Map.class) {
        return configuration.getDefaultMapType();
    }
}

四、性能对比

建议：在需要顺序且数据量不大时优先使用LinkedHashMap

五、注意事项

1. 分页插件兼容性：某些分页插件可能覆盖默认Map类型
2. 嵌套结果映射：嵌套的collection也需要单独配置有序类型
3. JSON序列化：FastJSON等库序列化时会保持LinkedHashMap顺序
4. 多表关联查询：字段别名需规范以避免顺序混乱

六、扩展方案

6.1 使用TreeMap实现排序

@MapType(TreeMap.class)
@MapKey("id")
TreeMap<String, Object> selectUserAsSortedMap();

6.2 自定义SortedMap实现

public class CustomOrderedMap extends LinkedHashMap<String, Object> {
    // 实现自定义排序逻辑
}

结语

通过合理配置LinkedHashMap，可以轻松实现MyBatis返回有序Map结果。根据实际场景选择全局配置或局部配置方案，同时注意性能影响和特殊场景的兼容性问题。当需要更复杂的排序逻辑时，可以考虑自定义ResultHandler或扩展Map实现。

最佳实践：中小型结果集使用LinkedHashMap，超大数据集考虑程序内排序 “`