关闭

SpringMVC框架上传表单时怎么将表单数据与实体对象绑定,然后在控制器中调用

5843人阅读 评论(0) 收藏 举报

时下很多 Web 框架 都实现了 Form 表单域与 Java 对象属性的自动装配功能,该功能确实非常有用,试想如果没这功能则势必到处冲积着 request.getParameter() 系列方法与类型转换方法的调用。重复代码量大,容易出错,同时又不美观,影响市容。

  现在的问题是,这些框架通过什么方法实现自动装配的?如果不用这些框架我们自己如何去实现呢?尤其对于那些纯 JSP/Servlet 应用,要是拥有自动装配功能该多好啊!本座深知各位之期盼,决定把自动装配的原理和实现方法娓娓道来。

  实现原理其实比较简单,主要由以下3个步骤构成:

    1. 通过 request.getParameterMap() 获取被提交的 Form 的所有表单域的名称-值映射,其中名称和值均为字符串类型。
    2. 利用 java.beans.PropertyDescriptor 对象获取 Java Bean 的所有属性的名称及其类型。
    3. 把表单域的名称与 Bean 的属性的名称逐个进行匹配,当找到相匹配的属性时就调用 Bean 的 setter 方法把表单域的值设置给该 Bean 属性。当然,因为表单域的值总是字符串类型,很可能与 Bean 属性的类型不一致,所以在设置 Bean 属性前要进行必要的类型转换。

  上面所表述的3点原理不知大家是否完全理解,没关系,下面我们通过一个具体的表单提交的例子来看一看实际的效果,首先看看待提交的表单页面及其代码:

复制代码
<form action="checkbean.action" method="post">
    First Name: <input type="text" name="firstName" value="丑">
    <br>
    Last Name: <input type="text" name="lastName" value="怪兽">
    <br>
    Birthday: <input type="text" name="birthday" value="1978-11-03">
    <br>
    Gender: 男 <input type="radio"" name="gender" value="false">
        &nbsp;<input type="radio"" name="gender" value="true" checked="checked">
    <br>
    Working age: <select name="working-Age">
        <option value="-1">-请选择-</option>
        <option value="3">三年</option>
        <option value="5" selected="selected">五年</option>
        <option value="10">十年</option>
        <option value="20">二十年</option>
    </select>
    <br>
    Interest: 游泳 <input type="checkbox" name="its" value="1" checked="checked">
        &nbsp;打球 <input type="checkbox" name="its" value="2" checked="checked">
        &nbsp;下棋 <input type="checkbox" name="its" value="3">
        &nbsp;打麻将 <input type="checkbox" name="its" value="4">
        &nbsp;看书 <input type="checkbox" name="its" value="5" checked="checked">
    <br>
<br>
<input type="submit" value="确 定">&nbsp;&nbsp;<input type="reset" value="重 置">
</form>
复制代码

 

  从上图可以看出,总共有6个表单域,其名称-值分别是:{"firstName" - "丑","lastName" - "怪兽","birthday" - "1978-11-03","gender" - "女","working-Age" - "5","its" - "1,2,5"},该表单需要提交给 checkbean.action 进行处理(请注意:不要一看到 .aciton 就以为是 struts2,骑白马的不一定都是唐僧!),下面来看看 CheckBean Action 的处理代码和 Bean 的定义:

 

复制代码
import java.util.HashMap;
import java.util.Map;

import vo.Persion;

import com.bruce.mvc.ActionSupport;

public class CheckBean extends ActionSupport
{
    @Override
    public String execute()
    {
        // 如果表单元素的名称和 Form Bean 属性名不一致则使用 keyMap 进行映射
        // key: 表单元素名称, value: Form Bean 属性名
        Map<String, String> keyMap = new HashMap<String, String>();
        keyMap.put("working-Age", "workingAge");
        keyMap.put("its", "interest");
        
        /* 自动装配方法一 */
        // 使用表单元素创建 Form Bean
        // 如果表单元素的名称和 Form Bean 属性名完全一致则不需使用 keyMap 进行映射
        Persion p = createFormBean(Persion.class, keyMap);
        
        /* 自动装配方法二 */
        // 先创建 Form Bean 对象, 然后再填充它的属性
        Persion p2 = new Persion();
        fillFormBeanProperties(p2, keyMap);
        
        // 可以获取 Form Bean 的所有属性值
        //Map<String, Object> result = BeanHelper.getProperties(p);
        
        // 把 p 设置为 request 属性,并最终在结果页面展示
        setRequestAttribute("persion", p);
        
        return SUCCESS;
    }
}
复制代码
复制代码
import java.util.Date;
import java.util.List;

public class Persion
{
    private String firstName;
    private String lastName;
    private Date birthday;
    private boolean gender;
    private int workingAge;
    private int[] interest;
    private List<String> photos;

    // getter 和 setter 方法
    // (略)。。。。。。
}
复制代码


   从 CheckBean 的代码可以看出,它是通过 createFormBean() 或 fillFormBeanProperties() 方法来自动装配 Persion 的,它们之间的区别是:前者会直接创建新的 Persion 对象,而后者填充原有 Persion 对象的属性。请注意,如果表单域的名称与 Persion 对应的属性名不一致则用 keyMap 进行映射,如表单域 "working-Age" 是对应 Persion 的 workingAge 属性的,但它们的名称不一致,所以要进行映射。另外,Persion 有一个 photos 属性,而我们的表单域却没有,自动装配时会忽略该属性。最后看一下输出的结果页面及其代码:

复制代码
  <body>
  <br>
  <div align="right">
      <a href="index.action"><u:msg key="jsp-set_locale.back-to-index"/></a>
  </div>
    <br><br><br><br>
    <div align="center">
    <table border="1">
    <caption>Persion Attributs</caption>
    
        <tr><td>Name</td><td><c:out value="${persion.firstName} ${persion.lastName}"/>&nbsp;</td></tr>
        <tr><td>Brithday</td><td><c:out value="${persion.birthday}"/>&nbsp;</td></tr>
        <tr><td>Gender</td><td><c:out value="${persion.gender}"/>&nbsp;</td></tr>
        <tr><td>Working Age</td><td><c:out value="${persion.workingAge}"/>&nbsp;</td></tr>
        <tr><td>Interest</td><td><c:forEach var="its" items="${persion.interest}">
                                     <c:out value="${its}" /> &nbsp;
                              </c:forEach>&nbsp;</td></tr>
        <tr><td>Photos</td><td><c:forEach var="p" items="${persion.photos}">
                                     <c:out value="${p}" /><br>
                              </c:forEach>&nbsp;</td></tr>
    </table>
   </div>
  </body>
复制代码

  

  通过上面的例子可以看到,通过自动装配 Bean,我们获得了非常大的便利。现在我们就从createFormBean() 和 fillFormBeanProperties() 开始,逐步揭开自动装配的神秘面纱,先看看下面两个类及其方法的定义:

 

复制代码
package com.bruce.mvc;

import com.bruce.util.http.HttpHelper;

/** {@link Action} 对象公共基类 */
public class ActionSupport implements Action
{
    private ServletContext servletContext;
    private HttpServletRequest request;
    private HttpServletResponse response;
    private HttpSession session;

    /** 默认 {@link Action} 入口方法(返回 {@link Action#SUCCESS}) */
    public String execute()
    {
        return SUCCESS;
    }

    /** 使用表单元素创建 Form Bean (表单元素的名称和 Form Bean 属性名完全一致) */
    public final <T> T createFormBean(Class<T> clazz)
    {
        return HttpHelper.createFormBean(request, clazz);
    }

    /** 使用表单元素创建 Form Bean (用 keyMap 映射与表单元素名称不对应的 Form Bean 属性) */
    public final <T> T createFormBean(Class<T> clazz, Map<String, String> keyMap)
    {
        return HttpHelper.createFormBean(request, clazz, keyMap);
    }
    
    /** 使用表单元素填充 Form Bean (表单元素的名称和 Form Bean 属性名完全一致) */
    public final <T> void fillFormBeanProperties(T bean)
    {
        HttpHelper.fillFormBeanProperties(request, bean);
    }
    
    /** 使用表单元素填充 Form Bean (用 keyMap 映射与表单元素名称不对应的 Form Bean 属性) */
    public final <T> void fillFormBeanProperties(T bean, Map<String, String> keyMap)
    {
        HttpHelper.fillFormBeanProperties(request, bean, keyMap);
    }
    
    // 其它方法
    // (略)。。。
}
复制代码
复制代码
package com.bruce.util.http;

import com.bruce.util.BeanHelper;

/** HTTP 帮助类 */
public class HttpHelper
{
    /** 使用表单元素创建 Form Bean (表单元素的名称和 Form Bean 属性名完全一致) */
    public final static <T> T createFormBean(HttpServletRequest request, Class<T> clazz)
    {
        return createFormBean(request, clazz, null);
    }

    /** 使用表单元素创建 Form Bean (用 keyMap 映射与表单元素名称不对应的 Form Bean 属性) */
    public final static <T> T createFormBean(HttpServletRequest request, Class<T> clazz, Map<String, String> keyMap)
    {
        Map<String, String[]> properties = getParamMap(request);
        return BeanHelper.createBean(clazz, properties, keyMap);
    }
    
    /** 使用表单元素填充 Form Bean (表单元素的名称和 Form Bean 属性名完全一致) */
    public final static <T> void fillFormBeanProperties(HttpServletRequest request, T bean)
    {
        fillFormBeanProperties(request, bean, null);
    }
    
    /** 使用表单元素填充 Form Bean (用 keyMap 映射与表单元素名称不对应的 Form Bean 属性) */
    public final static <T> void fillFormBeanProperties(HttpServletRequest request, T bean, Map<String, String> keyMap)
    {
     Map<String, String[]> properties = getParamMap(request);
     BeanHelper.setProperties(bean, properties, keyMap);
    }
    
    /** 获取 {@link HttpServletRequest} 的所有参数名称和值 */
    public final static Map<String, String[]> getParamMap(HttpServletRequest request)
    {
        return request.getParameterMap();
    }

    // 其它方法
    // (略)。。。
}
复制代码


  哈哈,大家看到了吧,我们迂回了那么久,但 ActionSupport 类和 HttpHelper 类并没有并没有做多少事情,他们只是获取请求参数 Map,并传递给 BeanHelper 类的 createBean() 和 setProperties() 方法进行装配,实际负责装配工作的是 BeanHelper 。这里解析一下为何要写得那么迂回,其实这些代码是从本座自己写的 “Portal-Basic MVC & REST 开发框架” 中摘录出来的,总之一句话:是因为框架的需要而写得那么迂回的,并非本座有意而为之。顺便做下广告:“Portal-Basic MVC & REST 开发框架是一套功能完备的 Web 服务端开发框架,内置 MVC Web 基础架构,支持可扩展的数据访问接口(已内置 Hibernate、MyBaits 和 JDBC 支持),集成拦截器、国际化、文件上传下载和缓存等基础 Web 服务,基于纯 Jsp/Servlet API 实现,非常容易学习和使用尤其适合那些希望使用纯 Jsp/Servlet API 进行开发或对 SSH 等主流框架的复杂性感到繁琐与无奈的人士使用。该框架已通过多个商业项目考验,并不是写来玩的哦。如果各位有兴趣,本座以后再找个机会开个专贴详细介绍下这个框架。

  不扯远了,回到我们的正题,我们再来看看 BeanHelper 的装配工装是如何实现的:

 

复制代码
/** Java Bean 帮助类,执行 Java Bean 属性的 get / set 相关操作 */
public class BeanHelper
{
    /** 创建指定类型的 Java Bean,并设置相关属性
     * 
     *  @param clazz        : Bean 类型
     *  @param properties    : 属性名 / 值映射<br>
     *                        其中名称为 {@link String} 类型,与属性名称可能一直也可能不一致<br>
     *                        属性值可能为以下 3 中类型:<br>
     *                        &nbsp; &nbsp; 1) 属性的实际类型:直接对属性赋值<br>
     *                        &nbsp; &nbsp; 2) {@link String} 类型:先执行自动类型转换再对属赋值<br>
     *                        &nbsp; &nbsp; 3) {@link String}[] 类型:先执行自动类型转换再对属赋值<br>
     *  @param keyMap        : properties.key / Bean 属性名映射,当 properties 的 key 与属性名不对应时,
     *                        用 keyMap 把它们关联起来
     *  @return                  生成的 Bean实例  
     */
    public static final <B, T> B createBean(Class<B> clazz, Map<String, T> properties, Map<String, String> keyMap)
    {
        B bean = null;
        
        try
        {
            // 创建 Bean 实例
            bean = clazz.newInstance();
            // 设置 Bean 属性
            setProperties(bean, properties, keyMap);
        }
        catch(Exception e)
        {
            throw new RuntimeException(e);
        }
        
        return bean;
    }
    
    public static final <B, T> B createBean(Class<B> clazz, Map<String, T> properties)
    {
        return createBean(clazz, properties, null);
    }

    /** 设置 Java Bean 的属性
     * 
     *  @param bean            : Bean 实例
     *  @param properties    : 属性名 / 值映射<br>
     *                        其中名称为 {@link String} 类型,与属性名称可能一直也可能不一致<br>
     *                        属性值可能为以下 3 中类型:<br>
     *                        &nbsp; &nbsp; 1) 属性的实际类型:直接对属性赋值<br>
     *                        &nbsp; &nbsp; 2) {@link String} 类型:先执行自动类型转换再对属赋值<br>
     *                        &nbsp; &nbsp; 3) {@link String}[] 类型:先执行自动类型转换再对属赋值<br>
     *  @param keyMap        : properties.key / Bean 属性名映射,当 properties 的 key 与属性名不对应时,
     *                        用 keyMap 把它们关联起来  
     */
    public static final <T> void setProperties(Object bean, Map<String, T> properties, Map<String, String> keyMap)
    {
        // 获取所有 Bean 属性
        Map<String, PropertyDescriptor> pps = getPropDescMap(bean.getClass());
        Set<Map.Entry<String, T>> set        = properties.entrySet();
        
        // 根据属性名称设置 Bean 的每个属性值
        for(Map.Entry<String, T> o : set)
        {
            String name    = null;    // 属性名称
            String key    = o.getKey();
            
            if(keyMap != null)
                name = keyMap.get(key);
            if(name == null)
                name = key;

            T value    = o.getValue();
            PropertyDescriptor pd = pps.get(name);    // 名称对应的 PropertyDescriptor
            
            if(pd != null && value != null)
                // 设置指定属性值
                setProperty(bean, pd, value);
        }
    }

    public static final <T> void setProperties(Object bean, Map<String, T> properties)
    {
        setProperties(bean, properties, null);
    }

    // 设置指定属性值
    private static final <T> boolean setProperty(Object bean, PropertyDescriptor pd, T value)
    {
        // 获取属性的 setter 方法
        Method method = pd.getWriteMethod();
        // 只处理 public 的实例 setter 方法
        if(method != null && isPublicInstanceMethod(method))
        {
            method.setAccessible(true);
            
            Class<?> clazz = pd.getPropertyType();
            // 设置具体属性值
            setProperty(bean, value, method, clazz);
            
            return true;
        }
        
        return false;
    }

    // 设置具体属性值
    private static <T> void setProperty(Object bean, T value, Method method, Class<?> clazz)
    {
        Object param                = null;
        Class<?> valueType        = value.getClass();
        Class<?> valueComType    = valueType.getComponentType();
        Class<?> clazzComType    = clazz.getComponentType();
        
        // 检查是否需要作类型转换        
        if(
            !clazz.isAssignableFrom(valueType)            &&
            (    
                (valueType.equals(String.class))        || 
                (valueType.isArray() && valueComType.equals(String.class))
            )                                            &&
            (    
                (GeneralHelper.isSimpleType(clazz))        || 
                (clazz.isArray() && GeneralHelper.isSimpleType(clazzComType))
            )
        )
            // 转换为目标类型的属性值
            param = parseParameter(clazz, value);
        else
            param = value;
        
        // 调研 setter 方法设置属性值
        invokeMethod(bean, method, param);
    }
    
    // 执行类型转换 (不解释了,看官们自己参详吧 ^_^)
    private static final <T> Object parseParameter(Class<?> clazz, T obj)
    {
        Object param        = null;
        Class<?> valueType    = obj.getClass();
        
        if(clazz.isArray())
        {
            String[] value = null;
            
            if(valueType.isArray())
                value    = (String[])obj;
            else
            {
                String str    = (String)obj;
                StringTokenizer st = new StringTokenizer(str, " ,;\t\n\r\f");
                value    = new String[st.countTokens()];

                for(int i = 0; st.hasMoreTokens(); i++)
                    value[i] = st.nextToken();
            }
            
            int length        = value.length;
            Class<?> type    = clazz.getComponentType();
            param            = Array.newInstance(type, length);

            for(int i = 0; i < length; i++)
            {
                String v = value[i];
                Object p = GeneralHelper.str2Object(type, v);
                Array.set(param, i, p);
            }
        }
        else
        {
            String value = null;
            
            if(valueType.isArray())
            {
                String[] array    = (String[])obj;
                if(array.length > 0)
                    value = array[0];
            }
            else
                value = (String)obj;
            
            param = GeneralHelper.str2Object(clazz, value);
        }
        
        return param;
    }
    
    // 其他方法
    // (略)。。。
}
复制代码
复制代码
public class GeneralHelper
{
    /** 简单数据类型集合 */
    public static final Set<Class<?>> SMIPLE_CLASS_SET    = new HashSet<Class<?>>(18);

    static
    {
        SMIPLE_CLASS_SET.add(int.class);
        SMIPLE_CLASS_SET.add(long.class);
        SMIPLE_CLASS_SET.add(float.class);
        SMIPLE_CLASS_SET.add(double.class);
        SMIPLE_CLASS_SET.add(byte.class);
        SMIPLE_CLASS_SET.add(char.class);
        SMIPLE_CLASS_SET.add(short.class);
        SMIPLE_CLASS_SET.add(boolean.class);
        SMIPLE_CLASS_SET.add(Integer.class);
        SMIPLE_CLASS_SET.add(Long.class);
        SMIPLE_CLASS_SET.add(Float.class);
        SMIPLE_CLASS_SET.add(Double.class);
        SMIPLE_CLASS_SET.add(Byte.class);
        SMIPLE_CLASS_SET.add(Character.class);
        SMIPLE_CLASS_SET.add(Short.class);
        SMIPLE_CLASS_SET.add(Boolean.class);
        SMIPLE_CLASS_SET.add(String.class);
        SMIPLE_CLASS_SET.add(Date.class);
    }

    /** 检查 clazz 是否为简单数据类型 */
    public final static boolean isSimpleType(Class<?> clazz)
    {
        return SMIPLE_CLASS_SET.contains(clazz);
    }

    /** String -> Any,如果 handler 为 null 则把字符串转换为 8 种基础数据类型、及其包装类、 {@link Date} 或 {@link String},
     *                   如果 handler 不为 null 则由 handler 执行转换 
     * 
     * @param type    : 目标类型的 {@link Class} 对象
     * @param v        : 要转换的字符串
     * @param handler    : 类型转换处理器
     * @return        : 转换结果,如果转换不成功返回 null
     * @throws         : 如果目标类型不支持抛出 {@link IllegalArgumentException}
     * 
     */
    @SuppressWarnings("unchecked")
    public static final <T> T str2Object(Class<T> type, String v, TypeHandler<T> handler)
    {
        Object param = null;
        
        if(handler != null)
            return handler.handle(v);
        
        if(type == String.class)
            param =  safeTrimString(v);
        else if(type == int.class)
            param =  str2Int_0(v);
        else if(type == long.class)
            param =  str2Long_0(v);
        else if(type == byte.class)
            param =  str2Byte_0(v);
        else if(type == char.class)
            param =  str2Char_0(v);
        else if(type == float.class)
            param =  str2Float_0(v);
        else if(type == double.class)
            param =  str2Double_0(v);
        else if(type == short.class)
            param =  str2Short_0(v);
        else if(type == boolean.class)
            param =  str2Boolean_False(v);
        else if(type == Integer.class)
            param =  str2Int(v);
        else if(type == Long.class)
            param =  str2Long(v);
        else if(type == Byte.class)
            param =  str2Byte(v);
        else if(type == Character.class)
            param =  str2Char(v);
        else if(type == Float.class)
            param =  str2Float(v);
        else if(type == Double.class)
            param =  str2Double(v);
        else if(type == Short.class)
            param =  str2Short(v);
        else if(type == Boolean.class)
            param =  str2Boolean(v);
        else if(Date.class.isAssignableFrom(type))
            param =  str2Date(v);
        else
            throw new IllegalArgumentException(String.format("object type '%s' not valid", type));
        
        return (T)param;
    }
    
    public static final <T> T str2Object(Class<T> type, String v)
    {
        return str2Object(type, v, null);
    }
    
    // 其他方法
    // (略)。。。
}
复制代码

 从上面的代码可以看出,BeanHelper 支持8种简单数据类型及其包装类、String 和 Date 类型以及它们的数组类型的自动装配,最后强调一下:BeanHelper 和 GeneralHelper 其实是两个用途非常广泛的类,其作用不单是为了协助 Form 表单域自动装配 Bean 。



文章转自:http://www.cnblogs.com/ldcsaa/archive/2012/02/16/2353030.html

1
1

查看评论
* 以上用户言论只代表其个人观点,不代表CSDN网站的观点或立场
    个人资料
    • 访问:74359次
    • 积分:1389
    • 等级:
    • 排名:千里之外
    • 原创:51篇
    • 转载:63篇
    • 译文:0篇
    • 评论:11条
    文章分类
    最新评论