MyBatis逆向工程程式碼的生成以及使用詳解(持續更新)

阿新 • • 發佈：2019-01-25

覺得文章太長可以直接看文章末尾的總結吐舌頭。

逆向工程簡介

什麼是逆向工程：

mybatis需要程式設計師自己編寫sql語句，mybatis官方提供逆向工程，可以針對單表自動生成mybatis執行所需要的程式碼（mapper.java、mapper.xml、pojo…），可以讓程式設計師將更多的精力放在繁雜的業務邏輯上。

企業實際開發中，常用的逆向工程方式：由資料庫的表生成java程式碼。

之所以強調單表兩個字，是因為Mybatis逆向工程生成的Mapper所進行的操作都是針對單表的，也許你可能會覺得那這就有點雞肋了，但是在大型專案中，很少有複雜的多表關聯查詢，所以作用還是很大的。

下載逆向工程：

逆向工程的使用

執行逆向工程（摘自官網）：

翻譯過來就是：

從帶有XML配置的命令提示符
作為具有XML配置的Ant任務
作為一個Maven外掛
從另一個java程式，基於XML配置
從另一個java程式，基於java的配置
通過Eclipse外掛

一般來說，我們會選擇使用一個Java程式，基於XML配置來生成程式碼，下面來介紹具體操作。

程式碼的生成

資料表：

Java工程結構：

GeneratorSqlmap.java

package xin.luxinda.NXProject;

import java.io.File;
import java.util.*;

import org.mybatis.generator.api.MyBatisGenerator;
import org.mybatis.generator.config.Configuration;
import org.mybatis.generator.config.xml.ConfigurationParser;
import org.mybatis.generator.internal.DefaultShellCallback;

public class GeneratorSqlmap {

	public void generator() throws Exception {
		List<String> warnings = new ArrayList<String>();
		boolean overwrite = true;
		// 指定配置檔案
		File configFile = new File("./config/NXProject/generatorConfig.xml");
		ConfigurationParser cp = new ConfigurationParser(warnings);
		Configuration config = cp.parseConfiguration(configFile);
		DefaultShellCallback callback = new DefaultShellCallback(overwrite);
		MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
		myBatisGenerator.generate(null);
	}

	// 執行main方法以生成程式碼
	public static void main(String[] args) {
		try {
			GeneratorSqlmap generatorSqlmap = new GeneratorSqlmap();
			generatorSqlmap.generator();
		} catch (Exception e) {
			e.printStackTrace();
		}
	}
}

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="DB2Tables" targetRuntime="MyBatis3">
    <commentGenerator>
    	<!-- 是否去除自動生成的註釋 -->
    	<property name="suppressAllComments" value="true"/>
    </commentGenerator>
    <!-- Mysql資料庫連線的資訊：驅動類、連線地址、使用者名稱、密碼 -->
    <jdbcConnection driverClass="com.mysql.jdbc.Driver"
        connectionURL="jdbc:mysql://localhost:3306/e3mall"
        userId="root"
        password="111">
    </jdbcConnection>
    <!-- Oracle資料庫
	    <jdbcConnection driverClass="oracle.jdbc.OracleDriver"
	        connectionURL="jdbc:oracle:thin:@127.0.0.1:1521:yycg"
	        userId="yycg"
	        password="yycg">
	    </jdbcConnection> 
    -->
	
	<!-- 預設為false，把JDBC DECIMAL 和NUMERIC型別解析為Integer，為true時
	把JDBC DECIMAL 和NUMERIC型別解析為java.math.BigDecimal -->
    <javaTypeResolver >
		<property name="forceBigDecimals" value="false" />
    </javaTypeResolver>
	
	<!-- targetProject：生成POJO類的位置 -->
    <javaModelGenerator targetPackage="cn.e3mall.pojo" targetProject=".\src">
		<!-- enableSubPackages:是否讓schema作為包的字尾 -->
		<property name="enableSubPackages" value="false" />
		<!-- 從資料庫返回的值被清理前後的空格 -->
		<property name="trimStrings" value="true" />
    </javaModelGenerator>
    
	<!-- targetProject：mapper對映檔案生成的位置 -->
    <sqlMapGenerator targetPackage="cn.e3mall.mapper"  targetProject=".\src">
		<!-- enableSubPackages:是否讓schema作為包的字尾 -->
		<property name="enableSubPackages" value="false" />
    </sqlMapGenerator>
    
	<!-- targetProject：mapper介面生成的的位置 -->
	<javaClientGenerator type="XMLMAPPER" targetPackage="cn.e3mall.mapper"  targetProject=".\src">
		<!-- enableSubPackages:是否讓schema作為包的字尾 -->
		<property name="enableSubPackages" value="false" />
    </javaClientGenerator>
    
	<!-- 指定資料表 -->
	<table schema="" tableName="tb_content"></table>
	<table schema="" tableName="tb_content_category"></table>
	<table schema="" tableName="tb_item"></table>
	<table schema="" tableName="tb_item_cat"></table>
	<table schema="" tableName="tb_item_desc"></table>
	<table schema="" tableName="tb_item_param"></table>
	<table schema="" tableName="tb_item_param_item"></table>
	<table schema="" tableName="tb_order"></table>
	<table schema="" tableName="tb_order_item"></table>
	<table schema="" tableName="tb_order_shipping"></table>
	<table schema="" tableName="tb_user"></table>
    
    <!-- 有些表的欄位需要指定java型別 
    <table schema="DB2ADMIN" tableName="ALLTYPES" domainObjectName="Customer" >
      <property name="useActualColumnNames" value="true"/>
      <generatedKey column="ID" sqlStatement="DB2" identity="true" />
      <columnOverride column="DATE_FIELD" property="startDate" />
      <ignoreColumn column="FRED" />
      <columnOverride column="LONG_VARCHAR_FIELD" jdbcType="VARCHAR" />
    </table> -->

  </context>
</generatorConfiguration>

配置檔案需要修改的內容：

資料庫驅動、地址、使用者名稱、密碼
POJO類、mapper介面、mapper對映檔案生成的位置
指定資料表

配置完成之後執行GeneratorSqlmap.java中的main方法就會生成對應資料表的程式碼，生成後記得右鍵專案名重新整理。如果需要再次生成，一定要記得先把原來生成的刪除。

生成的程式碼：

如果有N張表，就會生成2N個POJO，N個mapper.java以及N個mapper.xml，也許你會問，為什麼會生成2N個POJO呢？那是因為他除了常規的POJO之外還生成了用於設定條件的xxxExample，比如圖中的TbItem.java和TbItemExample.java，Example的具體使用會在後面的程式碼使用中詳細說。

程式碼的使用

---------------------------------------------------------------------------------

查詢

首先說一下查詢的不足之處：不能指定查詢的列，只能夠查詢所有列。

我們可以看到，有三個查詢方法（一般來說只有兩個查詢方法，第二個查詢方法只會在特定條件下出現）

方法1：selectByExample(TbItemDescExample example)

返回值：List<TbItemDesc>

作用：通過特定限制條件查詢資訊，example用於生成一個Criteria物件來設定查詢條件

例：

TbItemDescExample example = new TbItemDescExample();
cn.e3mall.pojo.TbItemDescExample.Criteria criteria = example.createCriteria();
long minId = 0;
long maxId = 50;
criteria.andItemIdBetween(minId, maxId); // 設定條件：ItemId在 0 和 50 之間
		
List<Long> ids = new ArrayList<>();
ids.add((long)20);
ids.add((long)40);
ids.add((long)60);
criteria.andItemIdIn(ids);	// 設定條件：ItemId等於 20 或 40 或 60
		
criteria.andCreatedIsNotNull(); // 設定條件：Created列屬性不為空
		
long id = 40;
criteria.andItemIdEqualTo(id); // 設定條件：ItemId等於40
		
// 執行查詢
List<TbItemDesc> selectByExample = itemDescMapper.selectByExample(example);

具體可設定的條件很多很多，根據表的結構的不同會有不同的可限制條件，比如：

在這裡就不一個一個解釋了，根據字面意思，很好理解的。

方法2：selectByPrimaryKey(Long itemId)

返回值：TbItemDesc

作用：通過主鍵查詢

方法3：selectByExampleWithBLOBs(TbItemDescExample example)

返回值：List<TbItemDesc>

作用：根據特定限制條件查詢，返回值包含型別為text的列(預設查詢並不會返回該列的資訊)。example用於生成一個Criteria物件來設定查詢條件，具體使用方法和方法1是一樣的，唯一的把不同就是返回值是所有列。

---------------------------------------------------------------------------------

插入

插入很簡單，只有兩個方法，方法傳入的引數都是POJO，返回值都是int型別的受影響的行數。不同之處在於insert會插入所有的資訊，如果傳入的物件某一屬性為空，則插入空，如果資料庫中設定了預設值，預設值就失效了。而insertSelective不同，他只會插入含有資料的屬性，對於為空的屬性，不予以處理，這樣的話如果資料庫中設定有預設值，就不會被空值覆蓋了。

---------------------------------------------------------------------------------

刪除

方法1：根據特定限制條件刪除，具體使用的方法和查詢的時候是一樣的。
方法2：根據主鍵刪除。

---------------------------------------------------------------------------------

更新

更新在這裡有6個方法，可以分為2組：

第一組：根據特定限制條件進行更新

引數1：TbItemDesc record -> 要更新的物件

引數2：TbItemDescExample example -> 生成一個Criteria物件來設定查詢條件

方法1：updateByExample(TbItemDesc record, TbItemDescExample example)

作用：根據特定的限制條件進行更新除了text型別(資料庫)的所有列。

方法2：updateByExampleSelective(TbItemDesc record, TbItemDescExample example)

作用：根據特定的限制條件更新所有設定了值的列。

方法3：updateByExampleWithBLOBs(TbItemDesc record, TbItemDescExample example)

作用：根據特定的限制條件進行更新所有列。

第二組：根據ID進行更新

引數：TbItemDesc record -> 要更新的物件

方法1：updateByPrimaryKey(TbItemDesc record)

作用：通過ID更新除了text型別(資料庫)的所有列

方法2：updateByPrimaryKeySelective(TbItemDesc record)

作用：通過ID更新所有設定了值的列。

方法3：updateByPrimaryKeyWithBLOBs(TbItemDesc record)

作用：通過ID進行更新所有列。

---------------------------------------------------------------------------------

計數

計數就一個方法，根據限制條件計數，example在前面已經說過了，在這裡就不敘述了。

---------------------------------------------------------------------------------

總結：

Example和Primarykey用來指定要刪除 / 更新 / 查詢的行。
不加字尾、Selective字尾、WithBLOBs字尾用來限制要刪除 / 更新 / 查詢的列。

參考圖（不嚴謹，僅供理解參考）：

持續更新，如有錯誤之處還望指正......

MyBatis逆向工程程式碼的生成以及使用詳解(持續更新)

逆向工程簡介

什麼是逆向工程：

逆向工程的使用

程式碼的生成

資料表：

Java工程結構：

生成的程式碼：

程式碼的使用

---------------------------------------------------------------------------------

查詢

---------------------------------------------------------------------------------

插入

---------------------------------------------------------------------------------

刪除

---------------------------------------------------------------------------------

更新

---------------------------------------------------------------------------------

計數

---------------------------------------------------------------------------------

總結：

相關推薦