C#中使用HttpWebRequest用Post提交MultiPart数据

在C#中有HttpWebRequest类，可以很方便用来获取http请求，但是这个类对Post方式没有提供一个很方便的方法来获取数据。网上有很多人提供了解决方法，但都参差不齐，这里我把我使用的方法总结出来，与大家分享。

 

本文精华：实现了post的时候即可以有字符串的key-value,还可以带文件。

 

Post数据格式

Post提交数据的时候最重要就是把Key-Value的数据放到http请求流中，而HttpWebRequest没有提供一个属性之类的东西可以让我们自由添加Key-Value，因此就必须手工构造这个数据。

根据RFC 2045协议，一个Http Post的数据格式如下：

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

 --AaB03x
 Content-Disposition: form-data; name="submit-name"

 Larry
 --AaB03x
 Content-Disposition: form-data; name="file"; filename="file1.dat"
 Content-Type: application/octet-stream

 ... contents of file1.dat ...
 --AaB03x--

详细解释如下：

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

如上面所示，首先声明数据类型为multipart/form-data, 然后定义边界字符串AaB03x，这个边界字符串就是用来在下面来区分各个数据的，可以随便定义，但是最好是用破折号等数据中一般不会出现的字符。然后是换行符。

注意：Post中定义的换行符是\r\n

--AaB03x

这个是边界字符串，注意每一个边界符前面都需要加2个连字符“--”，然后跟上换行符。

Content-Disposition: form-data; name="submit-name"

这里是Key-Value数据中字符串类型的数据。 submit-name 是这个Key-Value数据中的Key。当然也需要换行符。

Larry

这个就是刚才Key-Value数据中的value。

--AaB03x

边界符,表示数据结束。

Content-Disposition: form-data; name="file"; filename="file1.dat"

这个代表另外一个数据，它的key是file，文件名是file1.dat。 注意：最后面没有分号了。

Content-Type: application/octet-stream

这个标识文件类型。application/octet-stream表示二进制数据。

... contents of file1.dat ...

这个是文件内容。可以使二进制的数据。

--AaB03x--

数据结束后的分界符，注意因为这个后面没有数据了所以需要在后面追加一个“--”表示结束。

C#下Post数据的函数

搞明白格式后，我们就很容易写出C#的代码了。如下所示：

private static string HttpPostData(string url, int timeOut, string fileKeyName, 
                                    string filePath, NameValueCollection stringDict)
{
    string responseContent;
    var memStream = new MemoryStream();
    var webRequest = (HttpWebRequest)WebRequest.Create(url);
    // 边界符
    var boundary = "---------------" + DateTime.Now.Ticks.ToString("x");
    // 边界符
    var beginBoundary = Encoding.ASCII.GetBytes("--" + boundary + "\r\n");
    var fileStream = new FileStream(filePath, FileMode.Open, FileAccess.Read);
    // 最后的结束符
    var endBoundary = Encoding.ASCII.GetBytes("--" + boundary + "--\r\n");

    // 设置属性
    webRequest.Method = "POST";
    webRequest.Timeout = timeOut;
    webRequest.ContentType = "multipart/form-data; boundary=" + boundary;

    // 写入文件
    const string filePartHeader =
        "Content-Disposition: form-data; name=\"{0}\"; filename=\"{1}\"\r\n"+
         "Content-Type: application/octet-stream\r\n\r\n";
    var header = string.Format(filePartHeader, fileKeyName, filePath);
    var headerbytes = Encoding.UTF8.GetBytes(header);

    memStream.Write(beginBoundary, 0, beginBoundary.Length);
    memStream.Write(headerbytes, 0, headerbytes.Length);

    var buffer = new byte[1024];
    int bytesRead; // =0

    while ((bytesRead = fileStream.Read(buffer, 0, buffer.Length)) != 0)
    {
        memStream.Write(buffer, 0, bytesRead);
    }

    // 写入字符串的Key
    var stringKeyHeader = "\r\n--" + boundary +
                           "\r\nContent-Disposition: form-data; name=\"{0}\""+
                           "\r\n\r\n{1}\r\n";

    foreach (byte[] formitembytes in from string key in stringDict.Keys
                                     select string.Format(stringKeyHeader, key, stringDict[key])
                                         into formitem
                                         select Encoding.UTF8.GetBytes(formitem))
    {
        memStream.Write(formitembytes, 0, formitembytes.Length);
    }

    // 写入最后的结束边界符
    memStream.Write(endBoundary, 0, endBoundary.Length);

    webRequest.ContentLength = memStream.Length;

    var requestStream = webRequest.GetRequestStream();

    memStream.Position = 0;
    var tempBuffer = new byte[memStream.Length];
    memStream.Read(tempBuffer, 0, tempBuffer.Length);
    memStream.Close();

    requestStream.Write(tempBuffer, 0, tempBuffer.Length);
    requestStream.Close();

    var httpWebResponse = (HttpWebResponse)webRequest.GetResponse();

    using (var httpStreamReader = new StreamReader(httpWebResponse.GetResponseStream(), 
                                                    Encoding.GetEncoding("utf-8")))
    {
        responseContent = httpStreamReader.ReadToEnd();
    }

    fileStream.Close();
    httpWebResponse.Close();
    webRequest.Abort();

    return responseContent;
}

参考资料

1. Rfc2045:http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4.
2. http://stackoverflow.com/questions/566462/upload-files-with-httpwebrequest-multipart-form-data