【ASP.NET Web API教程】3.4 HttpClient消息处理器-阿里云开发者社区

开发者社区> 杰克.陈> 正文

【ASP.NET Web API教程】3.4 HttpClient消息处理器

简介: 原文:【ASP.NET Web API教程】3.4 HttpClient消息处理器 注:本文是【ASP.NET Web API系列教程】的一部分,如果您是第一次看本博客文章,请先看前面的内容。 3.4 HttpClient Message Handlers 3.
+关注继续查看
原文:【ASP.NET Web API教程】3.4 HttpClient消息处理器

注:本文是【ASP.NET Web API系列教程】的一部分,如果您是第一次看本博客文章,请先看前面的内容。

3.4 HttpClient Message Handlers
3.4 HttpClient消息处理器

本文引自:http://www.asp.net/web-api/overview/web-api-clients/httpclient-message-handlers

By Mike Wasson | October 1, 2012
作者:Mike Wasson | 日期:2012-10-1

A message handler is a class that receives an HTTP request and returns an HTTP response.
消息处理器是一个接收HTTP请求并返回HTTP响应的类。

Typically, a series of message handlers are chained together. The first handler receives an HTTP request, does some processing, and gives the request to the next handler. At some point, the response is created and goes back up the chain. This pattern is called a delegating handler.
典型地,一系列消息处理器会链接在一起。第一个处理器接收HTTP请求,进行某些处理,将此请求传给下一个处理器。在处理链的某个点上创建响应,并进行回溯。这种模式称为委托(delegating)处理器(如图3-7所示)。

WebAPI3-7

图3-7. 消息处理链及委托处理器

On the client side, the HttpClient class uses a message handler to process requests. The default handler is HttpClientHandler, which sends the request over the network and gets the response from the server. You can insert custom message handlers into the client pipeline:
在客户端,HttpClient类使用消息处理器处理请求。默认的处理器是HttpClientHandler,它在网络上发送请求,并从服务器获取响应。你可以把自定义消息处理器插入到这种客户端管线之中(如图3-8所示)。

WebAPI3-8

图3-8. 消息处理管线

ASP.NET Web API also uses message handlers on the server side. For more information, see HTTP Message Handlers.
ASP.NET Web API也使用服务器端的消息处理器,更多信息参阅“HTTP消息处理器”(本系列教程第5.1小节 — 译者注)。

Custom Message Handlers
自定义消息处理器

To write a custom message handler, derive from System.Net.Http.DelegatingHandler and override the SendAsync method. Here is the method signature:
要编写自定义消息处理器,需从System.Net.Http.DelegatingHandler进行派生,并重写SendAsync方法。以下是该方法的签名:

Task<HttpResponseMessage> SendAsync(
    HttpRequestMessage request, CancellationToken cancellationToken);

The method takes an HttpRequestMessage as input and asynchronously returns an HttpResponseMessage. A typical implementation does the following:
该方法以HttpRequestMessage作为输入,并异步地返回一个HttpResponseMessage。一种典型的实现(流程)如下:

  1. Process the request message.
    处理请求消息。
  2. Call base.SendAsync to send the request to the inner handler.
    调用base.SendAsync将请求发送给内部处理器。
  3. The inner handler returns a response message. (This step is asynchronous.)
    内部处理器返回一条响应消息。(这一步是异步的。)
  4. Process the response and return it to the caller.
    处理响应,并把它返回给客户端。

The following example shows a message handler that adds a custom header to the outgoing request:
以下示例展示了一个消息处理器,它把一个自定义报头添加到输出请求:

class MessageHandler1 : DelegatingHandler 
{ 
    private int _count = 0; 
    protected override Task<HttpResponseMessage> SendAsync( 
        HttpRequestMessage request, System.Threading.CancellationToken cancellationToken) 
    { 
        _count++; 
        request.Headers.Add("X-Custom-Header", _count.ToString()); 
        return base.SendAsync(request, cancellationToken); 
    } 
}

The call to base.SendAsync is asynchronous. If the handler does any work after this call, use the await keyword to resume execution after the method completes. The following example shows a handler that logs error codes. The logging itself is not very interesting, but the example shows how to get at the response inside the handler.
base.SendAsync的调用是异步的。如果处理器在调用之后还要做一些工作,需使用await关键字,以便在方法完成之后继续执行。以下示例展示了一个对错误码进行日志的处理器。如何进行日志没多大关系,但此例展示了如何得到处理器内部的响应。

class LoggingHandler : DelegatingHandler 
{ 
    StreamWriter _writer; 
    public LoggingHandler(Stream stream) 
    { 
        _writer = new StreamWriter(stream); 
    } 
    protected override async Task<HttpResponseMessage> SendAsync( 
        HttpRequestMessage request, System.Threading.CancellationToken cancellationToken) 
    { 
        var response = await base.SendAsync(request, cancellationToken); 
        if (!response.IsSuccessStatusCode) 
        { 
            _writer.WriteLine("{0}\t{1}\t{2}", request.RequestUri,  
                (int)response.StatusCode, response.Headers.Date); 
        } 
        return response; 
    } 
    protected override void Dispose(bool disposing) 
    { 
        if (disposing) 
        { 
            _writer.Dispose(); 
        } 
        base.Dispose(disposing); 
    } 
}

Adding Message Handlers to the Client Pipeline
将消息处理器添加到客户端管线

To add custom handlers to HttpClient, use the HttpClientFactory.Create method:
要将自定义处理器添加到HttpClient,需使用HttpClientFactory.Create方法:

HttpClient client = HttpClientFactory.Create(new Handler1(), new Handler2(), new Handler3());

Message handlers are called in the order that you pass them into the Create method. Because handlers are nested, the response message travels in the other direction. That is, the last handler is the first to get the response message.
消息处理器是按照把它们传递给Create方法中的顺序来调用的。因此处理器是内嵌的,响应消息以反方向传递。即,最后一个处理器首先得到响应消息。

看完此文如果觉得有所收获,恳请给个推荐

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

相关文章
asp.net发布到IIS中出现错误:处理程序“PageHandlerFactory-Integrated”在其模块列表中有一个错误模块“ManagedPipelineHandler”
开发web项目时需要安装IIS,在安装好IIS的Windows7本上发布asp.net网站时,web程序已经映射到了本地IIS上,但运行如下错误提示“处理程序“PageHandlerFactory-Integrated”在其模块列表中有一个错误模块“Man...
806 0
Json.Net系列教程 3.Json.Net序列化和反序列化设置
原文 Json.Net系列教程 3.Json.Net序列化和反序列化设置 上节补充 首先补充一点,Json.Net是支持序列化和反序列化DataTable,DataSet,Entity Framework和NHibernate的.
768 0
Asp.Net Web API 2第七课——Web API异常处理
原文:Asp.Net Web API 2第七课——Web API异常处理 前言 阅读本文之前,您也可以到Asp.Net Web API 2 系列导航进行查看 http://www.cnblogs.com/aehyok/p/3446289.
784 0
Json.Net系列教程 1.Json.Net介绍及实例
原文 Json.Net系列教程 1.Json.Net介绍及实例 本系列教程假设读者已经对Json有一定的了解,关于Json在这里不多说.本系列教程希望能对读者开发涉及到Json的.Net项目有一定的帮 助.本系列教程是根据官方文档资料和自己项目应用汇总而成.如果觉得本系列对你有用,望多多关注.本人还只是个未毕业的学生,水平有限,尽请指正. 一.Json.Net有什么用?   Json.Net是一个读写Json效率比较高的.Net框架.Json.Net 使得在.Net环境下使用Json更加简单。
1087 0
jQuery EasyUI API 中文文档 - 消息框(Messager)
Messager 消息框 用 $.messager.defaults 重写了 defaults。 依赖 window linkbutton progressbar 用法 1.
764 0
+关注
杰克.陈
一个安静的程序猿~
9798
文章
2
问答
文章排行榜
最热
最新
相关电子书
更多
文娱运维技术
立即下载
《SaaS模式云原生数据仓库应用场景实践》
立即下载
《看见新力量:二》电子书
立即下载