Spring Boot專案利用MyBatis Generator進行資料層程式碼自動生成
概 述
MyBatis Generator (簡稱 MBG) 是一個用於 MyBatis和 iBATIS的程式碼生成器。它可以為 MyBatis的所有版本以及 2.2.0之後的 iBATIS版本自動生成 ORM層程式碼，典型地包括我們日常需要手寫的 POJO 、 mapper xml 以及 mapper 介面等。MyBatis Generator 自動生成的 ORM層程式碼幾乎可以應對大部分 CRUD 資料表操作場景，可謂是一個生產力工具啊！
注： 本文首發於 My Personal Blog：CodeSheep·程式羊 ，歡迎光臨 小站
資料庫準備與工程搭建
- 首先我們準備一個 MySQL資料表
user_info用於下文實驗
裡面插入了若干條資料：
- 新建一個Spring Boot 工程
- 引入 MyBatis Generator 依賴
<dependency> <groupId>org.mybatis.generator</groupId> <artifactId>mybatis-generator-core</artifactId> <version>1.3.7</version> <scope>provided</scope> </dependency>
- 引入 MyBatis Generator Maven 外掛
<plugin> <groupId>org.mybatis.generator</groupId> <artifactId>mybatis-generator-maven-plugin</artifactId> <version>1.3.7</version> <configuration> <configurationFile>src/main/resources/mybatis-generator.xml</configurationFile> <overwrite>true</overwrite> </configuration> <dependencies> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>8.0.12</version> </dependency> </dependencies> </plugin>
MyBatis Generator Maven 外掛引入以後，我們可以在 Spring Boot工程的 Maven外掛工具欄中看到新增的外掛選項，類似下圖：
準備 MyBatis Generator 配置檔案
MyBatis Generator 也需要一個 xml格式的配置檔案，該檔案的位置配在了上文 引入 MyBatis Generator Maven 外掛的 xml配置裡，即 src/main/resources/mybatis-generator.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="MySql" defaultModelType="flat"> <plugin type="org.mybatis.generator.plugins.SerializablePlugin" /> <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://121.196.123.245:3306/demo" userId="root" password="xxxxxx" /> <javaModelGenerator targetPackage="cn.codesheep.springbt_mybatis_generator.entity" targetProject="src/main/java"></javaModelGenerator> <sqlMapGenerator targetPackage="mapper"targetProject="src/main/resources"></sqlMapGenerator> <javaClientGenerator targetPackage="cn.codesheep.springbt_mybatis_generator.mapper" targetProject="src/main/java" type="XMLMAPPER"></javaClientGenerator> <table tableName="user_info"> <property name="modelOnly" value="false"/> </table> </context> </generatorConfiguration>
上面 xml中幾個關鍵的配置簡介如下：
< jdbcConnection /> <javaModelGenerator /> <sqlMapGenerator /> <javaClientGenerator /> <table />
更多關於 MyBatis Generator 配置的內容，可以移步 官方文件 。
執行 MyBatis Generator
直接通過 IDEA的 Maven圖形化外掛來執行 MyBatis Generator，其自動生成的過程 和 生成的結果如下圖所示：
很明顯，通過 MyBatis Generator，已經很方便的幫我們自動生成了 POJO 、 mapper xml 以及 mapper 介面，接下來我們看看自動生成的程式碼怎麼用！
自動生成的程式碼如何使用
我們發現通過 MyBatis Generator自動生成的程式碼中帶有一個 Example檔案，比如上文中的 UserInfoExample ，其實 Example檔案對於平時快速開發還是有很大好處的，它能節省很多寫 sql語句的時間，舉幾個實際的例子吧：
- 單條件模糊搜尋 + 排序
在我們的例子中，假如我想通過使用者名稱 user_name 來在 MySQL資料表 user_info 中進行模糊搜尋，並對結果進行排序，此時利用 UserInfoExample 可以方便快速的實現：
@Autowired
private UserInfoMapper userInfoMapper;
public List<UserInfo> searchUserByUserName( String userName ) {
UserInfoExample userInfoExample = new UserInfoExample();
userInfoExample.createCriteria().andUserNameLike( '%'+ userName +'%' ); // 設定模糊搜尋的條件
String orderByClause = "user_name DESC";
userInfoExample.setOrderByClause( orderByClause );// 設定通過某個欄位排序的條件
return userInfoMapper.selectByExample( userInfoExample );
}
- 多條件精確搜尋
再比如，我們想通過電話號碼 phone 和使用者名稱 user_name 兩個欄位來在資料表 user_info 中實現精確搜尋，則可以如下實現：
public List<UserInfo> multiConditionsSearch( UserInfo userInfo ) {
UserInfoExample userInfoExample = new UserInfoExample();
UserInfoExample.Criteria criteria = userInfoExample.createCriteria();
if( !"".equals(userInfo.getPhone()) )
criteria.andPhoneEqualTo( userInfo.getPhone() );
if( !"".equals(userInfo.getUserName()) )
criteria.andUserNameEqualTo( userInfo.getUserName() );
return userInfoMapper.selectByExample( userInfoExample );
}
很明顯可以看出的是，我們是通過直接編寫程式碼邏輯來取代編寫 SQL語句，因此還是十分直觀和容易理解的！
後 記
由於能力有限，若有錯誤或者不當之處，還請大家批評指正，一起學習交流！
- My Personal Blog： CodeSheep 程式羊