DIV CSS 佈局教程網

Ajax 進階應用:把表單、JSON 與檔案一次送進伺服器
編輯:AJAX基礎知識     

Ajax 最常被拿來「取資料」,但「送資料」其實才是更核心的用途。本文從最原始的手工組字串說起,一路談到 JSON 與 FormData,最後示範如何連檔案一起上傳。

一、問題的起點:傳統表單提交的痛處

先看一張最普通的表單:

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>基本表單</title>
<style>
.table { display: table; }
.row   { display: table-row; }
.cell  { display: table-cell; padding: 5px; }
.lable { text-align: right; }
</style>
</head>
<body>
<form id="fruitform" method="post" action="https://127.0.0.1:8080/form">
  <div class="lable">
    <div class="row">
      <div class="cell lable">Apples:</div>
      <div class="cell"><input name="apples" value="5" /></div>
    </div>
    <div class="row">
      <div class="cell lable">Bananas:</div>
      <div class="cell"><input name="bananas" value="2" /></div>
    </div>
    <div class="row">
      <div class="cell lable">Cherries:</div>
      <div class="cell"><input name="cherries" value="20" /></div>
    </div>
    <div class="row">
      <div class="cell lable">Total:</div>
      <div id="results" class="cell">0 items</div>
    </div>
  </div>
  <button id="submit" type="submit">Submit Form</button>
</form>
</body>
</html>

傳統提交有兩個明顯缺陷:使用者必須等伺服器整頁處理完;而且結果以新文件呈現,原本的頁面脈絡全部丟失。Ajax 正好能解決這兩點——非同步送出,留在原頁面上更新局部。

二、建立測試用的伺服器

以下用 Node.js 寫一個最小的伺服器,能同時解析表單編碼與 JSON 兩種格式:

var http = require('http');
var querystring = require('querystring');

function writeResponse(res, data) {
    var total = 0;
    for (fruit in data) {
        total += Number(data[fruit]);
    }
    res.writeHead(200, "OK", {
        "Content-Type": "text/html",
        "Access-Control-Allow-Origin": "https://localhost:63342"
    });
    res.write('<html><head><title>Fruit Total</title></head><body>');
    res.write('<p>' + total + ' item ordered</p></body></html>');
    res.end();
}

http.createServer(function(req, res) {
    console.log("[200] " + req.method + " to " + req.url);

    if (req.method == "OPTIONS") {
        res.writeHead(200, "OK", {
            "Access-Control-Allow-Header": "Content-Type",
            "Access-Control-Allow-Methods": "*",
            "Access-Control-Allow-Origin": "*"
        });
        res.end();
    } else if (req.url == '/form' && req.method == 'POST') {
        var dataObj = new Object();
        var contentType = req.headers["content-type"];
        var fullBody = '';

        if (contentType) {
            if (contentType.indexOf("application/x-www-form-urlencode") > -1) {
                req.on('data', function(chunk) { fullBody += chunk.toString(); });
                req.on('end', function() {
                    var dBody = querystring.parse(fullBody);
                    dataObj.apples   = dBody["apples"];
                    dataObj.bananas  = dBody["bananas"];
                    dataObj.cherries = dBody["cherries"];
                    writeResponse(res, dataObj);
                });
            } else if (contentType.indexOf("application/json") > -1) {
                req.on('data', function(chunk) { fullBody += chunk.toString(); });
                req.on('end', function() {
                    dataObj = JSON.parse(fullBody);
                    writeResponse(res, dataObj);
                });
            }
        }
    }
}).listen(8080);

伺服器依 Content-Type 決定用哪種方式解析,回應則是一段簡單 HTML:

三、方式一:手工收集並送出表單資料

<script>
document.getElementById("submit").onclick = handleButtonPress;
var httpRequest;

function handleButtonPress(e) {
    // 阻止表單的預設(非 Ajax)提交行為
    e.preventDefault();

    var form = document.getElementById("fruitform");

    // 逐一收集各 input 的值,組為查詢字串
    var formData = "";
    var inputElements = document.getElementsByTagName("input");
    for (var i = 0; i < inputElements.length; i++) {
        formData += inputElements[i].name + "=" + inputElements[i].value + "&";
    }

    httpRequest = new XMLHttpRequest();
    httpRequest.onreadystatechange = handleResponse;

    // 由 form 的 action 屬性取得目標 URL
    httpRequest.open("POST", form.action);
    // 告知伺服器資料格式
    httpRequest.setRequestHeader('Content-Type', 'application/x-www-form-urlencoded');
    httpRequest.send(formData);
}

function handleResponse() {
    if (httpRequest.readyState == 4 && httpRequest.status == 200) {
        document.getElementById("results").innerHTML = httpRequest.responseText;
    }
}
</script>

回應直接寫進同一頁的 results 區塊,頁面完全不跳轉。

四、方式二:送出 JSON

Ajax 名字裡雖然有 XML,但實際上什麼都能送。JSON 常被稱為 XML 的「脫脂」替代品——更好讀、更精簡、支援面更廣。

{"bananas":"2","apples":"5","cherries":"20"}

改造後的前端:

<script>
document.getElementById("submit").onclick = handleButtonPress;
var httpRequest;

function handleButtonPress(e) {
    e.preventDefault();
    var form = document.getElementById("fruitform");

    // 組一個物件,屬性名對應 input 的 name
    var formData = new Object();
    var inputElements = document.getElementsByTagName("input");
    for (var i = 0; i < inputElements.length; i++) {
        formData[inputElements[i].name] = inputElements[i].value;
    }

    httpRequest = new XMLHttpRequest();
    httpRequest.onreadystatechange = handleResponse;
    httpRequest.open("POST", form.action);

    // 關鍵:宣告內容為 JSON
    httpRequest.setRequestHeader("Content-Type", "application/json");
    httpRequest.send(JSON.stringify(formData));
}

function handleResponse() {
    if (httpRequest.readyState == 4 && httpRequest.status == 200) {
        document.getElementById("results").innerHTML = httpRequest.responseText;
    }
}
</script>

JSON 物件提供兩個方法:stringify() 把物件轉為字串,parse() 把字串還原為物件。多數瀏覽器原生支援,舊版可另外引入 json2.js 補齊。

五、方式三:用 FormData 更省事

FormData 定義在 XMLHttpRequest 第二版規範中,是收集表單最簡潔的方式。此處改用 C# 的 aspx 作為伺服器:

using System;

namespace Web4Luka.Web.ajax.html5
{
    public partial class fruitcalc : System.Web.UI.Page
    {
        protected void Page_Load(object sender, EventArgs e)
        {
            int total = 0;
            if (Request.HttpMethod == "POST")
            {
                if (Request.ContentType.IndexOf("multipart/form-data") > -1)
                {
                    for (int i = 0; i < Request.Form.Count; i++)
                    {
                        total += Int32.Parse(Request.Form[i]);
                    }
                }
                writeResponse(Response, total);
            }
        }

        private void writeResponse(System.Web.HttpResponse Response, int total)
        {
            Response.AddHeader("Access-Control-Allow-Origin", "https://localhost:63342");
            Response.Write(total + " item ordered");
        }
    }
}

5.1 基本用法

把 HTMLFormElement 直接交給 FormData 建構子,所有欄位自動收集:

<script>
document.getElementById("submit").onclick = handleButtonPress;
var httpRequest;

function handleButtonPress(e) {
    e.preventDefault();
    var form = document.getElementById("fruitform");
    var formData = new FormData(form);      // 一行搞定收集

    httpRequest = new XMLHttpRequest();
    httpRequest.onreadystatechange = handleResponse;
    httpRequest.open("POST", form.action);
    httpRequest.send(formData);             // 不需設定 Content-Type
}

function handleResponse() {
    if (httpRequest.readyState == 4 && httpRequest.status == 200) {
        document.getElementById("results").innerHTML = httpRequest.responseText;
    }
}
</script>

注意:使用 FormData 時不要手動設定 Content-Type。瀏覽器會自動採用 multipart/form-data 並補上 boundary,自行設定反而會導致 boundary 缺失、後端無法解析。

5.2 用 append 挑選要送出的欄位

不傳 HTMLFormElement 時,可以自己決定送哪些:

<script>
document.getElementById("submit").onclick = handleButtonPress;
var httpRequest;

function handleButtonPress(e) {
    e.preventDefault();
    var form = document.getElementById("fruitform");
    var formData = new FormData();          // 空手建立

    var inputElements = document.getElementsByTagName("input");
    for (var i = 0; i < inputElements.length; i++) {
        // 刻意排除 cherries
        if (inputElements[i].name != "cherries") {
            formData.append(inputElements[i].name, inputElements[i].value);
        }
    }

    httpRequest = new XMLHttpRequest();
    httpRequest.onreadystatechange = handleResponse;
    httpRequest.open("POST", form.action);
    httpRequest.send(formData);
}

function handleResponse() {
    if (httpRequest.readyState == 4 && httpRequest.status == 200) {
        document.getElementById("results").innerHTML = httpRequest.responseText;
    }
}
</script>

六、連檔案一起上傳

FormData 的另一大優勢是天生支援檔案。表單只要多一個 file 輸入框:

<div class="row">
  <div class="cell lable">File:</div>
  <div class="cell"><input type="file" name="file" /></div>
</div>

其餘 JavaScript 完全不用改,FormData 會自動把使用者選的檔案內容與其他欄位一起打包上傳。

伺服器端接收:

using System;
using System.Web;

namespace Web4Luka.Web.ajax.html5
{
    public partial class fruitcalc : System.Web.UI.Page
    {
        protected void Page_Load(object sender, EventArgs e)
        {
            int total = 0;
            if (Request.HttpMethod == "POST")
            {
                if (Request.ContentType.IndexOf("multipart/form-data") > -1)
                {
                    for (int i = 0; i < Request.Form.Count; i++)
                    {
                        total += Int32.Parse(Request.Form[i]);
                    }

                    // 取得上傳的檔案並存檔
                    if (Request.Files["file"] != null)
                    {
                        HttpPostedFile file = Request.Files["file"];
                        file.SaveAs(Server.MapPath("/upload/pictures/" + file.FileName));
                    }
                }
                writeResponse(Response, total);
            }
        }

        private void writeResponse(System.Web.HttpResponse Response, int total)
        {
            Response.AddHeader("Access-Control-Allow-Origin", "https://localhost:63342");
            Response.Write(total + " item ordered");
        }
    }
}

安全提醒:範例直接採用使用者上傳的原始檔名存檔,這是明確的風險點——可能發生路徑穿越(以 ../ 跳出上傳目錄)或覆蓋既有檔案。實務上應以 GUID 重新命名、副檔名另存於資料庫,並限制檔案類型與大小。

七、還可以搭配 upload progress

FormData 搭配原生 xhr 能取得上傳進度,這是 jQuery 早期版本做不到的:

var xhr = new XMLHttpRequest();
xhr.upload.addEventListener("progress", function(e) {
    if (e.lengthComputable) {
        var percent = Math.round(e.loaded / e.total * 100);
        console.log(percent + "%");
    }
});
xhr.open("POST", "/upload");
xhr.send(formData);

四種方式怎麼選

  • 手工組字串:只在需要完全掌控格式、或環境過於老舊時才用。
  • JSON:適合與 RESTful API 溝通,結構清楚、易於擴充巢狀資料。
  • FormData(不傳 form):需要挑選欄位、或欄位來自多個來源時。
  • FormData(傳 form):一般表單提交的首選,程式碼最短,且天然支援檔案。

以上是小編整理的 Ajax 送出資料四種方式,希望對大家有所幫助。有問題歡迎留言,我會盡快回覆。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved