天天看点

探讨Ajax获取表单值向Servlet传递的设计方案

原文地址: http://www.iteye.com/topic/587879

现在JavaWeb领域,MVC框架越来越多,比较出名的有Struts、Struts2、SpringMVC、WebWork等。而Ajax,作为一种与特定的动态Web编程语言(如Java、C#、PHP)无关的技术,也已经被引入到了Java MVC框架的各家各户。而这些MVC框架,归根到底,都是对Servlet技术的封装。同时,支持Ajax的JavaScript框架(or类库)也越来越多,出名的如Jquery、Ext、Prototype、DWR等,而它们实现异步传输功能还是离不开JavaScript中的XMLHttpRequest这个对象。好,转入正题吧。

Ajax通过XMLHttpRequest对象实现异步传输,那我们首先要获取这个对象。由于浏览器的差异,为了兼容各种常用的浏览器,先写一个初始化XMLHttpRequest对象的方法,代码如下:

Js代码  

探讨Ajax获取表单值向Servlet传递的设计方案
  1. function doGet(url, data, callback) {     
  2.     var url = url;     
  3.     if(url.indexOf("?") == -1) {     
  4.         url = url + "?" + data;     
  5.     } else {     
  6.         url = url + "&" + data;     
  7.     }     
  8.     initXmlHttp();     
  9.     xmlHttp.onreadystatechange = callback;    //注册回调函数     
  10.     xmlHttp.open("GET", url, true);        //设置连接信息     
  11.     xmlHttp.send(null);     
  12. }      
  13. function doPost(url, data, callback) {     
  14.     initXmlHttp();        //初始化     
  15.     xmlHttp.onreadystatechange = callback;    //注册回调函数     
  16.     xmlHttp.open("POST", url, true);     
  17.     xmlHttp.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");     
  18.     xmlHttp.send(data);     
  19. }      
  20. function callback() {     
  21.     //判断对象的状态是否交互完成     
  22.     if(xmlHttp.readyState == 4) {     
  23.         //判断http的交互是否成功     
  24.         if(xmlHttp.status == 200) {     
  25.             //获取服务器返回的纯文本数据     
  26.             var responseText = xmlHttp.responseText;     
  27.             //获取服务器返回的XML格式数据     
  28.             //var responseXml = xmlHttp.responseXML;     
  29.             //Alert从服务器端返回的信息     
  30.             window.alert(responseText);     
  31.         }     
  32.     }     
  33. }     

对上面的代码,在这里解析一下:XMLHttpRequest对象的请求状态(readyState)有0、1、2、3、4,其中,0表示未初始化,1表示open方法成功调用,2表示服务器应答客户端请求,3表示交互中,HTTP头信息已经收到,但响应数据还没有接收,4表示数据接收完成。我们通过“xmlHttp.onreadystatechange = callback;” 来设置如果XMLHttpRequest对象的请求状态发生改变了,则会执行回调函数callback。我们可以看到,在callback方法体中,我们只关心readyState==4(交互完成)的情况,再获取从服务器端返回的状态码status,常见的状态码有:200表示交互成功,404表示页面没找到,500表示服务器处理错误等。接着,通过XMLHttpRequest的responseText属性得到从服务器端返回的文本数据,或者通过responseXML属性获得XML格式的数据。

在上面的代码中,doGet方法和doPost方法都有参数”data”,它由XMLHttpRequest负责从客户端传送到服务器端,对于Get方法,附在URL尾部,例如:member.jsp?name=xxx&sex=male。对于Post方式,可调用XMLHttpRequest的send方法发送。data的数据形式比较灵活,可以是普通的参数格式、XML格式,JSON格式或者是其他格式,只要你能发送过去,服务器端就有办法将你解析出来。在这里,我们降低难度,就用最简单的参数格式,即

key1=value1 & key2=value2 & key3=value3 & ……

我们都知道,HTTP协议的Get方式传输数据,是通过把这些key-value串附到URL后面的,也就是我们只要点表单的提交按钮,就可以看到地址栏后面会多了一串key-value,代表表单里各输入框的名和值。然后,我们要做异步发送数据,就不能用表单的自动提交了,也就是说,得自己一个一个获取到各输入框的数据,然后再一个一个拼成上面的key-value串再发送。有没有一种简单的办法来组织这些数据呢?大家看到key-value是否会想到Java中的什么类?请看下面代码,我用JavaScript写了一个Map类(JavaScript中的“function”可以看作是方法,也可以看作是面向对象的“类”),就是类似于Java中我们常用的Map接口。

Java代码  

探讨Ajax获取表单值向Servlet传递的设计方案
  1. function Map(){     
  2.     //key集     
  3.     this.keys = new Array();     
  4.     //value集     
  5.     this.values = new Array();         
  6.     //添加key-value进Map     
  7.     this.put = function(key, value){     
  8.         if(key == null || key == undefined)     
  9.             return;     
  10.         var length = this.size();     
  11.         for(var i = 0 ; i < length ; i ++ ) {     
  12.             //如果keys数组中有相同的记录,则不覆盖原记录的值   
  13.             if(this.keys[i] == key)     
  14.                 this.values[i] = value;    
  15.         }     
  16.         this.keys.push(key);     
  17.         this.values.push(value);     
  18.     };     
  19.     //获取指定key的value     
  20.     this.get = function(key){     
  21.         var length = this.size();     
  22.         for(var i = 0 ; i < length ; i ++ ) {     
  23.             if(this.keys[i] == key) {     
  24.                 return this.values[i];     
  25.             } else {     
  26.                 continue;     
  27.             }     
  28.             return null;     
  29.         }     
  30.     };      
  31.     //移除指定key所对应的map     
  32.     this.remove = function(key) {     
  33.         var length = this.size();     
  34.         for(var i = 0 ; i < length ; i ++ ) {     
  35.             if(this.keys[i] == key) {     
  36.                 while(i < length - 1) {     
  37.                     this.keys[i] = this.keys[i+1];     
  38.                     this.values[i] = this.values[i+1];     
  39.                     i ++ ;     
  40.                 }     
  41.                 //处理最后一个元素     
  42.                 this.keys.pop();     
  43.                 this.values.pop();     
  44.                 break;     
  45.             }     
  46.         }     
  47.     };     
  48.     //是否包含指定的key     
  49.     this.containsKey = function(key) {     
  50.         var length = this.size();     
  51.         for(var i = 0 ; i < length ; i ++ ) {     
  52.             if(this.keys[i] == key) {     
  53.                 return true;     
  54.             }     
  55.         }     
  56.         return false;     
  57.     };     
  58.     //是否包含指定的value     
  59.     this.containsValue = function(value) {     
  60.         var length = this.size();     
  61.         for(var i = 0 ; i < length ; i ++ ) {     
  62.             if(this.values[i] == value) {     
  63.                 return true;     
  64.             }     
  65.         }     
  66.         return false;     
  67.     };     
  68.     //包含记录总数     
  69.     this.size = function() {     
  70.         return this.keys.length;     
  71.     };     
  72.     //是否为空     
  73.     this.isEmpty = function() {     
  74.         return this.size() == 0 ? true : false;     
  75.     };     
  76.     //清空Map     
  77.     this.clear = function() {     
  78.         this.keys = new Array();     
  79.         this.values = new Array();     
  80.     };     
  81.     //将map转成字符串,格式:key1=value1,key2=value2     
  82.     this.toString = function() {     
  83.         var length = this.size();     
  84.         var str = "";     
  85.         for(var i = 0 ; i < length ; i ++ ) {     
  86.             str = str + this.keys[i] + "=" + this.values[i];     
  87.             if(i != length-1)     
  88.                 str += ",";     
  89.         }     
  90.         return str;     
  91.     };     
  92. }     

代码比较长,有些方法在本例中可能用不到,但也写出来了,或者在其他地方可能有用吧。当我们使用这个Map类来存储HTTP的参数时,发觉有几个不妥的地方:一是put方法,在Java的Map接口中,是不允许有重复的key存在的,而在JavaScript中作为传输参数的载体时,很多时候会出现多个同名的key的,例如处理表单的checkbox时,同一个name的有几个checkbox,构成一个复选框组,组织参数时就形如“key=value1&key=value2”,故put方法必须改。也是由于这个原因,get方法和remove方法也要改。二是toString方法,key=value对,不是用“,”号隔开的,而是用“&”号,故toString方法也须改。而有时候想想,如果把Map类改了,如果其他地方要用到的话,是不是还是改回来,与其改来改去的,不如继承它,重写put、get、remove和toString方法。好主意,代码如下:

Js代码  

探讨Ajax获取表单值向Servlet传递的设计方案
  1. function ParamMap() {     
  2.     //继承Map类     
  3.     Map.call(this);     
  4.     //重写put方法,允许多个同名key存在     
  5.     this.put = function(key, value){     
  6.         if(key == null || key == undefined)      
  7.             return;     
  8.         this.keys.push(key);     
  9.         this.values.push(value);     
  10.     };     
  11.     //重写get方法,返回values数组     
  12.     this.get = function(key) {     
  13.         var results = new Array();     
  14.         var length = this.size();     
  15.         for(var i = 0 ; i < length ; i ++ ) {     
  16.             if(this.keys[i] == key)     
  17.                 results.push(this.values[i]);     
  18.         }     
  19.         return results;     
  20.     };     
  21.     //重写remove方法     
  22.     this.remove = function(key) {     
  23.         var length = this.size();     
  24.         for(var i = 0 ; i < length ; i ++ ) {     
  25.             if(this.keys[i] == key) {     
  26.                 while(i < length - 1) {     
  27.                     this.keys[i] = this.keys[i+1];     
  28.                     this.values[i] = this.values[i+1];     
  29.                     i ++ ;     
  30.                 }     
  31.                 //处理最后一个元素     
  32.                 this.keys.pop();     
  33.                 this.values.pop();     
  34.             }     
  35.         }     
  36.     };     
  37.     //重写toString方法, 转成XMLHttpRequest.send(ajaxString)方法的参数格式的字符串,     
  38.     //形如:key1=value1&key2=value2     
  39.     this.toString = function() {     
  40.         var length = this.size();     
  41.         var str = "";     
  42.         for(var i = 0 ; i < length ; i ++ ) {     
  43.             str = str + this.keys[i] + "=" + this.values[i];     
  44.             if(i != length-1)     
  45.                 str += "&";     
  46.         }     
  47.         return str;     
  48.     };     
  49. }     

 怎么使用这个ParamMap类呢,且看下面的示例代码:

Js代码  

探讨Ajax获取表单值向Servlet传递的设计方案
  1. var username = document.getElementById("username").value;     
  2. var password = document.getElementById("password").value;     
  3. var sex = document.getElementById("sex").value;      
  4. var map = new ParamMap();     
  5. map.put("username", username);     
  6. map.put("password", password);     
  7. map.put("sex", sex);      
  8. doGet("test/register", map.toString(), callback);     
  9. doPost("test/register", map.toString(), callback);  

Js代码  

探讨Ajax获取表单值向Servlet传递的设计方案

 在JavaScript中,用来获取HTML结点的方法,常用的有如下方法:

Js代码  

探讨Ajax获取表单值向Servlet传递的设计方案
  1. Node  document.getElementById("username")  //根据标签的id     
  2. NodeList  document.getElementsByName(“username”)  //根据标签的name     
  3. NodeList  document.getElementsByTagName("input")  //根据标签的标签名   

 我们注意到在除了getElementById是返回Node对象外,其他两个方法都是返回NodeList对象,相当于Node数组。在Ajax应用中,根据ID来获取节点,很多时候十分方便,如获取text、password、hidden、textarea类型的值,但有时候并不那么方便,如处理checkbox、radio(不允许多个同名的id)。况且有许多情况下,开发者是由“非Ajax”转成Ajax应用的。在还没有引进Ajax的时候,表单传值都是根据输入域的name的值来区分的,不管是Get方式还是Post方式,在服务器端(这里指Java Servlet)获取数据的代码如下:

Java代码  

探讨Ajax获取表单值向Servlet传递的设计方案
  1. String  HttpServletRequest.getParameter("keyName");  //用于单值表单域     
  2. String[]  HttpServletRequest.getParameterValues("keyName"); //用于多值表单域     

所谓的“单值表单域”就是上面提到过的type为text、password、hidden的input或者textarea等,而“多值表单域”是指checkbox。其实,也不尽然,如单值表单域有时候也可以是多值表单域,如我们注册时有时会要求填多个邮箱,这个<input type=”text” name=”email”>就可以重复多行用同一个name,它在Servlet端获取值方式跟checkbox一样处理。

鉴于各种原因,我们在JavaScript获取HTML Form表单域方法,决定采用getElementsByName方法,这样,我们是不是每取一个表单元素,就得将NodeList类型的返回结果遍历一遍,获取Node,再从Node获取值呢?既然选择了这样做,当然少不了这样的工作,不过,我们可以写一个可重用的方法,让它处理一下NodeList对象。且看代码:

Js代码  

探讨Ajax获取表单值向Servlet传递的设计方案
  1. function nodeList2ValuesArray(nodeList) {     
  2.     //结果值数组,形如:['aaa','bbb','ccc']     
  3.     var values = new Array();     
  4.     var length = nodeList.length;     
  5.     var nodeName = nodeList.item(0).nodeName;     
  6.     //对"<input type='xxx'/>"的处理     
  7.     if(nodeName == "INPUT") {     
  8.         var type = nodeList.item(0).getAttribute("type");     
  9.         if(type == "text" || type == "password" || type == "hidden") {     
  10.             for(var i = 0 ; i < length ; i ++ ) {     
  11.                 values.push(nodeList.item(i).value);     
  12.             }     
  13.         }     
  14.         else if(type == "checkbox" || type == "radio") {     
  15.             for(var i = 0 ; i < length ; i ++ ) {     
  16.                 var node = nodeList.item(i);     
  17.                 if(node.checked) {     
  18.                     values.push(node.value);     
  19.                 }     
  20.             }     
  21.         }     
  22.     }     
  23.     //对"<textarea>xxx</textarea>"的处理     
  24.     else if(nodeName == "TEXTAREA") {     
  25.         for(var i = 0 ; i < length ; i ++ ) {     
  26.             values.push(nodeList.item(i).value);     
  27.         }     
  28.     }     
  29.     //对"<select></select>"的处理     
  30.     else if (nodeName == "SELECT") {     
  31.         var subNodeList = nodeList.item(0).getElementsByTagName("option");     
  32.         return nodeList2ValuesArray(subNodeList);     
  33.     }     
  34.     //对<select>的子元素"<option>xxx<option>"的处理     
  35.     else if (nodeName == "OPTION") {     
  36.         for(var i = 0 ; i < length ; i ++ ) {     
  37.             var node = nodeList.item(i);     
  38.             if(node.selected){     
  39.                 values.push(node.value);     
  40.             }     
  41.         }     
  42.     }     
  43.     return values;     
  44. }     

 上面代码将NodeList转成了值数组,而且让使用者忽略表单域类型的差异,专心于值的获取和使用。美中不足的是,上面的方法返回的是数组,我们还是一个一个遍历再拼成key=value字符串。接下来的方法不但解决了这一点,而且还大大简化我们的表单取值,且看:

Js代码  

探讨Ajax获取表单值向Servlet传递的设计方案
  1. function parseForm2ParamMap() {     
  2.     var map = new ParamMap();     
  3. //参数的长度,注意:方法定义的括号中虽然没有定义参数,但却可以设任意多个参数        
  4.     var length = arguments.length;       
  5.     for(var i = 0 ; i < length ; i ++ ) {     
  6.         var nodeList = document.getElementsByName(arguments[i]);     
  7.         var values = nodeList2ValuesArray(nodeList);     
  8.         for(var j = 0 ; j < values.length ; j ++ ) {     
  9.             map.put(arguments[i], values[j]);     
  10.         }     
  11.     }     
  12.     return map;     
  13. }     

这个方法返回值的类型是ParamMap,也就是我们刚才定义的用来传递参数的类,这个类中有一个toString的方法,不就是返回“key1=value1&key2=value2”形式的字符串吗?

OK,下面的测试例子,将涉及到表单的各种元素域,其中引进了ajax.js文件,其内容即是我们上面所写的JS函数和类,在附件中可下载到,在此就不重复贴出来了。且看HTML代码:

Html代码  

探讨Ajax获取表单值向Servlet传递的设计方案
  1. <?xml version="1.0" encoding="UTF-8" ?>     
  2. <%@ page language="java" contentType="text/html; charset=UTF-8"     
  3.     pageEncoding="UTF-8"%>     
  4. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">      
  5. <html xmlns="http://www.w3.org/1999/xhtml">     
  6. <head>     
  7. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />     
  8. <title>测试Ajax与Servlet之间的数据传递</title>     
  9. <script type="text/javascript" src="js/ajax.js"></script>     
  10. <script type="text/javascript">     
  11. window.onload = function(){      
  12.     var submit = document.getElementById("submit");     
  13.     submit.onclick = function(){      
  14.         var map = parseForm2ParamMap("username", "email", "password", "userid", "sex", "framework", "salary", "dream");     
  15.         //doPost("input", map.toString(), callback); //默认Alert出信息     
  16.         doPost("input", map.toString(), function(){     
  17.             if(xmlHttp.readyState == 4) {     
  18.                 if(xmlHttp.status == 200) {     
  19.                     var returnMsg = document.getElementById("returnMsg");     
  20.                     returnMsg.innerHTML = xmlHttp.responseText;     
  21.                 }     
  22.             }     
  23.         });     
  24.     };     
  25. };     
  26. </script>     
  27. </head>     
  28. <body>      
  29. <h2>测试Ajax与Servlet之间的数据传递<br />(Step1:从Client->Server)</h2>      
  30. <div id="returnMsg" style="color:red;"></div>      
  31. <form>      
  32. <!-- 文本域  -->     
  33. <p>你的姓名:     
  34. <input type="text" name="username" /><br />     
  35. </p>     
  36. <p>你的电子邮件(可填两个):<br />     
  37. 邮件地址1:<input type="text" name="email" /> <br />     
  38. 邮件地址2:<input type="text" name="email" />     
  39. </p>      
  40. <!-- 密码域 -->     
  41. <p>你的密码:     
  42. <input type="password" name="password"  /><br />     
  43. </p>      
  44. <!-- 隐藏域 -->     
  45. <input type="hidden" name="userid"  value="108" /><br />      
  46. <!-- 单选框 -->     
  47. <p>你的性别 :     
  48. <label><input type="radio" name="sex" value="male" />男</label>&nbsp;&nbsp;     
  49. <label><input type="radio" name="sex" value="female" />女</label>      
  50. </p>      
  51. <!-- 复选框 -->     
  52. <p>你掌握的开源框架 :<br />     
  53. <label><input type="checkbox" name="framework" value="struts" />Struts</label>  &nbsp;&nbsp;     
  54. <label><input type="checkbox" name="framework" value="spring" />Spring</label>  &nbsp;&nbsp;     
  55. <label><input type="checkbox" name="framework" value="hibernate" />Hibernate</label> &nbsp;&nbsp;     
  56. <label><input type="checkbox" name="framework" value="ibatis" />iBatis</label> &nbsp;&nbsp;     
  57. <label><input type="checkbox" name="framework" value="webwork" />WebWork</label> &nbsp;&nbsp;     
  58. </p>      
  59. <!-- 下拉列表  -->     
  60. <p>你的薪水范围 :     
  61. <select name="salary">     
  62.     <option value="2000以下">2000以下</option>     
  63.     <option value="2000——3000">2000——3000</option>     
  64.     <option value="3000——4000">3000——4000</option>     
  65.     <option value="4000——5000">4000——5000</option>     
  66.     <option value="5000以上">5000以上</option>     
  67. </select>     
  68. </p>      
  69. <!-- 文本域 -->     
  70. <p>你的职业梦想: <br />     
  71. <textarea rows="5" cols="36" name="dream"></textarea><br />     
  72. </p>      
  73. <input type="button" id="submit" value="submit" />      
  74. </form>      
  75. </body>     
  76. </html>   

服务器端的代码如下:

Java代码  

探讨Ajax获取表单值向Servlet传递的设计方案
  1. package simple.rongxh.servlet;      
  2. import java.io.IOException;     
  3. import java.io.PrintWriter;     
  4. import javax.servlet.ServletException;     
  5. import javax.servlet.http.HttpServlet;     
  6. import javax.servlet.http.HttpServletRequest;     
  7. import javax.servlet.http.HttpServletResponse;      
  8. public class Input extends HttpServlet {     
  9.     private static final long serialVersionUID = 1L;     
  10.     private void process(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {     
  11.         //获取数据     
  12.         request.setCharacterEncoding("UTF-8");     
  13.         String username = request.getParameter("username");     
  14.         String[] emails = request.getParameterValues("email");     
  15.         String password = request.getParameter("password");     
  16.         String userid = request.getParameter("userid");     
  17.         String sex = request.getParameter("sex");     
  18.         String[] framework = request.getParameterValues("framework");     
  19.         String salary = request.getParameter("salary");     
  20.         String dream = request.getParameter("dream");     
  21.         //响应给客户端     
  22.         response.setContentType("text/html;charset=UTF-8");     
  23.         PrintWriter out = response.getWriter();     
  24.         out.append("恭喜你,保存成功,你的基本信息如下:<br/>");     
  25.         out.append("姓名:" + username + "<br/>");     
  26.         for(int i = 0 ; i < emails.length ; i ++ ) {     
  27.             out.append("邮箱" + (i+1) + ":" + emails[i] + "<br/>");     
  28.         }     
  29.         out.append("密码:" + password + "<br/>");     
  30.         out.append("编号:" + userid + "<br/>");     
  31.         out.append("性别:" + sex + "<br/>");     
  32.         out.append("框架:");     
  33.         for(int i = 0 ; framework != null && i < framework.length ; i ++ ){     
  34.             out.append(framework[i] + "  ");     
  35.         }     
  36.         out.append("<br/>");     
  37.         out.append("薪水:" + salary + "<br/>");     
  38.         out.append("梦想:" + dream + "<br/>");     
  39.         out.println();     
  40.     }      
  41.     protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {     
  42.         process(request, response);     
  43.     }      
  44.     protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {     
  45.         process(request, response);     
  46.     }      
  47. }     

 运行结果截图如下:

探讨Ajax获取表单值向Servlet传递的设计方案
探讨Ajax获取表单值向Servlet传递的设计方案

本测试例子eclipse项目源码下载(附件中):rongxh2010_ajaxservlet。

当Java遇上Ajax,本文只是第一篇,欢迎提出宝贵的意见和建议,我将十分感谢!

继续阅读