如何在MyBatisPlus实体类中忽略某个属性不映射数据库字段？

Question

在使用 MyBatis-Plus 进行数据库操作时，实体类中的属性默认会与数据表字段进行映射。但在实际开发中，某些属性可能仅用于业务逻辑处理，不需要与数据库字段对应。此时，如何忽略这些属性的映射成为常见问题。MyBatis-Plus 提供了多种方式实现该需求，例如使用 `@TableId`、`@TableField` 注解控制字段映射行为，或者通过继承 `Model` 类并重写 `pkVal()` 方法。此外，还可以通过配置 `MyBatis-Plus` 的自动映射策略或使用注解组合灵活控制字段行为。掌握这些方法有助于提升实体类设计的灵活性与代码可维护性。

Answer 1

一、MyBatis-Plus 实体类映射机制概述

MyBatis-Plus 是基于 MyBatis 的增强框架，提供了便捷的 ORM 操作能力。其核心之一是实体类与数据库表之间的自动映射机制。默认情况下，MyBatis-Plus 会将实体类的每个属性映射到对应的数据库字段。

但在实际开发中，某些属性仅用于业务逻辑，如临时计算字段、缓存字段、DTO 转换字段等，并不需要与数据库表字段进行映射。此时，如何正确地忽略这些属性的映射成为开发中的关键问题。

二、忽略映射的常见方法

• @TableField(exist = false) 注解：用于标识该属性不是数据库字段。
• @TableId 注解：用于标识主键字段，同时可配合 exist 属性。
• 继承 Model 类并重写 pkVal() 方法，实现自定义主键逻辑。
• 全局配置字段自动映射策略，如设置 mapUnderscoreToCamelCase 或使用 AutoMappingBehavior。

三、使用 @TableField(exist = false) 忽略字段

该注解是最常见也是最直接的方式。适用于字段名与数据库字段不一致或不需要映射的情况。

public class User {
    private Long id;
    private String name;
    
    @TableField(exist = false)
    private String tempField; // 临时字段，不参与数据库操作
}

该方式简单有效，适合字段数量不多或映射关系明确的场景。

四、通过继承 Model 类实现自定义映射

当需要更灵活地控制实体类与数据库的映射行为时，可以继承 Model 类并重写 pkVal() 方法。

public class User extends Model {
    private Long id;
    private String name;
    
    @Override
    protected Serializable pkVal() {
        return this.id;
    }
}

该方式适用于需要自定义主键策略或与数据库结构解耦的复杂业务场景。

五、配置全局自动映射策略

在 application.yml 或 mybatis-plus-config.xml 中配置自动映射行为，可以影响所有实体类的映射逻辑。

配置项	说明
mapUnderscoreToCamelCase	自动将下划线命名转换为驼峰命名
autoMappingBehavior	控制自动映射的行为，如 NONE、PARTIAL、FULL

该方式适用于统一项目风格或处理复杂映射关系。

六、使用注解组合实现高级控制

结合 @TableName、@TableId、@TableField 等多个注解，可以实现对实体类字段的精细控制。

@TableName("user_table")
public class User {
    @TableId(value = "user_id", type = IdType.AUTO)
    private Long id;

    @TableField("user_name")
    private String name;
    
    @TableField(exist = false)
    private String tempField;
}

该方式适用于需要与数据库字段名完全解耦的场景，增强实体类的可读性和维护性。

七、流程图：字段映射控制逻辑

graph TD
    A[实体类属性] --> B{是否需要映射?}
    B -->|是| C[使用@TableField或@TableId注解]
    B -->|否| D[添加@TableField(exist = false)]
    C --> E[映射到数据库字段]
    D --> F[不参与数据库操作]