欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

ASP.NET Core扩展库之Http通用扩展库的使用详解

程序员文章站 2022-04-22 23:21:32
本文将介绍xfrogcn.aspnetcore.extensions扩展库对于http相关的其他功能扩展,这些功能旨在处理一些常见需求, 包括请求缓冲、请求头传递、请求头日志范围、针对httpclie...

    本文将介绍xfrogcn.aspnetcore.extensions扩展库对于http相关的其他功能扩展,这些功能旨在处理一些常见需求, 包括请求缓冲、请求头传递、请求头日志范围、针对httpclient与httprequestmessage、httpresponsemessage的扩展方法。

一、开启服务端请求缓冲

    asp.net core 中请求体是不能多次读取的,由于在mvc中,框架已经读取过请求体,如果你在控制器中再次读取,将会引发异常,如下示例:

    当通过post请求/test接口时,语句 request.body.position 将触发异常:

    当然,实际中可能不会像示例这样处理请求,但在业务需求中,的确可能会有多次读取请求体的情况出现。

    通过开启请求缓冲可以解决多次读取请求体的问题,xfrogcn.aspnetcore.extensions扩展库提供了enablebufferingattribute特性用于开启请求缓冲,你可以将此特性用于控制器或者action方法。

    以上示例,只需在save方法上添加enablebuffering特性:

二、请求头传递

    微服务架构下,通常我们使用请求头来实现请求的链路跟踪以及日志与请求的关联,例如,通过x-request-id,在日志系统中可以直接查看某一个请求在所有服务中的相关日志。

    扩展库通过拦截httpclient请求管道,可实现对指定请求头的自动传递。默认配置下,扩展库会自动传递以"x-"开始的请求头,如果你需要传递其他的请求头,可通过配置中的trackingheaders来添加。

三、请求头日志的记录

    .net core日志框架中,实现了日志范围的概念,通过日志范围,可以让日志系统记录当前上下文的信息,例如,asp.net core mvc中,日志范围包含actioncontext相关信息,故可以在一个请求的所有日志中都可自动记录action的相关信息。

    扩展库可以将配置的请求头加入请求的日志范围,例如,默认配置下,扩展库会将x-request-id加入到请求的日志范围,所以在单一请求中的所有日志,都可自动携带x-request-id信息,以此实现跨服务的日志关联。要包含其他的请求头,可以通过配置中的httpheaders来设置:

    注意: 默认的控制台日志、文件日志不会保存日志范围的相关信息,你可以使用json格式的控制台日志或文件日志,在此格式下将保存日志范围中的数据。

四、http消息上的扩展方法

    扩展库在httprequestmessage上提供了getobjectasync、writeobjectasync扩展方法,以便于对请求消息的读写。 在httpresponsemessage上提供了getobjectasync、writeobjectasync扩展方法,以便于对应答消息的读写。这些方法都采用json格式。

示例:

五、httpclient上的扩展方法

    为了更方便快捷地使用httpclient,扩展库在httpclient上增加了多个扩展方法:

  • postasync<tresponse>: 发送对象到服务端,并获取指定类型的应答
  • postasync: 发送对象到服务端,并获取应答字符串
  • getasync<tresponse>: 发送get请求,并获取tresponse类型的应答
  • getasync: 发送get请求,并获取string类型的应答
  • submitformasync<tresponse>: 向服务器提交表单数据,并获取tresponse类型的应答
  • submitformasync: 向服务器提交表单数据,并获取string类型的应答
  • uploadfileasync<tresponse>: 上次本地文件
  • uploadstreamasync<tresponse>: 上传流数据到服务器

    有关这些扩展方法的详细说明,可参考文档 github gitee

    xfrogcn.aspnetcore.extensions地址:github gitee

以上就是asp.net core扩展库之http通用扩展库的使用详解的详细内容,更多关于asp.net core扩展库之http通用扩展库的资料请关注其它相关文章!