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實戰開發經驗。