当字段名称的顺序发生变化时，MyBatis的结果映射不工作。

Question

我正在使用SQLite数据库存储播放列表信息。这是我的实体类：

@Data
@Builder
public class Playlist {
    private String id;
    private String playlistName;
    private PlaylistType type;
}

其中PlaylistType是一个枚举类型，包含("TYPE_A", "TYPE_B")两个值。

起初，在我的Mapper XML文件中，我尝试使用resultType="Playlist"，当数据库列名与Playlist属性按相同顺序时，它可以正常工作。但当我改变属性的顺序时（例如下面所示）：

public class Playlist {
    private String id;
    private PlaylistType type; // 移动了PlaylistType属性的位置
    private String playlistName;
}

就会出现如下错误：

Caused by: org.apache.ibatis.executor.result.ResultMapException: Error attempting to get column 'name' from result set.  Cause: java.lang.IllegalArgumentException: No enum constant com.example.demo.PlaylistType.p1

之后有一些帖子建议使用resultMap，但是问题依然存在。

这是我在使用resultMap的Mapper XML配置：

是否有更好的方式来映射数据库列？它不应该对实体类属性的顺序这样琐碎的问题过于严格。或者我是否遗漏了什么？

Divakar · Answer

难以置信的是，我在类似的情况下犯了同样的错误。为了我和他人的学习，让我分享一些见解。

这个问题看似来自MyBatis，但实际上是由Lombok注解导致的。在这种情况下，实际的映射操作可以追溯到以下代码片段：

private boolean applyColumnOrderBasedConstructorAutomapping(ResultSetWrapper rsw, List> constructorArgTypes,
      List

Mark · Answer

向类中添加@NoArgsConstructor是最简单的解决方案。
本答案针对那些不想在不可变类中添加无参构造函数的人群。

当你在类中添加@Builder注解时，Lombok会生成如下构造函数：

Playlist(String id, String playlistName, PlaylistType type) {
  this.id = id;
  this.playlistName = playlistName;
  this.type = type;
}

虽然它是包私有的，但MyBatis仍可以通过反射（且必须这样做，因为没有其他构造函数可供选择）使用此构造函数[1]。

为了将结果集映射到这个构造函数，MyBatis提供了四种不同的方法。

基于顺序的构造器自动映射
基于参数名的构造器自动映射
使用元素的结果映射（未指定name属性）
使用元素的结果映射（已指定name属性）

简要说明：

对于大多数简单情况，方法2应该足够有效。
对于高级映射或需要最佳性能的情况，请使用方法3或4。

1. 基于顺序的构造器自动映射

这是你不使用时的默认行为。

在你的示例中，构造函数接受三个参数，所以结果集中的第一、第二和第三个列分别被映射到id、playlistName和type。当你更改类中字段的顺序时，构造函数参数的顺序也会发生变化，此时你必须相应地更改列顺序。

个人而言，我不推荐这种基于顺序的构造器自动映射，因为它有一个已知问题，可能会让人感到困惑。如果你感兴趣，我在另一个回答中对此进行了详细解释。

2. 基于参数名的构造器自动映射

这种方法要求你在配置中启用argNameBasedConstructorAutoMapping选项，并且不使用。使用这种方法时，MyBatis会查找具有与构造函数参数同名的列[2]。列的顺序无关紧要。

注意，在你的示例中，列名name与目标参数名playlistName不匹配，因此你可能需要在SELECT语句中指定列别名。

argNameBasedConstructorAutoMapping特性是在3.5.10版本中新增的。

3. 使用元素的结果映射（未指定name属性）

使用结果映射时，你需要使用、和元素执行构造函数映射。

为了完整性，这里展示了用Java映射器声明相同结果映射的方法[3]。

@Arg(id = true, column = "id", javaType = String.class)
@Arg(column = "name", javaType = String.class)
@Arg(column = "type", javaType = PlaylistType.class)
Playlist findById(String id);

使用这种方法时，列的顺序无关紧要，但XML元素的顺序必须与构造函数参数的实际顺序一致。如果维护XML元素顺序对你来说比较困难（比如目标类频繁更新），请查看下一节。

4. 使用元素的结果映射（已指定name属性）

当指定了name属性时，XML元素的顺序无需与实际构造函数参数的顺序匹配[4]。

在你的案例中，构造函数参数类型始终与字段类型相匹配，因此可以省略javaType。

以及使用注解表示相同结果映射的方式：

@Arg(id = true, column = "id", name = "id")
@Arg(column = "name", name = "playlistName")
@Arg(column = "type", name = "type")
Playlist findById(String id);

采用上述结果映射，MyBatis会搜索具有任意顺序但满足以下条件的构造函数：

名称：id，类型=java.lang.String
名称：playlistName，类型=java.lang.String
名称：type，类型=pkg.PlaylistType

当有多个构造函数满足这些条件时，你需要在正确的构造函数上添加@AutomapConstructor注解。一旦找到构造函数，指定列的值将被映射到每个构造函数参数。

因此，使用这种方法时，无论是XML元素顺序还是列顺序都不重要，但如果更改字段名称，你可能需要编辑name值。

这种方法需要MyBatis 3.4.3或更高版本。

[1] 如果你使用Java平台模块系统（JPMS），你可能需要允许MyBatis访问这个构造函数。

[2] 为了在二进制文件中包含参数名，你必须要么指定-parameters编译器选项，要么向每个参数添加@Param注解。

[3] 如果你使用的版本早于3.5.4，你可能需要使用@ConstructorArgs。

[4] 必须写在前面，这是由DTD强制规定的。