将 HttpClientHandler 类与 System.Net.Http 命名空间中的 HttpClient 类结合使用,以向 Web Service发送 GET 请求并检索响应。
HttpClient 类用于通过 HTTP 发送和接收基本要求。它提供了一个用于从 URI 所标识的资源发送 HTTP 请求和接收 HTTP 响应的基类。该类可用来向 Web 服务发送 GET、PUT、POST、DELETE 以及其他请求。上述每种请求都作为异步操作进行发送。
HttpClientHandler 类是 HttpClient 的默认消息处理程序。HttpClientHandler 类以及从该类派生的类让开发人员可以对 HTTP 请求配置从代理到身份验证的一系列选项。
在本节中,我们将在 Windows Form 中定义应用的布局,以指定应用中每个对象的大小和位置。 通过添加显示数据的控件和内容,我们已经完成了应用的用户界面。如下图。
以下示例代码将首先创建 HttpClientHandler 对象。该代码还将对该对象设置一个属性,并使用 HttpClientHandler 创建一个 HttpClient 对象。
AllowAutoRedirect 属性指示 HttpClientHandler 对象的请求是否应遵循重定向响应。此属性的默认值是 true。如果此属性被设置为 false,则不会遵循 Web 服务的重定向请求。
然后,使用 HttpClientHandler 对象创建 HttpClient 对象。我们还在 HttpClient 对象上设置两个属性。HttpClient.MaxResponseContentBufferSize 属性的默认大小是整数的最大大小。为了限制应用作为来自 Web 服务的响应接受的数据量,我们将此属性设置为一个较小的值。
默认情况下,HttpClient 对象不会将用户代理标头随 HTTP 请求一起发送到 Web 服务。某些 HTTP 服务器(包括某些 Microsoft Web 服务器)要求从客户端发送的 HTTP 请求附带用户代理标头,并且如果没有标头,则返回错误。为了避免这些错误,示例使用 HttpClient.DefaultRequestHeaders 属性添加了用户代理标头。
打开 Form1.cs 文件,然后将如下代码添加到该文件中。
private HttpClient httpClient; private HttpClientHandler handler; public void Init() { txtUrl.Text = "http://webservices.amazon.com/AWSECommerceService/AWSECommerceService.wsdl"; handler = new HttpClientHandler(); handler.AllowAutoRedirect=false; httpClient = new HttpClient(handler); // Limit the max buffer size for the response so we don't get overwhelmed httpClient.MaxResponseContentBufferSize = 256000; // Add a user-agent header httpClient.DefaultRequestHeaders.Add("user-agent", "Mozilla/5.0 (compatible; MSIE 10.0; Windows NT 6.2; WOW64; Trident/6.0)"); }
2. 发送 GET 请求并检索响应。
在单击“请求”按钮之后,txtStatusText 和 txtMsg两个文本框中的文本将被更新,然后使用输入到txtUrl文本框中的 URI 地址发送 HTTP GET 请求并等待响应。如果发生错误或异常,错误信息会显示在 txtStatusText文本框中。如果没有错误发生,则来自该 Web 服务的响应将显示在 txtMsg文本框中。
说明:
在 visual studio 2012 中的 C# 和 Visual Basic 中可以使用 await 关键字时,发送 GET 请求并异步检索响应的代码与我们用于同步完成该操作的代码相似。只有在该方法被定义为 async 时,才能使用 await 关键字。
如果 Web 服务器返回 HTTP 错误状态代码,则 HttpResponseMessage.EnsureSuccessStatusCode 方法将引发异常。 如果发生错误,则对任何异常使用 try/catch 块,并把错误信息显示在txtStatusText 文本框中的异常消息。在 try 块中,显示 Web 服务所返回的状态和响应。
HttpResponseMessage.Content 属性声明 HTTP 响应的内容。HttpContent.ReadAsStringAsync 方法将 HTTP 内容作为异步操作写入到字符串中。
private void btnRequest_Click(object sender, EventArgs e) { try { txtMsg.Text=string.Empty; txtStatusText.Text = "等待请求返回 ..."; var task = httpClient.GetAsync(txtUrl.Text); task.Result.EnsureSuccessStatusCode(); HttpResponseMessage response = task.Result; txtStatusCode.Text = response.StatusCode + " " + response.ReasonPhrase + Environment.NewLine; txtStatusText.Text = "请求返回结果如下 ..."; var result = response.Content.ReadAsStringAsync(); string 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) { txtStatusText.Text = ex.ToString(); } }
在本文中,我们介绍了如何将 HttpClientHandler 与 HttpClient 类结合使用,以向 Web 服务发送 GET 请求,以及如何使用 HttpResponseMessage 和 HttpContent 类检索响应。HttpClientHandler 允许应用设置有关 HTTP 请求的选项。
有一些 HTTP 消息处理程序可以与 HttpClient 类结合使用。
完整示例:
HttpClientHandler 示例 C# using System; using System.Collections.Generic; using System.ComponentModel; using System.Data; using System.Drawing; using System.Linq; using System.Text; using System.Windows.Forms; using System.Net.Http; namespace HttpClientHandlerSample { public partial class Form1 : Form { public Form1() { InitializeComponent(); Init(); } private HttpClient httpClient; private HttpClientHandler handler; public void Init() { txtUrl.Text = "http://webservices.amazon.com/AWSECommerceService/AWSECommerceService.wsdl"; handler = new HttpClientHandler(); handler.AllowAutoRedirect=false; httpClient = new HttpClient(handler); // Limit the max buffer size for the response so we don't get overwhelmed httpClient.MaxResponseContentBufferSize = 256000; // Add a user-agent header httpClient.DefaultRequestHeaders.Add("user-agent", "Mozilla/5.0 (compatible; MSIE 10.0; Windows NT 6.2; WOW64; Trident/6.0)"); } private void btnRequest_Click(object sender, EventArgs e) { try { txtMsg.Text=string.Empty; txtStatusText.Text = "等待请求返回 ..."; var task = httpClient.GetAsync(txtUrl.Text); task.Result.EnsureSuccessStatusCode(); HttpResponseMessage response = task.Result; txtStatusCode.Text = response.StatusCode + " " + response.ReasonPhrase + Environment.NewLine; txtStatusText.Text = "请求返回结果如下 ..."; var result = response.Content.ReadAsStringAsync(); string 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) { txtStatusText.Text = ex.ToString(); } } } }