用了MyBatis的同行，應(yīng)該見過foreach，它一般是這樣用的：

<select id="foreachTest" resultType="Blog">
    select * from t_blog where id in
    <foreach collection="list" index="index" item="item" open="(" separator="," close=")">
        #{item}
    </foreach>
</select>

難記

有沒有人跟我一樣，覺得

<foreach collection="list" index="index" item="item" open="(" separator="," close=")">

這一串很啰嗦？每次寫<foreach>都因?yàn)橛洸蛔『团掠洸焕危檎液蛷?fù)制現(xiàn)有的來改。假如可以簡化，就不至于要這樣了。
一項(xiàng)項(xiàng)來分析：

• foreach這個(gè)是xml標(biāo)簽，少不了。
• collection可以通過探測參數(shù)類型+數(shù)量，從而在大多數(shù)情況下，知道對(duì)應(yīng)哪個(gè)參數(shù)而省略。
• index這個(gè)就更加不用寫了，幸好它真的是用時(shí)才寫，不用不寫。
• item假如缺省值就是item，則可能會(huì)有一些沖突，比如某個(gè)表名叫item，會(huì)不會(huì)讓人掉坑里才豁然知道緣由？想不清楚。
• open難道不是通常都是"("嗎？但只要不寫open，缺省值是沒有，即是空串，很無語，強(qiáng)迫我們幾乎每個(gè)foreach都要寫open="("
• separator難道不是絕大多數(shù)都是","嗎？缺省值也是空串，更無語
• close和open同理。

空集合問題

還有一個(gè)問題，當(dāng)傳入的集合是空集的時(shí)候，比如上面這個(gè)例子，某些情況計(jì)算出來的list是空集合。按道理，既然list是id的集合，空集合意味著應(yīng)該select到0條記錄。但結(jié)果卻是報(bào)SQL語法錯(cuò)誤。原因是生成的SQL長這樣：

select * from t_blog where id in ;      -- 為了明顯，我補(bǔ)了個(gè)分號(hào)

是的，按SQL語法，in后面的小括號(hào)是不能沒有內(nèi)容的，小括號(hào)本身也是不能省的，抓狂。

在以前，我接觸的項(xiàng)目有DAO層（指java interface mapper之上的一層），我會(huì)在DAO層先判斷，若list是Empty，直接返回空集，否則再執(zhí)行mybatis的查詢。后來的一些項(xiàng)目，推崇簡單化，沒有DAO層，Service直接調(diào)用java interface mapper。把這個(gè)“判空返回空”的邏輯寫在Service就顯得別扭。難道MyBatis就不能優(yōu)雅地解決這個(gè)問題嗎？

解法

直到后來看到了這種寫法：

<select id="foreachTest" resultType="Blog">
    select * from t_blog
  <where>
    <foreach collection="list" index="index" item="item" open=" id in (" separator="," close=")">
        #{item}
    </foreach>
  </where>
</select>

特別之處在于open="id in ("，與一開始的id in寫在foreach外面有什么不同呢？經(jīng)過實(shí)驗(yàn)，結(jié)論是這樣的：

• 當(dāng)list非空時(shí)，兩者并無區(qū)別。
• 當(dāng)list為空時(shí)，既不生成open值，也不生成close值！

所以，當(dāng)list為空時(shí)，SQL就是：select * from t_blog，也就沒有違反語法。但是查到的是全部的記錄，而不是預(yù)期的“0條記錄”。
改進(jìn)為這樣寫

<select id="foreachTest" resultType="Blog">
    select * from t_blog
  <where>
    1 = 0 
    <foreach collection="list" index="index" item="item" open=" or id in (" separator="," close=")">
        #{item}
    </foreach>
  </where>
</select>

如果，還有其它的and條件，則需要在or的兩邊加上小括號(hào)。

<select id="foreachTest" resultType="Blog">
    select * from t_blog
  <where>
    (1 = 0 
    <foreach collection="list" index="index" item="item" open=" or id in (" separator="," close=")">
        #{item}
    </foreach>
    )
    and ...
  </where>
</select>

這樣，不論list是否empty，都會(huì)生成正確語法和功能的SQL語句。有興趣的朋友可自行推導(dǎo)。

優(yōu)雅的解法

但我覺得上面的寫法不夠優(yōu)雅，經(jīng)過實(shí)驗(yàn)，找到一種我認(rèn)為更優(yōu)雅的寫法：

<select id="foreachTest" resultType="Blog">
    select * from t_blog
  <where>
    <foreach collection="list" index="index" item="item" open=" and id in (" close="-1)">
        #{item},
    </foreach>
    and ...
  </where>
</select>

留意：

• separator沒了，缺省就是空串
• #{item}后面有了個(gè)逗號(hào)(,)
• close里多了個(gè)-1

是這樣的思路，我們要解決的是in后面是空的問題，假如在list為empty時(shí)，也能“塞”入一個(gè)不存在的值，比如這里規(guī)定id不可能是-1，那么生成的sql就是where id in (-1)，語法沒錯(cuò)，且查不到數(shù)據(jù)。而當(dāng)list非空時(shí)，生成的sql如where id in (1,2,3,-1)，雖然有-1，但不影響查出來的結(jié)果。只是本來3是最后一個(gè)，不需要加逗號(hào)，由于后面固定有-1，所以每個(gè)#{item}后面固定要有逗號(hào)，如果逗號(hào)放在separator，則只出現(xiàn)在各個(gè)id之間，放在#{item}就可以出現(xiàn)在每個(gè)item后了。

通過此案例，回頭一看，思路一下子就打開了。open里的寫法可以很靈活，只要符合SQL語法的，理論上都可以往open里放。separator、close也一樣?？赡茏髡呔褪且?yàn)檫@些靈活的用法，所以干脆讓它們的缺省值是空串。這本無標(biāo)準(zhǔn)，所以不能說這樣做就是對(duì)或錯(cuò)的。

一種簡化<foreach>的設(shè)想

但如果允許我修改設(shè)計(jì)的話，我會(huì)讓open的缺省值為"("，separator的缺省值為", "，close的缺省值為")"。因?yàn)榇蠖鄶?shù)情況下它們的值就是這樣。假如特殊情況下，就想要它的值為空串，可以這么寫open=""，何嘗不可。這樣做的好處是，通常情況下foreach會(huì)很簡潔：

<foreach collection="list" item="item">
    #{item}
</foreach>

例如，像文章開頭分析的那樣，還可以去掉collection，甚至是item，那成為這樣的極簡：

<foreach>
    #{item}
</foreach>

整體這樣：

<select id="foreachTest" resultType="Blog">
    select * from t_blog where id in
    <foreach>
        #{item}
    </foreach>
</select>

簡化成這樣，誰還不敢直接寫<foreach>了？

總結(jié)

本文提出了一種簡化<foreach>寫法的設(shè)想，更重要的是通過解決空集時(shí)生成的SQL語法問題，更深刻地理解MyBatis的foreach的生成機(jī)制。打開思路，更靈活地利用open、separator、close，得到符合預(yù)期的SQL，還兼顧到代碼的優(yōu)雅。

到此這篇關(guān)于重新認(rèn)識(shí)MyBatis的foreach的文章就介紹到這了,更多相關(guān)MyBatis的foreach內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論