mybatis-generator自动生成工具

最新推荐文章于 2024-04-15 22:48:03 发布

十年小站

最新推荐文章于 2024-04-15 22:48:03 发布

阅读量375

点赞数

分类专栏： #mybatis

本文链接：https://blog.csdn.net/tenyears940326/article/details/103661757

版权

#mybatis 专栏收录该内容

3 篇文章 0 订阅

订阅专栏

个人网站 http://www.javamap.cn

** 基本目录（java项目，web项目略有区别）

1.mybatis-generator 概述

MyBatis官方提供了逆向工程 mybatis-generator，可以针对数据库表自动生成MyBatis执行所需要的代码（如Mapper.java、Mapper.xml、POJO）。mybatis-generator 有三种用法：命令行、eclipse插件、maven插件。而maven插件的方式比较通用，本文也将概述maven插件的使用方式。

2.pom.xml中配置plugin

<build>
    <plugins>
        <plugin>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-maven-plugin</artifactId>
            <version>1.3.7</version>
            <configuration>
                <verbose>true</verbose>
                <overwrite>true</overwrite>
            </configuration>
        </plugin>
    </plugins>
</build>

3、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="generator.properties"></properties>

    <!--指定特定数据库的jdbc驱动jar包的位置 -->
    <classPathEntry location="${jdbc.driverLocation}"/>

    <context id="context1" targetRuntime="MyBatis3">
        <!--覆盖生成XML文件  2019.12.15修改，非常非常重要-->
<plugin type="org.mybatis.generator.plugins.UnmergeableXmlMappersPlugin" />
        <!-- optional，旨在创建class时，对注释进行控制 -->
        <commentGenerator>
            <property name="suppressDate" value="true" />
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>
        <!--jdbc的数据库连接 -->
        <jdbcConnection
                driverClass="${jdbc.driverClass}"
                connectionURL="${jdbc.connectionURL}"
                userId="${jdbc.userId}"
                password="${jdbc.password}">
        </jdbcConnection>

        <!-- Model模型生成器,用来生成含有主键key的类，记录类 以及查询Example类
            targetPackage     指定生成的model生成所在的包名
            targetProject     指定在该项目下所在的路径
        -->
        <javaModelGenerator targetPackage="cn.javamap.pojo" targetProject=".\src\main\java">
            <!-- 是否对model添加 构造函数 -->
            <property name="constructorBased" value="true"/>

            <!-- 是否允许子包，即targetPackage.schemaName.tableName -->
            <property name="enableSubPackages" value="false"/>

            <!-- 建立的Model对象是否 不可改变  即生成的Model对象不会有 setter方法，只有构造方法 -->
            <property name="immutable" value="false"/>

            <!-- 是否对类CHAR类型的列的数据进行trim操作 -->
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>

        <!--Mapper映射文件生成所在的目录 为每一个数据库的表生成对应的SqlMap文件 *** 此处映射文件包名要与下面的接口包名一致，不然通过接口引入配置将不能实现-->
        <sqlMapGenerator targetPackage="cn.javamap.dao" targetProject=".\src\main\resources">
            <property name="enableSubPackages" value="false"/>
        </sqlMapGenerator>


        <!-- 指定mapper接口生成的位置
         targetPackage、targetProject同javaModelGenerator中作用一样          
*** 此处 接口包名 要与上面的 映射文件包名一致，不然通过接口引入配置将不能实现 -->
        <javaClientGenerator type="XMLMAPPER" targetPackage="cn.javamap.dao" targetProject=".\src\main\java" >
            <property name="enableSubPackages" value="false"/>
        </javaClientGenerator>

        <!-- 指定数据库表
        domainObjectName：生成的domain类的名字,当表名和domain类的名字有差异时一定要设置，如果不设置，直接使用表名作为domain类的名字；

        ***domainObjectName需要1.3.6版本以上才行
        *** tableName="%" 生成数据库里的所有表
        可以设置为somepck.domainName，那么会自动把domainName类再放到somepck包里面；
        -->
        <table tableName="%" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false">
            <domainObjectRenamingRule searchString="^Tbl" replaceString="" />
        </table>
    </context>
</generatorConfiguration>

4、generator.properties配置文件

*** 该文件旨在设定数据库的相关信息，单独建立一个文件，便于修改 **小坑1： jdbc.driverLocation 的值是本地库里数据库jar包的绝对路径，如果复制文件夹里的路径，注意修改 “\” 为 “\\”，如果不改会报错，IDEA会有提示 **小坑2： jdbc.connectionURL 的值是访问的数据库，注意修改

jdbc.driverLocation=F:\\java_tools\\myRepository\\mysql\\mysql-connector-java\\5.1.6\\mysql-connector-java-5.1.6.jar
jdbc.driverClass=com.mysql.jdbc.Driver
jdbc.connectionURL=jdbc:mysql://localhost:3306/zf
jdbc.userId=root
jdbc.password=root

5、建立运行方式

5.1 点击 “Run” –>”Edit Configurations”

5.2 新建maven Configurations

5.3 配置 Configurations （Name可以自定义, Command line不能变mybatis-generator:generate -e）

6、执行，生成代码

点击 “Run” –>”generator”

控制台出现上面的提示，即表示生成成功，同时左侧目录中的类生成，完美落地。

7、追加mybatis_config.xml文件（测试用，配置不全）

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <!--引入外部properties文件 必须放在最前面,否则会报错 -->
    <properties resource="generator.properties"></properties>
    <settings>
<!--    打印查询语句    -->
        <setting name="logImpl" value="STDOUT_LOGGING"/>
    </settings>

    <!-- 为实体类包设置别名，可以使用类名代替全名 -->
    <typeAliases>
        <package name="cn.javamap.pojo"/>
    </typeAliases>

    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <!-- 加载外部的properties配置文件 -->
                <property name="driver" value="${jdbc.driverClass}"/>
                <property name="url" value="${jdbc.connectionURL}"/>
                <property name="username" value="${jdbc.userId}"/>
                <property name="password" value="${jdbc.password}"/>
            </dataSource>
        </environment>
    </environments>

    <mappers>
        <!-- 通过接口引入配置：
             实现条件：   1.接口和mapper包名一致  2.文件名称必须一致（文件类型不影响）
                        -->
        <!--引用一个包中的所有dao接口-->
        <package name="cn.javamap.dao"/>

        <!--          注册UserMapper.xml文件-->
        <!--<mapper resource="cn/javamap/mapper/UsersMapper.xml"/>
        <!–  注册OrderMapper.xml文件      –>
        <mapper resource="cn/javamap/mapper/OrdersMapper.xml"/>
        <!–  注册ClassesMapper.xml文件      –>
        <mapper resource="cn/javamap/mapper/ClassesMapper.xml"/>
        <!–  注册TeacherMapper.xml文件      –>
        <mapper resource="cn/javamap/mapper/TeacherMapper.xml"/>
        <!–  注册StudentMapper.xml文件      –>
        <mapper resource="cn/javamap/mapper/StudentMapper.xml"/>
        <!–  注册PuserMapper.xml文件      –>
        <mapper resource="cn/javamap/mapper/PuserMapper.xml"/>-->
    </mappers>
</configuration>

8、追加pom.xml文件（测试用，配置不全）

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>cn.javamap</groupId>
    <artifactId>test_mybatis</artifactId>
    <packaging>pom</packaging>
    <version>1.0-SNAPSHOT</version>

    <dependencies>
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.4.6</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.6</version>
        </dependency>

        <dependency>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-core</artifactId>
            <version>1.3.7</version>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
            <scope>test</scope>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.3.7</version>
                <configuration>
                    <verbose>true</verbose>
                    <overwrite>true</overwrite>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

=======================华丽分割=================================

********* 使用中提示的错误 *********

1.generator.properties中jdbc.driverLocation 路径不对 **控制台错误Cannot resolve classpath（实际上万能的IDEA已经给我提示了，但是我没理会到）

2. **控制台错误Exception getting JDBC Driver（实际上这个IDEA也提示了，怪自己瞎啊），这个错误我折腾了很久，也度娘了很多前辈的博客，有人说要在POM文件的<build>–><plugins>–><plugin>内添加MySQL的依赖，甚至还有加上 mybatis-generator依赖，但是并没有什么作用，具体的错误原因看图就一眼明白了， generator.properties 文件的值后面手贱多了空格，剁手

3.**默认生成的实体类和数据库表名一样，但是数据库中的表名一般都有前缀 “tb_”或者 “tbl_”之类的，如果不配置将会生成类似 “TbUser”这样的类名。但是我们肯定是不想看到这样的实体类，就行如下配置，消除表名前缀，或者其他不希望出现的名。

<table tableName="%" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false">
    <domainObjectRenamingRule searchString="^Tbl" replaceString="" />
</table>

***** 但是<domainObjectRenamingRule>需要1.3.6版本以上才行至于之前的版本怎么达到相同的效果，有待研究。

4. 2019.12.15追加 **巨坑，绝对巨坑在生成完成后，测试时控制台报错 java.lang.IllegalArgumentException: Result Maps collection already contains value for cn.javamap.dao.UsersMapper.BaseResultMap，一搜度娘，出这个问题的人还不少

解决办法：在generatorConfig.xml内添加一个<plugin>,如下

<context id="context1" targetRuntime="MyBatis3">
    <!--覆盖生成XML文件-->
    <plugin type="org.mybatis.generator.plugins.UnmergeableXmlMappersPlugin" />
    <!-- optional，旨在创建class时，对注释进行控制 -->
    <commentGenerator>
        <property name="suppressDate" value="true" />
        <property name="suppressAllComments" value="true"/>
    </commentGenerator>

这个解决办法也是我去度娘找的，还是一个大佬给的解决方案，下附链接，感谢大佬https://www.cnblogs.com/xxoome/p/10068780.html

5. **测试接口，控制台异常：org.apache.ibatis.binding.BindingException: Invalid bound statement (not found): cn.javamap.dao.UsersMapper.selectByPrimaryKey

造成原因：在自动生成代码时，接口包取名：cn.javamap.dao，映射文件包取名：cn.javamap.mapper，两个包名不一致，造成在mybatis_config.xml中通过接口引入配置文件失败。

十年小站

关注

0
点赞
踩
2

收藏

觉得还不错? 一键收藏
1
评论
mybatis-generator自动生成工具

** 基本目录（java项目，web项目略有区别）1.mybatis-generator 概述MyBatis官方提供了逆向工程 mybatis-generator，可以针对数据库表自动生成MyBatis执行所需要的代码（如Mapper.java、Mapper.xml、POJO）。mybatis-generator 有三种用法：命令行、eclipse插件、maven插件。而maven插件的...
复制链接

扫一扫