SpringBoot 零基礎學習過程（四）小插曲之MyBatis Generator

在搜索資料過程中無意發現一個神奇的東西（自己不知道而已），MyBatis Generator這個插件可以幫助我們創建實體類、mapper.xml這樣可以簡化我們在新項目和就項目改版時數據庫手動創建的問題，可以用代碼快速生成我們需要的mapper、實體，老規矩廢話不多說，直接上代碼。

1.首先在maven配置中增加配置項

其中包含了一個配置文件的目錄，這個我看了很多的示例，覺得這個比較清晰，所以就以這個爲例給大家展示，大家可以根據自己喜好配置，最重要的就是引入這個包即可。

<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
        </plugin>

        <!-- MyBatis Generator 插件 -->
        <plugin>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-maven-plugin</artifactId>
            <version>1.3.7</version>
            <configuration>
                <configurationFile>
                    ${basedir}/src/main/resources/generatorConfig.xml
                </configurationFile>
                <overwrite>true</overwrite>
                <verbose>true</verbose>
            </configuration>
        </plugin>
    </plugins>
</build>

2.創建配置文件

由於配置信息比較多，不一一講解，具體配置內容大家可以參考官網進行查詢。下面是我用的示例，有很多配置項都是沒有用到的，大家可以根據自己需求定製即可。

重點：

1.其中包含數據庫配置信息，大家根據具體內容配置；

2.在mysql8的包中生成庫中所有表會有點問題，會出現掃描重複的情況，需要配置一個節點信息。就是下面的nullCatalogMeansCurrent，設置爲true即可。

<!-- JDBC連接配置 -->
<jdbcConnection driverClass="com.mysql.jdbc.Driver"
                connectionURL="jdbc:mysql://127.0.0.1:3306/java_demo_01?useSSL=false&amp;useUnicode=true&amp;characterEncoding=UTF-8"
                userId="root"
                password="admin123$%^">
    <property name="nullCatalogMeansCurrent" value="true" />
</jdbcConnection>

3.生成可以生成全表，也可以在實際項目增加表示，改變下面table的名字，%表示所有表，如果指定寫成具體表名即可。

<?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>

    <!--
        可以用於加載配置項或者配置文件,在整個配置文件中就可以使用${propertyKey}的方式來引用配置項
        resource:配置資源加載地址,使用resource,MBG從classpath開始找,比如com/myproject/generatorConfig.properties
        url:配置資源加載地址,使用URL的方式,比如file:///C:/myfolder/generatorConfig.properties
        注意,兩個屬性只能選址一個

        另外,如果使用了mybatis-generator-maven-plugin,那麼在pom.xml中定義的properties都可以直接在generatorConfig.xml中使用
        <properties resource="" url="" />
    -->
    <!--<properties resource="db.properties"/>-->

    <!--
        在MBG工作的時候,需要額外加載的依賴包
        location屬性指明加載jar/zip包的全路徑
    -->
    <classPathEntry
            location="/usr/local/maven/repository/mysql/mysql-connector-java/8.0.18/mysql-connector-java-8.0.18.jar"/>

    <!--
        context:生成一組對象的環境
        id:必選，上下文id，用於在生成錯誤時提示
        defaultModelType:指定生成對象的樣式
            1. conditional:類似hierarchical
            2. flat:所有內容(主鍵，blob)等全部生成在一個對象中
            3. hierarchical:主鍵生成一個XXKey對象(key class),Blob等單獨生成一個對象,其他簡單屬性在一個對象中(record class)
        targetRuntime:
            1. MyBatis3:默認的值,生成基於MyBatis3.x以上版本的內容,包括XXXBySample
            2. MyBatis3Simple:類似MyBatis3,只是不生成XXXBySample
        introspectedColumnImpl:類全限定名,用於擴展MBG
    -->
    <context id="MyBatis" targetRuntime="MyBatis3">

        <!--
            自動識別數據庫關鍵字,默認false,如果設置爲true,根據SqlReservedWords中定義的關鍵字列表
            一般保留默認值,遇到數據庫關鍵字(Java關鍵字),使用columnOverride覆蓋
        -->
        <property name="autoDelimitKeywords" value="true"/>
        <!-- 生成的Java文件的編碼 -->
        <property name="javaFileEncoding" value="UTF-8"/>
        <!-- 格式化Java代碼 -->
        <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>
        <!-- 格式化XML代碼 -->
        <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>

        <!-- 不生成註釋 -->
        <commentGenerator>
            <property name="suppressAllComments" value="true"/>
            <property name="suppressDate" value="true"/>
        </commentGenerator>

        <!-- JDBC連接配置 -->
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://127.0.0.1:3306/java_demo_01?useSSL=false&amp;useUnicode=true&amp;characterEncoding=UTF-8"
                        userId="root"
                        password="admin123$%^">
            <property name="nullCatalogMeansCurrent" value="true" />
        </jdbcConnection>

        <!--
            Java類型處理器
            用於處理DB中的類型到Java中的類型,默認使用JavaTypeResolverDefaultImpl
            注意一點,默認會先嚐試使用Integer,Long,Short等來對應DECIMAL和NUMERIC數據類型
        -->
        <javaTypeResolver>
            <!--
                true:使用BigDecimal對應DECIMAL和 NUMERIC數據類型
                false:默認
                scale>0;length>18:使用BigDecimal
                scale=0;length[10,18]:使用Long
                scale=0;length[5,9]:使用Integer
                scale=0;length<5:使用Short
            -->
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>

        <!--
            Java模型創建器,是必須要的元素
            負責:
            1. key類(見context的defaultModelType)
            2. java類
            3. 查詢類
            targetPackage:生成的類要放的包,真實的包受enableSubPackages屬性控制
            targetProject:目標項目,指定一個存在的目錄下,生成的內容會放到指定目錄中,如果目錄不存在,MBG不會自動建目錄
        -->
        <javaModelGenerator targetPackage="com.dream.demo.dao.entity"
                            targetProject="src/main/java">

            <!-- 自動爲每一個生成的類創建一個構造方法,構造方法包含了所有的field,而不是使用setter -->
            <!--<property name="constructorBased" value="false"/>-->

            <!-- 在targetPackage的基礎上,根據數據庫的schema再生成一層package,最終生成的類放在這個package下,默認爲false -->
            <property name="enableSubPackages" value="false"/>

            <!--
                是否創建一個不可變的類，如果爲true
                那麼MBG會創建一個沒有setter方法的類,取而代之的是類似constructorBased的類
            -->
            <!--<property name="immutable" value="false"/>-->

            <!--
                設置一個根對象
                如果設置了這個根對象,那麼生成的keyClass或者recordClass會繼承這個類,在Table的rootClass屬性中可以覆蓋該選項
                注意:
                如果在key class或者record class中有root class相同的屬性,MBG就不會重新生成這些屬性了,包括：
                1. 屬性名相同,類型相同,有相同的getter/setter方法
             -->
            <!--<property name="rootClass" value="com._520it.mybatis.domain.BaseDomain"/>-->

            <!-- 設置是否在getter方法中，對String類型字段調用trim()方法 -->
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>

        <!--
            生成SQL map的XML文件生成器
            注意,在Mybatis3之後,我們可以使用mapper.xml文件+Mapper接口(或者不用mapper接口)
            或者只使用Mapper接口+Annotation,所以,如果javaClientGenerator配置中配置了需要生成XML的話,這個元素就必須配置
            targetPackage/targetProject:同javaModelGenerator
        -->
        <sqlMapGenerator targetPackage="mapper"
                         targetProject="src/main/resources">
            <!-- 在targetPackage的基礎上,根據數據庫的schema再生成一層package,最終生成的類放在這個package下,默認爲false -->
            <property name="enableSubPackages" value="false"/>
        </sqlMapGenerator>

        <!--
            對於mybatis來說,即生成Mapper接口
            注意,如果沒有配置該元素,那麼默認不會生成Mapper接口
            targetPackage/targetProject:同javaModelGenerator
            type:選擇怎麼生成mapper接口(在MyBatis3/MyBatis3Simple下)
            1. ANNOTATEDMAPPER:會生成使用Mapper接口+Annotation的方式創建(SQL生成在annotation中)不會生成對應的XML
            2. MIXEDMAPPER:使用混合配置,會生成Mapper接口,並適當添加合適的Annotation,但是XML會生成在XML中
            3. XMLMAPPER:會生成Mapper接口,接口完全依賴XML
            注意,如果context是MyBatis3Simple:只支持ANNOTATEDMAPPER和XMLMAPPER
        -->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.dream.demo.dao.mapper"
                             targetProject="src/main/java">
            <!-- 在targetPackage的基礎上,根據數據庫的schema再生成一層package,最終生成的類放在這個package下,默認爲false -->
            <property name="enableSubPackages" value="false"/>

            <!--
                可以爲所有生成的接口添加一個父接口,但是MBG只負責生成,不負責檢查
                <property name="rootInterface" value=""/>
            -->
        </javaClientGenerator>

        <!--
            選擇一個table來生成相關文件,可以有一個或多個table,必須要有table元素
            選擇的table會生成一下文件:
            1. SQL map文件
            2. 生成一個主鍵類
            3. 除了BLOB和主鍵的其他字段的類
            4. 包含BLOB的類
            5. 一個用戶生成動態查詢的條件類(selectByExample, deleteByExample)可選
            6. Mapper接口(可選)

            tableName(必要):要生成對象的表名,%表示通配,即爲該數據庫下的所有表生成xml文件
            注意:大小寫敏感問題.正常情況下,MBG會自動的去識別數據庫標識符的大小寫敏感度,在一般情況下
            MBG會根據設置的schema,catalog或tablename去查詢數據表,按照下面的流程:
            1. 如果schema,catalog或tablename中有空格,那麼設置的是什麼格式,就精確的使用指定的大小寫格式去查詢
            2. 否則,如果數據庫的標識符使用大寫的,那麼MBG自動把表名變成大寫再查找
            3. 否則,如果數據庫的標識符使用小寫的,那麼MBG自動把表名變成小寫再查找
            4. 否則,使用指定的大小寫格式查詢
            另外,如果在創建表的時候,使用的""把數據庫對象規定大小寫,就算數據庫標識符是使用的大寫,在這種情況下也會使用給定的大小寫來創建表名
            這個時候,請設置delimitIdentifiers="true"即可保留大小寫格式

            可選:
            1. schema:數據庫的schema
            2. catalog:數據庫的catalog
            3. alias:爲數據表設置的別名,如果設置了alias,那麼生成的所有的SELECT SQL語句中,列名會變成:alias_actualColumnName
            4. domainObjectName:生成的domain類的名字,如果不設置,直接使用表名作爲domain類的名字;可以設置爲somepck.domainName,那麼會自動把domainName類再放到somepck包裏面
            5. enableInsert(默認true):指定是否生成insert語句
            6. enableSelectByPrimaryKey(默認true):指定是否生成按照主鍵查詢對象的語句(就是getById或get)
            7. enableSelectByExample(默認true):MyBatis3Simple爲false,指定是否生成動態查詢語句
            8. enableUpdateByPrimaryKey(默認true):指定是否生成按照主鍵修改對象的語句(即update)
            9. enableDeleteByPrimaryKey(默認true):指定是否生成按照主鍵刪除對象的語句(即delete)
            10. enableDeleteByExample(默認true):MyBatis3Simple爲false,指定是否生成動態刪除語句
            11. enableCountByExample(默認true):MyBatis3Simple爲false,指定是否生成動態查詢總條數語句(用於分頁的總條數查詢)
            12. enableUpdateByExample(默認true)MyBatis3Simple爲false,指定是否生成動態修改語句(只修改對象中不爲空的屬性)
            13. modelType:參考context元素的defaultModelType,相當於覆蓋
            14. delimitIdentifiers:參考tableName的解釋,注意,默認的delimitIdentifiers是雙引號,如果類似MYSQL這樣的數據庫,使用的是`(反引號,那麼還需要設置context的beginningDelimiter和endingDelimiter屬性)
            15. delimitAllColumns:設置是否所有生成的SQL中的列名都使用標識符引起來.默認爲false,delimitIdentifiers參考context的屬性

            注意,table裏面很多參數都是對javaModelGenerator,context等元素的默認屬性的一個複寫
        -->
        <!--生成對應表及類名,去掉Mybatis Generator生成的一堆 example-->
        <table tableName="%" enableCountByExample="false" enableUpdateByExample="false"
               enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false">
            <!-- 注意，該屬性只針對MyBatis3Simple有用；
            如果選擇的runtime是MyBatis3Simple，那麼會生成一個SelectAll方法，如果指定了selectAllOrderByClause，那麼會在該SQL中添加指定的這個order條件；
         -->
<!--            <property name="selectAllOrderByClause" value="age desc,username asc"/>-->

            <!-- 如果設置爲true，生成的model類會直接使用column本身的名字，而不會再使用駝峯命名方法，比如BORN_DATE，生成的屬性名字就是BORN_DATE,而不會是bornDate -->
            <property name="useActualColumnNames" value="false"/>


            <!-- generatedKey用於生成生成主鍵的方法，
                如果設置了該元素，MBG會在生成的<insert>元素中生成一條正確的<selectKey>元素，該元素可選
                column:主鍵的列名；
                sqlStatement：要生成的selectKey語句，有以下可選項：
                    Cloudscape:相當於selectKey的SQL爲： VALUES IDENTITY_VAL_LOCAL()
                    DB2       :相當於selectKey的SQL爲： VALUES IDENTITY_VAL_LOCAL()
                    DB2_MF    :相當於selectKey的SQL爲：SELECT IDENTITY_VAL_LOCAL() FROM SYSIBM.SYSDUMMY1
                    Derby     :相當於selectKey的SQL爲：VALUES IDENTITY_VAL_LOCAL()
                    HSQLDB    :相當於selectKey的SQL爲：CALL IDENTITY()
                    Informix  :相當於selectKey的SQL爲：select dbinfo('sqlca.sqlerrd1') from systables where tabid=1
                    MySql     :相當於selectKey的SQL爲：SELECT LAST_INSERT_ID()
                    SqlServer :相當於selectKey的SQL爲：SELECT SCOPE_IDENTITY()
                    SYBASE    :相當於selectKey的SQL爲：SELECT @@IDENTITY
                    JDBC      :相當於在生成的insert元素上添加useGeneratedKeys="true"和keyProperty屬性
            <generatedKey column="" sqlStatement=""/>
             -->

            <!--
                該元素會在根據表中列名計算對象屬性名之前先重命名列名，非常適合用於表中的列都有公用的前綴字符串的時候，
                比如列名爲：CUST_ID,CUST_NAME,CUST_EMAIL,CUST_ADDRESS等；
                那麼就可以設置searchString爲"^CUST_"，並使用空白替換，那麼生成的Customer對象中的屬性名稱就不是
                custId,custName等，而是先被替換爲ID,NAME,EMAIL,然後變成屬性：id，name，email；

                注意，MBG是使用java.util.regex.Matcher.replaceAll來替換searchString和replaceString的，
                如果使用了columnOverride元素，該屬性無效；

            <columnRenamingRule searchString="" replaceString=""/>
             -->


            <!-- 用來修改表中某個列的屬性，MBG會使用修改後的列來生成domain的屬性；
               column:要重新設置的列名；
               注意，一個table元素中可以有多個columnOverride元素哈~
             -->
            <generatedKey column="id" sqlStatement="Mysql" identity="true"/>
            <!--<columnOverride column="username">
                &lt;!&ndash; 使用property屬性來指定列要生成的屬性名稱 &ndash;&gt;
                <property name="property" value="userName"/>

                &lt;!&ndash; javaType用於指定生成的domain的屬性類型，使用類型的全限定名
                <property name="javaType" value=""/>
                 &ndash;&gt;

                &lt;!&ndash; jdbcType用於指定該列的JDBC類型
                <property name="jdbcType" value=""/>
                 &ndash;&gt;

                &lt;!&ndash; typeHandler 用於指定該列使用到的TypeHandler，如果要指定，配置類型處理器的全限定名
                    注意，mybatis中，不會生成到mybatis-config.xml中的typeHandler
                    只會生成類似：where id = #{id,jdbcType=BIGINT,typeHandler=com._520it.mybatis.MyTypeHandler}的參數描述
                <property name="jdbcType" value=""/>
                &ndash;&gt;

                &lt;!&ndash; 參考table元素的delimitAllColumns配置，默認爲false
                <property name="delimitedColumnName" value=""/>
                 &ndash;&gt;
            </columnOverride>-->

            <!-- ignoreColumn設置一個MGB忽略的列，如果設置了改列，那麼在生成的domain中，生成的SQL中，都不會有該列出現
               column:指定要忽略的列的名字；
               delimitedColumnName：參考table元素的delimitAllColumns配置，默認爲false

               注意，一個table元素中可以有多個ignoreColumn元素
            <ignoreColumn column="deptId" delimitedColumnName=""/>
            -->
        </table>
    </context>
</generatorConfiguration>

3.生成

當我們成功引入包的時候，我使用的idea開發工具，不同ide都有些區別，但是都是大同小異，主要給大家先做演示。

在我的idea右側有一個maven選項，我們點開。找到具體的mybatis-generator:generate，點擊run，就可以生成我們的mapper、實體啦，可以優雅的（主要是懶）幫助我們進行開發啦。

好啦，繼續去搞我的小demo，等待進步，加油💪

SpringBoot 零基礎學習過程（四）小插曲之MyBatis Generator

【面試準備】又一次失敗的面試經歷，題目離譜～資深軟件測試工程師

dotnet 8 版本與銀河麒麟V10和UOS系統的 glibc 兼容性

SpringBoot 零基礎學習過程（四）小插曲之MyBatis Generator

SpringBoot 日誌配置單文件

SpringBoot 零基礎學習過程（一）

SpringBoot 零基礎學習過程（二）寫一個訪問小demo

SpringBoot 零基礎學習過程（七）ES服務搭建，實現簡單的業務調用測試

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結