1. 程式人生 > >SpringBoot圖文教程8 — SpringBoot整合MBG「程式碼生成器」

SpringBoot圖文教程8 — SpringBoot整合MBG「程式碼生成器」

有天上飛的概念,就要有落地的實現

  • 概念十遍不如程式碼一遍,朋友,希望你把文中所有的程式碼案例都敲一遍

  • 先贊後看,養成習慣

SpringBoot 圖文教程系列文章目錄

  1. SpringBoot圖文教程1「概念+案例 思維導圖」「基礎篇上」
  2. SpringBoot圖文教程2—日誌的使用「logback」「log4j」
  3. SpringBoot圖文教程3—「‘初戀’情結」整合Jsp
  4. SpringBoot圖文教程4—SpringBoot 實現檔案上傳下載
  5. SpringBoot圖文教程5—SpringBoot 中使用Aop
  6. SpringBoot圖文教程6—SpringBoot中過濾器的使用
  7. SpringBoot圖文教程7—SpringBoot攔截器的使用姿勢這都有

前言

在使用Mybatis進行專案開發的時候,最繁瑣的事情就是實體類,dao介面,mapper.xml檔案的編寫,幾乎每個表都需要對應寫一套,並且大部分的工作量都在最基本的增刪改查上。如果表中的欄位進行了修改,那麼實體類,mapper檔案甚至dao介面都要進行修改。

天下苦mapper檔案久矣,於是Mybatis官方推薦了一個Mybatis程式碼生成器(MBG)來救民於水火之中。

Mybatis 程式碼生成器

MBG

MBG 全稱 MyBatis Generator,可以用來生成Mybatis開發相關的程式碼,包括基本增刪改查的實體類,dao介面和mapper檔案。並且 MBG 工具支援所有版本的Mybatis。

官方文件地址:http://mybatis.org/generator/

SpringBoot 整合 MBG

本文程式碼會在一個SpringBoot+Mybatis的空專案中進行,如有需要請去Git倉庫下載:https://gitee.com/bingqilinpeishenme/Java-Tutorials

1.匯入依賴

SpringBoot中使用MBG需要在匯入MBG依賴的同時匯入MBG的啟動外掛。
MBG的依賴

<!--MybatisGenerator的依賴jar包-->
<dependency>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-core</artifactId>
            <version>1.3.2</version>
        </dependency>

MBG的啟動外掛

<!--MybatisGenerator的啟動外掛-->
            <plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.3.2</version>
                <!--jar包去生成對應類 需要連線資料庫 資料連線的版本和專案中的一致-->
                <dependencies>
                    <dependency>
                        <groupId>mysql</groupId>
                        <artifactId>mysql-connector-java</artifactId>
                        <version>5.1.38</version>
                    </dependency>
                </dependencies>
                
                <configuration>
                    <!--MBG配置檔案的路徑 -->
                    <configurationFile>${basedir}/src/main/resources/generatorConfig.xml</configurationFile>
                    <overwrite>true</overwrite>
                </configuration>
            </plugin>

注意:

  1. 外掛中的 mysql-connector-java 版本和專案中版本號一致
  2. configurationFile 配置的是 MBG配置檔案的地址 src/main/resources

2.匯入並編寫MBG配置檔案

匯入依賴之後,需要在SpringBoot resources目錄下匯入 MBG 的配置檔案 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>
    <context id="test" targetRuntime="MyBatis3">
        <plugin type="org.mybatis.generator.plugins.EqualsHashCodePlugin"></plugin>  
        <plugin type="org.mybatis.generator.plugins.SerializablePlugin"></plugin> 
        <plugin type="org.mybatis.generator.plugins.ToStringPlugin"></plugin>

        <commentGenerator>
            <!-- 這個元素用來去除指定生成的註釋中是否包含生成的日期 false:表示包含 -->
            <!-- 如果生成日期,會造成即使修改一個欄位,整個實體類所有屬性都會發生變化,不利於版本控制,所以設定為true -->
            <property name="suppressDate" value="true" />
            <!-- 是否去除自動生成的註釋 true:是 : false:否 -->
            <property name="suppressAllComments" value="true" />

        </commentGenerator>

        <!--資料庫連結URL,使用者名稱、密碼 -->
        <jdbcConnection
                driverClass="com.mysql.jdbc.Driver"
                connectionURL="jdbc:mysql://localhost/demo"
                userId="root"
                password="123456">
        </jdbcConnection>

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

        <!-- 生成實體類的包名和位置 -->
        <javaModelGenerator targetPackage="com.lu.entity"
            targetProject="src/main/java">
            <property name="enableSubPackages" value="true" />
            <property name="trimStrings" value="true" />
        </javaModelGenerator>

        <!--生成對映檔案的包名和位置  com/lu/mapper-->
        <sqlMapGenerator targetPackage="mapper"
            targetProject="src/main/resources">
            <property name="enableSubPackages" value="true" />
        </sqlMapGenerator>

        <!-- 生成DAO的包名和位置 mybatis兩種開發模式 xml 註解式-->
        <javaClientGenerator type="XMLMAPPER"
            targetPackage="com.lu.dao" targetProject="src/main/java">
            <property name="enableSubPackages" value="true" />
        </javaClientGenerator>
        
        <!-- 要生成哪些表 -->
        <table tableName="user" domainObjectName="User"
               enableCountByExample="false" enableUpdateByExample="false"
               enableDeleteByExample="false" enableSelectByExample="false"
               selectByExampleQueryId="false">
        </table>

     

    </context>
</generatorConfiguration>

重點配置 !!!

在配置檔案中有一下配置需要使用者根據自己的情況進行配置

  1. 資料庫連線引數 修改為自己資料庫的連線引數

  2. dao介面 實體類 mapper檔案生成位置 包結構的配置

    注意:生成位置和包結構引數根據自己實際情況進行修改,其他的內容不需要修改

  1. 配置 要生成哪些表 對應的實體類 dao介面 和 mapper檔案

注意:除了以上三個配置,其他配置都可以不必修改

3.通過外掛啟動可生成程式碼

執行外掛,生成程式碼如下:

  • 實體類

  • dao介面

  • mapper檔案

總結

Tips:本文示例程式碼專案地址為:https://gitee.com/bingqilinpeishenme/Java-Tutorials

恭喜你完成了本章的學習,為你鼓掌!如果本文對你有幫助,請幫忙點贊,評論,轉發,這對作者很重要,謝謝。

讓我們再次回顧本文的學習目標

  • 掌握SpringBoot中MBG的使用

要掌握SpringBoot更多的用法,請持續關注本系列教程。

求關注,求點贊,求轉發

歡迎關注本人公眾號:鹿老師的Java筆記,將在長期更新Java技術圖文教程和視訊教程,Java學習經驗,Java面試經驗以及Java實戰開發經驗。

歡迎關注本人公眾號:鹿老師的Java筆記,將在長期更新Java技術圖文教程和視訊教程,Java學習經驗,Java面試經驗以及Java實戰開發經驗。