实体类生成：mybatis-generator-gui 复合主键配置详解

2024-01-16 08:36:13

使用 mybatis-generator-gui 生成具有复合主键的实体类

引言

在使用 MyBatis 框架进行持久化操作时，生成实体类、映射器接口和 SQL 映射 XML 文件是一项繁琐的任务。为了简化这一过程，mybatis-generator-gui 应运而生。它是一款功能强大的工具，允许开发人员从数据库表中自动生成这些文件。

然而，当表拥有复合主键时，生成实体类需要进行一些额外的配置。本指南将详细介绍如何使用 mybatis-generator-gui 为具有复合主键的表生成实体类。

配置 mybatis-generator-gui

打开 mybatis-generator-gui 并连接到您的数据库。
选择要生成代码的表 ，该表必须拥有复合主键。
在 “主键策略” 下拉菜单中选择 “复合主键” 。
在 “复合主键列” 字段中指定复合主键列的名称，以逗号分隔。例如，如果您的复合主键由 id 和 name 列组成，则输入 id, name。
单击“生成” 按钮以生成实体类、映射器接口和 SQL 映射 XML 文件。

生成实体类

mybatis-generator-gui 将生成两个实体类：

xxx： 此实体类包含表的所有字段，包括复合主键字段。
xxxKey： 此实体类仅包含复合主键字段。

字段映射

默认情况下，mybatis-generator-gui 将为每个表字段创建一个属性。但是，对于复合主键，需要为复合主键列创建单独的实体类。为此，请在 xxx 实体类的注释中指定 @Column 注解，如下所示：

@Column(name = "id")
private Integer id;

@Column(name = "name")
private String name;

配置选项

mybatis-generator-gui 提供了以下配置选项，用于自定义实体类的生成：

表名称前缀和后缀： 用于在生成代码时添加前缀或后缀到表名。
实体名称前缀和后缀： 用于在生成代码时添加前缀或后缀到实体类名。
字段类型映射： 允许您指定如何将数据库类型映射到 Java 类型。
注释生成： 您可以配置是否生成注释以及注释的类型。

示例

以下是一个使用 mybatis-generator-gui 为具有复合主键的表生成实体类的示例配置：

<configuration>
  <context id="myBatisContext">
    <table tableName="user">
      <generatedKey column="id" sqlStatement="SELECT LAST_INSERT_ID()" />
      <columnOverride column="id" property="id" javaType="java.lang.Integer" />
      <columnOverride column="name" property="name" javaType="java.lang.String" />
      <primaryKey column="id" />
      <primaryKey column="name" />
    </table>
  </context>
</configuration>