返回

一文掌握 Springboot Mybatis 代码生成:自动生成实体类和 Mapper

后端

借助 MyBatisGenerator:简化 Springboot Mybatis 开发

在 Springboot Mybatis 持久层开发中,撰写实体类和 Mapper 接口是一项繁琐且容易出错的任务。为了提升开发效率,我们可以借助代码生成器,其中 MyBatisGenerator 是一个理想的选择。

MyBatisGenerator 简介

MyBatisGenerator 由 MyBatis 官方提供,能够基于数据库表自动生成 Java 代码,包含实体类、Mapper 接口和 Mapper.xml 文件。它功能强大、使用简便,广泛适用于 Springboot Mybatis 开发。

MyBatisGenerator 使用指南

1. 导入依赖

将 MyBatisGenerator 的依赖添加到 Maven 项目的 pom.xml 文件中:

<dependency>
  <groupId>org.mybatis.generator</groupId>
  <artifactId>mybatis-generator-core</artifactId>
  <version>1.3.7</version>
</dependency>

2. 创建配置文件

创建 MyBatisGenerator 配置文件(generatorConfig.xml),用于配置代码生成器参数:

<configuration>
  <context id="default">
    <jdbcConnection connectionURL="jdbc:mysql://localhost:3306/test" driverClass="com.mysql.cj.jdbc.Driver" userId="root" password="123456" />
    <javaTypeResolver>
      <property name="forceBigDecimals" value="false" />
    </javaTypeResolver>
    <table tableName="user" />
    <generator type="mybatis3" targetPackage="com.example.demo" targetProject="src/main/java" />
  </context>
</configuration>

3. 运行代码生成器

在命令行中执行以下命令:

mvn mybatis-generator:generate

4. 查看生成结果

代码生成后,可在项目中找到以下文件:

  • 实体类: 位于 src/main/java 目录下
  • Mapper 接口: 位于 src/main/resources/mapper 目录下
  • Mapper.xml: 位于 src/main/resources/mapper 目录下

代码封装

为提升代码简洁性和可维护性,我们可以封装生成代码:

  • 将实体类和 Mapper 接口放置于单独模块中
  • 使用注解方式配置 MyBatisGenerator

总结

利用 MyBatisGenerator,我们可以轻松实现 Springboot Mybatis 代码自动生成,节省开发时间并避免错误。希望本文助您掌握 MyBatisGenerator 的使用技巧,提升开发效率。

常见问题解答

Q1:如何配置数据库连接信息?

A:在 generatorConfig.xml 文件中指定 jdbcConnection 节点。

Q2:如何指定要生成的表?

A:在 generatorConfig.xml 文件中添加 table 节点,指定 tableName 属性。

Q3:如何自定义生成代码的包名?

A:在 generatorConfig.xml 文件中,将 generator 节点的 targetPackage 属性设置为期望的包名。

Q4:如何使用注解配置 MyBatisGenerator?

A:使用 @Table、@Column 和 @Id 等注解配置实体类,并使用 @Mapper 和 @Select、@Insert 等注解配置 Mapper 接口。

Q5:MyBatisGenerator 无法生成代码,如何解决?

A:检查配置文件是否正确,确保数据库连接配置正确,并检查 Maven 项目中是否有 MyBatisGenerator 依赖。