Spring MVC中的@ModelAttribute注解

本文介绍在Spring MVC中非常重要的注解@ModelAttribute.这个注解可以用在方法参数上,或是方法声明上。这个注解的主要作用是绑定request或是form参数到模型对象。可以使用保存在request或session中的对象来组装模型对象。注意,被@ModelAttribute注解的方法会在controller方法(@RequestMapping注解的)之前执行。因为模型对象要先于controller方法之前创建。

请看下面的例子

  • ModelAttributeExampleController.java 是controller类,同时包含@ModelAttribute方法。
  • UserDetails.java是本例中的模型对象
  • 最后是Spring的配置文件
//ModelAttributeExampleController.java
package javabeat.net;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;

@Controller
public class ModelAttributeExampleController {
    @Autowired
    private UserDetails userDetails;
    @RequestMapping(value="/modelexample")
    public String getMethod(@ModelAttribute UserDetails userDetails){
        System.out.println("User Name : " + userDetails.getUserName());
        System.out.println("Email Id : " + userDetails.getEmailId());
        return "example";
    }

    //This method is invoked before the above method
    @ModelAttribute
    public UserDetails getAccount(@RequestParam String user, @RequestParam String emailId){
        System.out.println("User Value from Request Parameter : " + user);
        userDetails.setUserName(user);
        userDetails.setEmailId(emailId);
        return userDetails;
    }
}
//UserDetails.java
package javabeat.net;

public class UserDetails {
    private String userName;
    private String emailId;

    public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }

    public String getEmailId() {
        return emailId;
    }

    public void setEmailId(String emailId) {
        this.emailId = emailId;

    }
}
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context"
xmlns:jms="http://www.springframework.org/schema/jms"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-2.5.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context-2.5.xsd
http://www.springframework.org/schema/jms

http://www.springframework.org/schema/jms/spring-jms-2.5.xsd">
<context:component-scan base-package="org.spring.examples" />
<bean id="userDetails" class="org.spring.examples.UserDetails"/>
</beans>

-上面的例子,getAccount方法使用@ModelAttribute注解。这意味着方法会在controller的方法之前执行。这个方法会使用request的参数设置模型对象。这是一种在方法中设置值的途径。

-另一种@ModelAttribute注解的使用方法,是用在方法的参数上。在调用方法的时候,模型的值会被注入。这在实际使用时非常简单。将表单属性映射到模型对象时,这个注解非常有用。