Mybatis?List列表In查詢實(shí)現(xiàn)的注意事項(xiàng)說明
在SQL開發(fā)過程中,動(dòng)態(tài)構(gòu)建In集合條件查詢是比較常見的用法,在Mybatis中提供了foreach功能,該功能比較強(qiáng)大,它允許你指定一個(gè)集合,聲明集合項(xiàng)和索引變量,它們可以用在元素體內(nèi)。
它也允許你指定開放和關(guān)閉的字符串,在迭代之間放置分隔符。
這個(gè)元素是很智能的,它不會(huì)偶然地附加多余的分隔符。
下面是一個(gè)演示示例
?<select id="findByIdsMap" resultMap="BaseResultMap"> ??? Select ??? <include refid="Base_Column_List" /> ??? from jria where ID in ???? <foreach item="item" index="index" collection="list" ?????????????????? ?open="(" separator="," close=")"> ?????????????????? #{item} ??????????? </foreach> ?</select>
但由于官方文檔對這塊的使用,描述的比較簡短,細(xì)節(jié)上也被忽略掉了(可能是開源項(xiàng)目文檔一貫的問題吧),也使用不少同學(xué)在使用中遇到了問題。特別是foreach這個(gè)函數(shù)中,collection屬性做什么用,有什么注意事項(xiàng)。由于文檔不全,這塊只能通過源代碼剖析的方式來分析一下各個(gè)屬性的相關(guān)要求。
collection屬性的用途是接收輸入的數(shù)組或是List接口實(shí)現(xiàn)。但對于其名稱的要求,Mybatis在實(shí)現(xiàn)中還是有點(diǎn)不好理解的,所以需要特別注意這一點(diǎn)。
下面開始分析源代碼(筆記使用的是Mybatis 3.0.5版本)
先找到Mybatis執(zhí)行SQL配置解析的入口
MapperMethod.java類中 public Object execute(Object[] args) 該方法是執(zhí)行的入口.
針對 in 集合查詢,對應(yīng)用就是 selectForList 或 SelctForMap 方法。
但不管調(diào)用哪個(gè)方法,都會(huì)對原來JDK傳入的參數(shù) Object[]類型,通過 getParam方法轉(zhuǎn)換成一個(gè)Object,那這個(gè)方法是做什么的呢?
分析源碼如下
上圖中標(biāo)紅的兩處,很驚訝的發(fā)現(xiàn),一個(gè)參數(shù)與多個(gè)參數(shù)的處理方式是不同的(后續(xù)很多同學(xué)遇到的問題,就有一大部分出自這個(gè)地方)。如果參數(shù)個(gè)數(shù)大于一個(gè),則會(huì)被封裝成Map, key值如果使用了Mybatis的 Param注解,則會(huì)使用該key值,否則默認(rèn)統(tǒng)一使用數(shù)據(jù)序號,從1開始。這個(gè)問題先記下,繼續(xù)分析代碼,接下來如果是selectForList操作(其它操作就對應(yīng)用相應(yīng)方法),會(huì)調(diào)用DefaultSqlSession的public List selectList(String statement, Object parameter, RowBounds rowBounds) 方法
又一個(gè)發(fā)現(xiàn),見源代碼如下
上圖標(biāo)紅部分,對參數(shù)又做了一次封裝,我們看一下代碼
現(xiàn)在有點(diǎn)清楚了,如果參數(shù)類型是List,則必須在collecion中指定為list, 如果是數(shù)據(jù)組,則必須在collection屬性中指定為 array.
現(xiàn)在就問題就比較清楚了,如果是一個(gè)參數(shù)的話,collection的值取決于你的參數(shù)類型。
如果是多個(gè)值的話,除非使用注解Param指定,否則都是數(shù)字開頭,所以在collection中指定什么值都是無用的。下圖是debug顯示結(jié)果。
針對上面分析的結(jié)果,下面給出了一個(gè)使用的解決方案,希望對大家對幫助。
在使用這個(gè)功能是需要特別注意以下規(guī)則
1. 當(dāng)查詢的參數(shù)只有一個(gè)時(shí)
findByIds(List<Long> ids)
a 如果參數(shù)的類型是List, 則在使用時(shí),collection屬性要必須指定為 list
<select id="findByIdsMap" resultMap="BaseResultMap"> ? ? ? ? ?Select ? ? ? ? ?<include refid="Base_Column_List" /> ? ? ? ? ?from jria where ID in ? ? ? ? ? ? ? ? ? <foreach item="item" index="index" collection="list"? ? ? ? ? ? ? ? ? ? ? ? ? ?open="(" separator="," close=")"> ? ? ? ? ? ? ? ? ? ? ? ? #{item} ? ? ? ? ? ? ? ? </foreach> ? </select>? ? ?findByIds(Long[] ids)
b 如果參數(shù)的類型是Array,則在使用時(shí),collection屬性要必須指定為 array
? <select id="findByIdsMap" resultMap="BaseResultMap"> ? ? ? ? ? ? ? ? ?select ? ? ? ? ? ? ? ? ?<include refid="Base_Column_List" /> ? ? ? ? ? from jria where ID in ? ? ? ? ? ? ? ? ? <foreach item="item" index="index" collection="array"? ? ? ? ? ? ? ? ? ? ? ? ? ?open="(" separator="," close=")"> ? ? ? ? ? ? ? ? ? ? ? ? #{item} ? ? ? ? ? ? ? ? </foreach> ? </select>?
2. 當(dāng)查詢的參數(shù)有多個(gè)時(shí)
例如 findByIds(String name, Long[] ids)
這種情況需要特別注意,在傳參數(shù)時(shí),一定要改用Map方式, 這樣在collection屬性可以指定名稱
下面是一個(gè)示例
? ? ? ? Map<String, Object> params = new HashMap<String, Object>(2); ? ? ? ? params.put("name", name); ? ? ? ? params.put("ids", ids); ? ? ? ? mapper.findByIdsMap(params); ? ?<select id="findByIdsMap" resultMap="BaseResultMap"> ? ? ? ? ? ? ? ? ?select ? ? ? ? ? ? ? ? ?<include refid="Base_Column_List" /> ? ? ? ? ? from jria where ID in ? ? ? ? ? ? ? ? ? <foreach item="item" index="index" collection="ids"? ? ? ? ? ? ? ? ? ? ? ? ? ?open="(" separator="," close=")"> ? ? ? ? ? ? ? ? ? ? ? ? #{item} ? ? ? ? ? ? ? ? </foreach> ? ?</select>?
完整的示例如下
例如有一個(gè)查詢功能,Mapper接口文件定義如下方法:
List<Jria> findByIds(Long... ids);
使用 in 查詢的sql拼裝方法如下:
?<select id="findbyIds" resultMap="BaseResultMap"> ? ? ? ? ? ? ? ? ?select ? ? ? ? ? ? ? ? ?<include refid="Base_Column_List" /> ? ? ? ? ? from jria where ID in ? ? ? ? ? ? ? ? ? <foreach item="item" index="index" collection="array"? ? ? ? ? ? ? ? ? ? ? ? ? ?open="(" separator="," close=")"> ? ? ? ? ? ? ? ? ? ? ? ? #{item} ? ? ? ? ? ? ? ? </foreach> ? </select>?
以上為個(gè)人經(jīng)驗(yàn),希望能給大家一個(gè)參考,也希望大家多多支持腳本之家。
相關(guān)文章
詳解java中的深拷貝和淺拷貝(clone()方法的重寫、使用序列化實(shí)現(xiàn)真正的深拷貝)
這篇文章主要介紹了java中的深拷貝和淺拷貝(clone()方法的重寫、使用序列化實(shí)現(xiàn)真正的深拷貝),文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2019-03-03詳解SpringBoot中的統(tǒng)一結(jié)果返回與統(tǒng)一異常處理
這篇文章主要將通過詳細(xì)的討論和實(shí)例演示來幫助你更好地理解和應(yīng)用Spring Boot中的統(tǒng)一結(jié)果返回和統(tǒng)一異常處理,感興趣的小伙伴可以了解下2024-03-03Java通過經(jīng)緯度坐標(biāo)獲取兩個(gè)點(diǎn)之間的直線距離的示例
這篇文章主要介紹了Java通過經(jīng)緯度坐標(biāo)獲取兩個(gè)點(diǎn)之間的直線距離的示例,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-07-07springboot+springsecurity+mybatis+JWT+Redis?實(shí)現(xiàn)前后端離實(shí)戰(zhàn)教程
這篇文章主要介紹了springboot+springsecurity+mybatis+JWT+Redis?實(shí)現(xiàn)前后端離實(shí)戰(zhàn)教程,需要的朋友可以參考下2024-01-01SpringBoot工程啟動(dòng)順序與自定義監(jiān)聽超詳細(xì)講解
這篇文章主要介紹了SpringBoot工程啟動(dòng)順序與自定義監(jiān)聽,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)吧2022-11-11