MyBatis Generator (MBG) 是一个用于自动生成 MyBatis 相关代码的工具。它可以生成实体类、Mapper 接口、XML 映射文件等。下面是一个详细的步骤指南,包括配置文件的编写和生成代码的过程。
步骤 1: 添加依赖
首先,在你的项目中添加 MyBatis Generator 的依赖。如果你使用的是 Maven,可以在 pom.xml
文件中添加以下依赖:
<dependencies>
<!-- MyBatis Generator -->
<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-core</artifactId>
<version>1.4.0</version>
</dependency>
<!-- MyBatis -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.7</version>
</dependency>
<!-- MySQL Connector -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.23</version>
</dependency>
</dependencies>
步骤 2: 配置 MyBatis Generator
创建一个配置文件 generatorConfig.xml
,用于指定数据库连接信息、生成的代码类型等。以下是一个示例配置文件:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration
PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
"http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
<generatorConfiguration>
<!-- 数据库驱动类路径 -->
<classPathEntry location="path/to/mysql-connector-java-8.0.23.jar"/>
<context id="DB2Tables" targetRuntime="MyBatis3">
<jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
connectionURL="jdbc:mysql://localhost:3306/your_database"
userId="your_username"
password="your_password">
</jdbcConnection>
<javaModelGenerator targetPackage="com.example.model" targetProject="src/main/java">
<property name="enableSubPackages" value="true"/>
<property name="trimStrings" value="true"/>
</javaModelGenerator>
<sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources">
<property name="enableSubPackages" value="true"/>
</sqlMapGenerator>
<javaClientGenerator type="XMLMAPPER" targetPackage="com.example.mapper" targetProject="src/main/java">
<property name="enableSubPackages" value="true"/>
</javaClientGenerator>
<table tableName="users" domainObjectName="User" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"/>
</context>
</generatorConfiguration>
步骤 3: 运行 MyBatis Generator
你可以使用命令行或 Maven 插件来运行 MyBatis Generator。
使用命令行
- 下载 MyBatis Generator JAR 文件。
- 打开命令行,导航到包含
generatorConfig.xml
文件的目录。 - 运行以下命令:
java -jar mybatis-generator-core-1.4.0.jar -configfile generatorConfig.xml -overwrite
使用 Maven 插件
在 pom.xml
文件中添加 MyBatis Generator 插件配置:
<build>
<plugins>
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.4.0</version>
<configuration>
<configurationFile>${basedir}/src/main/resources/generatorConfig.xml</configurationFile>
<overwrite>true</overwrite>
</configuration>
<dependencies>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.23</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
然后在命令行中运行以下命令:
mvn mybatis-generator:generate
或者可以使用idea的maven,在侧边栏打开点击图示:
步骤 4: 查看生成的代码
运行完 MyBatis Generator 后,你会在指定的目录中看到生成的代码文件,包括:
- 实体类:例如
User.java
。 - Mapper 接口:例如
UserMapper.java
。 - XML 映射文件:例如
UserMapper.xml
。