使用ORM框架必须保持数据表、POJO实体类、 mapper接口方法和映射文件四者一致,如果数据表发生变化,则需要同时修改另外三个文件,过程非常烦琐,易出错。MyBatis Generator插件是MyBatis提供的自动插件,只需几步就能生成POJO实体类、mapper映射文件和接口文件。Spring Boot支持MyBatis Generator自动生成代码插件。以下的内容演示MyBatis Generator插件的使用。
一、添加MyBatis Generator插件
首先,在项目的pom.xml的build标签中引入MyBatis Generator依赖,示例代码如下:
<plugins>
<!--MyBatis generator 自动生成代码插件-->
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.3.2</version>
<configuration>
<configurationFile>
${basedir}/src/main/resources/generator/generatorConfig.xml
</configurationFile>
<overwrite>true</overwrite>
<verbose>true</verbose>
</configuration>
<!--配置数据库连接及myBatis generator core 依赖-->
<dependencies>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.33</version>
</dependency>
<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-core</artifactId>
<version>1.3.2</version>
</dependency>
</dependencies>
</plugin>
</plugins>
在上面的示例中,在build标签中添加了MyBatis-generator-maven-plugin插件,然后配置generatorConfig.xml。
二、配置MyBatis Generator
generaotrConfig.xml是插件的配置文件,它主要描述数据库连接配置、类型转换、生成模型的包名及位置、生成映射文件的包名及位置、生成mapper文件的包名及位置,要生成的表等信息。在src/main/resources/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>
<context id="MysqlContext" targetRuntime="MyBatis3Simple"
defaultModelType="flat">
<property name="beginningDelimiter" value="'" />
<property name="endingDelimiter" value="'" />
<jdbcConnection
driverClass="com.mysql.cj.jdbc.Driver"
connectionURL="jdbc:mysql://localhost:3306/MyBatis_test?serverTimezone=Asia/Shanghai"
userId="root"
password="usbw" >
</jdbcConnection>
<javaModelGenerator
targetPackage="org.weiz.example01.model"
targetProject="src/main/java" />
<sqlMapGenerator
targetPackage="mapper"
targetProject="src/main/resources" />
<javaClientGenerator
targetPackage="org.weiz.example01.mapper"
targetProject="src/main/java"
type="XMLMAPPER" />
<table tableName="classes"></table>
</context>
</generatorConfiguration>
主要有以下内容:
jdbcConnection: 配置数据库、连接地址。
javaModelGenerator: 生成的POJO类的包名和位置。
javaClientGenerator: 生成的Mapper接口的位置
sqlMapGenerator: 配置mapper.xml映射文件
table: 要生成的表
三、执行MyBatis Generator
配置完成后,单击界面右上角的Maven,然后依次单击Plugin-mybatis-generator , 双击mybatis-generator generators ,如图所示:
MyBatis Generator插件可以一键生成Mapper.xml映射文件、POJO实体类和Mapper接口,避免重复低效的工作,提高了工作效率。