以前，我們都把對資料庫的增刪改查語句寫在xml檔案中(詳見:《程式設計師成長筆記(一)》第三部分，第四章，第四節)。

由於Java註解的簡潔高效，在Java註解的思想(幹掉xml)下，現在越來越多的人使用java註解來進行增刪改查操作。

而且MyBatis3也支援並鼓勵我們使用Java註解來進行CRUD操作。

注:CRUD即:增Create、查Retrive、刪Delete、改Update。

下面以示例進行說明

本例子的軟硬體環境:

     Windows7、Eclipse(Oxygen.3a Release)、Jdk1.8、MyBatis(3.4.5)、SpringBoot(2.0.1.RELEASE)、MySQL。

一級顏色:綠色    二級顏色:黃色     注意事項:紅色      插入說明:藍

增@Insert

先給出MySQL資料庫中的相關employee表

增(簡單增)示例:

資料訪問層中的查詢語句示例:

注:如果引數只有一個，那麼可以直接#{屬性名}進行屬性值獲取，如果有多個引數，必須使用@Param指明。

增(同時獲取主鍵)方式一:

注:如果只有一個引數的話，那麼可以不使用@Param，此時#{xxx}和keyProperty = “xxx”中的xxx可以直接寫實體類模型的屬性名。

注:如果有多個引數，那麼我們需要使用@Param來進行指明，當然也推薦一個引數時也使用@Param註解。如果使用@Param指明引數了，且在註解中使用到了該引數的某些值時，一定要指明是該引數的。

如:這裡的keyProperty = “e.id”是可以的;而keyProperty = “id”不可以。

增(同時獲取主鍵)方式二:

注:方式二的注意事項與方式一一樣。

增(既有實體引數,又有普通引數):

注:使用註解CRUD時，可以多個引數，這些引數可以是普通引數，也可以是複雜引數。

注:使用自動獲取主鍵@Options或@SelectKey能正常獲取到該物件插入資料庫表中後的主鍵。

刪@Delete

先給出MySQL資料庫中的相關employee表

刪(簡單刪)示例:

改@Update

先給出MySQL資料庫中的相關employee表

改(簡單改)示例:

查@Select

先給出MySQL資料庫中的相關employee表

簡單查(以“一般”型別 接收資料)示例:

資料訪問層中的查詢語句示例一:

資料訪問層中的查詢語句示例二:

簡單查(以 物件模型 接收資料)示例:

資料訪問層中的查詢語句示例:

 注:id = true出現在哪裡，就說明那個引數是主鍵。

如:

就說明idCard是主鍵。

注:如果接收查詢結果的，是一個物件模型，那麼程式是通過對應的有參構造或則無參構造+setter方法，將結果放進實體類模    型的。

   即:這就要求我們，在建立實體類模型時，一定要建立有對應的有參構造或無參構造+setter方法。

注:如果column名字與property不一致，那麼需要在Result中指出來。

簡單查(以 Map<String, Object> 接收資料)示例:

上圖中的此寫法只能接收一條(一行)資料內容。如果想接收多條(多行)資料內容，那麼可以:

法一：以形如List<Map<String, Object>>這樣的來接收多行資料。一個Map<String, Object>只儲存一行資料。

法二：

   每一行資料專門拿一個物件模型來接收，並指定以該模型的哪一個屬性作為key。

注:法一是List的每一個Map中只有一條資料;法二是多條資料都放在同一個Map中，以不同的key來對應不同的行。

注:法二依賴於物件模型，且法二在選擇以物件的什麼屬性作為key時，要考慮是否會重複(如果作為key的屬性的屬性
     值可能會重複,那麼在Map裡可能發生資料覆蓋的情況)。

簡單查(以 集合型別 接收資料)示例:

示例一:

示例二:

注:如果查詢結果橫跨多個實體模型，那麼我們使用List來接收資料。

動態語句:

我們都知道如何在xml中處理動態的SQL語句，那麼使用Java註解如何處理呢？需要使用@xxxProvider，並指定(經過邏輯處理後)返回SQL語句的方法，以及該方法所在的類。

注:使用@xxxProvider時，就不要使用@Param了，否者容易出錯。

注:xxx為Insert、Update、Delete、Select。

注:這些(代理)方法最好不要過載，避免不必要的問題。

注:我們可以單獨建立一個package、建立一個類來放置這些方法，如:

動態增@InsertProvider

單個引數:

資料訪問層中的方法示例:

注:@InsertProvider需要指定(經過邏輯處理後)返回SQL語句的方法，以及該方法所在的類。

給出邏輯處理方法示例:

多個引數:

資料訪問層中的方法示例:

注:@InsertProvider需要指定(經過邏輯處理後)返回SQL語句的方法，以及該方法所在的類。

給出邏輯處理方法示例:

注:如果資料訪問層中的對應的方法有多個引數時，那麼此方法的引數型別必須為Map<String,Object>;

注:此方法需要返回一個SQL字串。

同時獲得主鍵(獲得主鍵的方式和@Insert是一樣的):

獲得主鍵方式一:

獲得主鍵方式二:

批量增:

提示:批量增也能同時獲取到主鍵，與上面的單個增的自動獲取主鍵方式一樣；這裡就不再演示了。

資料訪問層中的方法示例:

注:@InsertProvider需要指定(經過邏輯處理後)返回SQL語句的方法，以及該方法所在的類。

給出邏輯處理方法示例一(直接迴圈拼接sql語句):

注:使用#{}防止sql注入

注:在拼接的sql字串中,用的直接是map中的key(即:上圖Map中的key為listTest),而不是我們新new的集合物件(我們新new一個集合來獲取map中對應key的集合的目的是:幫助我們知道集合的長度，進而進行邏輯判斷)。

   呼叫上圖的方法，傳過去的是這個:

注:由於我們的目的只是利用新new的集合來獲取對應key的集合的長度，所以，即使我們不使用泛型，直接使用Map<String,Object>，(經測試)也是可以的。

給出邏輯處理方法示例二(採用MessageFormat拼接sql語句):

注:MessageFormat模板中的{0}即為第一個佔位符。

注:使用#{}防止sql注入

注:和方式一一樣，引數可以直接Map<String, Object>也行。

     拼接sql字串時,用的直接是map中的key(即:上圖Map中的key為listTest),而不是我們新new的集合物件。

特別說明:

在資料訪問層（即:Mapper層）呼叫SQL的代理方法時，我們也可以直接傳遞List過去，代理方法用Map接收，如:

Mapper層中的方法

處理SQL的方法

注:此時Mapper中的方法裡的引數前，務必要有@Param，其值將被作為Map中的key;否者就要嚴格按照原始碼中的arg0之類的作為key了，最下面會講到。

注:Provider中接收時，可以在接收引數時，就指定對應的泛型；也可以用Map<String, Object>接收後，再拆箱。

如果我們是將連庫操作的資料放在Map<String ,Object>中項資料庫表中插入的話,我們可以這麼獲取主鍵

Mapper層中的方法為:

注:這裡以@Options為例的，使用@SelectKey獲取主鍵也是一樣的。

我們在呼叫dynamicInsertMultiParam這個方法時,在傳過去的Map引數中,多放一個key，來接收新增後查詢出來的id,如:

注意:key要和@Options註解中的keyProperty對應。

可以看見,獲取到了新增後的id:

動態刪@DeleteProvider

資料訪問層中的方法示例:

注:@InsertProvider需要指定(經過邏輯處理後)返回SQL語句的方法，以及該方法所在的類。

給出邏輯處理方法示例:

注:此方法需要返回一個SQL字串。

注:當需要傳遞多個引數時，處理方式與@InsertProvider一樣。

動態改@DeleteUpdate

資料訪問層中的方法示例:

注:@InsertProvider需要指定(經過邏輯處理後)返回SQL語句的方法，以及該方法所在的類。

給出邏輯處理方法示例:

注:此方法需要返回一個SQL字串。

注:當需要傳遞多個引數時，處理方式與@InsertProvider一樣。

動態查@SelectProvider(示例一)

資料訪問層中的方法示例:

注:@InsertProvider需要指定(經過邏輯處理後)返回SQL語句的方法，以及該方法所在的類。

注:@InsertProvide與@Insert一樣，如果column與property不一致，那麼需要使用@Results指明對應關係。

給出邏輯處理方法示例:

注:因為引數沒有放入一個實體類或Map中，所以這裡#{}無法使用;因此建議:如果是使用了xxxProvider註解，那麼引數都儘量放入實體類或Map中進行傳參。

注:此方法需要返回一個SQL字串。

注:當需要傳遞多個引數時，處理方式與@InsertProvider一樣。

持有物件、集合:

宣告:在分散式叢集專案中，我們一般都會盡量避免顯示的主外來鍵關係、持有物件、持有集合等情況，目的是:降低耦合，方便程式的擴充套件以及後期維護等。

注:如果遇見了持有物件持有集合等情況，如果多次查詢能夠解決問題，那麼就儘量避免一次性全部查詢；如果非要一次查詢解決持有物件持有集合的問題，那麼需要引入xml檔案，在xml檔案中配置對映。

注:雖然@Result註解有@One、@Many註解，但是目前來說個人感覺並不那麼好用。

動態查@SelectProvider(示例二)

資料訪問層中的方法示例

Sql代理方法為

單元測試中的測試方法為

xml示例(持有物件):

說明:一個people持有一個身份證idcard物件

People實體類:

people表:

Idcard實體類:

idcard表:

xml檔案位置:

資料訪問層中的方法:

xml中的相關配置為:

注:更多關於xml中配置sql對映的內容，詳見《程式設計師成長筆記(一)》第三部分，第四章，第四節。

Mapper介面中,呼叫方法時，引數是這麼與sqlProvider中的形參匹配的(這是原始碼)

extractProviderMethodArguments方法是這樣的：

所以，其實我們的mapper中的方法裡，可以有多個形參，代理方法中也可以有多個形參如:

對應的代理方法為

注:由原始碼可知:時通過key來進行引數的匹配的。我們可以通過使用@Param來指定引數的key為多少,這樣就能準確地匹配了。

注:引數前其實不使用@Param也是可以的。但是不建議這麼做，因為如果我們不使用@Param來指定key的話，那麼程式就會按照引數的順序依次以arg0、arg1、arg2……來作為Map中的key;所以如果我們在mapper中對應的方的引數前不寫key的話，那麼在sqlProvider中的對應的方法的形參的順序就要和傳入時引數的順序一致。而使用@Param的話，則沒有此顧忌。

注:如果Mapper層中的方法傳遞多引數時,部分引數前使用了@Param()註解(或sqlProvider中對應方法的部分形參前使用了@Param()註解),那麼其會頂替原來預設的key;以Mapper中的方法為例:

那麼key依次為map1 和 arg1,即:map1取代了arg0作為key。對應sqlProvider中就要以相應的key取值。

注:更多細節上的使用,這裡就不再一一說明了。感興趣的話，可以去看下對應的原始碼。

使用Junit對所寫方法進行的測試

如有不當之處，歡迎指正

本文已經被收錄進《程式設計師成長筆記(二)》，作者JustryDeng