Spring MVC 中 @ModelAttribute 注解的妙用

Spring MVC 提供的這種基于注釋的編程模型猜嘱,極大的簡(jiǎn)化了 web 應(yīng)用的開(kāi)發(fā)流礁。其中 @Controller@RestController 注解的組件使用 @RequestMapping顽聂、 @ExceptionHandler 等注解來(lái)表示請(qǐng)求映射硫戈,請(qǐng)求輸入倍谜,異常處理等瓢省,使得開(kāi)發(fā)者能專注于業(yè)務(wù)邏輯的編寫窟坐,提高了開(kāi)發(fā)效率抖棘。 帶注釋的控制器具有靈活的方法簽名,不必?cái)U(kuò)展基類狸涌,也不需要實(shí)現(xiàn)特定的接口切省。

可以使用 ServletWebApplicationContext 中的標(biāo)準(zhǔn) Spring bean 定義來(lái)定義控制器 bean。 所有帶有 @Controller 注解的類會(huì)被自動(dòng)檢測(cè)帕胆,就像 Spring 通常的掃描方式一樣朝捆,檢測(cè)類路徑中的 @Component 類,并為它們自動(dòng)注冊(cè) bean 定義懒豹。 它也充當(dāng)注釋類的刻板芙盘,表示它可以作為一個(gè) Web 組件。

帶有 @RequestMapping 注解的方法叫做 Handler Method - 處理器方法脸秽,它的參數(shù)可以來(lái)自很多地方儒老,比如 ServletRequestServletResponse 记餐、 HttpSession 等驮樊。

@ModelAttribute

在控制器的處理器方法參數(shù)上添加 @ModelAttribute 注釋可以訪問(wèn)模型中的屬性,如果不存在這個(gè)模型,則會(huì)自動(dòng)將其實(shí)例化囚衔,產(chǎn)生一個(gè)新的模型挖腰。 模型屬性還覆蓋了來(lái)自 HTTP Servlet 請(qǐng)求參數(shù)的名稱與字段名稱匹配的值,也就是請(qǐng)求參數(shù)如果和模型類中的域變量一致练湿,則會(huì)自動(dòng)將這些請(qǐng)求參數(shù)綁定到這個(gè)模型對(duì)象猴仑,這被稱為數(shù)據(jù)綁定,從而避免了解析和轉(zhuǎn)換每個(gè)請(qǐng)求參數(shù)和表單字段這樣的代碼肥哎。 例如:

@PostMapping("/componies/{componyId}/departments/{departmentId}/edit")
public String processSubmit(@ModelAttribute Department department) { }

這個(gè)處理器方法中的 department 參數(shù)會(huì)被從以下幾個(gè)來(lái)源進(jìn)行匹配綁定:

  • 已經(jīng)定義過(guò)的模型方法(帶有 @ModelAttribute 的方法辽俗,后面解釋)
  • HTTP Session 中和字段名匹配的會(huì)話方法(帶有 @SessionAttribute 的方法,和模型方法類似篡诽,只是作用域不同)
  • 經(jīng)過(guò) URL 轉(zhuǎn)換器解析過(guò)的路徑變量
  • 該模型類的默認(rèn)構(gòu)造方法
  • 調(diào)用具有與 Servlet 請(qǐng)求參數(shù)匹配的參數(shù)的 “主構(gòu)造函數(shù)”; 參數(shù)名稱通過(guò) JavaBeans @ConstructorProperties 或通過(guò)字節(jié)碼中的運(yùn)行時(shí)保留參數(shù)名稱確定崖飘。

雖然一般都是使用模型方法 Model method 來(lái)使用屬性填充模型,但另一種方法是依靠 Converter<String,T> 識(shí)別 URI 路徑變量來(lái)綁定霞捡。在下面的例子中,模型屬性名稱 “user” 與 URI 路徑變量 “user” 匹配薄疚,并且通過(guò)將 String 類型的用戶名交給給已注冊(cè)的 Converter<String,User> 這個(gè)轉(zhuǎn)換器來(lái)生成創(chuàng)建模型:

@PutMapping("/users/{user}")
public String saveUser(@ModelAttribute("user") User user) {
    // ...
}

在獲得模型屬性實(shí)例之后碧信,請(qǐng)求數(shù)據(jù)就會(huì)被綁定到模型屬性上。 WebDataBinder 負(fù)責(zé)將 Servlet 請(qǐng)求參數(shù)名稱(查詢參數(shù)或表單字段)和目標(biāo)模型對(duì)象上的字段名稱進(jìn)行匹配街夭。 必要時(shí)會(huì)將屬性的類型進(jìn)行轉(zhuǎn)換后再填充對(duì)應(yīng)字段砰碴。

數(shù)據(jù)綁定不能保證不會(huì)出錯(cuò),發(fā)生錯(cuò)誤時(shí)默認(rèn)情況下會(huì)拋出 BindException 異常板丽,但要在處理器方法中識(shí)別出這些錯(cuò)誤呈枉,需要在 @ModelAttribute 后面添加一個(gè) BindingResult 類型的參數(shù),需要注意的是:這個(gè)參數(shù)必須和模型屬性參數(shù) (@ModelAttribute 參數(shù))相鄰埃碱,如下所示:

@PostMapping("/owners/{componyId}/departments/{departmentId}/edit")
public String processSubmit(@ModelAttribute("compony") Compony compony, BindingResult result) {
    if (result.hasErrors()) {
        return "componyForm";
    }
    // ...
}

這個(gè)例子表示如果用戶提交的表單不符合預(yù)期的匹配規(guī)則猖辫,就會(huì)返回視圖 componyForm

有時(shí)候我們需要獲得一個(gè)不帶數(shù)據(jù)綁定的模型屬性砚殿,也就是需要在處理器方法中使用 new 關(guān)鍵字來(lái)實(shí)例化一個(gè)對(duì)象啃憎。但是在 Spring MVC 中就不用這么麻煩了,我們可以將模型注入控制器并直接訪問(wèn)它似炎,或者可以添加 @ModelAttribute(binding = false) 來(lái)表示不需要綁定數(shù)據(jù)辛萍,如下所示:

@ModelAttribute
public UserForm setUpForm() {
    return new UserForm();
}

@ModelAttribute
public User findUser(@PathVariable String userId) {
    return userRepository.findOne(userId);
}

@PostMapping("update")
public String update(@Valid UserUpdateForm form, BindingResult result,
        @ModelAttribute(binding=false) User user) {
    // ...
}

在參數(shù)上添加 javax.validation.Valid 注解或 Spring 的 @Validated 注解,就可以在數(shù)據(jù)綁定后使用字段校驗(yàn)功能了羡藐,就像這樣:

@PostMapping("/componies/{componyId}/departments/{departmentId}/edit")
public String processSubmit(@Valid @ModelAttribute("department") Department department, BindingResult result) {
    if (result.hasErrors()) {
        return "departmentForm";
    }
    // ...
}

這樣寫和在方法體中寫 model.addAttribute("compony",compony) 是等價(jià)的贩毕。

需要注意的是 @ModelAttribute 注解如果不加,按照 BeanUtils 中的 isSimpleProperty 方法來(lái)判斷仆嗦,如果不屬于簡(jiǎn)單類型的參數(shù)辉阶,都會(huì)被自動(dòng)視為 ModelAttribute

歡迎訪問(wèn) 鄭保樂(lè)的博客

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市睛藻,隨后出現(xiàn)的幾起案子启上,更是在濱河造成了極大的恐慌,老刑警劉巖店印,帶你破解...
    沈念sama閱讀 222,627評(píng)論 6 517
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件冈在,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡按摘,警方通過(guò)查閱死者的電腦和手機(jī)包券,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 95,180評(píng)論 3 399
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)炫贤,“玉大人溅固,你說(shuō)我怎么就攤上這事±颊洌” “怎么了侍郭?”我有些...
    開(kāi)封第一講書(shū)人閱讀 169,346評(píng)論 0 362
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)掠河。 經(jīng)常有香客問(wèn)我亮元,道長(zhǎng),這世上最難降的妖魔是什么唠摹? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 60,097評(píng)論 1 300
  • 正文 為了忘掉前任爆捞,我火速辦了婚禮,結(jié)果婚禮上勾拉,老公的妹妹穿的比我還像新娘煮甥。我一直安慰自己,他們只是感情好藕赞,可當(dāng)我...
    茶點(diǎn)故事閱讀 69,100評(píng)論 6 398
  • 文/花漫 我一把揭開(kāi)白布成肘。 她就那樣靜靜地躺著,像睡著了一般斧蜕。 火紅的嫁衣襯著肌膚如雪艇劫。 梳的紋絲不亂的頭發(fā)上,一...
    開(kāi)封第一講書(shū)人閱讀 52,696評(píng)論 1 312
  • 那天惩激,我揣著相機(jī)與錄音店煞,去河邊找鬼。 笑死风钻,一個(gè)胖子當(dāng)著我的面吹牛顷蟀,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播骡技,決...
    沈念sama閱讀 41,165評(píng)論 3 422
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼鸣个,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼羞反!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起囤萤,我...
    開(kāi)封第一講書(shū)人閱讀 40,108評(píng)論 0 277
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤昼窗,失蹤者是張志新(化名)和其女友劉穎,沒(méi)想到半個(gè)月后涛舍,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體澄惊,經(jīng)...
    沈念sama閱讀 46,646評(píng)論 1 319
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,709評(píng)論 3 342
  • 正文 我和宋清朗相戀三年富雅,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了掸驱。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 40,861評(píng)論 1 353
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡没佑,死狀恐怖毕贼,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情蛤奢,我是刑警寧澤鬼癣,帶...
    沈念sama閱讀 36,527評(píng)論 5 351
  • 正文 年R本政府宣布,位于F島的核電站啤贩,受9級(jí)特大地震影響待秃,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜瓜晤,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 42,196評(píng)論 3 336
  • 文/蒙蒙 一锥余、第九天 我趴在偏房一處隱蔽的房頂上張望腹纳。 院中可真熱鬧痢掠,春花似錦、人聲如沸嘲恍。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 32,698評(píng)論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)佃牛。三九已至淹辞,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間俘侠,已是汗流浹背象缀。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 33,804評(píng)論 1 274
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留爷速,地道東北人央星。 一個(gè)月前我還...
    沈念sama閱讀 49,287評(píng)論 3 379
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像惫东,于是被迫代替她去往敵國(guó)和親莉给。 傳聞我的和親對(duì)象是個(gè)殘疾皇子毙石,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,860評(píng)論 2 361

推薦閱讀更多精彩內(nèi)容