Spring MVC @ModelAttribute 详解

本文详细介绍了Spring MVC框架中@ModelAttribute注解的应用场景,包括如何使用此注解进行模型填充、对象合并以及实现权限控制。此外还探讨了该注解在不同方法签名中的使用技巧。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

1.@ModelAttribute注释void返回值的方法


  1. @Controller  
  2. public class HelloModelController {  
  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.jsp”;    
  12.     }    
  13.   
  14. }  
@Controller
public class HelloModelController {

    @ModelAttribute 
    public void populateModel(@RequestParam String abc, Model model) {  
       model.addAttribute("attributeName", abc);  
    }  

    @RequestMapping(value = "/helloWorld")  
    public String helloWorld() {  
       return "helloWorld.jsp";  
    }  

}

在这个代码中,访问控制器方法helloWorld时,会首先调用populateModel方法,将页面参数abc(/helloWorld.ht?abc=text)放到model的attributeName属性中,在视图中可以直接访问。


jsp页面页面如下:

  1. <%@ page language=“java” contentType=“text/html; charset=utf-8”  
  2.     pageEncoding=“utf-8”%>  
  3. <%@taglib prefix=“c” uri=“http://java.sun.com/jsp/jstl/core”%>  
  4. <html>  
  5. <head>  
  6. </head>  
  7. <body>  
  8. <c:out value=“${attributeName}”></c:out>  
  9. </body>  
  10. </html>  
<%@ page language="java" contentType="text/html; charset=utf-8"
    pageEncoding="utf-8"%>
<%@taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core"%>
<html>
<head>
</head>
<body>
<c:out value="${attributeName}"></c:out>
</body>
</html>


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


  1. @Controller  
  2. public class Hello2ModelController {  
  3.       
  4.     @ModelAttribute   
  5.     public User populateModel() {    
  6.        User user=new User();  
  7.        user.setAccount(”ray”);  
  8.        return user;  
  9.     }    
  10.     @RequestMapping(value = “/helloWorld2”)    
  11.     public String helloWorld() {    
  12.        return “helloWorld.jsp”;    
  13.     }    
  14. }  
@Controller
public class Hello2ModelController {

    @ModelAttribute 
    public User populateModel() {  
       User user=new User();
       user.setAccount("ray");
       return user;
    }  
    @RequestMapping(value = "/helloWorld2")  
    public String helloWorld() {  
       return "helloWorld.jsp";  
    }  
}


当用户请求 http://localhost:8080/test/helloWorld2.html时,首先访问populateModel方法,返回User对象,model属性的名称没有指定,它由返回类型隐含表示,如这个方法返回User类型,那么这个model属性的名称是user。
这个例子中model属性名称有返回对象类型隐含表示,model属性对象就是方法的返回值。它无须要特定的参数。


jsp 中如下访问:

  1. <c:out value={user.account}"</span><span class="tag">&gt;</span><span class="tag">&lt;/</span><span class="tag-name">c:out</span><span class="tag">&gt;</span><span>&nbsp;&nbsp;</span></span></li></ol></div><pre name="code" class="html" style="display: none;">&lt;c:out value="{user.account}”></c:out>
    也可以指定属性名称
    1. @Controller  
    2. public class Hello2ModelController {  
    3.       
    4.     @ModelAttribute(value=“myUser”)  
    5.     public User populateModel() {    
    6.        User user=new User();  
    7.        user.setAccount(”ray”);  
    8.        return user;  
    9.     }    
    10.     @RequestMapping(value = “/helloWorld2”)    
    11.     public String helloWorld(Model map) {    
    12.        return “helloWorld.jsp”;    
    13.     }    
    14. }  
    @Controller
    public class Hello2ModelController {
    
        @ModelAttribute(value="myUser")
        public User populateModel() {  
           User user=new User();
           user.setAccount("ray");
           return user;
        }  
        @RequestMapping(value = "/helloWorld2")  
        public String helloWorld(Model map) {  
           return "helloWorld.jsp";  
        }  
    }
    
    

    jsp中如下访问:
    1. <c:out value={myUser.account}"</span><span class="tag">&gt;</span><span class="tag">&lt;/</span><span class="tag-name">c:out</span><span class="tag">&gt;</span><span>&nbsp;&nbsp;</span></span></li></ol></div><pre name="code" class="html" style="display: none;">&lt;c:out value="{myUser.account}”></c:out>


      对象合并:

      1. @Controller  
      2. public class Hello2ModelController {  
      3.       
      4.     @ModelAttribute  
      5.     public User populateModel() {    
      6.        User user=new User();  
      7.        user.setAccount(”ray”);  
      8.        return user;  
      9.     }    
      10.       
      11.     @RequestMapping(value = “/helloWorld2”)    
      12.     public String helloWorld(User user) {  
      13.         user.setName(”老王”);  
      14.        return “helloWorld.jsp”;    
      15.     }    
      16. }  
      @Controller
      public class Hello2ModelController {
      
          @ModelAttribute
          public User populateModel() {  
             User user=new User();
             user.setAccount("ray");
             return user;
          }  
      
          @RequestMapping(value = "/helloWorld2")  
          public String helloWorld(User user) {
              user.setName("老王");
             return "helloWorld.jsp";  
          }  
      }
      
      

       

      对象合并指定对象名称:

      1. @Controller  
      2. public class Hello2ModelController {  
      3.       
      4.     @ModelAttribute(“myUser”)  
      5.     public User populateModel() {    
      6.        User user=new User();  
      7.        user.setAccount(”ray”);  
      8.        return user;  
      9.     }    
      10.       
      11.     @RequestMapping(value = “/helloWorld2”)    
      12.     public String helloWorld(@ModelAttribute(“myUser”) User user) {  
      13.         user.setName(”老王”);  
      14.        return “helloWorld.jsp”;    
      15.     }    
      16. }  
      @Controller
      public class Hello2ModelController {
      
          @ModelAttribute("myUser")
          public User populateModel() {  
             User user=new User();
             user.setAccount("ray");
             return user;
          }  
      
          @RequestMapping(value = "/helloWorld2")  
          public String helloWorld(@ModelAttribute("myUser") User user) {
              user.setName("老王");
             return "helloWorld.jsp";  
          }  
      }
      
      

      这样在jsp中可以使用如下方式访问


      1. <c:out value={myUser.name}"</span><span class="tag">&gt;</span><span class="tag">&lt;/</span><span class="tag-name">c:out</span><span class="tag">&gt;</span><span>&nbsp;&nbsp;</span></span></li><li class=""><span><span class="tag">&lt;</span><span class="tag-name">c:out</span><span>&nbsp;</span><span class="attribute">value</span><span>=</span><span class="attribute-value">"{myUser.account}”></c:out>  
      <c:out value="${myUser.name}"></c:out>
      <c:out value="${myUser.account}"></c:out>
      
      

      3.通过此特性控制权限.

      我们可以在基类方法中控制写此注解,需要控制权限的控制器,继承控制器就可以了。


      1. public class BaseController {  
      2.       
      3.     @ModelAttribute  
      4.     public void populateModel() throws Exception {    
      5.        SysUser user=ContextUtil.getCurrentUser();  
      6.        if(user.getAccount().equals(“admin”)){  
      7.            throw new Exception(“没有权限”);  
      8.        }  
      9.     }    
      10. }  
      public class BaseController {
      
          @ModelAttribute
          public void populateModel() throws Exception {  
             SysUser user=ContextUtil.getCurrentUser();
             if(user.getAccount().equals("admin")){
                 throw new Exception("没有权限");
             }
          }  
      }
      
      

      需要控制权限的类继承BaseController

      1. @Controller  
      2. public class Hello2ModelController extends BaseController {  
      3.       
      4.     @RequestMapping(value = “/helloWorld2”)    
      5.     public String helloWorld(@ModelAttribute(“myUser”) User user) {  
      6.         user.setName(”老王”);  
      7.        return “helloWorld.jsp”;    
      8.     }    
      9. }  
      @Controller
      public class Hello2ModelController extends BaseController {
      
          @RequestMapping(value = "/helloWorld2")  
          public String helloWorld(@ModelAttribute("myUser") User user) {
              user.setName("老王");
             return "helloWorld.jsp";  
          }  
      }
      
      

      这样就可以控制权限了,当然控制权限的方法有很多,比如通过过滤器等。这里只是提供一种思路。


      总结:


      @ModelAttribute具有如下三个作用:

      ①绑定请求参数到命令对象:放在功能处理方法的入参上时,用于将多个请求参数绑定到一个命令对象,从而简化绑定流程,而且自动暴露为模型数据用于视图页面展示时使用。其实@ModelAttribute此处对于供视图页面展示来说与model.addAttribute(”attributeName”, abc);功能类似,当传递为**对象**时经常使用。同时会配合RequestMethod.**POST**(POst也用于传递对象)

      1. public String test(@ModelAttribute(“user”) UserModel user)   
      public String test(@ModelAttribute("user") UserModel user) 

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


      ②暴露@RequestMapping 方法返回值为模型数据:放在功能处理方法的返回值上时,是暴露功能处理方法的返回值为模型数据,用于视图页面展示时使用。

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


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

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



      ③暴露表单引用对象为模型数据:放在处理器的一般方法(非功能处理方法)上时,是为表单准备要展示的表单引用对象,如注册时需要选择的所在城市等,而且在执行功能处理方法(@RequestMapping 注解的方法)之前,自动添加到模型对象中,用于视图页面展示时使用;



评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值