mybatis根據表逆向自動化生成程式碼

發表於2021-08-28
MyBatis

 自動生成程式碼總結（1）——（mybatis自動生成實體類、mapper檔案、mapper.xml檔案）

　　若採用mybatis框架，資料庫新建表，手動編寫的話，需要編寫大量的實體類、mapper檔案、mapper.xml檔案，都是一些重複且有規律的工作。

我們可以引用外掛，然後做配置，自動生成這些檔案，提供工作效率。

　　本部落格包含的內容：

　　①自動生成外掛的引入

　　②定義配置檔案

　　③執行外掛，生成程式碼

1.引入外掛

　　在專案的pom檔案中引入generator外掛

            <plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.3.7</version>
                <configuration>
                    <!-- 配置檔案存放路徑 -->
                    <configurationFile>${basedir}/src/main/resources/generator/generatorConfig.xml</configurationFile>
                    <overwrite>true</overwrite>
                    <verbose>true</verbose>
                </configuration>
                <dependencies>
                    <!-- mysql -->
                    <dependency>
                        <groupId>mysql</groupId>
                        <artifactId>mysql-connector-java</artifactId>
                        <version>5.1.46</version>
                    </dependency>
                    <!-- mapper -->
                    <dependency>
                        <groupId>tk.mybatis</groupId>
                        <artifactId>mapper</artifactId>
                        <version>3.4.1</version>
                    </dependency>
                </dependencies>
            </plugin>

 

2.修改generatorConfig.xml檔案

　　注：generatorConfig.xml 一定要放在pom中外掛配置的路徑下。

　　下面給出配置檔案中的程式碼，程式碼中都有註釋。主要注意的點有：

　　①jdbc連線 資料庫的路徑

　　②生成實體類存放的路勁

　　③生成mapper.xml存放的路勁

　　④生成mapper檔案的存放路徑

　　⑤修改表以及該表對應的實體類名稱

<?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:資料庫的JDBC驅動,換成你自己的驅動位置 可選 -->
    <!--    <classPathEntry location="F://jdbc//mysql-connector-java-8.0.18.jar"/>-->

    <!-- 一個資料庫一個context -->
    <context id="DB2Tables" targetRuntime="Mybatis3">
        <!-- 自動識別資料庫關鍵字，預設false，如果設定為true，根據SqlReservedWords中定義的關鍵字列表；一般保留預設值，遇到資料庫關鍵字（Java關鍵字），使用columnOverride覆蓋 -->
        <property name="autoDelimitKeywords" value="true"/>
        <!-- 生成的Java檔案的編碼 -->
        <property name="javaFileEncoding" value="utf-8"/>
        <!-- beginningDelimiter和endingDelimiter：指明資料庫的用於標記資料庫物件名的符號，比如ORACLE就是雙引號，MYSQL預設是`單引號； -->
        <property name="beginningDelimiter" value="`"/>
        <property name="endingDelimiter" value="`"/>
        <!-- 格式化java程式碼 -->
        <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>
        <!-- 格式化XML程式碼 -->
        <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>
        <plugin type="org.mybatis.generator.plugins.SerializablePlugin"/>
        <plugin type="org.mybatis.generator.plugins.ToStringPlugin"/>

        <!-- 配置 tk.mybatis 外掛 -->
        <plugin type="tk.mybatis.mapper.generator.MapperPlugin">
            <property name="mappers" value="com.glsx.plat.mybatis.mapper.CommonBaseMapper"/>
        </plugin>

        <!--配置生成註釋資訊，最多配置一個 -->
        <commentGenerator>
            <!-- 阻止生成註釋包含時間戳 預設為false -->
            <property name="suppressDate" value="true"/>
            <!-- 註釋是否新增資料庫表的備註資訊 預設為false -->
            <property name="addRemarkComments" value="true"/>
        </commentGenerator>
        <!-- jdbc連線-->
        <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
                        connectionURL="jdbc:mysql://127.0.0.1:3307/test?serverTimeZone=Shanghai&amp;useUnicode=true&amp;characterEncoding=utf8&amp;useSSL=false"
                        userId="root"
                        password="root">
            <!--防止生成其他庫同名表-->
            <property name="nullCatalogMeansCurrent" value="true"/>
        </jdbcConnection>
        <!-- 型別轉換 -->
        <javaTypeResolver>
            <!-- 是否使用bigDecimal， false可自動轉化以下型別（Long, Integer, Short, etc.） -->
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>

        <!-- 生成實體類地址 -->
        <javaModelGenerator targetPackage="cn.com.glsx.admin.modules.entity" targetProject="src/main/java">
            <!-- 是否讓schema作為包的字尾 -->
            <property name="enableSubPackages" value="true"/>
            <!-- 從資料庫返回的值去掉前後空格 -->
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>

        <!-- 生成mapper.xml檔案存放地址 -->
        <sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources">
            <property name="enableSubPackages" value="true"/>
        </sqlMapGenerator>

        <!-- 生成介面dao  type="ANNOTATEDMAPPER",生成Java Model 和基於註解的Mapper物件 type="MIXEDMAPPER",
　　　　　　　　生成基於註解的Java Model 和相應的Mapper物件 type="XMLMAPPER",生成SQLMap XML檔案和獨立的Mapper介面 -->
        <javaClientGenerator targetPackage="cn.com.glsx.admin.modules.mapper" targetProject="src/main/java" type="XMLMAPPER">
            <property name="enableSubPackages" value="false"/>
        </javaClientGenerator>

        <!-- table可以有多個,每個資料庫中的表都可以寫一個table，tableName表示要匹配的資料庫表,也可以在tableName屬性中通過使用%萬用字元來匹配所有資料庫表,
　　　　　　　　只有匹配的表才會自動生成檔案 enableSelectByPrimaryKey相應的配置表示是否生成相應的介面 -->
        <table tableName="d_user" domainObjectName="User" enableCountByExample="false" enableUpdateByExample="false"
               enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"/>
　　　　<table tableName="d_student" domainObjectName="Student" enableCountByExample="false" enableUpdateByExample="false"
               enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"/>
    </context> 
</generatorConfiguration>

 

 

3.執行外掛，生成程式碼

 　　雙擊外掛，執行後，在控制檯中能看到BUILD SUCCESS，說明執行成功。

　　

 

若在專案中沒有，滑鼠右擊專案，則重新重新整理整個專案或者重新載入專案，就可以在配置的路徑下看到生成的檔案。

 

 

 

 

 

 

若覺得博文對你有幫助，請點【推薦】，感謝你的支援鼓勵。

 

相關文章