在做mybatis的mapper.xml文件的時候，我們時常用到這樣的情況：動態(tài)生成sql語句的查詢條件，這個時候我們就可以用mybatis的foreach了

foreach元素的屬性主要有item，index，collection，open，separator，close。

• item：集合中元素迭代時的別名，該參數(shù)為必選。
• index：在list和數(shù)組中,index是元素的序號，在map中，index是元素的key，該參數(shù)可選
• open：foreach代碼的開始符號，一般是(和close=")"合用。常用在in(),values()時。該參數(shù)可選
• separator：元素之間的分隔符，例如在in()的時候，separator=","會自動在元素中間用“,“隔開，避免手動輸入逗號導致sql錯誤，如in(1,2,)這樣。該參數(shù)可選。
• close: foreach代碼的關閉符號，一般是)和open="("合用。常用在in(),values()時。該參數(shù)可選。
• collection: 要做foreach的對象，作為入?yún)r，List對象默認用"list"代替作為鍵，數(shù)組對象有"array"代替作為鍵，Map對象沒有默認的鍵。當然在作為入?yún)r可以使用@Param("keyName")來設置鍵，設置keyName后，list,array將會失效。 除了入?yún)⑦@種情況外，還有一種作為參數(shù)對象的某個字段的時候。舉個例子：如果User有屬性List ids。入?yún)⑹荱ser對象，那么這個collection = "ids".如果User有屬性Ids ids;其中Ids是個對象，Ids有個屬性List id;入?yún)⑹荱ser對象，那么collection = "ids.id"

在使用foreach的時候最關鍵的也是最容易出錯的就是collection屬性，該屬性是必須指定的，但是在不同情況下，該屬性的值是不一樣的，主要有一下3種情況：

• 如果傳入的是單參數(shù)且參數(shù)類型是一個List的時候，collection屬性值為list .
• 如果傳入的是單參數(shù)且參數(shù)類型是一個array數(shù)組的時候，collection的屬性值為array .
• 如果傳入的參數(shù)是多個的時候，我們就需要把它們封裝成一個Map了，當然單參數(shù)也可以封裝成map，實際上如果你在傳入?yún)?shù)的時候，在MyBatis里面也是會把它封裝成一個Map的，map的key就是參數(shù)名，所以這個時候collection屬性值就是傳入的List或array對象在自己封裝的map里面的key.

針對最后一條，我們來看一下官方說法：

注意 你可以將一個 List 實例或者數(shù)組作為參數(shù)對象傳給 MyBatis，當你這么做的時候，MyBatis 會自動將它包裝在一個 Map 中并以名稱為鍵。List 實例將會以“l(fā)ist”作為鍵，而數(shù)組實例的鍵將是“array”。

所以，不管是多參數(shù)還是單參數(shù)的list,array類型，都可以封裝為map進行傳遞。如果傳遞的是一個List，則mybatis會封裝為一個list為key，list值為object的map，如果是array，則封裝成一個array為key，array的值為object的map，如果自己封裝呢，則colloection里放的是自己封裝的map里的key值。

源碼分析

由于官方文檔對這塊的使用，描述的比較簡短，細節(jié)上也被忽略掉了(可能是開源項目文檔一貫的問題吧)，也使用不少同學在使用中遇到了問題。特別是foreach這個函數(shù)中，collection屬性做什么用，有什么注意事項。由于文檔不全，這塊只能通過源代碼剖析的方式來分析一下各個屬性的相關要求。

collection屬性的用途是接收輸入的數(shù)組或是List接口實現(xiàn)。但對于其名稱的要求，Mybatis在實現(xiàn)中還是有點不好理解的，所以需要特別注意這一點。

下面開始分析源代碼(筆記使用的是Mybatis 3.0.5版本)

先找到Mybatis執(zhí)行SQL配置解析的入口

MapperMethod.java類中publicObject execute(Object[] args)該方法是執(zhí)行的入口.

針對in集合查詢，對應用就是selectForList或SelctForMap方法。

但不管調(diào)用哪個方法，都會對原來JDK傳入的參數(shù) Object[]類型，通過 getParam方法轉(zhuǎn)換成一個Object,那這個方法是做什么的呢？分析源碼如下：

上圖中標紅的兩處，很驚訝的發(fā)現(xiàn)，一個參數(shù)與多個參數(shù)的處理方式是不同的(后續(xù)很多同學遇到的問題，就有一大部分出自這個地方)。如果參數(shù)個數(shù)大于一個，則會被封裝成Map, key值如果使用了Mybatis的 Param注解，則會使用該key值，否則默認統(tǒng)一使用數(shù)據(jù)序號,從1開始。這個問題先記下，繼續(xù)分析代碼，接下來如果是selectForList操作(其它操作就對應用相應方法),會調(diào)用DefaultSqlSession的publicListselectList(String statement, Object parameter, RowBounds rowBounds)方法

又一個發(fā)現(xiàn)，見源代碼如下：

上圖標紅部分，對參數(shù)又做了一次封裝，我們看一下代碼

現(xiàn)在有點清楚了，如果參數(shù)類型是List,則必須在collecion中指定為list, 如果是數(shù)據(jù)組，則必須在collection屬性中指定為 array.

現(xiàn)在就問題就比較清楚了，如果是一個參數(shù)的話，collection的值取決于你的參數(shù)類型。

如果是多個值的話，除非使用注解Param指定，否則都是數(shù)字開頭，所以在collection中指定什么值都是無用的。下圖是debug顯示結果。

使用方法

單參數(shù)List 類型

<select id="countByUserList" resultType="_int" parameterType="list">
select count(*) from users
 <where>
  id in
  <foreach item="item" collection="list" separator="," open="(" close=")" index="">
   #{item.id, jdbcType=NUMERIC}
  </foreach>
 </where>
</select>

測試代碼：

@Test
 public void shouldHandleComplexNullItem() {
  SqlSession sqlSession = sqlSessionFactory.openSession();
  try {
   Mapper mapper = sqlSession.getMapper(Mapper.class);
   User user1 = new User();
   user1.setId(2);
   user1.setName("User2");
   List<User> users = new ArrayList<User>();
   users.add(user1);
   users.add(null);
   int count = mapper.countByUserList(users);
   Assert.assertEquals(1, count);
  } finally {
   sqlSession.close();
  }
 }

上述collection為array，對應的Mapper代碼：

public List dynamicForeach2Test(int[] ids);

對應的測試代碼：

@Test
 public void dynamicForeach2Test() {
     SqlSession session = Util.getSqlSessionFactory().openSession();
     BlogMapper blogMapper = session.getMapper(BlogMapper.class);
     int[] ids = new int[] {1,3,6,9};
     List blogs = blogMapper.dynamicForeach2Test(ids);
     for (Blog blog : blogs)
     System.out.println(blog);  
     session.close();
 }

3.自己把參數(shù)封裝成Map的類型

<select id="dynamicForeach3Test" resultType="Blog">
     select * from t_blog where title like "%"#{title}"%" and id in
     <foreach collection="ids" index="index" item="item" open="(" separator="," close=")">
        #{item}
     </foreach>
 </select>

上述collection的值為ids，是傳入的參數(shù)Map的key，對應的Mapper代碼：

public List dynamicForeach3Test(Map params);

對應測試代碼：

@Test
  public void dynamicForeach3Test() {
    SqlSession session = Util.getSqlSessionFactory().openSession();
     BlogMapper blogMapper = session.getMapper(BlogMapper.class);
     final List ids = new ArrayList();
     ids.add(1);
     ids.add(2);
     ids.add(3);
     ids.add(6);
     ids.add(7);
     ids.add(9);
    Map params = new HashMap();
     params.put("ids", ids);
     params.put("title", "中國");
    List blogs = blogMapper.dynamicForeach3Test(params);
     for (Blog blog : blogs)
       System.out.println(blog);
     session.close();
   }

注意注意sql語句SELECT * FROM ny_jobs WHERE id IN () 這個會報錯，所以最后判斷一下Ids是有元素的

以上就是本文的全部內(nèi)容，希望對大家的學習有所幫助，也希望大家多多支持腳本之家。

最新評論