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

简介: `@TableField`注解在MyBatis-Plus中是一个非常灵活和强大的工具,能够帮助开发者精细控制实体类与数据库表字段之间的映射关系。通过合理使用 `@TableField`注解,可以实现字段名称映射、自动填充、条件查询以及自定义类型处理等高级功能。这些功能在实际开发中,可以显著提高代码的可读性和维护性。如果需要进一步优化和管理你的MyBatis-Plus应用程

在MyBatis-Plus中,@TableField注解用于控制实体类与数据库表字段之间的映射关系。通过合理使用 @TableField注解,可以更灵活地控制字段的映射、查询和插入等行为。以下是对@TableField注解的深入理解和使用方法的详细介绍。

基本用法

@TableField注解主要用于字段的属性映射,通常使用在实体类的字段上。其常见的属性包括 valueexistfill等。

1. value属性

value属性用于指定数据库表中的实际字段名称。如果实体类的字段名与数据库表字段名不一致,可以通过 value属性进行映射。

import com.baomidou.mybatisplus.annotation.TableField;

public class User {

    @TableField("user_name")
    private String userName;

    // getter and setter
}
​
AI 代码解读

在上述例子中,userName字段将映射到数据库表中的 user_name字段。

2. exist属性

exist属性用于指定该字段是否在数据库表中存在。如果某个字段在数据库表中不存在,但又不想删除该字段,可以设置 exist = false

import com.baomidou.mybatisplus.annotation.TableField;

public class User {

    @TableField(exist = false)
    private String temporaryData;

    // getter and setter
}
​
AI 代码解读

在上述例子中,temporaryData字段在数据库表中不存在,但它仍然可以在实体类中使用。

3. fill属性

fill属性用于指定字段的填充策略。MyBatis-Plus提供了多种填充策略,例如在插入或更新时自动填充字段。

import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.FieldFill;
import java.time.LocalDateTime;

public class User {

    @TableField(fill = FieldFill.INSERT)
    private LocalDateTime createTime;

    // getter and setter
}
​
AI 代码解读

在上述例子中,createTime字段将在插入记录时自动填充当前时间。

高级用法

1. 使用条件查询

通过 @TableField注解,可以指定在查询条件中使用的SQL片段。常见的属性有 condition

import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;

public class User {

    @TableField(condition = "%s LIKE CONCAT('%%',#{%s},'%%')")
    private String email;

    // getter and setter
}

// 使用示例
QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.like("email", "example.com");
​
AI 代码解读

在上述例子中,email字段在查询时使用了 LIKE条件。

2. 字段加密和解密

在某些场景中,可能需要对字段进行加密存储和解密读取。可以通过自定义的类型处理器实现。

import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.extension.handlers.EncryptHandler;

public class User {

    @TableField(typeHandler = EncryptHandler.class)
    private String sensitiveData;

    // getter and setter
}
​
AI 代码解读

分析说明表

属性 说明 示例
value 指定数据库表中的实际字段名称 @TableField("user_name")
exist 指定字段是否在数据库表中存在 @TableField(exist = false)
fill 指定字段的填充策略 @TableField(fill = FieldFill.INSERT)
condition 指定查询条件中使用的SQL片段 @TableField(condition = "%s LIKE CONCAT('%%',#{%s},'%%')")
typeHandler 指定自定义的类型处理器用于字段的加密和解密 @TableField(typeHandler = EncryptHandler.class)

结论

@TableField注解在MyBatis-Plus中是一个非常灵活和强大的工具,能够帮助开发者精细控制实体类与数据库表字段之间的映射关系。通过合理使用 @TableField注解,可以实现字段名称映射、自动填充、条件查询以及自定义类型处理等高级功能。这些功能在实际开发中,可以显著提高代码的可读性和维护性。如果需要进一步优化和管理你的MyBatis-Plus应用程

目录
打赏
0
2
3
0
465
分享
相关文章
Mybatisplus中的主要使用注解
3.有些注解需要配合其他配置使用。例如,@Version需要配合乐观锁插件使用,@EnumValue需要配合对应的TypeHandler使用。
119 11
|
3月前
|
MyBatis——选择混合模式还是全注解模式?
在MyBatis开发中,Mapper接口的实现方式有两种:全注解模式和混合模式。全注解模式直接将SQL嵌入代码,适合小规模、简单逻辑项目,优点是直观简洁,但复杂查询时代码臃肿、扩展性差。混合模式采用接口+XML配置分离的方式,适合大规模、复杂查询场景,具备更高灵活性与可维护性,但学习成本较高且调试不便。根据项目需求与团队协作情况选择合适模式至关重要。
64 4
微服务——SpringBoot使用归纳——Spring Boot集成MyBatis——基于注解的整合
本文介绍了Spring Boot集成MyBatis的两种方式:基于XML和注解的形式。重点讲解了注解方式,包括@Select、@Insert、@Update、@Delete等常用注解的使用方法,以及多参数时@Param注解的应用。同时,针对字段映射不一致的问题,提供了@Results和@ResultMap的解决方案。文章还提到实际项目中常结合XML与注解的优点,灵活使用两者以提高开发效率,并附带课程源码供下载学习。
98 0
【MyBatisPlus·最新教程】包含多个改造案例,常用注解、条件构造器、代码生成、静态工具、类型处理器、分页插件、自动填充字段
MyBatis-Plus是一个MyBatis的增强工具,在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而生。本文讲解了最新版MP的使用教程,包含多个改造案例,常用注解、条件构造器、代码生成、静态工具、类型处理器、分页插件、自动填充字段等核心功能。
1346 5
【MyBatisPlus·最新教程】包含多个改造案例,常用注解、条件构造器、代码生成、静态工具、类型处理器、分页插件、自动填充字段
【详细实用のMyBatis教程】获取参数值和结果的各种情况、自定义映射、动态SQL、多级缓存、逆向工程、分页插件
本文详细介绍了MyBatis的各种常见用法MyBatis多级缓存、逆向工程、分页插件 包括获取参数值和结果的各种情况、自定义映射resultMap、动态SQL
【详细实用のMyBatis教程】获取参数值和结果的各种情况、自定义映射、动态SQL、多级缓存、逆向工程、分页插件
|
8月前
|
MyBatis如何关闭一级缓存(分注解和xml两种方式)
MyBatis如何关闭一级缓存(分注解和xml两种方式)
255 5
Springboot整合shiro,带你学会shiro,入门级别教程,由浅入深,完整代码案例,各位项目想加这个模块的人也可以看这个,又或者不会mybatis-plus的也可以看这个
本文详细讲解了如何整合Apache Shiro与Spring Boot项目,包括数据库准备、项目配置、实体类、Mapper、Service、Controller的创建和配置,以及Shiro的配置和使用。
1932 1
Springboot整合shiro,带你学会shiro,入门级别教程,由浅入深,完整代码案例,各位项目想加这个模块的人也可以看这个,又或者不会mybatis-plus的也可以看这个
Mybatis使用注解方式实现批量更新、批量新增
Mybatis使用注解方式实现批量更新、批量新增
134 3
Mybatis使用注解方式实现批量更新、批量新增
Mybatis使用注解方式实现批量更新、批量新增
662 1
mybatis复习02,简单的增删改查,@Param注解多个参数,resultType与resultMap的区别,#{}预编译参数
文章介绍了MyBatis的简单增删改查操作,包括创建数据表、实体类、配置文件、Mapper接口及其XML文件,并解释了`#{}`预编译参数和`@Param`注解的使用。同时,还涵盖了resultType与resultMap的区别,并提供了完整的代码实例和测试用例。
mybatis复习02,简单的增删改查,@Param注解多个参数,resultType与resultMap的区别,#{}预编译参数
AI助理

你好,我是AI助理

可以解答问题、推荐解决方案等