深入理解@TableField注解的使用-MybatisPlus教程

@TableField注解是MyBatis-Plus框架提供的一个功能，用于指定实体类属性与数据库表列的映射关系。当实体类的属性名称和数据库表的列名称不一致，或者需要指定一些特殊的处理逻辑时，可以使用@TableField注解。

以下是@TableField注解的一些常见用法：

目录

1.指定属性与列的映射：

2.表示属性不存在于数据库表中：

3.指定自动填充的逻辑：

4.指定字段选择性更新：

5.指定字段的数据库排序：

6.指定字段的读写策略：

---

1.指定属性与列的映射：

当实体类中的属性名称与数据库表中的列名称不一致时，可以使用value属性指定数据库表中的列名。

public class UserEntity {
    private String userId;
    private String userName;

    @TableField(value = "user_name")
    private String nickName;
    
    // getters and setters
}

2.表示属性不存在于数据库表中：

如果实体类中的某个属性不需要映射到数据库表的列，可以使用exist = false标记。

public class UserEntity {
    private String id;
    private String name;

    @TableField(exist = false)
    private String fullName; // 这个属性不会映射到数据库表中

    // getters and setters
}

3.指定自动填充的逻辑：

对于数据库自动填充的字段（如创建时间、更新时间等），可以使用fill属性指定填充策略。

public class UserEntity {
    private String id;
    private String name;

    @TableField(fill = FieldFill.INSERT)
    private Date createTime; // 插入时自动填充

    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Date updateTime; // 插入和更新时自动填充

    // getters and setters
}

4.指定字段选择性更新：

使用updateStrategy属性，可以指定字段的更新策略，例如仅当字段值为非空时才更新。

public class UserEntity {
    private String id;
    private String name;

    @TableField(updateStrategy = FieldStrategy.NOT_EMPTY)
    private String nickname; // 只有当nickname非空时，才会更新这个字段

    // getters and setters
}

5.指定字段的数据库排序：

使用select属性，可以指定字段在选择时的排序方式。

public class UserEntity {
    private String id;
    private String name;

    @TableField(select = "EQ") // 指定选择时的等值匹配
    private String status;

    // getters and setters
}

6.指定字段的读写策略：

使用writeStrategy属性，可以指定字段的读写策略，例如仅在插入时写入数据库。

public class UserEntity {
    private String id;
    private String name;

    @TableField(writeStrategy = FieldWriteStrategy.INSERT)
    private String initialPassword; // 仅在插入时写入数据库

    // getters and setters
}

请注意，@TableField注解的使用需要与MyBatis-Plus框架的其他配置和注解一起工作，用来确保实体类和数据库表之间的正确映射。此外，注解的具体使用可能会根据MyBatis-Plus的版本和项目配置有所不同。