Jeecg-Boot项目中手写SQL与实体类字段映射问题解析

在使用Jeecg-Boot 3.7.2版本开发过程中，开发者在查询权限数据时遇到了字段映射错误的问题。本文将深入分析这一问题的成因、解决方案以及相关的技术原理。

问题现象

当开发者执行权限查询操作时，返回结果中部分字段值出现错误或为空。通过检查发现，这是由于在手写SQL语句中直接使用了实体类的@TableField注解值作为查询字段名，而实际上应该使用数据库表的真实字段名。

问题根源分析

1. MyBatis映射机制：MyBatis在执行SQL查询时，默认会将查询结果集的列名与返回类型的属性名进行匹配映射。

2. 注解使用误区：@TableField是MyBatis-Plus提供的注解，主要用于实体类与数据库表字段的映射配置，但在手写SQL中直接使用这些注解值会导致映射失败。

3. ResultType与ResultMap区别：

   • resultType：直接指定返回类型，依赖自动映射
   • resultMap：使用预定义的映射规则，可以精确控制字段映射

解决方案

针对这个问题，有以下两种解决方案：

方案一：使用resultMap（推荐）

<select id="queryByUser" resultMap="SysPermission">
    <!-- SQL语句 -->
</select>

这种方式利用了预定义的SysPermission映射规则，可以确保字段正确映射。

方案二：修正SQL字段名

确保SQL语句中使用的是数据库表实际的字段名，而不是实体类的属性名或@TableField值：

<select id="queryByUser" resultType="org.jeecg.modules.system.entity.SysPermission">
    SELECT 
        id,
        parent_id,
        name,
        <!-- 其他数据库字段 -->
    FROM sys_permission
    <!-- 查询条件 -->
</select>

最佳实践建议

1. 保持一致性原则：在手写SQL时，始终使用数据库表实际的字段名。

2. 复杂查询使用resultMap：对于包含关联查询或字段转换的复杂SQL，建议使用resultMap进行显式映射。

3. 文档化映射关系：在团队协作中，建议维护实体类与数据库字段的映射文档。

4. 自动化测试验证：编写单元测试验证查询结果的字段映射是否正确。

技术延伸

理解MyBatis的自动映射行为非常重要：

• 默认情况下，MyBatis会尝试将结果集的列名转换为Java属性名（驼峰命名）
• 当列名包含下划线时（如parent_id），会自动映射到驼峰属性名（如parentId）
• 使用@TableField注解可以覆盖默认的映射规则

通过本文的分析，开发者可以更好地理解Jeecg-Boot项目中SQL查询的字段映射机制，避免类似问题的发生，提高开发效率。