SpringMVC注解之@ModelAttribute

在 SpringMVC 的 Controller 中使用 

@ModelAttribute

 時，應用位置包括下面幾種：

• 應用在方法上。
• 應用在方法的參數上。
• 應用在方法上，并且方法也使用了

  @RequestMapping

首先說明一下，被 

@ModelAttribute

 注解的方法會在Controller每個方法執行之前都執行，是以對于一個Controller中包含多個URL的時候，要謹慎使用。

1) 使用 

@ModelAttribute

 注解無傳回值的方法

@Controller
@RequestMapping("/modelattributeTest")
public class ModelAttributeTestController1 {

    @ModelAttribute
    public void myModel(@RequestParam(required = false) String abc, Model model) {
        model.addAttribute("attributeName", abc);
    }

    @RequestMapping(value = "/test1")
    public String test1() {
        return "modelattributetest/test1";
    }
}
           

這個例子，在請求

/modelattributeTest/test1?abc=aaa

後，會先執行 

myModel

方法，然後接着執行

test1

方法，參數

abc

的值被放入

Model

中後，接着被帶到 

test

方法中。

當傳回視圖 

modelattributetest/test1

時，

Model

 會被帶到頁面上，當然你在使用 

@RequestParam

的時候可以使用

required

來指定參數是否是必須的。

如果把 

myModel

和 

test1

 合二為一後的方法可以為，這也是我們最常用的方法：

@RequestMapping(value = "/test2")
public String test1(@RequestParam(required = false) String abc, Model model) {
    model.addAttribute("attributeName", abc);
    return "modelattributetest/test1";
}
           

2）使用 

@ModelAttribute

 注解帶有傳回值的方法

@ModelAttribute
public String myModel(@RequestParam(required = false) String abc) {
    return abc;
}

或者

@ModelAttribute
public Student myModel(@RequestParam(required = false) String abc) {
    Student stu = new Student(abc);
     return stu;
}

或者

@ModelAttribute
public int myModel(@RequestParam(required = false) int number) {
     return number;
}
           

對于這種情況，傳回值對象會被預設放到隐含的 

Model

中，在 

Model

中的 

key

為 “傳回值首字母小寫”，

value

 為傳回的值。

上面3種情況等同于：

model.addAttribute("string", abc);
model.addAttribute("int", number);
model.addAttribute("student", stu);
           

如果隻能這樣，未免太局限了，我們很難接受

key

 為 

string

、

int

、

float

 等等這樣的。

想自定義其實很簡單，隻需要給

@ModelAttribute

添加

value

屬性即可，如下：

@ModelAttribute(value = "num")
 public int myModel(@RequestParam(required = false) int number) {
    return number;
}
           

這樣就相當于

model.addAttribute(“num”, number);

@Controller
@RequestMapping("/modelattributeTest3")
public class ModelAttributeTestController3 {

    @ModelAttribute(value = "attributeName")
    public String myModel(@RequestParam(required = false) String abc) {
        return abc;
    }

    @ModelAttribute
    public void myModel3(Model model) {
        model.addAttribute("name", "SHANHY");
        model.addAttribute("age", "28");
    }

    @RequestMapping(value = "/test1")
    public String test1(@ModelAttribute("attributeName") String str, 
            @ModelAttribute("name") String str2,
            @ModelAttribute("age") String str3) {
        return "modelattributetest/test1";
    }

}
           

從代碼中可以看出，使用 

@ModelAttribute

注解的參數，意思是從前面的 

Model

中提取對應名稱的屬性。

這裡提及一下 

@SessionAttributes

 的使用：

1. 如果在類上面使用了 

   @SessionAttributes(“attributeName”)

    注解，而本類中恰巧存在

   attributeName

   ，則會将 

   attributeName

    放入到 session 作用域。
2. 如果在類上面使用了

   @SessionAttributes(“attributeName”)

   注解，SpringMVC 會在執行方法之前，自動從 session 中讀取 key 為 

   attributeName

    的值，并注入到 

   Model

   中。

   是以我們在方法的參數中使用

   @ModelAttribute(“attributeName”)

   就會正常的從 

   Model

   讀取這個值，也就相當于擷取了 

   session

   中的值。
3. 使用了 

   @SessionAttributes

   之後，Spring 無法知道什麼時候要清掉 

   @SessionAttributes

    存進去的資料，如果要明确告知，也就是在方法中傳入 

   SessionStatus

   對象參數，并調用 

   status.setComplete()

   就可以了。

這兩點大家好好嘗試下，或者找一下關于 

@SessionAttributes

更詳細的介紹。

如下代碼：

@Controller
@RequestMapping("/modelattributeTest4")
public class ModelAttributeTestController4 {

    @RequestMapping(value = "/test1")
    @ModelAttribute("name")
    public String test1(@RequestParam(required = false) String name) {
        return name;
    }

}
           

這種情況下，傳回值 

String （或者其他對象）

，就不再是視圖了。還是我們上面講到的放入 

Model

 中的值，此時對應的頁面就是 

@RequestMapping

的值 test1。