SpringBoot整合mybatis-generator-maven-plugin

简介

mybatis-generator-maven-plugin 是一个 Maven 插件，可以帮我们自动生成 Java 代码，并且可以一键完成 DAO 层和 Mapper 映射文件的生成，是一个开发效率较高的工具。

SpringBoot 整合 mybatis-generator-maven-plugin 后，我们可以更加方便地生成 DAO 层和 Mapper 映射文件，提高工作效率。

本文将详细讲解 SpringBoot 整合 mybatis-generator-maven-plugin 的方法，并且提供两个实例供大家参考。

方法

第一步：引入 mybatis-generator-maven-plugin

在 pom.xml 文件的 <plugins> 标签中添加如下代码：

<plugin>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-maven-plugin</artifactId>
    <version>1.4.0</version>
    <configuration>
        <configurationFile>${basedir}/src/main/resources/generator/generatorConfig.xml</configurationFile>
        <overwrite>true</overwrite>
        <verbose>true</verbose>
    </configuration>
    <dependencies>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>${mysql-connector-java.version}</version>
        </dependency>
        <dependency>
            <groupId>tk.mybatis</groupId>
            <artifactId>mapper</artifactId>
            <version>${tk.mybatis.mapper.version}</version>
        </dependency>
    </dependencies>
</plugin>

其中，${mysql-connector-java.version} 和 ${tk.mybatis.mapper.version} 分别为 MySQL 驱动版本和通用 Mapper 版本，需要根据实际情况进行修改。

第二步：配置 generatorConfig.xml 文件

在 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="MyBatis3">
        <commentGenerator>
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/db_name?useUnicode=true&amp;characterEncoding=utf-8&amp;useSSL=false"
                        userId="root"
                        password="123456"/>
        <javaTypeResolver>
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>
        <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 schema="" tableName="t_table_name">
            <property name="useActualColumnNames" value="true"/>
            <generatedKey column="id" sqlStatement="mysql" identity="true"/>
        </table>
    </context>
</generatorConfiguration>

其中，需要将 <jdbcConnection> 标签中的数据库连接信息和 <table> 标签中的表名改成实际的情况。

第三步：执行 mybatis-generator-maven-plugin 插件

执行 Maven 插件，生成 DAO 层和 Mapper 映射文件。

在项目根目录下执行命令：

mvn mybatis-generator:generate

示例一

我们以 SpringBoot 整合 mybatis-generator-maven-plugin 的方式生成 MyBatis 的 DAO 层和 Mapper 映射文件。

假设我们已经创建好了一个名为 springboot-mybatis 的 SpringBoot 项目，现在需要生成 DAO 层和 Mapper 映射文件。

第一步：引入依赖

在 pom.xml 文件中引入如下依赖：

<!-- MySQL 驱动 -->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.23</version>
</dependency>
<!-- MyBatis 依赖 -->
<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>2.2.0</version>
</dependency>
<!-- mybatis-generator-maven-plugin 插件 -->
<plugin>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-maven-plugin</artifactId>
    <version>1.4.0</version>
    <configuration>
        <configurationFile>${basedir}/src/main/resources/generator/generatorConfig.xml</configurationFile>
        <overwrite>true</overwrite>
        <verbose>true</verbose>
    </configuration>
    <dependencies>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.23</version>
        </dependency>
        <dependency>
            <groupId>tk.mybatis</groupId>
            <artifactId>mapper</artifactId>
            <version>4.2.0</version>
        </dependency>
    </dependencies>
</plugin>

第二步：配置 generatorConfig.xml

在 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="MyBatis3">
        <commentGenerator>
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/test?useUnicode=true&amp;characterEncoding=utf-8&amp;useSSL=false"
                        userId="root"
                        password="123456"/>
        <javaTypeResolver>
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>
        <javaModelGenerator targetPackage="com.example.entity" 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.dao" targetProject="src/main/java">
            <property name="enableSubPackages" value="true"/>
        </javaClientGenerator>
        <table schema="" tableName="user">
            <property name="useActualColumnNames" value="true"/>
            <generatedKey column="id" sqlStatement="mysql" identity="true"/>
        </table>
    </context>
</generatorConfiguration>

其中，需要将 <jdbcConnection> 标签中的数据库连接信息和 <table> 标签中的表名改成实际的情况。

第三步：执行 mybatis-generator-maven-plugin

在项目根目录下执行命令：

mvn mybatis-generator:generate

执行完毕后，src/main/java/com/example/dao 和 src/main/resources/mapper 两个目录下会生成对应的 DAO 和 Mapper 映射文件。

示例二

我们以 SpringBoot 整合 mybatis-generator-maven-plugin 的方式生成 MyBatis-Plus 的 DAO 层和 Mapper 映射文件。

假设我们已经创建好了一个名为 springboot-mybatis-plus 的 SpringBoot 项目，现在需要生成 DAO 层和 Mapper 映射文件。

第一步：引入依赖

在 pom.xml 文件中引入如下依赖：

<!-- MySQL 驱动 -->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.23</version>
</dependency>
<!-- MyBatis Plus 依赖 -->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.4.1</version>
</dependency>
<!-- mybatis-generator-maven-plugin 插件 -->
<plugin>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-maven-plugin</artifactId>
    <version>1.4.0</version>
    <configuration>
        <configurationFile>${basedir}/src/main/resources/generator/generatorConfig.xml</configurationFile>
        <overwrite>true</overwrite>
        <verbose>true</verbose>
    </configuration>
    <dependencies>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.23</version>
        </dependency>
        <dependency>
            <groupId>tk.mybatis</groupId>
            <artifactId>mapper</artifactId>
            <version>4.2.0</version>
        </dependency>
    </dependencies>
</plugin>

第二步：配置 generatorConfig.xml

在 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="MyBatis3">
        <commentGenerator>
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/test?useUnicode=true&amp;characterEncoding=utf-8&amp;useSSL=false"
                        userId="root"
                        password="123456"/>
        <javaTypeResolver>
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>
        <javaModelGenerator targetPackage="com.example.entity" 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.dao" targetProject="src/main/java">
            <property name="enableSubPackages" value="true"/>
        </javaClientGenerator>
        <table schema="" tableName="user">
            <property name="useActualColumnNames" value="true"/>
            <generatedKey column="id" sqlStatement="mysql" identity="true"/>
        </table>
    </context>
</generatorConfiguration>

其中，需要将 <jdbcConnection> 标签中的数据库连接信息和 <table> 标签中的表名改成实际的情况。

第三步：执行 mybatis-generator-maven-plugin

在项目根目录下执行命令：

mvn mybatis-generator:generate

执行完毕后，src/main/java/com/example/dao 和 src/main/resources/mapper 两个目录下会生成对应的 DAO 和 Mapper 映射文件。

结语

通过本文，我们对 SpringBoot 整合 mybatis-generator-maven-plugin 的使用方法，以及两个具体的示例进行了详细讲解。希望能对大家的开发工作有所帮助。

本站文章如无特殊说明，均为本站原创，如若转载，请注明出处：SpringBoot整合mybatis-generator-maven-plugin的方法 - Python技术站

SpringBoot整合mybatis-generator-maven-plugin的方法

SpringBoot整合mybatis-generator-maven-plugin

简介

方法

第一步：引入 mybatis-generator-maven-plugin

第二步：配置 generatorConfig.xml 文件

第三步：执行 mybatis-generator-maven-plugin 插件

示例一

第一步：引入依赖

第二步：配置 generatorConfig.xml

第三步：执行 mybatis-generator-maven-plugin

示例二

第一步：引入依赖

第二步：配置 generatorConfig.xml

第三步：执行 mybatis-generator-maven-plugin

结语

相关文章