关于mybatis-plus的一些默认配置

写在前面

最近在熟悉公司项目环境的时候,发现项目里面用了一些mybatis-plus的表名映射默认配置,在这里做个小总结。

MyBatis-Plus(简称 MP)在简化 MyBatis 开发的同时,内置了大量默认规则和自动配置,涵盖实体映射、SQL 生成、字段处理等多个方面。

默认规则和自动配置

实体类与数据库的默认映射规则

1. 表名映射

  • 默认规则:类名 → 下划线命名表名

    • Useruser
    • UserInfouser_info
  • 控制开关:mybatis-plus.global-config.db-config.table-underline-hump = true(默认开启)

⚠️ 不支持复数形式(如 Users 不会变成 users),只是简单驼峰转下划线。


2. 字段名映射

  • 默认规则:属性名 → 下划线命名字段名

    • userNameuser_name
    • createTimecreate_time
  • 同样由 table-underline-hump 控制(该配置同时影响表名和字段名)

3. 主键字段识别

  • 默认将名为 id 的字段视为主键 (无论类型是 LongString 等)
  • 若主键字段不是 id,需使用 @TableId 显式标注
java 复制代码
@TableId(value = "user_id", type = IdType.AUTO)
private Long userId;

4. 主键生成策略(IdType)

若未指定 @TableId(type = ...),默认策略为:

  • IdType.NONE:即不自动处理主键,依赖数据库或手动赋值

但如果你用了 @TableId 但没写 type,MP 会根据数据库类型尝试推断(例如 MySQL 下常配合自增)。

常见策略:

枚举值 说明
AUTO 数据库自增(需 DB 支持)
INPUT 用户手动输入
ASSIGN_ID 雪花 ID(默认使用 DefaultIdentifierGenerator,兼容 Long/String)
ASSIGN_UUID UUID(32位无横线字符串)

💡 从 MP 3.3.0 起,ASSIGN_ID 成为推荐默认策略(尤其分布式场景)

二、字段忽略与逻辑处理

1. 非表字段自动忽略

  • 实体类中没有对应数据库字段的属性,默认会被忽略(不会参与 SQL 构建)
  • 但若属性名恰好和某字段重名,可能误入 SQL → 建议对非表字段加 @TableField(exist = false)
ini 复制代码
java
编辑
@TableField(exist = false)
private String tempData;

2. 逻辑删除

  • 默认不启用逻辑删除
  • 启用后,默认识别字段名为 deleted 的字段(值:0=未删,1=已删)
  • 可通过配置修改字段名和值:
yaml 复制代码
yaml
编辑
mybatis-plus:
  global-config:
    db-config:
      logic-delete-field: deleted     # 全局逻辑删除字段名
      logic-delete-value: 1           # 已删除值
      logic-not-delete-value: 0       # 未删除值

使用前需在实体字段加 @TableLogic


3. 自动填充(Auto Fill)

  • 默认不启用自动填充
  • 需配合 @TableField(fill = FieldFill.INSERT) + 实现 MetaObjectHandler
  • 常用于 create_timeupdate_timecreate_by 等字段

三、SQL 与查询默认行为

1. Select 查询

  • select * 是默认行为(如 selectById, list()
  • 可通过 QueryWrapper.select("col1, col2") 指定字段

2. Update 更新

  • 默认只更新非 null 字段 (针对 update(entity, wrapper)
  • 若想更新 null 值,需使用 UpdateWrapper.set("field", null) 或配置 FieldStrategy

3. 字段更新策略(FieldStrategy)

  • 默认策略:NOT_NULL(仅当字段值非 null 时才加入 SQL)
  • 其他选项:IGNORED(强制更新)、NOT_EMPTY(非空字符串/集合)、DEFAULT(跟随全局)

可通过 @TableField(strategy = FieldStrategy.IGNORED) 覆盖

⚠️ 注意:MP 3.4+ 已弃用 FieldStrategy,改用更灵活的 updateStrategy / whereStrategy

写在最后

mybatis-plus虽然提供了很多默认规则配置,最佳实践还是建议如下:

  • 显式优于隐式 :即使符合默认规则,也建议加上 @TableName@TableId,提高可读性。
  • 谨慎使用自动填充和逻辑删除:确保团队理解其触发机制,避免数据异常。

参考

mp.weixin.qq.com/s/Lr_S89lFr...

相关推荐
Juchecar2 小时前
Java示例:设计模式是如何在实战中“自然生长”出来
java·设计模式
能摆一天是一天2 小时前
JAVA Function
java
The Sheep 20232 小时前
Dotnet-Dapper的用法
java·开发语言
SimonKing2 小时前
百度统计、Google Analytics平替开源网站分析工具:Umami
java·后端·程序员
Juchecar2 小时前
设计模式不是Java专属,其他语言的使用方法
java·python·设计模式
马克学长2 小时前
SSM基于Java的医疗器械销售系统oy281(程序+源码+数据库+调试部署+开发环境)带论文文档1万字以上,文末可获取,系统界面在最后面。
java·开发语言·用户管理·ssm 框架·医疗器械销售系统
Seven973 小时前
MyBatis 常见面试题
java·mybatis
我命由我123453 小时前
Android WebView - loadUrl 方法的长度限制
android·java·java-ee·android studio·android jetpack·android-studio·android runtime
前端架构师-老李3 小时前
Maven安装以及环境变量配置(macOS)
java·macos·maven