MyBatis Generator安装详细步骤
1. 准备工作
- 确保你的系统已经安装了Java开发环境(JDK),并且配置好了相关的环境变量。因为MyBatis Generator是一个Java工具,它依赖于Java运行环境来执行。你可以在命令行中输入
java -version
来检查JDK是否正确安装。
2. 添加依赖
- Maven项目
- 如果你的项目是使用Maven构建的,需要在项目的pom.xml文件中添加MyBatis Generator的依赖。打开pom.xml文件,在
<dependencies>
标签内添加以下内容:
<dependency> <groupId>org.mybatis.generator</groupId> <artifactId>mybatis-generator-core</artifactId> <version>1.4.2</version> </dependency>
- 添加完成后,Maven会自动下载相关的依赖包。你可以通过在项目目录下执行
mvn clean install
命令来更新依赖。
- 如果你的项目是使用Maven构建的,需要在项目的pom.xml文件中添加MyBatis Generator的依赖。打开pom.xml文件,在
- Gradle项目
- 对于Gradle构建的项目,在build.gradle文件的
dependencies
部分添加如下内容:
implementation 'org.mybatis.generator:mybatis-generator-core:1.4.2'
- 然后执行
gradle build
命令来下载和配置依赖。
- 对于Gradle构建的项目,在build.gradle文件的
3. 配置MyBatis Generator
- 创建一个MyBatis Generator的配置文件(通常命名为
generatorConfig.xml
)。这个配置文件用于指定数据库连接信息、生成策略等内容。以下是一个简单配置文件的示例:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration
PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
"https://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
<generatorConfiguration>
<!-- 数据库驱动 -->
<classPathEntry location="你的数据库驱动路径(如mysql-connector-java-8.0.30.jar的路径)"/>
<context id="DB2Tables" targetRuntime="MyBatis3">
<jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
connectionURL="jdbc:mysql://localhost:3306/你的数据库名"
userId="root"
password="你的数据库密码">
</jdbcConnection>
<!-- 生成实体类的包名和位置 -->
<javaModelGenerator targetPackage="com.example.entity" targetProject="你的项目实体类存放路径">
<property name="enableSubPackages" value="true"/>
<property name="trimStrings" value="true"/>
</javaModelGenerator>
<!-- 生成Mapper接口的包名和位置 -->
<sqlMapGenerator targetPackage="com.example.mapper" targetProject="你的项目Mapper存放路径">
<property name="enableSubPackages" value="true"/>
</sqlMapGenerator>
<!-- 生成Mapper XML文件的包名和位置 -->
<javaClientGenerator type="XMLMAPPINGCOMPONENT" targetPackage="com.example.mapper" targetProject="你的项目Mapper XML文件存放路径">
<property name="enableSubPackages" value="true"/>
</javaClientGenerator>
<!-- 要生成的表 -->
<table tableName="你的表名"/>
</context>
</generatorConfiguration>
- 你需要根据自己的实际情况修改配置文件中的数据库连接信息(如驱动类、连接URL、用户名和密码)、生成文件的包名和路径以及要生成的表名等内容。
4. 运行MyBatis Generator
- 通过Maven插件运行(Maven项目)
- 在pom.xml文件中添加MyBatis Generator插件配置:
<build> <plugins> <plugin> <groupId>org.mybatis.generator</groupId> <artifactId>mybatis-generator-maven-plugin</artifactId> <version>1.4.2</version> <configuration> <configurationFile>你的generatorConfig.xml文件路径</configurationFile> <overwrite>true</overwrite> </configuration> <executions> <execution> <id>Generate MyBatis Artifacts</id> <goals> <goal>generate</goal> </goals> </execution> </executions> </plugin> </plugins> </build>
- 然后在项目目录下执行
mvn mybatis-generator:generate
命令,MyBatis Generator就会根据配置文件生成相关的代码,包括实体类、Mapper接口和Mapper XML文件。
- 通过命令行运行(独立运行)
- 如果你没有使用Maven或Gradle来管理项目,也可以通过命令行直接运行MyBatis Generator。首先确保已经将
mybatis - generator - core
的相关JAR包添加到了类路径中。然后执行以下命令:
java -cp mybatis-generator-core-1.4.2.jar;你的数据库驱动JAR包路径 org.mybatis.generator.api.ShellRunner -configfile generatorConfig.xml -overwrite
- 这条命令会告诉Java虚拟机运行MyBatis Generator的主类
ShellRunner
,并传入配置文件路径和覆盖策略等参数,来生成代码。
- 如果你没有使用Maven或Gradle来管理项目,也可以通过命令行直接运行MyBatis Generator。首先确保已经将
安装和配置完成后,你就可以利用MyBatis Generator自动生成的代码来进行数据库操作,提高开发效率。