[.NET] 產生具有多個值，multipart/form-data 的 HTTP POST 訊息

2010-12-20

37972
0
.NET Framework
2011-08-25

這個功能是在設計 Facebook Graph API Client Library 時碰到的問題，在 Graph API 中的 Publish_Stream 中有一項上傳相片的功能，這個功能內有一個 message 和 access_token 參數，而原本我們學習的 HTTP 技術本身大多都是沒有混合二進位和字串值的參數，所以當時碰到這個問題時，一時想不到什麼解決方法，後來搜尋到 RFC 2188: Returning Values from Forms: multipart/form-data，這份文件說明了在 HTTP POST 訊息中使用多種格式訊息的作法，它可以用在許多 REST-based API 的系統，它可以混合多種資料格式並一次傳送，當然非文字的資料必須要編碼為二進位字串。

在 RFC 2387 文件中，指出若要傳輸多種參數，多種資料型態混合的訊息時，要先將 HTTP 要求的 Content-Type 設為 multipart/form-data，而且要設定一個 boundary 參數，這個參數是由應用程式自行產生，它會用來識別每一份資料的邊界 (boundary)，用以產生多重訊息部份 (message part)，而 HTTP 伺服器可以抓取 HTTP POST 的訊息，並且以慣用的物件模型來顯露給伺服器存取 (ex: ASP.NET 的 Request.Form)。

下面是一個多重參數的 multipart/form-data 的訊息 (source: RFC 2388)：

Content-Type: multipart/form-data; boundary=MYBOUNDARY

…

--MYBOUNDARY
Content-Disposition: form-data; name="[PARAMETER-NAME]"
<NEWLINE>
<NEWLINE>
<Data goes here>
--MYBOUNDARY
Content-Disposition: form-data; name="[PARAMETER-NAME]"
<NEWLINE>
<NEWLINE>
<Data goes here>
--MYBOUNDARY
Content-Disposition: form-data; name="[PARAMETER-NAME]"
Content-Type: image/jpeg
<NEWLINE>
<NEWLINE>
<Image data goes here>
--MYBOUNDARY

上面的訊息看起來還蠻難懂的，不過它的幾個基本概念是：

1. 每個訊息部份都要用 --[BOUNDARY_NAME] 來包裝，以區隔出訊息的每個部份，而最後要再加上一個 --[BOUNDARY_NAME] 來表示結束。
2. 每個訊息部份都要有一個 Content-Disposition: form-data; name=""，而 name 設定的就是 HTTP POST 的鍵值 (key)。
3. 宣告區和值區中間要隔兩個新行符號 (以 .NET 來說，就是 Environment.NewLine)。
4. 中間可以夾入二進位資料，但二進位資料必須要格式化為二進位字串，這個工作會由 HttpWebRequest 在使用 NetworkStream.Write() 寫入上傳資料時自動由系統做掉。
5. 若要設定不同訊息段的資料型別 (Content-Type)，則要在訊息段內的宣告區設定。


只要了解了資料格式，就能夠寫程式來產生它：

public static byte[] BuildMultipartPostData(string Boundary, Dictionary<string, string> HttpPostData, PostFileData FileUploadData)
{
StringBuilder sb = new StringBuilder();

    // append access token.
    sb.AppendLine("--" + Boundary);
    sb.AppendLine("Content-Disposition: form-data;name=\"access_token\"");
    sb.Append(Environment.NewLine);
    sb.AppendLine(FBGraphAPIConfiguration.FBValidAccessToken);

    // append form part.
    if (HttpPostData != null && HttpPostData.Count > 0)
    {
        foreach (KeyValuePair<string, string> HttpPostDataItem in HttpPostData)
        {
            sb.AppendLine("--" + Boundary);
            sb.AppendLine(string.Format("Content-Disposition: form-data;name=\"{0}\"", HttpPostDataItem.Key));
            sb.Append(Environment.NewLine);
            sb.AppendLine(HttpPostDataItem.Value);
        }
    }

    // handle file upload.
    if (FileUploadData != null)
    {
        sb.AppendLine("--" + Boundary);
        sb.AppendLine(string.Format("Content-Disposition: form-data;name=\"{0}\"; filename=\"{1}\"", FileUploadData.Name, FileUploadData.FileName));
        sb.AppendLine(string.Format("Content-Type: {0}", FileUploadData.ContentType));
        sb.Append(Environment.NewLine);
    }

    MemoryStream ms = new MemoryStream();
    BinaryWriter bw = new BinaryWriter(ms);
    bw.Write(Encoding.UTF8.GetBytes(sb.ToString()));
    bw.Write(FileUploadData.FileData);
    bw.Write(Encoding.UTF8.GetBytes(Environment.NewLine));
    bw.Write(Encoding.UTF8.GetBytes("--" + Boundary));
    ms.Flush();
    ms.Position = 0;

byte[] result = ms.ToArray();

bw.Close();

return result;
}

而實際傳送的程式就無需特別的修改，但唯一要注意的是要加上 boundary 參數，否則多訊息部份的能力會無法使用。

public static string MakeHttpPost(string RequestUrl, Dictionary<string, string> HttpPostData, PostFileData FileUploadData)
{
HttpWebRequest request = WebRequest.Create(RequestUrl) as HttpWebRequest;
HttpWebResponse response = null;

StreamReader sr = null;
string boundary = "FBGraphAPIClient" + DateTime.Now.Ticks.ToString();

    try
    {
        request.Method = "POST";
        request.ContentType = "multipart/form-data; boundary=" + boundary;

byte[] multipartPostData = Helpers.BuildMultipartPostData(boundary, HttpPostData, FileUploadData);

        BinaryWriter bw = new BinaryWriter(request.GetRequestStream());
        bw.Write(multipartPostData);
        bw.Close();

response = request.GetResponse() as HttpWebResponse;

        sr = new StreamReader(response.GetResponseStream());
        string responseData = sr.ReadToEnd();
        sr.Close();

response.Close();

        return responseData;
    }
    catch (WebException we)
    {
        throw new FBGraphAPIException((we.Response as HttpWebResponse));
    }
    catch (Exception)
    {
        throw;
    }
}

Reference:

1. RFC 2388
2. Facebook Graph API Documentation

備註：因應 Bug 逃走中第五回的問題，此處的範例程式碼已修正編碼為 UTF8。

回首頁

小朱® 的技術隨手寫

本部落格不吹捧、不自戀、不造神，也絕不用技術文偷渡政治文，請各位朋友安心服用。

[.NET] 產生具有多個值，multipart/form-data 的 HTTP POST 訊息

標籤雲