MyBatisPlus @TableName表名注解的基本操作

更新時間：2025年09月17日 11:11:35 作者：awonw

@TableName注解是MyBatis-Plus中用于指定實體類與數(shù)據(jù)庫表映射關系的重要工具,通過使用@TableName注解,可以明確地指定表名,支持多級表名和動態(tài)表名,本文給大家介紹MyBatisPlus @TableName表名注解的相關操作,感興趣的朋友跟隨小編一起看看吧

在 MyBatis-Plus 中，@TableName 是一個非常重要的注解，用于指定實體類（Entity）與數(shù)據(jù)庫表之間的映射關系。通過使用 @TableName 注解，可以明確地告訴 MyBatis-Plus 哪個實體類對應數(shù)據(jù)庫中的哪張表。這使得 MyBatis-Plus 能夠正確地生成 SQL 語句并進行數(shù)據(jù)操作。

1.@TableName的基本用法

@TableName 注解通常用于實體類的類定義上，用于指定實體類對應的數(shù)據(jù)庫表名。如果實體類的類名與數(shù)據(jù)庫表名一致（按照駝峰命名規(guī)則），則可以省略 @TableName 注解。如果表名與類名不一致，則必須使用 @TableName 注解來指定表名。

示例 1：省略@TableName注解

假設數(shù)據(jù)庫中有一張表 user，表結構如下：

CREATE TABLE `user` (
  `id` BIGINT(20) NOT NULL AUTO_INCREMENT,
  `name` VARCHAR(50) NOT NULL,
  `age` INT(11) NOT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

對應的實體類可以這樣定義（省略 @TableName 注解）：

package com.example.entity;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
public class User {
    @TableId(type = IdType.AUTO)
    private Long id;
    private String name;
    private Integer age;
    // 省略 getter 和 setter 方法
}

因為實體類 User 和表名 user 是一致的（按照駝峰命名規(guī)則），所以可以省略 @TableName 注解。

示例 2：使用@TableName注解

如果表名與實體類名不一致，或者表名是多級表名（例如 sys_user），則必須使用 @TableName 注解來指定表名。

假設數(shù)據(jù)庫中有一張表 sys_user，表結構如下：

CREATE TABLE `sys_user` (
  `id` BIGINT(20) NOT NULL AUTO_INCREMENT,
  `username` VARCHAR(50) NOT NULL,
  `age` INT(11) NOT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

對應的實體類可以這樣定義：

package com.example.entity;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
@TableName("sys_user") // 指定表名
public class User {
    @TableId(type = IdType.AUTO)
    private Long id;
    private String username; // 注意字段名與表字段名一致
    private Integer age;
    // 省略 getter 和 setter 方法
}

2.@TableName的屬性

@TableName 注解提供了以下屬性，用于進一步配置表名映射：

value：指定數(shù)據(jù)庫表名。
resultMap：指定 resultMap 的名稱（可選）。
autoResultMap：是否自動生成 resultMap（默認為 true）。
exclude：指定需要排除的字段名（可選）。

示例：使用exclude屬性

假設表 sys_user 中有一個字段 create_time，但在實體類中不需要映射這個字段，可以使用 exclude 屬性來排除它：

package com.example.entity;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
@TableName(value = "sys_user", exclude = "create_time")
public class User {
    @TableId(type = IdType.AUTO)
    private Long id;
    private String username;
    private Integer age;
    // 省略 getter 和 setter 方法
}

3. 多級表名映射

在實際項目中，表名可能包含多級命名（例如 sys_user）。@TableName 注解可以直接指定完整的表名，MyBatis-Plus 會根據(jù)指定的表名生成 SQL 語句。

示例：多級表名

假設數(shù)據(jù)庫中有一張表 sys_user，表結構如下：

CREATE TABLE `sys_user` (
  `id` BIGINT(20) NOT NULL AUTO_INCREMENT,
  `username` VARCHAR(50) NOT NULL,
  `age` INT(11) NOT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

對應的實體類可以這樣定義：

package com.example.entity;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
@TableName("sys_user") // 指定多級表名
public class User {
    @TableId(type = IdType.AUTO)
    private Long id;
    private String username;
    private Integer age;
    // 省略 getter 和 setter 方法
}

4. 動態(tài)表名

在某些場景下，表名可能需要動態(tài)生成（例如分表）。MyBatis-Plus 支持通過 @TableName 注解的 value 屬性動態(tài)拼接表名。

示例：動態(tài)表名

假設有一個分表策略，表名根據(jù)年份動態(tài)生成（例如 user_2024、user_2025 等），可以通過以下方式實現(xiàn)：

package com.example.entity;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import java.time.LocalDate;
@TableName(value = "user_" + LocalDate.now().getYear()) // 動態(tài)表名
public class User {
    @TableId(type = IdType.AUTO)
    private Long id;
    private String name;
    private Integer age;
    // 省略 getter 和 setter 方法
}

5. 總結

@TableName 注解是 MyBatis-Plus 中用于指定實體類與數(shù)據(jù)庫表映射關系的重要工具。通過使用 @TableName 注解，可以明確地指定表名，支持多級表名和動態(tài)表名。合理使用 @TableName 注解可以提高代碼的可讀性和可維護性，同時避免因表名不一致導致的問題。

到此這篇關于MyBatisPlus @TableName表名注解的文章就介紹到這了,更多相關MyBatisPlus @TableName表名注解內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: