@TableField(exist = false)注解含义

在 MyBatis-Plus 框架中，@TableField(exist = false)是一个关键注解，用于告诉框架某个实体类字段不需要映射到数据库表中。下面详细解读它的作用、使用场景和注意事项：

1. 作用说明

• 忽略字段：当某个字段在数据库表中不存在时，使用这个注解标记该字段，避免 MyBatis-Plus 在执行 CRUD 操作（如插入、更新、查询）时尝试操作不存在的数据库列。
• 避免异常：如果不添加此注解，框架会认为该字段需要映射到数据库列，运行时会报错（例如字段不存在于表中）。

2. 使用场景

场景 1：临时计算字段

在实体类中添加一个字段，用于存储临时计算值，而该值不需要持久化到数据库。

public class User { @TableId private Long id; private String name; // 数据库中没有该字段，仅用于临时计算用户订单总数 @TableField(exist = false) private Integer orderCount; // 可能通过关联查询时动态计算 }

场景 2：遗留表结构兼容

如果数据库表的结构无法修改（如历史遗留表），但实体类中需要添加一个字段时使用：

public class LegacyTable { private Long id; private String oldFieldName; // 新增的字段不会在旧数据库表中存在 @TableField(exist = false) private String newFeatureField; }

场景 3：DTO（数据传输对象）

在 DTO 中包含数据库表中不存在的字段，通常用于组合数据：

public class UserDTO { private Long id; private String name; // 以下字段为 DTO 扩展，不存储在数据库的用户表中 @TableField(exist = false) private String address; // 可能从其他表查询结果拼接 @TableField(exist = false) private String avatarUrl; // 可能通过逻辑生成，而非存储 }

3. 示例代码

实体类定义

@Data public class Order { @TableId private Long id; private String productName; // 不需要映射到数据库 @TableField(exist = false) private Double recommendPrice; // 推荐价格，可能通过算法计算 }

查询时的行为

假设数据库表中的order仅包含id和product_name字段：

• 查询时，recommendPrice的值不会被数据库返回。
• 在持久化操作（如插入/更新）时，框架会完全忽略这个字段，不会尝试操作数据库。

4. 特别注意

1. 字段吞吐行为：

   • 查询时：该字段值需通过其他方式赋值（如手动计算、关联查询后赋值）。
   • 插入/更新时：框架会完全忽略这个字段，不会尝试将其值写入数据库。

2. 与@TableField填充(Fill)的结合：

   • 如果字段使用exist = false，则其fill属性（如填充策略）不会生效，因为框架不会处理该字段：

     @TableField(fill = FieldFill.INSERT) // 会被忽略 private String createTime;

3. 默认行为对比：

   • 如果字段没有@TableField(exist = false)：
     • MyBatis-Plus 会尝试自动映射数据库表列，若表中不存在该列，将导致SQL 错误。

5. 其他用途

• 继承场景：当父类字段不存在于子类对应的表时：

  @Data public class BaseEntity { @TableField(exist = false) private String metadata; // 不需要子类表继承该字段时 }

• 动态拼接字段：在某些场景中，可以通过代码动态填充值，如封装请求的 IP 地址等信息。

6. 总结

通过合理使用@TableField(exist = false)，可以灵活地解耦业务代码与数据库结构，提升灵活性和可维护性。