Spring MVC表单标签库实例代码入门教程

悠悠 2022-09-24 09:25 110阅读 0赞

原文：[Spring MVC表单标签库实例代码入门教程][Spring MVC]

源代码下载地址： [http://www.zuidaima.com/share/1825321313733632.htm][Spring MVC]

**概述**  
    在低版本的Spring中，你必须通过JSTL或<spring:bind>将表单对象绑定到HTML表单页面中，对于习惯了Struts表单标签的开发者来说，Spring MVC的这一表现确实让人失望。不过这一情况已经一去不复返了，从Spring 2.0开始，Spring MVC开始全面支持表单标签，通过Spring MVC表单标签，我们可以很容易地将控制器相关的表单对象绑定到HTML表单元素中。  
在本文中我们将对Spring MVC表单标签进行全面的介绍，让我们首先从<form:form>标签开始吧。

**form标签**  
    和使用任何JSP扩展标签一样，在使用Spring表单标签之前，你必须在JSP页面中添加一行引用Spring表单标签的声明，如下所示：

<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
    <%@ taglib prefix="form" uri="http://www.springframework.org/tags/form"%> ①引入标签的声明
    <html>
    … ②声明后，在页面中就可以使用任意Spring表单标签了
    </html>

一般情况下，我们使用“form”作为Spring MVC表单标签的前缀，当然只要愿意，你可以调整为其它的前缀名。在声明好标签引用后，就可以在该JSP文件中使用所有Spring MVC的表单标签了。下面是一个使用<form:form>表单标签的示例，它将最终生成一个HTML的 form表单：

<form:form>
    用户名：<form:input path="userName" /> <br>
    密 码：<form:password path="password" /><br>
    Email：<form:input path="email" /><br>
    <input type="submit" value="注册" name="testSubmit"/>
    <input type="reset" value="重置" />
    </form:form>

正因为表单页面是通过访问表单控制器导向过来的，所以<form:form>标签本身无需做额外的设置就可以达到以下两个目标：  
    1) 它不需要象HTML的<form>标签或Struts的表单标签一样通过action属性指定表单提交的地址。假设和<form:form>标签对应的控制器的URL是“/registerUser.html”，应用部署目录为“baobaotao”，则最后产生的HTML代码自动包含表单提交地址：  
<form id="command" method="post" action="/baobaotao//registerUser.html">…</form>  
    2) <form:form>标签内部的组件标签（如<form:input>、<form:password>等）可以直接和表单控制器所对应的表单对象进行值绑定。

默认情况下，表单控制器将表单对象以“command”为名放到PageContext中，你可以通过表单控制器commandName属性的设置使用其它的名字（假设设置为“user”），这时你必须通过<form:form commandName="user">显式指定绑定的表单对象名称。

除了commandName属性外，Spring表单标签拥有丰富的可设置属性，这些属性大都是HTML表单标签属性的镜像，如onclick、ondblclick、tabindex等等。需要注意的一点是这些属性都是小写的，而对应的HTML标签的属性则没有这个限制。但是有几个和HTML标签有区别的属性，我们通过表 1进行说明：

表 1 表单元素标签特殊属性

<table> 
 <tbody> 
  <tr> 
   <td> <p>目录</p> </td> 
   <td> <p>说明</p> </td> 
  </tr> 
  <tr> 
   <td> <p>cssClass</p> </td> 
   <td> <p>使用该属性指定表单元素CSS样式名，相当于HTML元素的class属性。示例：&lt;form:input path="userName" cssClass="inputStyle"/&gt;。</p> </td> 
  </tr> 
  <tr> 
   <td> <p>cssStyle</p> </td> 
   <td> <p>直接通过该属性指定样式，相当于HTML元素的style属性。示例：</p> <p>&lt;form:input path="userName" cssStyle="width:100px"/&gt;。</p> </td> 
  </tr> 
  <tr> 
   <td> <p>cssErrorClass</p> </td> 
   <td> <p>cssClass表示表单元素未发生错误时对应的样式，而cssErrorClass表示表单元素发生错误时对应的样式，示例：</p> </td> 
  </tr> 
 </tbody> 
</table>

**输入组件标签**  
    表单中有一些用于接受输入值的组件，如单行文本框、多行文本框以及密码框，Spring为它们提供了对应的表单标签，请看下面的例子：  
代码清单 1 使用输入组件标签的表单

<form:form>
    用户名：<form:input path="userName" /> <br> ①单行文件框标签
    密 码：<form:password path="password" /><br> ②密码框标签
    描 述：<form:textarea path="desc" cols="20" rows="3"/><br> ③多行文件框标签
    <form:hidden path="times"/> ④隐藏组件的值
    <input type="submit" value="注册" name="testSubmit"/>
    <input type="reset" value="重置" />
    </form:form>

正如你看到的，所有表单组件标签都通过path属性绑定表单对象的属性值，它支持级联属性，比如path="user.userName"将调用表单对象getUser.getUserName()绑定表单对象的属性值。这些表单组件标签拥有大多数HTML组件标签的镜像属性，如③处的<form:textarea>就使用了cols和rows属性设定列数和行数。

以上使用表单标签的页面的对应HTML页面如下所示：

**单选框和复选框组件标签**   
    单选框和复选框组件虽然在HTML中都对应<input>元素标签，但在Spring MVC表单标签中，它们分别对应两个更达意的标签：

<form:radiobutton>和<form:checkbox>。
    radiobutton
    单选框组件由两个同名的标签组件组成，当表单对象对应属性值和value值相等时，单选框选中。下面是一个代表性别的单选框：
    <form:form>
    性 别：<form:radiobutton path="sex" value="0"/>男
    <form:radiobutton path="sex" value="1"/>女
    </form:form>
    当表单对象的sex属性为0时（可以是String、int等可以自动转换为String的类型），所生成的HTML代码如下所示：
    <form id="command" method="post" action="/baobaotao//registerUser.html">
    性 别：<input id="sex1" name="sex" type="radio" value="0" checked="checked"/>男
    <input id="sex2" name="sex" type="radio" value="1"/>女
    </form>

**checkbox**   
    复选框组件标签相对来说复杂一些，复选框组件对应的表单属性不但可以boolean类型，还可以是String\[\]、Collection，Enum等类型。针对不同属性类型，复选框的选中状态的判断条件是不一样的：  
 boolean类型：当对应属性为true时，该复选框选中（一个属性仅对应一个复选框）；  
 String\[\]、Collection或Enum类型：复选框对应值出现在对应属性列表中，该复选框选中；  
 其它类型：当复选框对应的值可以转换为对应属性值，该复选框选中。  
假设用户注册的User表单对象包含了一个List类型的favorites属性：

import java.util.List; 
     public class User { 
     private List favorites; 
     public List getFavorites() { 
     return favorites; 
     } 
     public void setFavorites(List favorites) { 
     this.favorites = favorites; 
     } 
     }

我们希望将其在页面中使用一个复选框组件绑定这个属性，则可以使用以下的代码：  
代码清单 2 复选框标签的使用

<form:form> 
    兴趣爱好： 
    <form:checkbox path="favorites" value="1"/>computer 
     <form:checkbox path="favorites" value="2"/>sport 
     <form:checkbox path="favorites" value="3"/>entertainment 
     <form:checkbox path="favorites" value="4"/>literature 
     </form:form>

除了正常的path属性名外，还必须提供一个value属性，假设User表单对象的favorites属性包括了1和3的值，那么产生的HTML页面为：

<form id="command" method="post" action="/baobaotao//registerUser.html"> 
    兴趣爱好：<input id="favorites1" name="favorites" type="checkbox" value="1" checked="checked"/> 
     <input type="hidden" value="1" name="_favorites"/>computer 
     <input id="favorites2" name="favorites" type="checkbox" value="2" /> 
     <input type="hidden" value="1" name="_favorites"/>sport 
     <input id="favorites3" name="favorites" type="checkbox" value="3" checked="checked"/> 
     <input type="hidden" value="1" name="_favorites"/>entertainment 
     <input id="favorites4" name="favorites" type="checkbox" value="4"/> 
     <input type="hidden" value="1" name="_favorites"/>literature 
     </form>

大家可能已经注意到每个复选框组件的后台都跟着一个隐藏组件，这是因为当HTML页面中的复选框没有被选中时，这个复选框的值不会在表单提交时作为HTTP请求参数发送到服务器端，这给Spring的表单数据绑定造成了麻烦——因为无法触发setFavorites()方法的调用（如果原来已经有值，这个值不会被设置为空）。解决方法就是在每个复选框后面加一个隐藏组件，并且将对应的复选框名字前添加一个下划线（"\_"）作为隐藏组件的名字。这样一来，你相当于告诉Spring“这个表单中存在这样一个复选框，我希望表单对象中对应的属性和这个checkbox的状态保持一致”。  
假设复选框对应的选项在数据库或配置文件中定义，那么页面复选框标签就不能通过硬编码的方式指定，相反必须根据配置的选项数据动态产生。对于这样的需求，代码清单 2的编写方式显然不能满足需求。回忆一下表单控制器的工作流程，我们知道可以通过复写referenceData()方法在表单显示前准备一些需要的数据，现在终于派上用场了，来看一下具体的实现：

代码清单 3 UserRegisterController：准备表单显示数据

package com.baobaotao.web.user;
    …
    import org.springframework.ui.ModelMap;
    public class UserRegisterController extends SimpleFormController {
    private BbtForum bbtForum;
    ①创建初始表单对象
    protected Object formBackingObject(HttpServletRequest request)
    throws Exception {
    int userId = ServletRequestUtils.getIntParameter(request, "userId",-1);
    User user = bbtForum.getUser(userId);
    user.setUserName("tom");
    List favorites = new ArrayList();①-1默认选中值为1和3的选项
    favorites.add("1");
    favorites.add("3");
    user.setFavorites(favorites);
    return user;
    }
    @Override ②准备表单显示时需要的数据
    protected Map referenceData(HttpServletRequest request) throws Exception {
    Map favoriteMap = new LinkedHashMap();
    favoriteMap.put("1", "computer");
    favoriteMap.put("2", "sport");
    favoriteMap.put("3", "entertainment");
    favoriteMap.put("4", "literature");
    ②-1将表单页面需要的对象以ModelMap返回，最终将以属性名值对方式出现在请求属性中
    return new ModelMap().addObject("favoriteMap", favoriteMap);
    }
    @Override
    protected ModelAndView onSubmit(Object command, BindException errors)
    throws Exception {
    User user = (User) command;
    bbtForum.registerUser(user);
    return new ModelAndView(getSuccessView(), "user", user);
    }
    }

原文网址：[http://www.blogjava.net/Alpha/archive/2009/06/26/284241.html][http_www.blogjava.net_Alpha_archive_2009_06_26_284241.html]

[Spring MVC]: http://www.zuidaima.com/share/1825321313733632.htm
[http_www.blogjava.net_Alpha_archive_2009_06_26_284241.html]: http://www.blogjava.net/Alpha/archive/2009/06/26/284241.html