Spring的@ModelAttribute注解

Posted 2020-07-02 南开小巷

1.

一、绑定请求参数到指定对象     

 

Java代码  

1. public String test1(@ModelAttribute("user") UserModel user)  

 只是此处多了一个注解@ModelAttribute("user")，它的作用是将该绑定的命令对象以“user”为名称添加到模型对象中供视图页面展示使用。我们此时可以在视图页面使用${user.username}来获取绑定的命令对象的属性。

 

 

如请求参数包含“?username=zhang&password=123&workInfo.city=bj”自动绑定到user 中的workInfo属性的city属性中。

 

 

Java代码  

1. @RequestMapping(value="/model2/{username}")  
2. public String test2(@ModelAttribute("model") DataBinderTestModel model)  

URI 模板变量也能自动绑定到命令对象中， 当你请求的URL 中包含“bool=yes&schooInfo.specialty=computer&hobbyList[0]=program&hobbyList[1]=music&map[key1]=value1&map[key2]=value2&state=blocked”会自动绑定到命令对象上。当URI模板变量和请求参数同名时，URI模板变量具有高优先权。 

 

 

二、暴露表单引用对象为模型数据 

Java代码  

1. /** 
2.  * 设置这个注解之后可以直接在前端页面使用hb这个对象（List）集合 
3.  * @return 
4.  */  
5. @ModelAttribute("hb")  
6. public List<String> hobbiesList(){  
7.     List<String> hobbise = new LinkedList<String>();  
8.     hobbise.add("basketball");  
9.     hobbise.add("football");  
10.     hobbise.add("tennis");  
11.     return hobbise;  
12. }  

 

JSP页面展示出来

Java代码  

1. <br>  
2. 初始化的数据 ：    ${hb }  
3. <br>  
4.   
5.     <c:forEach items="${hb}" var="hobby" varStatus="vs">  
6.         <c:choose>  
7.             <c:when test="${hobby == ‘basketball‘}">  
8.             篮球<input type="checkbox" name="hobbies" value="basketball">  
9.             </c:when>  
10.             <c:when test="${hobby == ‘football‘}">  
11.                 足球<input type="checkbox" name="hobbies" value="football">  
12.             </c:when>  
13.             <c:when test="${hobby == ‘tennis‘}">  
14.                 网球<input type="checkbox" name="hobbies" value="tennis">  
15.             </c:when>  
16.         </c:choose>  
17.     </c:forEach>  

 备注:

1、通过上面这种方式可以显示出一个集合的内容

2、上面的jsp代码使用的是JSTL，需要导入JSTL相关的jar包

<%@taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>

 

三、暴露@RequestMapping方法返回值为模型数据 

Java代码  

1. public @ModelAttribute("user2") UserModel test3(@ModelAttribute("user2") UserModel user)  

 

大家可以看到返回值类型是命令对象类型，而且通过@ModelAttribute("user2")注解，此时会暴露返回值到模型数据（ 名字为user2 ） 中供视图展示使用

 

@ModelAttribute 注解的返回值会覆盖@RequestMapping 注解方法中的@ModelAttribute 注解的同名命令对象

 

2.

@ModelAttribute使用详解

[email protected]注释方法 
    例子（1），（2），（3）类似，被@ModelAttribute注释的方法会在此controller每个方法执行前被执行，因此对于一个controller映射多个URL的用法来说，要谨慎使用。
    
    （1）@ModelAttribute注释void返回值的方法 
    

[java] view plain copy

 

 print?

1. <span style="font-size:12px;">@Controller  
2.     public class HelloWorldController {  
3.   
4.         @ModelAttribute  
5.         public void populateModel(@RequestParam String abc, Model model) {  
6.            model.addAttribute("attributeName", abc);  
7.         }  
8.   
9.         @RequestMapping(value = "/helloWorld")  
10.         public String helloWorld() {  
11.            return "helloWorld";  
12.         }  
13.     }</span>  
14. <span style="font-size:12px;">  
15. </span>  

 

    这个例子，在获得请求/helloWorld 后，populateModel方法在helloWorld方法之前先被调用，它把请求参数（/helloWorld?abc=text）加入到一个名为attributeName的model属性中，在它执行后helloWorld被调用，返回视图名helloWorld和model已由@ModelAttribute方法生产好了。
这个例子中model属性名称和model属性对象有model.addAttribute()实现，不过前提是要在方法中加入一个Model类型的参数。
    当URL或者post中不包含次参数时，会报错，其实不需要这个方法，完全可以把请求的方法写成，这样缺少此参数也不会出错

[java] view plain copy

 

 print?

1. <span style="font-size:12px;">       @RequestMapping(value = "/helloWorld")  
2.         public String helloWorld(String abc) {  
3.            return "helloWorld";  
4.         }</span>  
5. <span style="font-size:12px;">  
6. </span>  

        
    （2）@ModelAttribute注释返回具体类的方法 
    

[java] view plain copy

 

 print?

1. <span style="font-size:12px;">@ModelAttribute  
2.     public Account addAccount(@RequestParam String number) {  
3.        return accountManager.findAccount(number);  
4.     }  
5. </span>  
6. <span style="font-size:12px;">  
7. </span>  

 

    这种情况，model属性的名称没有指定，它由返回类型隐含表示，如这个方法返回Account类型，那么这个model属性的名称是account。
    这个例子中model属性名称有返回对象类型隐含表示，model属性对象就是方法的返回值。它无须要特定的参数。
    
    （3）@ModelAttribute(value="")注释返回具体类的方法 
    

[java] view plain copy

 

 print?

1. <span style="font-size:12px;">@Controller  
2.     public class HelloWorldController {  
3.   
4.         @ModelAttribute("attributeName")  
5.         public String addAccount(@RequestParam String abc) {  
6.            return abc;  
7.         }  
8.   
9.         @RequestMapping(value = "/helloWorld")  
10.         public String helloWorld() {  
11.            return "helloWorld";  
12.         }  
13.     }</span>  
14. <span style="font-size:12px;">  
15. </span>  

 

    这个例子中使用@ModelAttribute注释的value属性，来指定model属性的名称。model属性对象就是方法的返回值。它无须要特定的参数。
    
    （4）@ModelAttribute和@RequestMapping同时注释一个方法 
    

[java] view plain copy

 

 print?

1. <span style="font-size:12px;">@Controller  
2.     public class HelloWorldController {  
3.   
4.         @RequestMapping(value = "/helloWorld.do")  
5.         @ModelAttribute("attributeName")  
6.         public String helloWorld() {  
7.            return "hi";  
8.         }  
9.     }</span>  
10. <span style="font-size:12px;">  
11. </span>  

 

    这时这个方法的返回值并不是表示一个视图名称，而是model属性的值，视图名称由RequestToViewNameTranslator根据请求"/helloWorld.do"转换为逻辑视图helloWorld。
    Model属性名称有@ModelAttribute(value=””)指定，相当于在request中封装了key=attributeName，value=hi。
    
[email protected]注释一个方法的参数 

    （1）从model中获取     
    

[java] view plain copy

 

 print?

1. <span style="font-size:12px;">@Controller  
2.     public class HelloWorldController {  
3.   
4.         @ModelAttribute("user")  
5.         public User addAccount() {  
6.            return new User("jz","123");  
7.         }  
8.   
9.         @RequestMapping(value = "/helloWorld")  
10.         public String helloWorld(@ModelAttribute("user") User user) {  
11.            user.setUserName("jizhou");  
12.            return "helloWorld";  
13.         }  
14.     }</span>  
15. <span style="font-size:12px;">  
16. </span>  

 

    在这个例子里，@ModelAttribute("user") User user注释方法参数，参数user的值来源于addAccount()方法中的model属性。
    此时如果方法体没有标注@SessionAttributes("user")，那么scope为request，如果标注了，那么scope为session
    
    （2）从Form表单或URL参数中获取（实际上，不做此注释也能拿到user对象） 
    
    

[java] view plain copy

 

 print?

1. <span style="font-size:12px;">@Controller  
2.     public class HelloWorldController {  
3.   
4.         @RequestMapping(value = "/helloWorld")  
5.         public String helloWorld(@ModelAttribute User user) {  
6.            return "helloWorld";  
7.         }  
8.     }</span>  
9. <span style="font-size:12px;">  
10. </span>