[06] 利用mybatis-generator自動生成代碼


一、mybatis-generator 概述

MyBatis官方提供了逆向工程 mybatis-generator,能夠針對數據庫表自動生成MyBatis執行所須要的代碼(如Mapper.java、Mapper.xml、POJO)。 mybatis-generator 有三種用法:命令行、eclipse插件、maven插件。而maven插件的方式比較通用,本文也將概述maven插件的使用方式。

二、pom.xml中配置plugin

(官方文檔: Running MyBatis Generator With Maven
<build>
    <plugins>
        <!-- mybatis-generator -->
        <plugin>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-maven-plugin</artifactId>
            <version>1.3.2</version>
            <configuration>
                <!-- mybatis-generator的配置文件,根據狀況調整位置 -->
                <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>
    </plugins>
</build>

三、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>

    <!--JDBC驅動jar包的位置-->
    <classPathEntry location="C:/workspace/project/learning/mybatis/lib/mysql-connector-java-5.1.6.jar"/>

    <context id="default" targetRuntime="MyBatis3">

        <!--建立Java類時是否取消生成註釋-->
        <commentGenerator>
            <property name="suppressDate" value="true"/>
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>

        <!--JDBC數據庫鏈接-->
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/test"
                        userId="root"
                        password="dev">
        </jdbcConnection>

        <!--
        Model模型生成器,用來生成含有主鍵key的類,記錄類 以及查詢Example類
        targetPackage     指定生成的model生成所在的包名
        targetProject     指定在該項目下所在的路徑
        -->
        <javaModelGenerator targetPackage="dulk.learn.mybatis.generator.pojo"
                            targetProject="./src/main/java">
            <!-- 是否容許子包,即targetPackage.schemaName.tableName -->
            <property name="enableSubPackages" value="false"/>
            <!-- 是否對model添加構造函數 -->
            <property name="constructorBased" value="true"/>
            <!-- 是否對類CHAR類型的列的數據進行trim操做 -->
            <property name="trimStrings" value="true"/>
            <!-- 創建的Model對象是否 不可改變  即生成的Model對象不會有 setter方法,只有構造方法 -->
            <property name="immutable" value="false"/>
        </javaModelGenerator>

        <!--
        mapper映射文件生成所在的目錄 爲每個數據庫的表生成對應的SqlMap文件 
        -->
        <sqlMapGenerator targetPackage="generator"
                         targetProject="./src/main/resources">
            <property name="enableSubPackages" value="false"/>
        </sqlMapGenerator>

        <!-- 
        客戶端代碼,生成易於使用的針對Model對象和XML配置文件的代碼
        type="ANNOTATEDMAPPER",生成Java Model和基於註解的Mapper對象
        type="MIXEDMAPPER",生成基於註解的Java Model和相應的Mapper對象
        type="XMLMAPPER",生成SQLMap XML文件和獨立的Mapper接口
        -->
        <javaClientGenerator type="XMLMAPPER"
                             targetPackage="dulk.learn.mybatis.generator.mapper"
                             targetProject="./src/main/java">
            <property name="enableSubPackages" value="false"/>
        </javaClientGenerator>


        <!--tables-->
        <table tableName="author" domainObjectName="Author"
               enableCountByExample="false" enableUpdateByExample="false"
               enableDeleteByExample="false" enableSelectByExample="false"
               selectByExampleQueryId="false">
        </table>
        <table tableName="book" domainObjectName="Book"
               enableCountByExample="false" enableUpdateByExample="false"
               enableDeleteByExample="false" enableSelectByExample="false"
               selectByExampleQueryId="false">
        </table>

    </context>
</generatorConfiguration>

有些默認配置沒必要顯性去配置,因此簡化一下快速配置的話也能夠這樣:
(注意:配置中文件的生成地址等根據我的實際狀況進行調整,另外,如有其餘配置想要調整請參考官方文檔)
<?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="C:/workspace/project/learning/mybatis/lib/mysql-connector-java-5.1.6.jar"/>

    <context id="default" targetRuntime="MyBatis3">

        <commentGenerator>
            <property name="suppressDate" value="true"/>
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>

        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/test"
                        userId="root"
                        password="dev">
        </jdbcConnection>

        <javaModelGenerator targetPackage="dulk.learn.mybatis.generator.pojo"
                            targetProject="./src/main/java">
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>

        <sqlMapGenerator targetPackage="generator"
                         targetProject="./src/main/resources">
        </sqlMapGenerator>

        <javaClientGenerator type="XMLMAPPER"
                             targetPackage="dulk.learn.mybatis.generator.mapper"
                             targetProject="./src/main/java">
        </javaClientGenerator>

        <table tableName="author" domainObjectName="Author"
               enableCountByExample="false" enableUpdateByExample="false"
               enableDeleteByExample="false" enableSelectByExample="false"
               selectByExampleQueryId="false">
        </table>
        <table tableName="book" domainObjectName="Book"
               enableCountByExample="false" enableUpdateByExample="false"
               enableDeleteByExample="false" enableSelectByExample="false"
               selectByExampleQueryId="false">
        </table>

    </context>
</generatorConfiguration>

另,配置文件中諸如 javaModelGenerator / sqlMapGenerator / javaClientGenerator 等配置的順序不要輕易改變,可能會致使插件執行時失敗。

四、使用方式

mvn mybatis-generator:generate
若是是在IDEA環境中,直接鼠標點擊執行便可:

目錄結構以下:

注:建表時,字段名稱建議用"_"分隔多個單詞,好比:author_id...,這樣生成的model,屬性名稱就會變成的駝峯命名,即:authorId

五、參考連接

相關文章
相關標籤/搜索