MyBatis逆向生成器使用教程

介绍

在教程之前先给出MyBatis逆向生成器的官方文档（只有英文）：MyBatis Generator，这里包含最全的教程，英语不好的朋友只能Google翻译了。

逆向生成是指使用已建立数据库模型生成MyBatis需要的：Java PO，Mybatis的SQL映射文件和DAO层的接口。

简易步骤：

1. 编写逆向配置文件；
2. 添加逆向工程的Maven插件；
3. 使用Maven执行逆向配置文件；

编写配置文件

配置文件命名为：generatorConfig.xml，放在项目的src\main\resources\目录下，因为使用Maven执行生成器，这两个都是默认的。下面是配置的例子：

<?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>
    <!-- 添加jar包依赖：MySQL connector/J-->
    <classPathEntry
            location="/Users/Gawegor/.m2/repository/mysql/mysql-connector-java/5.1.46/mysql-connector-java-5.1.46.jar"/>


    <context id="GshopTables" targetRuntime="MyBatis3">
        <!-- 防止生成的代码中有很多注释，加入下面的配置控制 -->
        <commentGenerator>
            <property name="suppressAllComments" value="true"/>
            <property name="suppressDate" value="true"/>
        </commentGenerator>

        <!-- 数据库连接 -->
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/test"
                        userId="root"
                        password="12345">
        </jdbcConnection>

        <javaTypeResolver>
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>

        <!-- 配置生成数据表对应PO,存放位置必填 -->
        <javaModelGenerator targetPackage="com.gawegor.model" targetProject="src/main/java">
            <property name="enableSubPackages" value="false"/>
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>

        <!-- 配置生成的mapper SQL映射文件,存放位置必填 -->
        <sqlMapGenerator targetPackage="com.gawegor.mapper" targetProject="src/main/java">
            <property name="enableSubPackages" value="false"/>
        </sqlMapGenerator>

        <!-- 配置生成的mapper接口,存放位置必填 -->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.gawegor.dao" targetProject="src/main/java">
            <property name="enableSubPackages" value="false"/>
        </javaClientGenerator>

        <!-- 指定逆向据库中的那些数表 -->
        <table tableName="users"></table>
        <table tableName="goods"></table>

    </context>
</generatorConfiguration>

添加生成器的Maven插件

在pom.xml中添加生成器的jar包：

<project>
    ...
    <build>
        <pluginManagement>
            <plgins>
                ...
                 <plugin>
                    <groupId>org.mybatis.generator</groupId>
                    <artifactId>mybatis-generator-maven-plugin</artifactId>
                    <version>1.3.5</version>
                </plugin>
            </plgins>
        </pluginManagement>
    </build>
</project>

使用Maven执行生成器

在命令行中执行：

mvn -Dmybatis.generator.overwrite=true mybatis-generator:generate

其中-Dmybatis.generator.overwrite=true表示覆盖同名的生成文件。这里是使用命令行执行，如果使用你使用IDE执行的话，一般不用前面的命令前面mvn。