在数据库字段命名格式和实体类属性命名格式不一致的情况下，通过配置 MyBatis 的通用 Mapper 并结合 Example 模式，高效地管理字段映射关系并完成数据库操作（二）

如果在 MyBatis 的通用 Mapper 中结合 Example 模式查询时，未自动使用实体类中 @Column 注解定义的字段映射，可能的原因是配置或使用方式上存在一些问题。以下是解决方案和注意事项：

原因分析

1. 通用 Mapper 的 @Column 支持： 通用 Mapper 支持通过 @Column 注解映射字段和数据库列，但要求配置正确，并且在查询时按规范使用通用 Mapper 的方法（如 selectByExample）。

2. 未启用 @Column 注解映射： 如果你的项目没有显式支持 JPA 注解（@Column），例如没有正确导入 jakarta.persistence 或 javax.persistence 包，@Column 注解可能被忽略。

3. Example 模式使用了动态字段匹配： 通用 Mapper 的 Example 模式会根据实体类的字段名称生成 SQL。如果字段名称和数据库列名不一致，而未启用 @Column 注解，可能导致字段无法正确映射。

解决方案

1. 确保依赖正确引入

确保项目中正确引入了 JPA 注解的依赖（jakarta.persistence 或 javax.persistence）。以下是常见的 Maven 依赖：

<dependency>
    <groupId>jakarta.persistence</groupId>
    <artifactId>jakarta.persistence-api</artifactId>
    <version>3.1.0</version> <!-- 或最新版本 -->
</dependency>

2. 确保实体类正确配置了 @Column 注解

在实体类中，明确使用 @Column 注解定义数据库列名：

import jakarta.persistence.Column;
import jakarta.persistence.Table;
@Table(name = "user") // 指定表名

public class User {
@Column(name = "id_no") // 数据库列名
private String idNo;

@Column(name = "user_name")
private String userName;

// Getter 和 Setter
public String getIdNo() {
    return idNo;
}

public void setIdNo(String idNo) {
    this.idNo = idNo;
}

public String getUserName() {
    return userName;
}

public void setUserName(String userName) {
    this.userName = userName;
}

}

3. 检查通用 Mapper 的配置

确保项目中正确配置了通用 Mapper：

• 通用 Mapper 默认支持 @Column 注解，但需要确保 Mapper 接口继承了 Mapper 或其子接口。例如：

import tk.mybatis.mapper.common.Mapper;
public interface UserMapper extends Mapper<User> {

}

4. 使用 Example 模式的正确方式

在使用 Example 模式时，直接通过实体类字段指定条件，通用 Mapper 会自动解析 @Column 注解并生成正确的 SQL。

• 示例：

  Example example = new Example(User.class);
  Example.Criteria criteria = example.createCriteria();
  // 按字段名添加条件
  
  criteria.andEqualTo("idNo", "123456"); // 自动映射到数据库列 id_no
  List<User> users = userMapper.selectByExample(example);
  
  

• 生成的 SQL：

  SELECT id_no, user_name FROM user WHERE id_no = '123456';
  

5. 如果仍未生效，考虑启用驼峰映射

如果 @Column 注解未生效，且实体类字段和数据库列名符合驼峰命名规则，可以启用 MyBatis 的驼峰映射：

• 在配置文件中设置：

  <settings>
      <setting name="mapUnderscoreToCamelCase" value="true" />
  </settings>
  

此时，即使不使用 @Column 注解，字段 idNo 也会自动映射到数据库的 id_no 列。

6. 使用 example.setUseColumn(true) 强制启用 @Column 支持

在通用 Mapper 的 Example 对象中，可以通过 setUseColumn(true) 方法强制启用 @Column 支持：

• 示例：

  Example example = new Example(User.class);
  example.setUseColumn(true); // 强制使用 @Column 注解
  Example.Criteria criteria = example.createCriteria();
  
  criteria.andEqualTo("idNo", "123456"); // 会解析为 id_no
  List<User> users = userMapper.selectByExample(example);
  
  

• 生成的 SQL：

  SELECT id_no, user_name FROM user WHERE id_no = '123456';
  

总结

如果通用 Mapper 的 Example 模式查询时未自动使用 @Column 注解，可以通过以下步骤解决：

1. 确保项目正确引入 JPA 注解依赖。
2. 在实体类中正确配置 @Column 注解。
3. 使用 Example.setUseColumn(true) 强制启用 @Column 支持。
4. 配置 MyBatis 的全局驼峰映射作为补充。

通常情况下，只要配置正确，通用 Mapper 能很好地支持 @Column 注解映射字段与数据库列名。