mybatis-generator插件使用(mysql)

最新推荐文章于 2025-05-17 09:33:28 发布

原创最新推荐文章于 2025-05-17 09:33:28 发布 · 685 阅读

2 ·

CC 4.0 BY-SA版权

文章标签：

#mybatis generator #mysql #自动生成 #逆向工程

工具专栏收录该内容

1 篇文章

订阅专栏

本文介绍了MyBatis Generator代码生成器，可通过数据库表生成实体类、mapper接口和xml等基础性代码。详细说明了使用步骤，包括在pom.xml添加配置、在resources下建立文件等。还提及使用中可能遇到的问题及解决方式，如mapper方法生成不全、生成系统表等。

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

MyBatis Generator代码生成器。通过数据库表，生成基础性的代码：实体类，mapper接口和xml（包含常用的CRUD操作）。
注意：blob字段需要特殊处理。
步骤：
在这里插入图片描述

pom.xml中plugins节点下添加plugin节点。里面描述了配置文件的位置，和相关依赖。

<plugin>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-maven-plugin</artifactId>
    <version>1.3.2</version>
    <executions>
        <execution>
            <id>Generate MyBatis Artifacts</id>
            <phase>deploy</phase>
            <goals>
                <goal>generate</goal>
            </goals>
        </execution>
    </executions>
    <configuration>
        <!-- generator 工具配置文件的位置 -->
        <configurationFile>src/main/resources/mybatis-generator/generatorConfig.xml</configurationFile>
        <verbose>true</verbose>
        <overwrite>true</overwrite>
    </configuration>
    <dependencies>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.16</version>
        </dependency>
        <dependency>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-core</artifactId>
            <version>1.3.2</version>
        </dependency>
    </dependencies>

resources下的mybatis-generator目录下建立xml和properties文件
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>
    <!-- 引入配置文件 -->
    <properties resource="mybatis-generator/mybatisGeneratorinit.properties"/>
    <!-- 一个数据库一个context -->
    <!--defaultModelType="flat" 大数据字段，不分表 -->
    <context id="MysqlTables" targetRuntime="MyBatis3Simple" defaultModelType="flat">
        <!-- 自动识别数据库关键字，默认false，如果设置为true，根据SqlReservedWords中定义的关键字列表；
        一般保留默认值，遇到数据库关键字（Java关键字），使用columnOverride覆盖 -->
        <property name="autoDelimitKeywords" value="true"/>
        <!-- 生成的Java文件的编码 -->
        <property name="javaFileEncoding" value="utf-8"/>
        <!-- beginningDelimiter和endingDelimiter：指明数据库的用于标记数据库对象名的符号，比如ORACLE就是双引号，MYSQL默认是`反引号； -->
        <property name="beginningDelimiter" value="`"/>
        <property name="endingDelimiter" value="`"/>
        <!-- 格式化java代码 -->
        <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>
        <!-- 格式化XML代码 -->
        <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>
        <plugin type="org.mybatis.generator.plugins.SerializablePlugin"/>

        <plugin type="org.mybatis.generator.plugins.ToStringPlugin"/>
        <!-- 注释 -->
        <commentGenerator>
            <property name="suppressAllComments" value="true"/><!-- 是否取消注释 -->
            <property name="suppressDate" value="false"/> <!-- 是否生成注释代时间戳-->
        </commentGenerator>

        <!-- jdbc连接 -->
        <jdbcConnection driverClass="${jdbc_driver}" connectionURL="${jdbc_url}" userId="${jdbc_user}"
                        password="${jdbc_password}"/>
        <!-- 类型转换 -->
        <javaTypeResolver>
            <!-- 是否使用bigDecimal， false可自动转化以下类型（Long, Integer, Short, etc.） -->
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>

        <!-- 生成实体类地址 -->
        <javaModelGenerator targetPackage="com.hisense.entity" targetProject="${project}">
            <property name="enableSubPackages" value="false"/>
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>
        <!-- 生成mapxml文件 -->
        <sqlMapGenerator targetPackage="mapper" targetProject="${resources}">
            <property name="enableSubPackages" value="false"/>
        </sqlMapGenerator>
        <!-- 生成mapxml对应client，也就是接口dao -->
        <javaClientGenerator targetPackage="com.hisense.mapper" targetProject="${project}" type="XMLMAPPER">
            <property name="enableSubPackages" value="false"/>
        </javaClientGenerator>
        <!-- table可以有多个,每个数据库中的表都可以写一个table，tableName表示要匹配的数据库表,也可以在tableName属性中通过使用%通配符来匹配所有数据库表,只有匹配的表才会自动生成文件 -->
        <table tableName="task" domainObjectName="Task"
               enableCountByExample="true" enableUpdateByExample="false"
               enableDeleteByExample="false" enableSelectByExample="false"
               selectByExampleQueryId="false"></table>
        <!--这里包含SQL通配符，表示匹配所有config开头的表-->
        <table tableName="config%">

        </table>
    </context>
</generatorConfiguration>

mybatisGeneratorinit.properties

#dao类和实体类的位置
project =src/main/java
#mapper文件的位置
resources=src/main/resources
#根据数据库中的表生成对应的pojo类、dao、mapper
jdbc_driver =com.mysql.jdbc.Driver
jdbc_url=jdbc:mysql://localhost:3306/data_capture_db?useUnicode=true&characterEncoding=UTF-8&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=Asia/Shanghai&nullCatalogMeansCurrent=true
jdbc_user=root
jdbc_password=123456

根据项目需要，可能需要更改的：

1.数据库链接、用户名，密码
2.生成的实体类位置、mapper的接口位置，mapper的xml位置
3.需要根据哪些表生成代码，需要生成哪些方法。
4.如果要修改，重新生成，则需要把旧的删除，否则是追加。

在pom.xml目录下（也就是根目录下）打开命令行，敲击mvn mybatis-generator:generate
在这里插入图片描述
由于我在设置时候，设置了Task，以及一个Config%两种表名，因此生成了如下的代码

遇到的问题：
1.mapper中只生成了insert和selectAll两个方法。按道理将，默认情况，方法都会生成。
解决方式：连接字符串中添加nullCatalogMeansCurrent=true。（上文中已经有了这个设置）
2.如果设置表为%，也就是所有表，会将系统表也生成了，需要注意。

<table tableName="%"></table>

3.oracle中，数值形的字段，如果指定精度，比如Number(9,2)，生成entity属性是BigDecimal型，如果不指定精度，比如:Number(9)，生成的是Long型
4.oracle中的nvarchar/nvarchar2，mybatis-generator会识别成Object型，建议改用varchar2。（引用自https://www.cnblogs.com/yjmyzz/p/4210554.html）