C# HttpWebRequest详解

一.前言

HttpWebRequest是C#原生语法提供的实现了Http协议完整封装的类，可以实现任意类型的Http请求。但是也因为参数众多，导致很多人不容易掌握它。

今天我们来尝试从简入繁的给大家介绍下HttpWebRequest

二.常用属性

• AllowAutoRedirect：获取或设置一个值，该值指示请求是否应跟随重定向响应。

• CookieContainer：获取或设置与此请求关联的cookie。

• Credentials：获取或设置请求的身份验证信息。

• KeepAlive：获取或设置一个值，该值指示是否与 Internet 资源建立持久性连接。

• MaximumAutomaticRedirections：获取或设置请求将跟随的重定向的最大数目。

• Proxy：获取或设置请求的代理信息。

• SendChunked：获取或设置一个值，该值指示是否将数据分段发送到 Internet 资源。

• Timeout：获取或设置请求的超时值。

• UserAgent：获取或设置 User-agent HTTP 标头的值

• ContentType：Http内容类型

• Headers：指定组成 HTTP 标头的名称/值对的集合。

ContentType

• 普通文本: “text/plain”

• JSON字符串: “application/json”

• 数据流类型(文件流): “application/octet-stream”

• 表单数据(键值对): “application/x-www-form-urlencoded”

• 多分部数据: “multipart/form-data”

三.简单示例

下面是一个最简单的HttpWebRequest请求和相应

我们只需要传url，就可以想服务器发送请求，并接收回复了。

//创建HttpWeb请求
HttpWebRequest request = (HttpWebRequest)WebRequest.Create (url);
//创建HttpWeb相应
HttpWebResponse response = (HttpWebResponse)request.GetResponse ();

Console.WriteLine ("Content length is {0}", response.ContentLength);
Console.WriteLine ("Content type is {0}", response.ContentType);

//获取response的流
Stream receiveStream = response.GetResponseStream ();

//使用streamReader读取流数据
StreamReader readStream = new StreamReader (receiveStream, Encoding.UTF8);

Console.WriteLine ("Response stream received.");
Console.WriteLine (readStream.ReadToEnd ());
response.Close ();
readStream.Close ();

四.Json文本请求示例

使用application/json作为请求头，用来告诉服务端消息主体是序列化的JSON字符串。

/*
*  url:POST请求地址
*  postData:json格式的请求报文,例如：{"key1":"value1","key2":"value2"}
*/
public static string PostUrl(string url, string postData)
{
    
    
    HttpWebRequest req = (HttpWebRequest)WebRequest.Create(url);
    req.Method = "POST";
    req.TimeOut = "800";//设置请求超时时间，单位为毫秒
    req.ContentType = "application/json";
    byte[] data = Encoding.UTF8.GetBytes(postData);
    req.ContentLength = data.Length;

    using (Stream reqStream = req.GetRequestStream())
    {
    
    
        reqStream.Write(data, 0, data.Length);
        reqStream.Close();
    }

    HttpWebResponse resp = (HttpWebResponse)req.GetResponse();
    Stream stream = resp.GetResponseStream();

    //获取响应内容
    string result = "";
    using (StreamReader reader = new StreamReader(stream, Encoding.UTF8))
    {
    
    
        result = reader.ReadToEnd();
    }
    return result;
}

五.文件上传示例

使用multipart/form-data作为请求头，用来告诉服务器消息主体是 多发文件 格式

multipart/form-data格式使用一长串字符作为boundtry封装线对字段进行分割。这也很符合multipart多个部分的语义，包含了多个部分集，每一部分都包含了一个content-desposition头，其值为form-data,以及一个name属性，其值为表单的字段名，文件输入框还可以使用filename参数指定文件名。content-type非必须属性，其值会根据文件类型进行变化，默认值是text/plain。multipart的每一个part上方是边界线，最后一个part的下方添加一个边界线。

参考示例：

/// <summary>
/// 上传文件请求
/// </summary>
/// <param name="url">Url</param>
/// <param name="filePath">文件路径</param>
/// <param name="formDatas">表单数据（字典格式）</param>
/// <param name="callback">上传回调</param>
public static void UploadRequest(string url, string filePath, Dictionary<string,string> formDatas, Action<string> callback)
{
    
    
    // 时间戳，用做boundary
    string timeStamp = DateTime.Now.Ticks.ToString("x");

    //根据uri创建HttpWebRequest对象
    HttpWebRequest httpReq = (HttpWebRequest) WebRequest.Create(new Uri(url));
    httpReq.Method = "POST";
    httpReq.AllowWriteStreamBuffering = false; //对发送的数据不使用缓存
    httpReq.Timeout = 300000; //设置获得响应的超时时间（300秒）
    httpReq.ContentType = "multipart/form-data; boundary=" + timeStamp;

    //读取file文件
    FileStream fileStream = new FileStream(filePath, FileMode.Open, FileAccess.Read);
    BinaryReader binaryReader = new BinaryReader(fileStream);
    
    //表单信息
    string boundary = "--" + timeStamp;
    string form = "";
    string formFormat = boundary + "\r\nContent-Disposition: form-data; name=\"{0}\"\r\n\r\n{1}\r\n";
    string formEnd = boundary + "\r\nContent-Disposition: form-data; name=\"{0}\"; filename=\"{1}\";\r\nContent-Type:application/octet-stream\r\n\r\n";
    foreach (var pair in formDatas)
    {
    
    
        form += string.Format(formFormat, pair.Key, pair.Value);
    }
    form += string.Format(formEnd,"file", Path.GetFileName(filePath));
    byte[] postHeaderBytes = Encoding.UTF8.GetBytes(form);

    //结束边界
    byte[] boundaryBytes = Encoding.ASCII.GetBytes("\r\n--" + timeStamp + "--\r\n");
    long length = fileStream.Length + postHeaderBytes.Length + boundaryBytes.Length;
    httpReq.ContentLength = length; //请求内容长度

    try
    {
    
    
        //每次上传4k
        int bufferLength = 4096;
        byte[] buffer = new byte[bufferLength];

        //已上传的字节数
        long offset = 0;
        int size = binaryReader.Read(buffer, 0, bufferLength);
        Stream postStream = httpReq.GetRequestStream();

        //发送请求头部消息
        postStream.Write(postHeaderBytes, 0, postHeaderBytes.Length);

        while (size > 0)
        {
    
    
            postStream.Write(buffer, 0, size);
            offset += size;
            size = binaryReader.Read(buffer, 0, bufferLength);
        }

        //添加尾部边界
        postStream.Write(boundaryBytes, 0, boundaryBytes.Length);
        postStream.Close();

        //获取服务器端的响应
        using (HttpWebResponse response = (HttpWebResponse) httpReq.GetResponse())
        {
    
    
            Stream receiveStream = response.GetResponseStream();
            StreamReader readStream = new StreamReader(receiveStream, Encoding.UTF8);
            string returnValue = readStream.ReadToEnd();
            Debug.Log("upload result:"+returnValue);
            callback?.Invoke(returnValue);
            
            response.Close();
            readStream.Close();
        }
    }
    catch (Exception ex)
    {
    
    
        Debug.Log("文件传输异常： " + ex.Message);
    }
    finally
    {
    
    
        fileStream.Close();
        binaryReader.Close();
    }
}

首先明确一点，上传文件使用Get请求时无效的，必须使用Post请求结合multipart/form-data才能真正将文件内容传入请求体。

上传文件是一个前端常见的需求，但是为什么上传文件必须使用content-type:multipart/form-data作为请求头?

文档《RFC 2388：Returning Values from Forms: multipart/form-data 》，阐明了不仅在HTTP协议下传输文件、而且使用邮件传输文件时 multipart/form-data 中的各个部分的具体格式[1]。分别对3.Definition of multipart/form-data multipart/form-data的定义；4.Use of multipart/form-data具体使用格式和方法做了更详细的阐述，

• Postman示例：
  
  
  

六.其他示例

未完待续…