使用mybatis-generator生成Mybatis代码

Dear 丶 2022-01-31 06:25 188阅读 0赞

**目录**

是否要使用代码生成工具？

mybatis-generator能做什么？

本文示例环境

具体操作步骤

步骤1：修改pom.xml，添加mybatis-generator-maven-plugin插件

步骤2：配置生成代码的配置文件generatorConfig.xml

步骤3：执行插件生成代码

生成的结果文件

如何使用生成的代码？

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

# 是否要使用代码生成工具？ #

有些声音说使用代码生成工具不好，理由诸如：会不利于个人学习成长，生成的代码不好，可能使得一些初学者望而却步！

我要说，还是那句老话：工欲善其事必先利其器，善于使用工具可以大大提高工作效率，再现今社会效率就是王道。事情都是怎么简单怎么做，偷懒使社会进步。一些琐碎的事情，能交给工作去做就使用工具做，只有从琐碎的重复的劳动中摆脱出来，才能有时间专注其他，才能更好的思考业务，更好的做设计，才能提高代码质量，做出好的产品！

工具要灵活运用，能借几分力就借几分力，剩余的没办法就自己上手做，生成的代码不好就取对自己有用的进行修改使用。

# mybatis-generator能做什么？ #

能够生成PO类，能生成mapper映射文件（其中包括基本的增删改查功能）、能生成mapper接口。

这可是省了很多功夫，即使你要做些修改，添加下自己需要的功能或删除自己不需要的功能。

# 本文示例环境 #

maven工程、IDE是Intellij IDEA、mybatis-generator-maven-plugin插件。

Intellij IDEA也有几个mybatis-generator插件，可以安装使用，具体笔者也还没试过，这里不做介绍，有兴趣有时间可以研究一下。

当然手动下载mybatis-generator的jar包，或者使用Grande也是可以的，本文不做介绍。

IDE使用Eclipse等也是可以的。

# 具体操作步骤 #

## 步骤1：修改pom.xml，添加mybatis-generator-maven-plugin插件 ##

<plugin>
                    <groupId>org.mybatis.generator</groupId>
                    <artifactId>mybatis-generator-maven-plugin</artifactId>
                    <version>1.3.2</version>
                    <configuration>
                        
                        <configurationFile>src/main/resources/generatorConfig.xml</configurationFile>
                        <verbose>true</verbose>
                        <overwrite>true</overwrite>
                    </configuration>
                    <executions>
                        <execution>
                            <id>Generate MyBatis Artifacts</id>
                            <goals>
                                <goal>generate</goal>
                            </goals>
                        </execution>
                    </executions>
                    <dependencies>
                        <dependency>
                            <groupId>org.mybatis.generator</groupId>
                            <artifactId>mybatis-generator-core</artifactId>
                            <version>1.3.2</version>
                        </dependency>
                    </dependencies>
                </plugin>

## 步骤2：配置生成代码的配置文件generatorConfig.xml ##

在resources目录下创建xml文件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>
        
        <classPathEntry location="E:/mvnRespo/mysql/mysql-connector-java/5.1.47/mysql-connector-java-5.1.47.jar"/>
    
        <context id="testTables" targetRuntime="MyBatis3">
            <commentGenerator>
                
                <property name="suppressAllComments" value="true"/>
            </commentGenerator>
    
            
            <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                            connectionURL="jdbc:mysql://localhost:3306/mybatis" userId="root"
                            password="123">
            </jdbcConnection>
    
            
            <javaTypeResolver>
                <property name="forceBigDecimals" value="false"/>
            </javaTypeResolver>
    
            
            <javaModelGenerator targetPackage="com.boge.xiushi.manage.web.model" targetProject="src/main/java">
                
                <property name="enableSubPackages" value="false"/>
                
                <property name="trimStrings" value="true"/>
            </javaModelGenerator>
    
            
            <sqlMapGenerator targetPackage="mybatis" targetProject="src/main/resources">
                <property name="enableSubPackages" value="false"/>
            </sqlMapGenerator>
    
            
            <javaClientGenerator type="XMLMAPPER" targetPackage="com.boge.xiushi.manage.web.dao" targetProject="src/main/java">
                <property name="enableSubPackages" value="false"/>
            </javaClientGenerator>
    
            
            <table tableName="items" domainObjectName="Items"></table>
        </context>
    </generatorConfiguration>

详细配置见官方文档：[http://www.mybatis.org/generator/configreference/xmlconfig.html][http_www.mybatis.org_generator_configreference_xmlconfig.html]

或网上的配置详解：[https://www.jianshu.com/p/e09d2370b796][https_www.jianshu.com_p_e09d2370b796]

## 步骤3：执行插件生成代码 ##

可以直接执行maven命令，详情见：[http://www.mybatis.org/generator/running/runningWithMaven.html][http_www.mybatis.org_generator_running_runningWithMaven.html]

也可以使用eclipse或者Intellij IDEA执行mybatis-generator-maven-plugin插件。

如果使用的是Intellij IDEA，推荐添加一个mybatis-generator的执行配置。

和添加tomcat类似，进入配置弹窗，点击+好，填入名称，选择目录，输入命令mybatis-generator:generate -e，点击OK。

![20190515221405645.png][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FPQk81MTY_size_16_color_FFFFFF_t_70][]

![20190515221546402.png][]

然后选择mybatis-generator配置，点击执行。

## 生成的结果文件 ##

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FPQk81MTY_size_16_color_FFFFFF_t_70 1][]

# 如何使用生成的代码？ #

如果配置得当，生成的符合要求，可以直接在生成的基础上进行修改和添加功能。

如果生成的实在是不符合要求，也可以只复制自己能使用的进行修改使用。

[http_www.mybatis.org_generator_configreference_xmlconfig.html]: http://www.mybatis.org/generator/configreference/xmlconfig.html
[https_www.jianshu.com_p_e09d2370b796]: https://www.jianshu.com/p/e09d2370b796
[http_www.mybatis.org_generator_running_runningWithMaven.html]: http://www.mybatis.org/generator/running/runningWithMaven.html
[20190515221405645.png]: /images/20220131/a350e8974c054a0f800b80b800de3f4c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FPQk81MTY_size_16_color_FFFFFF_t_70]: /images/20220131/00866f4a8cb0412a9f0c78889c5c496f.png
[20190515221546402.png]: /images/20220131/6d27ed8eb043463e8dfa445288fca741.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FPQk81MTY_size_16_color_FFFFFF_t_70 1]: /images/20220131/aff2604130c94ae189065937793e31eb.png