@ModelAttribute注解的使用

来源：互联网发布：唯品会官网首页淘宝编辑：程序博客网时间：2024/05/20 21:21

先看一下，spring官方给的解释：

@ModelAttribute has two usage scenarios in controllers. When you place it on a method parameter, @ModelAttribute maps a model attribute to the specific, annotated method parameter (see the processSubmit() method below). This is how the controller gets a reference to the object holding the data entered in the form.

You can also use @ModelAttribute at the method level to provide reference data for the model (see the populatePetTypes() method in the following example). For this usage the method signature can contain the same types as documented previously for the @RequestMapping annotation.

Note
@ModelAttribute annotated methods are executed before the chosen @RequestMapping annotated handler method. They effectively pre-populate the implicit model with specific attributes, often loaded from a database. Such an attribute can then already be accessed through @ModelAttribute annotated handler method parameters in the chosen handler method, potentially with binding and validation applied to it.

Spring3关于@ModelAttribute的文档

模式一（作用于方法上）

@ModelAttribute(value="user")public Employee initUser(HttpServletRequest request){return getSesionUser(request);}

这种情况下，你调用任何一个它所在的类中的链接，即@requestMapping方法的时候都会首先执行这个方法，并且返回对象，对象的标签就是该注解的value,这边就是"user".这样你在jsp页面中就可以使用这个user对象。使用方法就是${user.usercode}

遇到的问题，一些其他的类继承这个类，所以在调用它们里面的链接的时候都会调用一次这个链接，可是有个类的调用是不需要登录的，所以获取不到session,这个时候就会报错，可是这个类的业务本身是不需要session的，所以在用这个属性的时候主要使用场景。

模式二（作用在方法属性上）

@RequestMapping(value="/{userCode}/newRegular")public String newRegular(@ModelAttribute(value="user")Model model,@PathVariable(value="userCode")int userCode){        Employee  ep = getSesionUser(request);        if(!employeeService.checkEmployee(userCode,ep.getCompanyObject())){            return error_new(model,"对不起，无此员工信息，请联系管理员");        } if (ep.checkPrivilege(Constants.CHANGES_ADD)) { processRequest(userCode, model, EmployeeChangeRecords.CHANGE_TYPE_REGULAR); return "/changes/newRegular"; } return errorNoPrivilege(model);}

在方法上面使用，则对应的jsp页面操作完后返回的参数自动匹配到命名user对象上面。参考的例子如下：

Java代码  
package org.liukai.tutorial.controller;  
  
import java.util.ArrayList;  
import java.util.List;  
  
import javax.annotation.Resource;  
  
import org.apache.log4j.Logger;  
import org.liukai.tutorial.domain.Person;  
import org.liukai.tutorial.service.PersonService;  
import org.springframework.stereotype.Controller;  
import org.springframework.ui.Model;  
import org.springframework.web.bind.annotation.ModelAttribute;  
import org.springframework.web.bind.annotation.PathVariable;  
import org.springframework.web.bind.annotation.RequestMapping;  
import org.springframework.web.bind.annotation.RequestMethod;  
  
@Controller  
@RequestMapping("/main")  
public class MainController {  
  
    protected static Logger logger = Logger.getLogger("controller");  
  
    @Resource(name = "personService")  
    private PersonService personService;  
  
    /** 
     * 获得所有Person,并使他们成为一个model. 
     */  
    @ModelAttribute("persons")  
    public List<Person> getAllPersons() {  
        logger.debug("Retrieving all persons and adding it to ModelAttribute");  
        // Delegate to PersonService  
        return personService.getAll();  
    }  
  
    /** 
     * 获得所有的货币类型,并使他们成为一个model. 
     */  
    @ModelAttribute("currencies")  
    public List<String> getAllCurrencies() {  
        logger.debug("Retrieving all currencies and adding it to ModelAttribute");  
  
        // Prepare data  
        List<String> currencies = new ArrayList<String>();  
        currencies.add("Dollar");  
        currencies.add("Yen");  
        currencies.add("Pound");  
        currencies.add("Euro");  
        currencies.add("Dinar");  
  
        return currencies;  
    }  
  
    /** 
     * 处理和检索一个包含Perosn 的JSP Page 
     */  
    @RequestMapping(method = RequestMethod.GET)  
    public String getAllPage(Model model) {  
  
        logger.debug("Received request to show all persons page");  
  
        // personsage.jsp会引用一个名叫persons的model attribute  
        // 我们不需要手动添加这个model  
        // 前面他已经自动的通过@ModelAttribute("persons")进行了添加.  
  
        // 他会解析 /WEB-INF/jsp/personspage.jsp  
        return "personspage";  
    }  
  
    /** 
     * 检索修改页面 
     */  
    @RequestMapping(value = "/edit/{id}", method = RequestMethod.GET)  
    public String getEdit(@PathVariable Integer id, Model model) {  
        /* 
         * @PathVariable表示指定@RequestMapping的URL模板中{}里的值  
         * 相当于以前我们URL后面传的参数如XX?id=XXXX . 
         * 但是现在我们可以用 XX/id/XX来代替.  
         * 这个就是REST风格的URL,我们可以实现非常复杂的URL模板 
         */  
  
        logger.debug("Received request to show edit page");  
  
        /* 
         * 根据ID检索出对应的Person,然后把检索出来的Person放入一个叫 
         * "personAttribute"的model中. 
         * 这样editpage.jsp就会接收一个 名为personAttribute的参数. 
         * 相当于request.setAttribute("XX",XX) 
         */  
        model.addAttribute("personAttribute", personService.get(id));  
  
        // This will resolve to /WEB-INF/jsp/editpage.jsp  
        return "editpage";  
    }  
  
    /** 
     * 保存修改结果 
     */  
    @RequestMapping(value = "/edit/{id}", method = RequestMethod.POST)  
    public String saveEdit(@ModelAttribute("personAttribute") Person person,  
            @PathVariable Integer id, Model model) {  
        logger.debug("Received request to update person");  
  
        // 我们从页面接收到了一个名为"personAttribute"的model并命名为person  
        // 同样我们也获得了指定的id.  
        person.setId(id);  
  
        // 更新person  
        personService.edit(person);  
  
        // 在更新后我们重新显示所有Person 的页面  
        model.addAttribute("persons", personService.getAll());  
  
        // This will resolve to /WEB-INF/jsp/personspage.jsp  
        return "personspage";  
    }  
  
}  

这个controller里定义了两个method级别的@ModelAttribute方法:getAllPersons和getAllCurrencies
我们已经了解了他们的用法和意义.
然后在saveEdit方法中,有个一个参数是用@ModelAttribute注解的.

Java代码  
@RequestMapping(value = "/edit/{id}", method = RequestMethod.POST)  
    public String saveEdit(@ModelAttribute("personAttribute") Person person,   
      @PathVariable Integer id, Model model) {  
...  
}  

表示从JSP 页面返回的一个叫"personAttribute"的值.并自动的转化为Person对象.
这样和以前我们用的request.getParameters("personAttribute")效果一样.
但是一个是操作参数对象.一个是处理请求.两者的实现思想不同.

在此controller中我们有3个映射:
/main - 检索所有的Person

/main/edit/{id} - (GET)根据ID进行检索和edit

/main/edit/{id} - (POST) 根据ID进行更新

注:后两者的URL虽然一样,
但一个是GET方法,一般用于检索.
一个是POST方法,一般用于提交表单.
如果大家有注意@RequestMapping中的method方法其实有四种.
GET
POST
PUT
DELETE

每个方法对应一个逻辑操作.对于REST风格的编程是一个相当好的补充.
关于这点感兴趣的同学可以看看springsource一篇官方BLOG:REST in Spring 3: @MVC

让我们继续完成其他的JSP

personspage.jsp

Jsp代码  
<%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %>  
<%@ page language="java" contentType="text/html; charset=UTF-8"  
    pageEncoding="UTF-8"%>  
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">  
<html>  
<head>  
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">  
<title>Insert title here</title>  
</head>  
<body>  
  
<h1>Persons</h1>  
  
<table>  
    <tr>  
        <td width="50">Id</td>  
        <td width="150">First Name</td>  
        <td width="150">Last Name</td>  
        <td width="100">Money</td>  
        <td width="50">Currency</td>  
    </tr>  
    <c:forEach items="${persons}" var="person">  
        <tr>  
            <td><c:out value="${person.id}" /></td>  
            <td><c:out value="${person.firstName}" /></td>  
            <td><c:out value="${person.lastName}" /></td>  
            <td><c:out value="${person.money}" /></td>  
            <td><c:out value="${person.currency}" /></td>  
        </tr>  
    </c:forEach>  
</table>  
  
</body>  
</html>  

这个主要是映射 /main.

editpage.jsp

Jsp代码  
<%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %>  
<%@ taglib uri="http://www.springframework.org/tags/form" prefix="form" %>  
<%@ page language="java" contentType="text/html; charset=UTF-8"  
    pageEncoding="UTF-8"%>  
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">  
<html>  
<head>  
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">  
<title>Insert title here</title>  
</head>  
<body>  
  
<h1>Edit Person</h1>  
  
<c:url var="saveUrl" value="/main/edit/${personAttribute.id}" />  
  
<form:form modelAttribute="personAttribute" method="POST" action="${saveUrl}">  
    <table>  
        <tr>  
            <td><form:label path="id">Id:</form:label></td>  
            <td><form:input path="id" disabled="true"/></td>  
        </tr>  
      
        <tr>  
            <td><form:label path="firstName">First Name:</form:label></td>  
            <td><form:input path="firstName"/></td>  
        </tr>  
  
        <tr>  
            <td><form:label path="lastName">Last Name</form:label></td>  
            <td><form:input path="lastName"/></td>  
        </tr>  
          
        <tr>  
            <td><form:label path="money">Money</form:label></td>  
            <td><form:input path="money"/></td>  
        </tr>  
          
        <tr>  
            <td><form:label path="currency">Currency:</form:label></td>  
            <td><form:select path="currency"  items="${currencies}"/></td>  
        </tr>  
    </table>  
      
    <input type="submit" value="Save" />  
</form:form>  
  
</body>  
</html>  

此页面返回以下controller中的方法:

Java代码  
@RequestMapping(value = "/edit/{id}", method = RequestMethod.GET)  
    public String getEdit(@PathVariable Integer id, Model model) {  
...  
}  

我们可以通过类似
http://localhost:8080/spring-jsp/main/edit/1
的链接进行编辑.
下面是编辑页面

当我们编辑完提交表格,执行了下面的方法

Java代码  
  @RequestMapping(value = "/edit/{id}", method = RequestMethod.POST)  
    public String saveEdit(@ModelAttribute("personAttribute") Person person,   
      @PathVariable Integer id, Model model) {  
...  
}  

0 0