利用mybatis插件自动生成mapper、model文件

原创已于 2024-03-07 16:01:40 修改 · 1.5k 阅读

9 ·

CC 4.0 BY-SA版权

文章标签：

#mybatis

于 2024-03-07 16:01:31 首次发布

本文介绍了如何在Maven项目中使用MyBatisGenerator插件，包括在pom.xml中添加配置、配置generatorConfig.xml以指定数据库连接和生成模型、映射文件等，以及如何运行插件自动生成Java代码和SQL映射文件。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1、在项目根目录的pom.xml文件中添加插件代码。

<build>
    <plugins>
        <!--自动生成mybatis插件-->
        <plugin>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-maven-plugin</artifactId>
            <version>1.3.7</version>
            <configuration>
                <configurationFile>${basedir}/src/main/resources/generatorConfig.xml</configurationFile>
                <overwrite>false</overwrite>
                <verbose>true</verbose>
            </configuration>
            <executions>
                <execution>
                    <id>Generate MyBatis Files</id>
                    <goals>
                        <goal>generate</goal>
                    </goals>
                    <phase>generate</phase>
                    <configuration>
                        <verbose>true</verbose>
                        <overwrite>true</overwrite>
                    </configuration>
                </execution>
            </executions>
            <dependencies>
                <dependency>
                    <groupId>mysql</groupId>
                    <artifactId>mysql-connector-java</artifactId>
                    <version>8.0.17</version>
                </dependency>
                <dependency>
                    <groupId>org.mybatis.generator</groupId>
                    <artifactId>mybatis-generator-core</artifactId>
                    <version>1.3.7</version>
                </dependency>
                <dependency>
                    <groupId>org.mybatis</groupId>
                    <artifactId>mybatis</artifactId>
                    <version>3.4.6</version>
                </dependency>
            </dependencies>
        </plugin>
    </plugins>
</build>

2、配置generatorConfig.xml文件。

（1）在包名下新建包mybatis；在包mybatis新建包model和包mapper。

（2）在resources文件夹下新建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="context">
        <plugin
                type="org.mybatis.generator.plugins.RenameExampleClassPlugin">
            <property name="searchString" value="Example$" />
            <property name="replaceString" value="Criteria" />
        </plugin>
        <!--自动实现序列化接口 -->
        <plugin type="org.mybatis.generator.plugins.SerializablePlugin" />
        <!--生成toString方法 -->
        <plugin type="org.mybatis.generator.plugins.ToStringPlugin" />
        <!--生成equals和hashCode方法 -->
        <plugin
                type="org.mybatis.generator.plugins.EqualsHashCodePlugin" />

        <plugin
                type="org.mybatis.generator.plugins.UnmergeableXmlMappersPlugin" />

        <commentGenerator>
            <property name="suppressDate" value="true" />
            <property name="suppressAllComments" value="false" />
        </commentGenerator>

        <jdbcConnection
                connectionURL="jdbc:mysql://数据库地址:端口号/数据库名称?characterEncoding=UTF-8"
                driverClass="com.mysql.cj.jdbc.Driver" password="密码"
                userId="用户名" />

        <javaModelGenerator
                targetPackage="包名.mybatis.model"
                targetProject="src/main/java">
            <property name="enableSubPackages" value="true" />
            <property name="trimStrings" value="true" />
        </javaModelGenerator>
        <sqlMapGenerator
                targetPackage="包名.mybatis.mapper"
                targetProject="src/main/java">
            <property name="enableSubPackages" value="true" />
        </sqlMapGenerator>

        <javaClientGenerator type="XMLMAPPER"
                             targetPackage="包名.mybatis.mapper"
                             targetProject="src/main/java">
            <property name="enableSubPackages" value="true" />
        </javaClientGenerator>

        <table tableName="表名"
               domainObjectName="CodeInformation(生成的类名)">
            <generatedKey column="主键" sqlStatement="MySql"
                          identity="true" />
        </table>
    </context>
</generatorConfiguration>

3、运行插件。