MyBatisX 初级使用教程

使用mybatisx 能帮助减少工作量，快速生成项目结构框架，model里的参数都是按照数据库中连接好的对应表单进行生成。

我的配置基于idea2023.3.1

这里是项目工程文件

1. 基础配置:

   • Module path: 这应该自动填充为您当前的模块路径，例如 C:\Users\jksps\IdeaProjects\SpringTest001。
   • Base package: 这是您的基本包路径，根据您的项目结构，应该是 com.demo.springtest001。
   • Base path: 保持为 src/main/java，这是标准的 Maven 项目结构。
   • Relative package: 这里填入 domain 是用来指定生成的实体类相对于基本包的位置。它将在 base package 下创建一个新的 domain 子包。

2. 高级配置:

   • Encoding: 保持为 UTF-8，这是最常见的字符编码。
   • Ignore field/table prefix/suffix: 如果您的数据库表或字段有一致的前缀或后缀，您可以在这里设置来忽略它们。
   • Extra class suffix: 如果您想为生成的类添加额外的后缀，比如 Entity 或 DTO，可以在这里填写。
   • Class/Table name: 这里可以填写您想要生成的特定表的名称和对应的类名。

3. 生成操作:

   • 确认好上述配置后，点击 Next，MyBatisX 会根据配置连接到数据库，并根据您选择的表生成相应的实体类、Mapper 接口、XML 映射文件等。

在您的项目结构中，这些生成的文件应该放置在以下位置：

• 实体类 (Entities): 放在 com.demo.springtest001.domain 包下。
• Mapper 接口: 通常放在 com.demo.springtest001.mapper 包下，如果您没有这个包，可以在生成器中设置相应的包路径，或手动创建它。
• Mapper XML 文件: 通常放在 src/main/resources/mapper 目录下，如果该目录不存在，您可以创建它。

请确保您的 Mapper XML 文件路径与 mybatis 配置中的 mapper-locations 一致，以便 Spring Boot 能够正确地加载和识别它们。

完成配置并生成文件后，它们应该自动地出现在您的项目目录中，如 src/main/java/com/demo/springtest001/domain 以及 src/main/resources/mapper（如果是 XML 文件）。您可以在 IDEA 中的项目视图中看到这些新创建的文件。

接下来的步骤

template里建议选择mybatis plus3的，会带着service model啥的一起生成。

1. Annotation:

   • 您可以选择生成的代码中使用的注解类型。根据您的需求，可以选择 Mybatis-Plus 2, Mybatis-Plus 3, 或 JPA。这将决定生成的实体类中会使用哪个版本的 MyBatis-Plus 注解，或是使用 JPA 注解。

2. Options:

   • Comment: 如果勾选，将在生成的代码中包含字段的注释，这些通常是基于数据库中的列描述。
   • Actual Column: 如果勾选，将在实体类字段上使用实际数据库列名的注解。
   • Model: 如果勾选，表示将生成实体类（Model）。
   • toString/hashCode/equals: 如果勾选，将为实体类生成 toString、hashCode 和 equals 方法。
   • Actual Column Annotation: 如果勾选，字段上将包含表示实际数据库列名的注解。
   • Lombok: 如果勾选，生成的代码将使用 Lombok 库简化 Java 类的代码，比如自动为类属性生成 getters 和 setters。
   • JSR310: Date API: 如果勾选，将使用 Java 8 的日期和时间 API（即 java.time 包下的类）来处理日期类型。

3. Template:

   • 您可以选择使用哪个模板来生成代码。
   • custom-model-swagger: 这个模板可能包括与 Swagger 集成的配置，为生成的模型添加 Swagger 注解。
   • mybatis-plus2: 使用 MyBatis-Plus 2.x 版本的模板。
   • mybatis-plus3: 使用 MyBatis-Plus 3.x 版本的模板。
   • default-all: 使用一个包含所有默认设置的模板。
   • default-empty: 使用一个最小化的模板。

根据您的项目需要，您可以选择合适的注解、选项和模板来生成代码。完成这些配置后，点击 Finish 将开始生成过程，将根据您的数据库表结构和选择的配置项在指定的包路径下生成代码。