一、寫在開頭
最近一直在更新《Java成長計劃》這個專欄，主要是Java全流程學習的一個記錄，目前已經更新到Java併發多執行緒部分，後續會繼續更新；而今天準備開設一個全新的專欄 《EfficientFarm》。
EfficientFarm：高效農場，期許軟體開發工作能夠像很多國外的高效農場一般機械化，自動化。拿來即用，提高工作效率，是這個專欄的宗旨！
二、Mybatis 逆向工程
我們在開發傳統的Maven專案或者SpringBoot專案過程中，最終處理的就是對於資料的讀與存，這時就免不了寫物件關係對映程式碼，實體類、mapper、mapper.xml等程式碼，若存在大量的增刪改查功能的話，我們開發時就會不斷重複相同的操作，大大降低了工作效率。
為此便但成了Mybatis “逆向工程” ，所謂逆向工程，就是從資料庫表結構出發，反向去生成對應的實體和對映程式碼，今天我們在這裡提供2種方案進行實現。
三、方案一
3.1 環境準備
1）springboot 專案（JDK1.8）
2）apache-maven-3.6.1
3）MySQL 8.0.30
3.2 資料庫表
逆向工程的第一步，需要先有資料庫表結構！我們在這裡先建立一個表，作為示例使用，sql指令碼如下：
--若已存在，先刪除
drop table user
-- 建立資料庫使用者表
create table user (
id int NOT NULL AUTO_INCREMENT COMMENT '主鍵',
name varchar(100) DEFAULT NULL COMMENT '員工姓名',
phone_num varchar(20) DEFAULT NULL COMMENT '聯絡方式',
address varchar(200) DEFAULT NULL COMMENT '住址',
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci;
3.3 新增依賴
逆向工程的實現，需要先引入mybatis相關依賴，如果專案中已經引入過，可自動忽略這一步。
<dependencies>
<!-- mybatis-generator -->
<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-core</artifactId>
<version>1.3.7</version>
</dependency>
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>2.2.2</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
3.4 資料庫連線配置
依賴與資料庫表建立好之後，我們就正式進入了springboot專案中進行逆向工程開發啦，首先在resources目錄下建立一個資料庫連線的配置檔案：generator.properties
jdbc.driverClass=com.mysql.cj.jdbc.Driver
jdbc.connectionURL=jdbc:mysql://localhost:3306/vhr?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai
jdbc.userId=root
jdbc.password=123456
3.5 逆向工程生成規則配置
資料庫配置完成後，我們緊接著來設定一個生成規則，包括編碼，生成檔案路徑、是否設定自定義註釋等等，這個配置可以從網上搜，有很多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>
<!--根據配置檔案讀取資料庫表資訊-->
<properties resource="generator.properties"/>
<context id="MySqlContext" targetRuntime="MyBatis3" defaultModelType="flat">
<!--前置分隔符-->
<property name="beginningDelimiter" value="`"/>
<!--後置分隔符-->
<property name="endingDelimiter" value="`"/>
<!--設定編碼-->
<property name="javaFileEncoding" value="UTF-8"/>
<!-- 為模型生成序列化方法-->
<plugin type="org.mybatis.generator.plugins.SerializablePlugin"/>
<!-- 為生成的Java模型建立一個toString方法 -->
<plugin type="org.mybatis.generator.plugins.ToStringPlugin"/>
<!--生成mapper.xml時覆蓋原檔案-->
<plugin type="org.mybatis.generator.plugins.UnmergeableXmlMappersPlugin" />
<!--可以自定義生成model的程式碼註釋-->
<commentGenerator type="org.javaboy.vhr.utils.CommentGenerator">
<!-- 是否去除自動生成的註釋 true：是 ： false:否 -->
<property name="suppressAllComments" value="true"/>
<property name="suppressDate" value="true"/>
<property name="addRemarkComments" value="true"/>
</commentGenerator>
<!--配置資料庫連線-->
<jdbcConnection driverClass="${jdbc.driverClass}"
connectionURL="${jdbc.connectionURL}"
userId="${jdbc.userId}"
password="${jdbc.password}">
<!--解決mysql驅動升級到8.0後不生成指定資料庫程式碼的問題-->
<property name="nullCatalogMeansCurrent" value="true" />
</jdbcConnection>
<!--指定生成model的路徑-->
<javaModelGenerator targetPackage="org.javaboy.vhr.pojo" targetProject="vhr-web\src\main\java"/>
<!--指定生成mapper.xml的路徑-->
<sqlMapGenerator targetPackage="mybatis.mapper" targetProject="vhr-web\src\main\resources"/>
<!--指定生成mapper介面的的路徑-->
<javaClientGenerator type="XMLMAPPER" targetPackage="org.javaboy.vhr.mapper"
targetProject="vhr-web\src\main\java"/>
<!--單獨生成某個表，寫具體表名，否則生成全部表tableName設為%-->
<table tableName="user" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false"
enableSelectByExample="false" selectByExampleQueryId="false">
<property name="useActualColumnNames" value="false"/>
<property name="constructorBased" value="false"/>
<generatedKey column="id" sqlStatement="JDBC" identity="true"/>
</table>
</context>
</generatorConfiguration>
3.6 自定義實體類註釋配置
由於在上一步我們配置了註釋生成器，因此，我們要在相應的路徑下，建立一個類，來自定義註釋的生成規則。路徑：org.javaboy.vhr.utils.CommentGenerator
<commentGenerator type="org.javaboy.vhr.utils.CommentGenerator">
<!-- 是否去除自動生成的註釋 true：是 ： false:否 -->
<property name="suppressAllComments" value="true"/>
<property name="suppressDate" value="true"/>
<property name="addRemarkComments" value="true"/>
</commentGenerator>
CommentGenerator程式碼
**
* @author 86138
* @date 2024-05-01 13:27:15
* @description 新增自定義註釋
*/
public class CommentGenerator extends DefaultCommentGenerator {
private boolean addRemarkComments = false;
/**
* 設定使用者配置的引數
*/
@Override
public void addConfigurationProperties(Properties properties) {
super.addConfigurationProperties(properties);
this.addRemarkComments = StringUtility.isTrue(properties.getProperty("addRemarkComments"));
}
/**
* 給欄位新增註釋
*/
@Override
public void addFieldComment(Field field, IntrospectedTable introspectedTable,
IntrospectedColumn introspectedColumn) {
String remarks = introspectedColumn.getRemarks();
//根據引數和備註資訊判斷是否新增備註資訊
if (addRemarkComments && StringUtility.stringHasValue(remarks)) {
addFieldJavaDoc(field, remarks);
}
}
/**
* 給model的欄位新增註釋
*/
private void addFieldJavaDoc(Field field, String remarks) {
//文件註釋開始
field.addJavaDocLine("/**");
//獲取資料庫欄位的備註資訊
String[] remarkLines = remarks.split(System.getProperty("line.separator"));
for (String remarkLine : remarkLines) {
field.addJavaDocLine(" * " + remarkLine);
}
addJavadocTag(field, false);
field.addJavaDocLine(" */");
}
}
3.7 生成器
以上步驟做完後，我們就要寫我們的逆向工程生成器啦，呼叫org.mybatis.generator.api中的MyBatisGenerator生成器進行實現。注意：當生成的程式碼重複時，覆蓋原始碼！
Generator程式碼
/**
* @author 86138
* @date 2024-05-01 13:35:22
* @description 逆向工程生成器
*/
public class Generator {
public static void main(String[] args) throws Exception {
//MBG 執行過程中的警告資訊
List<String> warnings = new ArrayList<String>();
//當生成的程式碼重複時，覆蓋原始碼
boolean overwrite = true;
//讀取我們的 MBG 配置檔案
InputStream is = Generator.class.getResourceAsStream("/generatorConfig.xml");
ConfigurationParser cp = new ConfigurationParser(warnings);
Configuration config = cp.parseConfiguration(is);
is.close();
DefaultShellCallback callback = new DefaultShellCallback(overwrite);
//建立 MBG
MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
//執行生成程式碼
myBatisGenerator.generate(null);
//輸出警告資訊
for (String warning : warnings) {
System.out.println(warning);
}
}
}
3.8 結果展示
直接執行上述的Generator類的main方法，就會自動讀取資料庫中的表，並生成對應的實體類與對映啦，以及簡單的增刪改查功能程式碼。
09:07:48.051 [main] DEBUG org.mybatis.generator.logging.LogFactory - Logging initialized using 'org.mybatis.generator.logging.slf4j.Slf4jLoggingLogFactory@1dde4cb2' adapter.
09:07:48.054 [main] DEBUG org.mybatis.generator.internal.db.DatabaseIntrospector - Retrieving column information for table "user"
09:07:48.086 [main] DEBUG org.mybatis.generator.internal.db.DatabaseIntrospector - Found column "id", data type 4, in table "vhr..user"
09:07:48.086 [main] DEBUG org.mybatis.generator.internal.db.DatabaseIntrospector - Found column "name", data type 12, in table "vhr..user"
09:07:48.086 [main] DEBUG org.mybatis.generator.internal.db.DatabaseIntrospector - Found column "phone_num", data type 12, in table "vhr..user"
09:07:48.086 [main] DEBUG org.mybatis.generator.internal.db.DatabaseIntrospector - Found column "address", data type 12, in table "vhr..user"
【生成檔案】
四、方案二
基於方案一，我們可以快速的根據資料庫中的表進行逆向工程的建立，大量的減少了我們的重複性工作，但是！它的實現還是比較複雜的，generatorConfiguration配置中的內容豐富且複雜，比較難記，而且在原有程式碼中需要寫一定的程式碼量才能實現。
接下來我們要說的這種方案二，幾乎不用寫任何程式碼，只需要點點點就可以實現逆向工程啦，如果你使用idea的話，這種方案尤其方便。
4.1 下載MybatisX外掛
在外掛管理中下載MybatisX外掛
4.2 配置資料來源
在idea的database中配置資料來源，這裡以MySQL為例，需要注意時區的配置。
點選Test Connection 測試成功說明配置完成啦
4.3 配置maven依賴
<!--lombok依賴-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<!--MyBatis Plus依賴-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.1.0</version>
</dependency>
4.4 配置生成規則
1）開啟剛剛配置好的本地資料庫，選擇你想構建的資料表，右鍵 -> MybatisX-Generator。
2）選擇專案包路徑、實體包名、表名；
3) next後繼續配置mapper、xml、service的生成路徑以及需要的註釋功能，hashCode/equals、Lombk註解等等。
4.5 結果展示
在上一步的最後配置完成，點選Finish按鈕，檢視結果，在對應的路徑下成功的生成了我們需要的檔案。
五、總結
這兩種方案各有優劣：
- 方案一實現複雜，但可以滿足基本的增刪改查的實現，並且熟練的掌握generatorConfiguation配置的編輯，能實現更強大的功能；
- 方案二，實現簡單，只需要頁面點幾下就可以完成完整的結構，但內容需要我們自己去實現。大家可以根據自己的日常開發場景，進行合理選擇。
六、結尾彩蛋
如果本篇部落格對您有一定的幫助，大家記得留言+點贊+收藏呀。原創不易，轉載請聯絡Build哥！