使用mybatis-generator生成Mybatis代码

目录

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

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插件

            <!-- mybatis代码生成插件 -->
            <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>
    <!--mysql 连接数据库jar 这里选择自己本地位置;
    如果不知道maven本地仓库地址，可以使用EveryThing工具全局搜索mysql-connector-java，找到jar包位置；
    也可以手动下载一个jar放在指定位置，进行引用。
    -->
    <classPathEntry location="E:/mvnRespo/mysql/mysql-connector-java/5.1.47/mysql-connector-java-5.1.47.jar"/>

    <context id="testTables" targetRuntime="MyBatis3">
        <commentGenerator>
            <!-- 是否去除自动生成的注释,true：是,false:否 -->
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>

        <!--数据库连接的信息：驱动类、连接地址、用户名、密码 -->
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/mybatis" userId="root"
                        password="123">
        </jdbcConnection>

        <!-- 默认false，把JDBC DECIMAL 和 NUMERIC 类型解析为 Integer，为 true时把JDBC DECIMAL 和
           NUMERIC 类型解析为java.math.BigDecimal -->
        <javaTypeResolver>
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>

        <!-- 指定javaBean生成的位置
            targetPackage：生成的类要放的包，真实的包受enableSubPackages属性控制；
            targetProject：目标项目，指定一个存在的目录下，生成的内容会放到指定目录中，如果目录不存在，MBG不会自动建目录
         -->
        <javaModelGenerator targetPackage="com.boge.xiushi.manage.web.model" targetProject="src/main/java">
            <!-- 在targetPackage的基础上，根据数据库的schema再生成一层package，最终生成的类放在这个package下，默认为false；如果多个数据库改为true分目录 -->
            <property name="enableSubPackages" value="false"/>
            <!-- 设置是否在getter方法中，对String类型字段调用trim()方法 -->
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>

        <!--  指定mapper映射文件生成的位置
           targetPackage、targetProject同javaModelGenerator中作用一样-->
        <sqlMapGenerator targetPackage="mybatis" targetProject="src/main/resources">
            <property name="enableSubPackages" value="false"/>
        </sqlMapGenerator>

        <!-- 指定mapper接口生成的位置
         targetPackage、targetProject同javaModelGenerator中作用一样
         -->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.boge.xiushi.manage.web.dao" targetProject="src/main/java">
            <property name="enableSubPackages" value="false"/>
        </javaClientGenerator>

        <!-- 指定数据库表
        domainObjectName：生成的domain类的名字,当表名和domain类的名字有差异时一定要设置，如果不设置，直接使用表名作为domain类的名字；
        可以设置为somepck.domainName，那么会自动把domainName类再放到somepck包里面；
        -->
        <table tableName="items" domainObjectName="Items"></table>
    </context>
</generatorConfiguration>

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

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

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

可以直接执行maven命令，详情见：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。

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

生成的结果文件

如何使用生成的代码？

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

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