在发送表单数据一文中,HTML表单可以声明式地发送一个HTTP请求。但表单也可以用JavaScript来准备一个HTTP请求。本文将探索如何做到这点。
表单,不只是表单
随着开放式Web应用的出现,现在提供HTML表单、而不是文字表单供用户填写的做法,已经越发普遍了。而越来越多的开发者也获得了数据传输的控制权。
获得对数据传输的控制权
标准的HTML表单提交操作会加载数据发送到的URL,这就意味着浏览器的窗口中会进行整个页面的重新加载。而如果避免了页面的重新加载,就会避免页面的闪烁和网络延迟,进而提供更顺畅的用户体验。
在许多现代的UI设计中,HTML表单只是用来收集用户的输入。当用户要发送数据时,Web应用会进行控制,并在后台异步地发送数据,只更新UI中需要更改的部分。
能异步地发送任意数据的技术称为AJAX,表示“异步的JavaScript和XML”。
和传统表单处理的不同
AJAX使用了XMLHttpRequest(XHR)DOM对象,它可以建立HTTP请求、发送请求并处理结果。
注意: 老的AJAX技术可能不是用XMLHttpRequest。比如JSONP和eval()函数结合起来使用。虽然该方法可行,但不推荐使用它,因为其存在严重的安全问题。所以除非为了兼容那些特别老旧、不支持XMLHttpRequest或JSON的浏览器,还是避免使用该技术。
由于历史原因,XMLHttpRequest本是设计用来获取和发送交换格式为XML的数据的。但现在JSON取代了XML,有着更普遍的使用。
不过XML和JSON都不符合作为表单数据请求的编码。表单数据(application/x-www-form-urlencoded
)是用于构造键值对的URL编码列表的,若是要传输二进制数据,HTTP请求会被重塑为multipart/form-data
。
若你能掌控前端(运行在浏览器上的代码)和后端(运行在服务器上的代码),你就能发送JSON或XML、并随心所欲地处理它们。
但如果你使用的是第三方服务,这就没那么容易了,因为某些服务只接受表单数据。当然也有使用表单数据处理起来更方便的情况,比如数据是键值对或二进制数据时,用现成的后端工具就能处理它们、不需要额外的代码。
那么,具体该如何发送数据呢?
发送表单数据
目前有三种方式来发送表单数据,既有老旧的技术、也有新特性FormData对象,接下来就来深入了解下它们。
在隐藏的iframe中构建DOM
发送表单数据最古老的方法,是用DOM API建立一个表单,然后发送数据到一个隐藏的<iframe>
。为了访问你提交内容的处理结果,应检索下<iframe>
的内容。
警告:避免使用该技术。在使用第三方服务时,该技术有安全风险,因为它会导致你面临脚本注入攻击。若你使用HTTPS,使用<ifrme>
发送表单还会影响同源策略,并导致内容被发送到一个无法访问的<ifrme>
中。当然如果你要兼容很老旧的浏览器,这项技术可能就是你唯一的选择了。
下面是一个例子:
1
| <button onclick="sendData({test:'ok'})">Click Me!</button>
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
| var iframe = document.createElement("iframe"); iframe.name = "myTarget"; window.addEventListener("load", function () { iframe.style.display = "none"; document.body.appendChild(iframe); }); function sendData(data) { var name, form = document.createElement("form"), node = document.createElement("input"); iframe.addEventListener("load", function () { alert("Yeah! Data sent."); }); form.action = "http://www.cs.tut.fi/cgi-bin/run/~jkorpela/echo.cgi"; form.target = iframe.name; for(name in data) { node.name = name; node.value = data[name].toString(); form.appendChild(node.cloneNode()); } form.style.display = "none"; document.body.appendChild(form); form.submit(); document.body.removeChild(form); }
|
结果如下:
效果
手动创建一个XMLHttpRequest
XMLHttpRequest是发送HTTP请求最安全和可靠的方式。要想用XMLHttpRequest发送表单数据,得先用URL编码要发送的数据,并遵循表单数据请求的规范。
注意: 若想了解更多关于XMLHttpRequest,这几篇文章可能对你有用:An introductory article to AJAX,以及一个关于使用XMLHttpRequest的高级教程。
来重构下我们先前的例子:
1
| <button type="button" onclick="sendData({test:'ok'})">Click Me!</button>
|
如你所见,HTML部分并未真的有所改变,但JavaScript部分就完全不同了:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
| function sendData(data) { var XHR = new XMLHttpRequest(); var urlEncodedData = ""; var urlEncodedDataPairs = []; var name; for(name in data) { urlEncodedDataPairs.push(encodeURIComponent(name) + '=' + encodeURIComponent(data[name])); } urlEncodedData = urlEncodedDataPairs.join('&').replace(/%20/g, '+'); XHR.addEventListener('load', function(event) { alert('Yeah! Data sent and response loaded.'); }); XHR.addEventListener('error', function(event) { alert('Oups! Something goes wrong.'); }); XHR.open('POST', 'https://example.com/cors.php'); XHR.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded'); XHR.send(urlEncodedData); }
|
结果如下:
效果
注意: 若你想使用此处的XMLHttpRequest方法发送数据到第三方网站,也会受到同源策略的限制。要实现跨域请求,还需要CORS和HTTP访问控制。
手动构建HTTP请求是挺麻烦的,幸运的是,最近的一项XMLHttpRequest标准提供了一个处理表单请求的简便方法–FormData对象。
FormData对象可被用来建立要传输的表单数据,或者从表单元素中获取数据来管理如何发送。要注意FormData对象是“只写”的,这意味着你可以改变它们、但不能访问它们的内容。
使用FormData对象的方法会在使用FormData对象一文中详细介绍,下面有两个例子:
1
| <button type="button" onclick="sendData({test:'ok'})">Click Me!</button>
|
现在你该很熟悉这个HTML的样子了。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
| function sendData(data) { var XHR = new XMLHttpRequest(); var FD = new FormData(); for(name in data) { FD.append(name, data[name]); } XHR.addEventListener('load', function(event) { alert('Yeah! Data sent and response loaded.'); }); XHR.addEventListener('error', function(event) { alert('Oups! Something went wrong.'); }); XHR.open('POST', 'https://example.com/cors.php'); XHR.send(FD); }
|
结果如下:
效果
你也可以将FormData对象绑定到一个表单元素上,这样做会创建一个FormData对象来表示表单中的数据。
HTML是典型的表单:
1 2 3 4 5
| <form id="myForm"> <label for="myName">Send me your name:</label> <input id="myName" name="name" value="John"> <input type="submit" value="Send Me!"> </form>
|
但JavaScript会接管表单的提交操作:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
| window.addEventListener("load", function () { function sendData() { var XHR = new XMLHttpRequest(); var FD = new FormData(form); XHR.addEventListener("load", function(event) { alert(event.target.responseText); }); XHR.addEventListener("error", function(event) { alert('Oups! Something goes wrong.'); }); XHR.open("POST", "https://example.com/cors.php"); XHR.send(FD); } var form = document.getElementById("myForm"); form.addEventListener("submit", function (event) { event.preventDefault(); sendData(); }); });
|
结果如下:
效果
处理二进制数据
若你在一个含有<input type="file">
组件的表单中使用FormData对象,那么数据会被自动处理。但要手动发送二进制数据的话,还有很多额外工作要做。
现代Web有很多二进制数据源:比如FileReader、Canvas、WebRTC。但不幸的是,某些老旧浏览器不能访问二进制数据或者需要复杂的方法才能实现。这些遗留的问题已不在本文讨论范围之内。若你想了解更多关于FileReader API,请阅读Using files from web applications。
用FormData来发送二进制是很直接的,使用append()
方法就好了。但要手动做到这点,就需要一些技巧了。
在下面的例子中,我们会用来FileReader API来访问二进制数据,然后手动建立多部分的表单数据请求。
1 2 3 4 5 6 7 8 9 10 11
| <form id="myForm"> <p> <label for="i1">text data:</label> <input id="i1" name="myText" value="Some text data"> </p> <p> <label for="i2">file data:</label> <input id="i2" name="myFile" type="file"> </p> <button>Send Me!</button> </form>
|
如你所见,HTML用了标准的<form>
,这没什么神奇的。“神奇”的部分在JavaScript里:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115
| window.addEventListener('load', function () { var text = document.getElementById("i1"); var file = { dom : document.getElementById("i2"), binary : null }; var reader = new FileReader(); reader.addEventListener("load", function () { file.binary = reader.result; }); if(file.dom.files[0]) { reader.readAsBinaryString(file.dom.files[0]); } file.dom.addEventListener("change", function () { if(reader.readyState === FileReader.LOADING) { reader.abort(); } reader.readAsBinaryString(file.dom.files[0]); }); function sendData() { if(!file.binary && file.dom.files.length > 0) { setTimeout(sendData, 10); return; } var XHR = new XMLHttpRequest(); var boundary = "blob"; var data = ""; if (file.dom.files[0]) { data += "--" + boundary + "\r\n"; data += 'content-disposition: form-data; ' + 'name="' + file.dom.name + '"; ' + 'filename="' + file.dom.files[0].name + '"\r\n'; data += 'Content-Type: ' + file.dom.files[0].type + '\r\n'; data += '\r\n'; data += file.binary + '\r\n'; } data += "--" + boundary + "\r\n"; data += 'content-disposition: form-data; name="' + text.name + '"\r\n'; data += '\r\n'; data += text.value + "\r\n"; data += "--" + boundary + "--"; XHR.addEventListener('load', function(event) { alert('Yeah! Data sent and response loaded.'); }); XHR.addEventListener('error', function(event) { alert('Oups! Something went wrong.'); }); XHR.open('POST', 'https://example.com/cors.php'); XHR.setRequestHeader('Content-Type','multipart/form-data; boundary=' + boundary); XHR.send(data); } var form = document.getElementById("myForm"); form.addEventListener('submit', function (event) { event.preventDefault(); sendData(); }); });
|
结果如下:
效果
结论
浏览器的不同,导致通过JavaScript发送表单数据可以简单或很困难。FromData对象是通常的解决方案,而且我们应该毫不犹豫地在老旧浏览器上使用其polyfill: