使用HttpWebRequest附加携带请求参数以post方式模拟上传大文件(以图片为例)到Web服务器端

本是古典何须时尚 2021-06-26 16:06 195阅读 0赞

## 一、`Http`协议上传文件（以图片为例）请求报文体内容格式 ##

首先，我们来看下通过浏览器上传文件的请求报文内容格式，这里以本人自己写的实例为例，如下图。除了能上传图片（即：头像字段），还携带了用户名、密码两个字段，很好的诠释了`http`带参数上传文件的情形。点击提交按钮后，浏览器会将文件（即头像文件）二进制数据和用户名、密码以`post`方式发送至服务器。这时我们可以通过抓包工具（如：`fiddler`）（或者浏览器自带的开发者工具F12)查看请求报文内容。

`HttpWebRequest`携带参数上传图片等大文件

**通过抓包工具获取到携带参数上传文件请求报文体内容格式如下：**

POST /PostUploadHandler.ashx HTTP/1.1
    Host: localhost:44187
    Connection: keep-alive
    Content-Length: 19839
    Cache-Control: max-age=0
    Accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8
    Origin: http://localhost:44187
    Upgrade-Insecure-Requests: 1
    User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/45.0.2454.101 Safari/537.36
    Content-Type: multipart/form-data; boundary=----WebKitFormBoundaryNSF3vGLxKBlk5kcB
    Referer: http://localhost:44187/UploadDemo.aspx
    Accept-Encoding: gzip, deflate
    Accept-Language: zh-CN,zh;q=0.8
     
     
    ------WebKitFormBoundaryNSF3vGLxKBlk5kcB
    Content-Disposition: form-data; name="userName"
     
    admin
    ------WebKitFormBoundaryNSF3vGLxKBlk5kcB
    Content-Disposition: form-data; name="userPwd"
     
    123456
    ------WebKitFormBoundaryNSF3vGLxKBlk5kcB
    Content-Disposition: form-data; name="photo"; filename="1.png"
    Content-Type: image/png
     
    
    ------WebKitFormBoundaryNSF3vGLxKBlk5kcB--

1、请求头中有一个`Content-Type`参数（默认值：`application/x-www-form-urlencoded`），其中`multipart/form-data`值表示向服务器发送二进制数据，`boundary`表示请求体的分界线，服务器就是依靠分界线分割请求体来读取数据，此参数值可自定义。

2、请求体依靠`boundary`有规则的排列参数。每一行字符串后面包含一个换行符“`\r\n`”，有一个开始分界线（`--boundary`)和一个结束分界线（`--boundary--`），参数与参数之间通过`--boundary`分离，每一个参数的键（`key`）和值（`value`）之间包含一个空行即：“`\r\n`"。

## 二、完整版`HttpWebRequest`模拟上传文件请求报文内容封装 ##

通过上面介绍，我们已经清楚了解了`http`协议上传文件的`POST`请求报文内容格式，在`.net`中使用`HttpWebRequest`上传文件，我们只要按照此格式封装请求报文，即可实现携带参数上传功能了。

为了方便扩展和维护，把所有请求参数（如上传地址`url`、携带参数、上传文件流等）封装到一个类中，代码如下：

/// <summary>
    /// 上传文件 - 请求参数类
    /// </summary>
    public class UploadParameterType
    { 
        public UploadParameterType()
        { 
            FileNameKey = "fileName";
            Encoding = Encoding.UTF8;
            PostParameters = new Dictionary<string, string>();
        }
        /// <summary>
        /// 上传地址
        /// </summary>
        public string Url {  get; set; }
        /// <summary>
        /// 文件名称key
        /// </summary>
        public string FileNameKey {  get; set; }
        /// <summary>
        /// 文件名称value
        /// </summary>
        public string FileNameValue {  get; set; }
        /// <summary>
        /// 编码格式
        /// </summary>
        public Encoding Encoding {  get; set; }
        /// <summary>
        /// 上传文件的流
        /// </summary>
        public Stream UploadStream {  get; set; }
        /// <summary>
        /// 上传文件 携带的参数集合
        /// </summary>
        public IDictionary<string, string> PostParameters {  get; set; } 
    }

新建一个上传文件工具类（命名为：`HttpUploadClient`),在类中增加上传方法（命名为：`Execute`），如下所示：

/// <summary>
    /// Http上传文件类 - HttpWebRequest封装
    /// </summary>
    public class HttpUploadClient
    { 
        /// <summary>
        /// 上传执行 方法
        /// </summary>
        /// <param name="parameter">上传文件请求参数</param>
        public static string Execute(UploadParameterType parameter)
        { 
             
        }
        static bool CheckValidationResult(object sender, X509Certificate certificate, X509Chain chain, SslPolicyErrors errors)
        { 
            return true;
        }
    }

`Post`上传请求体参数是二进制格式的，我们只需要将参数根据以上报文体内容格式拼接好数据，存放在内存流里面，拼接完整后，将整个内存流转换成二进制格式写入到`HttpWebRequest`请求体中就行，下面我们来一步一步的拼接报文体内容。

1、定义开始结束分界线`boundary`及拼接开始分界线:

public static string Execute(UploadParameterType parameter)
    { 
        using (MemoryStream memoryStream = new MemoryStream())
        { 
            // 1.分界线
            string boundary = string.Format("----{0}", DateTime.Now.Ticks.ToString("x")),       // 分界线可以自定义参数
                beginBoundary = string.Format("--{0}\r\n", boundary),
                endBoundary = string.Format("\r\n--{0}--\r\n", boundary);
            byte[] beginBoundaryBytes = parameter.Encoding.GetBytes(beginBoundary),
                endBoundaryBytes = parameter.Encoding.GetBytes(endBoundary);
            // 2.组装开始分界线数据体 到内存流中
            memoryStream.Write(beginBoundaryBytes, 0, beginBoundaryBytes.Length);
            // ……
        }
    }

2、拼接附加携带参数：

// 3.组装 上传文件附加携带的参数 到内存流中
    if (parameter.PostParameters != null && parameter.PostParameters.Count > 0)
    { 
        foreach (KeyValuePair<string, string> keyValuePair in parameter.PostParameters)
        { 
            string parameterHeaderTemplate = string.Format("Content-Disposition: form-data; name=\"{0}\"\r\n\r\n{1}\r\n{2}", keyValuePair.Key, keyValuePair.Value, beginBoundary);
            byte[] parameterHeaderBytes = parameter.Encoding.GetBytes(parameterHeaderTemplate);
     
            memoryStream.Write(parameterHeaderBytes, 0, parameterHeaderBytes.Length);
        }
    }

3、拼接上传文件体及结束分界线`boundary`（需要注意的是`Content-Type`的值是：`application/octet-stream`）：

// 4.组装文件头数据体 到内存流中
    string fileHeaderTemplate = string.Format("Content-Disposition: form-data; name=\"{0}\"; filename=\"{1}\"\r\nContent-Type: application/octet-stream\r\n\r\n", parameter.FileNameKey, parameter.FileNameValue);
    byte[] fileHeaderBytes = parameter.Encoding.GetBytes(fileHeaderTemplate);
    memoryStream.Write(fileHeaderBytes, 0, fileHeaderBytes.Length);
    // 5.组装文件流 到内存流中
    byte[] buffer = new byte[1024 * 1024 * 1];
    int size = parameter.UploadStream.Read(buffer, 0, buffer.Length);
    while (size > 0)
    { 
        memoryStream.Write(buffer, 0, size);
        size = parameter.UploadStream.Read(buffer, 0, buffer.Length);
    }
    // 6.组装结束分界线数据体 到内存流中
    memoryStream.Write(endBoundaryBytes, 0, endBoundaryBytes.Length);

4、通过以上步骤，上传文件请求体内容数据已经拼接完成，接下来就是对`HttpWebRequest`对象的属性设置（如：请求地址`Url`，请求方法`Method`，`Content-Type`等），把整个上传文件请求体内存流写入到`HttpWebRequest`对象的请求体中，然后发起上传请求。如下源码：

// 7.获取二进制数据
    byte[] postBytes = memoryStream.ToArray();
    // 8.HttpWebRequest 组装
    HttpWebRequest webRequest = (HttpWebRequest)WebRequest.Create(new Uri(parameter.Url, UriKind.RelativeOrAbsolute));
    webRequest.Method = "POST";
    webRequest.Timeout = 10000;
    webRequest.ContentType = string.Format("multipart/form-data; boundary={0}", boundary);
    webRequest.ContentLength = postBytes.Length;
    if (Regex.IsMatch(parameter.Url, "^https://"))
    { 
        ServicePointManager.SecurityProtocol = SecurityProtocolType.Tls;
        ServicePointManager.ServerCertificateValidationCallback = CheckValidationResult;
    }
    // 9.写入上传请求数据
    using (Stream requestStream = webRequest.GetRequestStream())
    { 
        requestStream.Write(postBytes, 0, postBytes.Length);
        requestStream.Close();
    }
    // 10.获取响应
    using (HttpWebResponse webResponse = (HttpWebResponse)webRequest.GetResponse())
    { 
        using (StreamReader reader = new StreamReader(webResponse.GetResponseStream(), parameter.Encoding))
        { 
            string body = reader.ReadToEnd();
            reader.Close();
            return body;
        }
    }

完整版`HttpWebRequest`模拟上传文件代码如下：

/// <summary>
    /// Http上传文件类 - HttpWebRequest封装
    /// </summary>
    public class HttpUploadClient
    { 
        /// <summary>
        /// 上传执行 方法
        /// </summary>
        /// <param name="parameter">上传文件请求参数</param>
        public static string Execute(UploadParameterType parameter)
        { 
            using (MemoryStream memoryStream = new MemoryStream())
            { 
                // 1.分界线
                string boundary = string.Format("----{0}", DateTime.Now.Ticks.ToString("x")),       // 分界线可以自定义参数
                    beginBoundary = string.Format("--{0}\r\n", boundary),
                    endBoundary = string.Format("\r\n--{0}--\r\n", boundary);
                byte[] beginBoundaryBytes = parameter.Encoding.GetBytes(beginBoundary),
                    endBoundaryBytes = parameter.Encoding.GetBytes(endBoundary);
                // 2.组装开始分界线数据体 到内存流中
                memoryStream.Write(beginBoundaryBytes, 0, beginBoundaryBytes.Length);
                // 3.组装 上传文件附加携带的参数 到内存流中
                if (parameter.PostParameters != null && parameter.PostParameters.Count > 0)
                { 
                    foreach (KeyValuePair<string, string> keyValuePair in parameter.PostParameters)
                    { 
                        string parameterHeaderTemplate = string.Format("Content-Disposition: form-data; name=\"{0}\"\r\n\r\n{1}\r\n{2}", keyValuePair.Key, keyValuePair.Value, beginBoundary);
                        byte[] parameterHeaderBytes = parameter.Encoding.GetBytes(parameterHeaderTemplate);
     
                        memoryStream.Write(parameterHeaderBytes, 0, parameterHeaderBytes.Length);
                    }
                }
                // 4.组装文件头数据体 到内存流中
                string fileHeaderTemplate = string.Format("Content-Disposition: form-data; name=\"{0}\"; filename=\"{1}\"\r\nContent-Type: application/octet-stream\r\n\r\n", parameter.FileNameKey, parameter.FileNameValue);
                byte[] fileHeaderBytes = parameter.Encoding.GetBytes(fileHeaderTemplate);
                memoryStream.Write(fileHeaderBytes, 0, fileHeaderBytes.Length);
                // 5.组装文件流 到内存流中
                byte[] buffer = new byte[1024 * 1024 * 1];
                int size = parameter.UploadStream.Read(buffer, 0, buffer.Length);
                while (size > 0)
                { 
                    memoryStream.Write(buffer, 0, size);
                    size = parameter.UploadStream.Read(buffer, 0, buffer.Length);
                }
                // 6.组装结束分界线数据体 到内存流中
                memoryStream.Write(endBoundaryBytes, 0, endBoundaryBytes.Length);
                // 7.获取二进制数据
                byte[] postBytes = memoryStream.ToArray();
                // 8.HttpWebRequest 组装
                HttpWebRequest webRequest = (HttpWebRequest)WebRequest.Create(new Uri(parameter.Url, UriKind.RelativeOrAbsolute));
                webRequest.Method = "POST";
                webRequest.Timeout = 10000;
                webRequest.ContentType = string.Format("multipart/form-data; boundary={0}", boundary);
                webRequest.ContentLength = postBytes.Length;
                if (Regex.IsMatch(parameter.Url, "^https://"))
                { 
                    ServicePointManager.SecurityProtocol = SecurityProtocolType.Tls;
                    ServicePointManager.ServerCertificateValidationCallback = CheckValidationResult;
                }
                // 9.写入上传请求数据
                using (Stream requestStream = webRequest.GetRequestStream())
                { 
                    requestStream.Write(postBytes, 0, postBytes.Length);
                    requestStream.Close();
                }
                // 10.获取响应
                using (HttpWebResponse webResponse = (HttpWebResponse)webRequest.GetResponse())
                { 
                    using (StreamReader reader = new StreamReader(webResponse.GetResponseStream(), parameter.Encoding))
                    { 
                        string body = reader.ReadToEnd();
                        reader.Close();
                        return body;
                    }
                }
            }
        }
        static bool CheckValidationResult(object sender, X509Certificate certificate, X509Chain chain, SslPolicyErrors errors)
        { 
            return true;
        }
    }

为了验证封装是否正确，可以写一个控制台应用程序来模拟`Http`协议上传文件（以图片为例），结果如图：

## 三、[asp.net][](c\#)使用`HttpWebRequest`携带请求参数模拟上传文件封装源码下载 ##

[HttpWebRequest模拟上传文件封装源码][HttpWebRequest]

[asp.net]: http://asp.net
[HttpWebRequest]: http://pan.baidu.com/s/1kV8f0ft