eclipse安装mybatis generator插件，自动生成实体类、mapper接口和SQL XM文件

超、凢脫俗 2022-12-03 08:46 363阅读 0赞

**目录**

一、什么是MyBatis逆向工程？

二、mybatis generator插件安装过程

三、配置generatorConfig.xml文件

--------------------

### 一、什么是MyBatis逆向工程？ ###

平时在开发项目的时候，数据持久层经常会用到mybatis框架来操作数据库，sql语句需要程序员自己去编写，这样就浪费了一部分没有必要的时间了。不过mybatis官方是提供逆向工程，简单理解的话就是，mybatis通过mybatis generator插件针对数据库单表生成mybatis执行时所需要的代码，比如：mapper.java、mapper.xml、pojo等，有效的提高了工作效率。

实际的开发中，经常用到的mybatis逆向工程的方式为：由数据库的表生成java代码；之所以强调单表两个字，是因为Mybatis逆向工程生成的Mapper所进行的操作都是针对单表的，也许你可能会觉得那这就有点鸡肋了，但是在大型项目中，很少有复杂的多表关联查询，所以作用还是很大的。

### 二、mybatis generator插件安装过程 ###

1、在eclipse导航栏选择Help-->Eclipse Marketpalce --> 搜索框搜，输入：mybatis generator；然后出现如下页面：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lvdTE4MTMxMzcxODM2_size_16_color_FFFFFF_t_70][]

最后按照步骤说明进行安装即可

2、安装结束以后，选中要生成代码的项目，鼠标右击，选择New–>Other，键入mybatis，可以查看到刚刚安装好的mybatis generator。如下图，说明mybatis generator插件安装成功。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lvdTE4MTMxMzcxODM2_size_16_color_FFFFFF_t_70 1][]

### 三、配置generatorConfig.xml文件 ###

选择mybatis 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>
    
    
      <properties resource="mybatis/generator.properties"></properties>
      
      
      <classPathEntry location="${db.driverLocation}"/>
      
      
      <context id="mysql" targetRuntime="MyBatis3Simple" defaultModelType="flat">
         
         <property name="autoDelimitKeywords" value="true"/>
         
         <property name="javaFileEncoding" value="UTF-8"/>
         
         <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>
         
         <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>
        
         
         <property name="beginningDelimiter" value="`"/>
         <property name="endingDelimiter" value="`"/>
         
         <plugin type="org.mybatis.generator.plugins.EqualsHashCodePlugin"></plugin>
         <plugin type="org.mybatis.generator.plugins.SerializablePlugin"></plugin>
         <plugin type="org.mybatis.generator.plugins.ToStringPlugin"></plugin>
         
         <commentGenerator>
                
                
                <property name="suppressDate" value="true" />
                
                <property name="suppressAllComments" value="true" />
        </commentGenerator>
        
        
        <jdbcConnection connectionURL="${db.url}" 
                        driverClass="${db.driverClassName}"
                        userId="${db.username}"
                        password="${db.password}">
        
        <property name="nullCatalogMeansCurrent" value="true"/>
        </jdbcConnection>
        
          
        <javaTypeResolver>  
            <property name="forceBigDecimals" value="false" />  
        </javaTypeResolver>
        
        
        <javaModelGenerator targetPackage="com.you.rabbitmq" 
                            targetProject="rabbitmq-demo/src/main/java">
            
            <property name="constructorBased" value="false"/>
            
            <property name="enableSubPackages" value="false"/>
            
            <property name="immutable" value="false"/>
            
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>
        
        
        <sqlMapGenerator targetPackage="mapper"
                         targetProject="rabbitmq-demo/src/main/resources/">
            
            <property name="enableSubPackages" value="false"/>
        </sqlMapGenerator>
        
        
        <javaClientGenerator targetPackage="com.you.rabbitmq" 
                             type="XMLMAPPER" 
                             targetProject="rabbitmq-demo/src/main/java">
            
            <property name="enableSubPackages" value="false"/>
        </javaClientGenerator>
        
        
        
        
        <table tableName="userinfo" domainObjectName="UserInfo">
            
            
            <property name="constructorBased" value="false"/>
            
            <property name="ignoreQualifiersAtRuntime" value="false"/>
            
            <property name="immutable" value="false"/>
            
            <property name="modelOnly" value="false"/>
            
            <property name="useActualColumnNames" value="false"/>
            
            <property name="delimitAllColumns" value="true"/>
            
            <generatedKey column="user_id" sqlStatement="Mysql" identity="true"/>
           
            
             <columnOverride column="user_name" property="jiaName" javaType="java.lang.String"/>
             
             
             <ignoreColumn column="user_age" delimitedColumnName="true"/>
        </table>
      </context>
    </generatorConfiguration>

补充generator.properties文件配置：

db.driverLocation=C:/software/maven/maven-repository/mysql/mysql-connector-java/8.0.15/mysql-connector-java-8.0.15.jar
    db.driverClassName=com.mysql.cj.jdbc.Driver
    db.url=jdbc:mysql://localhost:3306/test?serverTimezone=UTC&useUnicode=true&characterEncoding=utf8&useSSL=false
    db.username=root
    db.password=123456

generatorConfig.xml文件配置好以后，选中generatorConfig.xml文件，鼠标右击选择run as，选择run mybatis generator即可逆向生成相关java代码。上面的配置是在单应用程序中执行的，不过有几点需要注意的地方：

1、generatorConfig.xml文件中标签的顺序不能颠倒，否则执行时会报错；

2、生成文件放置的位置targetProject="rabbitmq-demo/src/main/java"，路径前面一定要加行项目名称，否则不能生成文件；网上有些例子说的是不用加项目名称，写成targetProject="src/main/java"就可以生成文件，本人亲测了一下，然而并没有生成相应的文件，可能是和mybatis generator插件的版本有关系，我也搞不明白为啥。

3、在springboot多模块项目中，如何使用mybatis generator插件逆向生成代码，其实就是改一下generatorConfig.xml文件中修改一下文件生成位置的路径即可，其他的不用修改，修改如下：

<javaModelGenerator targetPackage="com.you.wstro.bean" 
                            targetProject="wstro-entity/src/main/java">
            
            <property name="constructorBased" value="false"/>
            
            <property name="enableSubPackages" value="false"/>
            
            <property name="immutable" value="false"/>
            
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>
        
        
        <sqlMapGenerator targetPackage="mapper"
                         targetProject="wstro-dao/src/main/resources/">
            
            <property name="enableSubPackages" value="false"/>
        </sqlMapGenerator>
        
        
        <javaClientGenerator targetPackage="com.you.wstro.mapper" 
                             type="XMLMAPPER" 
                             targetProject="wstro-dao/src/main/java">
            
            <property name="enableSubPackages" value="false"/>
        </javaClientGenerator>

我这里是将java实体类放在wstro-entity模块中，将mapper接口以及sql xml文件放在了wstro-到模块中，这样的话就需要修改文件生成的路径，文件生成在哪个模块，就在路径上加上哪个模块的名称即可。网上有的说是用相应模块的结对路径，我尝试了一下文件生成失败。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lvdTE4MTMxMzcxODM2_size_16_color_FFFFFF_t_70]: /images/20221123/360d1f1554fe4125847f7a20ae9e9dc1.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lvdTE4MTMxMzcxODM2_size_16_color_FFFFFF_t_70 1]: /images/20221123/5754783c389e4171af0fbd642cc0812f.png