概 述
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 />指定自動生成的 POJO置於哪個包下 -
<sqlMapGenerator />指定自動生成的 mapper.xml置於哪個包下 -
<javaClientGenerator />指定自動生成的 DAO接口置於哪個包下 -
<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 程序羊