MyBatis update 標(biāo)簽用于定義更新語句,執(zhí)行更新操作。當(dāng) MyBatis 執(zhí)行完一條更新語句后,會返回一個整數(shù),表示受影響的數(shù)據(jù)庫記錄的行數(shù)。
下面我們通過一個示例演示 update 標(biāo)簽的用法。
1. 在 WebsiteMapper.xml 中添加以下更新語句,代碼如下。
<!--update 標(biāo)簽--> <update id="updateWebsite" parameterType="string"> update website set name = #{name} </update>
2. 在 WebsiteMapper 接口中增加一個 updateWebsite() 方法,代碼如下。
int updateWebsite(String name);
參數(shù)為 String 類型的字符串;返回值為 int 類型,表示執(zhí)行 sql 語句后受影響的記錄的行數(shù)。
3. 測試代碼如下。
int i = websiteMapper.updateWebsite("菜鳥教程專業(yè)版"); System.out.println("共更新了 " + i + " 條記錄");
4. 執(zhí)行測試代碼,控制臺輸出如下。
共更新了 9 條記錄
通過控制臺輸出可知,該更新語句執(zhí)行后,共影響了 9 條數(shù)據(jù)庫記錄。
update 標(biāo)簽常用屬性如下表。
屬性名稱 | 描述 | 備注 |
---|---|---|
id | 它和 Mapper 的命名空間組合起來使用,是唯一標(biāo)識符,供 MyBatis 調(diào)用 | 如果命名空間+ id 不唯一,那么 MyBatis 拋出異常 |
parameterType | 傳入 SQL 語句的參數(shù)類型的全限定名或別名,它是一個可選屬性。 | 支持基本數(shù)據(jù)類型和 JavaBean、Map 等復(fù)雜數(shù)據(jù)類型 |
flushCache | 該屬性用于設(shè)置執(zhí)行該操作后,是否會清空二級緩存和本地緩存,默認(rèn)值為 true。 | - |
timeout | 該屬性用于設(shè)置 SQL 執(zhí)行的超時時間,如果超時,就拋異常。 | - |
statementType | 執(zhí)行 SQL 時使用的 statement 類型, 默認(rèn)為 PREPARED,可選值:STATEMENT,PREPARED 和 CALLABLE。 | - |
注意:update 標(biāo)簽中沒有 resultType 屬性,只有查詢操作才需要對返回結(jié)果類型進(jìn)行相應(yīng)的指定。
在上面的示例中,我們在更新語句中只使用了一個 String 類型的參數(shù),而在實(shí)際的開發(fā)過程中,大多數(shù)時候,我們的更新語句都需要使用多個參數(shù),Mybatis 為我們提供以下 3 種方式,來實(shí)現(xiàn)給映射器傳遞多個參數(shù):
使用 Map 傳遞參數(shù)
使用注解傳遞參數(shù)
使用 JavaBean 傳遞參數(shù)
我們可以將參數(shù)封裝到一個 Map 對象中,然后傳遞給 MyBatis 的映射器,示例如下。
1. 在 WebsiteMapper 接口中,定義一個 updateWebsiteByMap() 方法,并使用 Map 傳遞參數(shù),代碼如下。
int updateWebsiteByMap(Map<String, Object> params);
2. 在 WebsiteMapper.xml 使用 update 標(biāo)簽定義一個 update 語句,并接收通過 Map 傳遞的參數(shù),代碼如下。
<!--更新語句接收 Map 傳遞的參數(shù)--> <update id="updateWebsiteByMap" parameterType="map"> update website set name = #{name},url= #{url} where id = #{id} </update>
3. 測試代碼如下。
//使用 Map 向 update 標(biāo)簽傳遞參數(shù) Map<String, Object> params = new HashMap<>(); params.put("id", 1); params.put("name", "編程幫"); params.put("url", "www.soo66.com"); int i = websiteMapper.updateWebsiteByMap(params); System.out.println("通過 Map 傳遞參數(shù),共更新了 " + i + " 條記錄");
4. 執(zhí)行測試代碼,控制臺輸出如下。
通過 Map 傳遞參數(shù),共更新了 1 條記錄
我們還可以使用 MyBatis 提供的 @Param 注解給注解器傳遞參數(shù),示例如下。
1. 在 WebsiteMapper 接口中,定義一個 updateWebsiteByParam() 方法,并使用 @Param 注解傳遞參數(shù),方法如下。
int updateWebsiteByParam(@Param("name") String name, @Param("url") String url, @Param("id") Integer id);
2. 在 WebsiteMapper.xml 中使用 update 標(biāo)簽定義一個 update 語句,并接收通過 @Param 注解傳遞的參數(shù),配置如下。
<!--更新語句接收 @Param 注解傳遞的參數(shù)--> <update id="updateWebsiteByParam"> update website set name = #{name},url= #{url} where id = #{id} </update>
3. 測試代碼如下。
// 使用@Param 注解傳遞參數(shù)到更新語句中 String name = "編程幫2"; String url = "www.soo66.com"; Integer id = 2; int i = websiteMapper.updateWebsiteByParam(name, url, id); System.out.println("通過 @Param 注解傳遞參數(shù),共更新了 " + i + " 條記錄");
4. 執(zhí)行測試代碼,控制臺輸出如下。
通過 @Param 注解傳遞參數(shù),共更新了 1 條記錄
在參數(shù)過多的情況下,我們還可以將參數(shù)通過 setter 方法封裝到 JavaBean(實(shí)體類)對象中傳遞給映射器。
1. 在 WebsiteMapper 接口中,定義一個 updateWebsiteByJavaBean() 方法,并使用 JavaBean 傳遞參數(shù),方法如下。
int updateWebsiteByJavaBean(Website website);
2. 在 WebsiteMapper.xml 中使用 update 標(biāo)簽定義一個 update 語句,并接收通過 JavaBean 傳遞的參數(shù),配置如下。
<!--更新語句接收 JavaBean 傳遞的參數(shù)--> <update id="updateWebsiteByJavaBean" parameterType="net.biancheng.www.po.Website"> update website set name = #{name},url= #{url} where id = #{id} </update>
3. 測試代碼如下。
//使用 JavaBean 傳遞參數(shù)到更新語句中 Website website = new Website(); website.setName("編程幫3"); website.setUrl("www.soo66.com"); website.setId(3); int i = websiteMapper.updateWebsiteByJavaBean(website); System.out.println("通過 JavaBean 傳遞參數(shù),共更新了 " + i + " 條記錄");
4. 執(zhí)行測試代碼,控制臺輸出如下。
通過 JavaBean 傳遞參數(shù),共更新了 1 條記錄
以上 3 種方式的區(qū)別如下:
使用 Map 傳遞參數(shù)會導(dǎo)致業(yè)務(wù)可讀性的喪失,繼而導(dǎo)致后續(xù)擴(kuò)展和維護(hù)的困難,所以在實(shí)際應(yīng)用中我們應(yīng)該果斷廢棄該方式。
使用 @Param 注解傳遞參數(shù)會受到參數(shù)個數(shù)的影響。當(dāng) n≤5 時,它是最佳的傳參方式,因為它更加直觀;當(dāng) n>5 時,多個參數(shù)將給調(diào)用帶來困難。
當(dāng)參數(shù)個數(shù)大于 5 個時,建議使用 JavaBean 方式。