使用 HttpClient 进行连接

对于System.Net.Http的学习（二）——使用 HttpClient 进行连接

 

 对于System.Net.Http的学习（一）——System.Net.Http 简介

 

 使用 HttpClient 进行连接

　　使用 System.Net.Http 命名空间中的 HttpClient 类可以向 WebService发送 POST与GET 请求并检索响应数据。

　　System.Net.Http 命名空间中的类可为现代 HTTP 应用提供编程接口。System.Net.Http 命名空间和相关的 System.Net.Http.Headers 命名空间提供的 HTTP 客户端组件，允许用户通过 HTTP 使用现代的 WebService。

　　HttpClient 类用于通过 HTTP 发送和接收基本要求。它提供了一个用于从 URI 所标识的资源发送 HTTP 请求和接收 HTTP 响应的基类。该类可用来向 Web Service发送 GET、PUT、POST、DELETE 以及其他请求。上述每种请求都作为异步操作进行发送。

　　HttpResponseMessage 类用于声明从 HTTP 请求接收到的 HTTP 响应消息。HTTP 消息由 IETF 在 RFC 2616 中进行定义。 

　　HttpContent 类是用于声明 HTTP 实体正文和内容标题的基类。 在这种情况下，HttpContent 用于声明 HTTP 响应。

 

　　以下示例使用 .NET Framework 4.0 的 C#。同时你必须对 RFC 2616 中详细描述的 HTTP 请求有基本的了解。

一、 创建新项目

　　1. 打开 Microsoft Visual Studio 2010，然后从“文件”菜单中选择“新建项目”。在模板列表中，选择 Visual C#。在该区域下面，选择“Windows 应用程序应用”，然后选择“空白应用程序”。将该应用程序命名为 winHttpClientBase，然后单击“确定”。

　　2. 添加Microsoft HTTP Client Libraries的引用如下图1，图2，图3，图4。

 

图1

 

 

图2

 

图3

 

 

图4

二、设置启用网络访问的功能

　　需要为应用设置网络功能，以启用家庭网络或工作网络以及 Internet 的访问。你需要为你的应用启用网络功能，因为客户端需要连接到因特网上的 Web Service。

　　对于使用 HttpClient 连接到另一台计算机上 Web Service的应用，该应用将需要设置网络功能。

三、添加 Windows 控件 

　　在本小节中，我们将在添加显示数据的控件和内容，每个控件的大小和位置，我们的用户界面如下。

　　本示例使用了简单的 Windows 控件，包括：

　　o 包含Label 标签、输入 URI 地址的 TextBox和用于启动异步请求的Button(请求) 。

　　o 包一个显示状态与状态代码的两个Lable与TextBox。

　　o 包一个显示请求结果的TextBox。用于显示从 Web 服务接收到的信息。在此示例中，HTTP GET 操作的结果会以包含 HTML 标记的纯文本显示。

 

 

　　四、创建 HttpClient，发送 GET 请求并检索响应

　　以下代码将首先创建 HttpClient 对象。

　　1. 首先创建 HttpClient 对象。我们还在 HttpClient 对象上设置两个属性。

　　HttpClient.MaxResponseContentBufferSize 属性的默认值是整数的最大值。为了限制应用作为来自 Web 服务的响应接受的数据量，我们将此属性设置为一个较小的值。

　　默认情况下，HttpClient 对象不会将用户代理标识头随 HTTP 请求一起发送到 Web 服务。某些 HTTP 服务器（包括某些 Microsoft Web 服务器）要求从客户端发送的 HTTP 请求附带用户代理标识头，并且如果没有标识头，则返回错误。为了避免这些错误，使用 HttpClient.DefaultRequestHeaders 属性添加了用户代理标头。

　　2. 打开 Form1.cs 文件。然后将如下代码添加到该文件中。

   

   private void btnRequest_Click(object sender, EventArgs e)

        {

            Init();

        }

        private HttpClient httpClient;

 

    public void Init()

    {

        this.InitializeComponent();

        httpClient = new HttpClient();

        // Limit the max buffer size for the response so we don't get overwhelmed

        httpClient.MaxResponseContentBufferSize = 256000;

        httpClient.DefaultRequestHeaders.Add("user-agent", "Mozilla/5.0 (compatible; MSIE 10.0; Windows NT 6.2; WOW64; Trident/6.0)");

    }

 

 

 

 

 

　　3. 发送 GET 请求并检索响应。

　　在单击“请求”按钮之后， txtStatusText和 txtMsg文本框中的文本将被更新，然后应用程序使用txtUrl文本框中的 URI 地址发送 HTTP GET 请求并等待响应。如果发生错误或异常，结果会显示在 txtStatusText文本框中。如果没有错误发生，则来自该 Web 服务的响应将显示在 txtMsg文本框中。

　　如果是使用vs 2012与net 4.5 则可以在 C# 和 Visual Basic 中使用 await 关键字时，发送 GET 请求并异步检索响应的代码与我们用于同步完成该操作的代码相似。只有在该方法被定义为 async 时，才能使用 await 关键字。

　　如果 Web 服务器返回 HTTP 错误状态代码，则 HttpResponseMessage.EnsureSuccessStatusCode 方法将引发异常。 如果发生错误，则对任何异常使用 try/catch 块，并在 txtStatusText 文本框中显示异常信息。在 try 块中，显示 Web 服务所返回的状态（txtStatusText）和状态代码（txtStatusCode）。

　　HttpResponseMessage.Content 属性声明 HTTP 响应的内容。HttpContent.ReadAsStringAsync 方法将 HTTP 内容作为异步操作写入到字符串中。 为了方便显示，我们将所返回的 HTML 文本中的所有 <br> 标记都替换成了新行。

 

 

 

         private  void GetHtml()

        {

            try

            {

                string responseBodyAsText;

                txtMsg.Text = "";

                txtStatusText.Text = "Waiting for response ...";

                var task = httpClient.GetAsync(new Uri(txtUrl.Text));

                task.Result.EnsureSuccessStatusCode();

                //var result = task.Result.Content.ReadAsStringAsync();

                HttpResponseMessage response = task.Result;

                 

                

                

                txtStatusText.Text = response.StatusCode + " " + response.ReasonPhrase + Environment.NewLine;

                var result =  response.Content.ReadAsStringAsync();

                responseBodyAsText = result.Result;

                responseBodyAsText = responseBodyAsText.Replace("<br>", Environment.NewLine); // Insert new lines

                txtMsg.Text = responseBodyAsText;

            }

            catch (HttpRequestException hre)

            {

                txtStatusText.Text = hre.ToString();

            }

            catch (Exception ex)

            {

                // For debugging

                txtStatusText.Text = ex.ToString();

            }

        }

 

 

 

　　如果使用 System.Net.Http 命名空间中的 HttpClient 和相关类的应用用于下载大量数据（50M 或更多），则该应用应流式传输这些下载内容并且不使用默认缓冲。如果使用了默认缓冲，则客户端内存使用量将变得非常大，这可能会导致大幅度降低性能。

　　当 HttpClient 类和相关类的成员检测到无效的统一资源标识符 (URI) 时，则将引发 UriFormatException 此例外不可以在 Windows 应用商店应用中使用。若要在这种情况下捕获此例外，请为 FormatException 编写捕获语句。 

 

 

五、小结

　　在本文中，我们已了解如何使用 HttpClient 类向 Web 服务发送 GET 请求以及如何使用 HttpResponseMessage 和 HttpContent 类检索响应。

　　HttpClientBasic 完整示例

 

public partial class Form1 : Form

    {

        public Form1()

        {

            InitializeComponent();

        }

 

        private void btnRequest_Click(object sender, EventArgs e)

        {

            Init();

            GetHtml();

        }

 

        private void GetHtml()

        {

            try

            {

                string responseBodyAsText;

                txtMsg.Text = "";

                txtStatusText.Text = "等待请求返回 ...";

                var task = httpClient.GetAsync(new Uri(txtUrl.Text));

                task.Result.EnsureSuccessStatusCode();

                HttpResponseMessage response = task.Result;

                txtStatusCode.Text = response.StatusCode + " " + response.ReasonPhrase + Environment.NewLine;

                txtStatusText.Text = "请求返回结果如下 ...";

                var result = response.Content.ReadAsStringAsync();

                responseBodyAsText = result.Result;

                responseBodyAsText = responseBodyAsText.Replace("<br>", Environment.NewLine); // Insert new lines

 

                txtMsg.Text = responseBodyAsText;

            }

            catch (HttpRequestException hre)

            {

                txtStatusText.Text = hre.ToString();

            }

            catch (Exception ex)

            {

                // For debugging

                txtStatusText.Text = ex.ToString();

            }

        }

 

 

        private HttpClient httpClient;

 

        public void Init()

        {

 

            httpClient = new HttpClient();            

            httpClient.MaxResponseContentBufferSize = 256000;

            httpClient.DefaultRequestHeaders.Add("user-agent", "Mozilla/5.0 (compatible; MSIE 10.0; Windows NT 6.2; WOW64; Trident/6.0)");

        }

    }

 

 

可以将 HttpClientHandler 类与 HttpClient 类结合使用，以设置有关 HTTP 请求的选项。 

 

 

 

 

分类:  AspNet,  c#