MyBatis 中的@Param注解最佳實(shí)踐
在 MyBatis 中,@Param 注解的作用是為方法參數(shù)指定一個(gè)在 XML 映射文件或注解 SQL 中引用的名稱。對(duì)于你的問題,是否可以不寫,取決于 MyBatis 的版本和參數(shù)類型。
情況分析
1. 可以省略的情況(單個(gè)基本類型參數(shù))
如果你的 MyBatis 版本是 3.4.1+,且方法只有一個(gè)基本類型或簡(jiǎn)單對(duì)象參數(shù)(如 Long, String, 自定義對(duì)象等),可以省略 @Param。
此時(shí) MyBatis 會(huì)自動(dòng)使用參數(shù)的實(shí)際變量名(regionId)作為引用名。
// MyBatis 3.4.1+ 可以省略 List<ServeResDTO> queryServeListByRegionId(Long regionId);
在 XML 中這樣引用:
<select id="queryServeListByRegionId" resultType="com.xxx.ServeResDTO">
SELECT * FROM serve WHERE region_id = #{regionId}
</select>2. 必須添加的情況
- 多參數(shù)方法:當(dāng)有多個(gè)參數(shù)時(shí),必須使用
@Param區(qū)分
List<Serve> query(@Param("name") String name, @Param("status") Integer status);- 集合類型參數(shù):如
@Param("list") List<Long> ids - 動(dòng)態(tài) SQL:在
<if>、<foreach>等標(biāo)簽中引用參數(shù) - 代碼可讀性:顯式聲明參數(shù)名更清晰,避免編譯后參數(shù)名丟失的問題(Java 8+ 需加上
-parameters編譯參數(shù)才能保留參數(shù)名)
建議的最佳實(shí)踐
寫上 @Param("regionId") 是更安全的做法,原因如下:
- 編譯兼容性:確保即使 Java 編譯時(shí)未保留參數(shù)名(默認(rèn)情況),也能正常工作
- 代碼清晰:明確指定 SQL 中使用的參數(shù)名
- 避免升級(jí)風(fēng)險(xiǎn):項(xiàng)目升級(jí) MyBatis 或修改編譯配置時(shí)不會(huì)出錯(cuò)
- 團(tuán)隊(duì)協(xié)作規(guī)范:統(tǒng)一風(fēng)格,便于維護(hù)
所以雖然單個(gè)參數(shù)時(shí)可以省略,但推薦始終加上 @Param,這是一種防御性編程的好習(xí)慣。
結(jié)論:在你的代碼中,不寫通常也能運(yùn)行(MyBatis 3.4.1+),但寫上更好。
到此這篇關(guān)于MyBatis 中的@Param注解的文章就介紹到這了,更多相關(guān)MyBatis @Param注解內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
JavaWeb實(shí)現(xiàn)簡(jiǎn)單文件上傳功能
這篇文章主要為大家詳細(xì)介紹了JavaWeb實(shí)現(xiàn)簡(jiǎn)單文件上傳功能,文中示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2022-06-06
SWT(JFace) FTP客戶端實(shí)現(xiàn)
SWT(JFace)小制作:FTP客戶端實(shí)現(xiàn)2009-06-06
SpringBoot實(shí)現(xiàn)發(fā)送驗(yàn)證碼功能(圖片驗(yàn)證碼)
這篇文章主要介紹了SpringBoot實(shí)現(xiàn)發(fā)送驗(yàn)證碼功能(圖片驗(yàn)證碼),本次內(nèi)容主要學(xué)習(xí)如何做一個(gè)發(fā)送驗(yàn)證碼和識(shí)別驗(yàn)證碼的功能,需要的朋友可以參考下2024-06-06
Java語(yǔ)言實(shí)現(xiàn)非遞歸實(shí)現(xiàn)樹的前中后序遍歷總結(jié)
今天小編就為大家分享一篇關(guān)于Java語(yǔ)言實(shí)現(xiàn)非遞歸實(shí)現(xiàn)樹的前中后序遍歷總結(jié),小編覺得內(nèi)容挺不錯(cuò)的,現(xiàn)在分享給大家,具有很好的參考價(jià)值,需要的朋友一起跟隨小編來看看吧2019-01-01
java的jdk基礎(chǔ)知識(shí)點(diǎn)總結(jié)
在本篇文章里小編給大家整理的是一篇關(guān)于java的jdk基礎(chǔ)知識(shí)點(diǎn)總結(jié)內(nèi)容,有興趣的朋友們可以學(xué)習(xí)參考下。2021-01-01
SpringBoot將所有依賴(包括本地jar包)打包到項(xiàng)目
這篇文章主要介紹了SpringBoot將所有依賴(包括本地jar包)打包到項(xiàng)目,本文通過示例代碼給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2023-06-06
java中Base64字符串出現(xiàn)不合法字符的問題解決
非法的base64數(shù)據(jù)可能導(dǎo)致編碼或解碼過程出錯(cuò),本文主要介紹了java中Base64字符串出現(xiàn)不合法字符的問題解決,具有一定的參考價(jià)值,感興趣的可以了解一下2024-06-06
IDEA遠(yuǎn)程連接HBase及其Java API實(shí)戰(zhàn)詳解
這篇文章主要介紹了IDEA遠(yuǎn)程連接HBase及其Java API實(shí)戰(zhàn)詳解,本文通過實(shí)例代碼給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2021-04-04
Java中的HashMap弱引用之WeakHashMap詳解
這篇文章主要介紹了Java中的HashMap弱引用之WeakHashMap詳解,當(dāng)內(nèi)存空間不足,Java虛擬機(jī)寧愿拋出OutOfMemoryError錯(cuò)誤,使程序異常終止,也不會(huì)靠隨意回收具有強(qiáng)引用的對(duì)象來解決內(nèi)存不足的問題,需要的朋友可以參考下2023-09-09

