前言

本篇文章的内容是WebApiClient底层说明,也是WebApiClient系列接近尾声的一篇文章,如果你没有阅读过之前的的相关文章,可能会觉得本文章的内容断层,WebApiClient系列文章索引:

库简介

WebApiClient是开源在github上的一个httpClient客户端库,内部基于HttpClient开发,是一个只需要定义c#接口(interface),并打上相关特性,即可异步调用http-api的框架 ,支持.net framework4.5+、netcoreapp2.0和netstandard2.0。

WebApiClient是我2017年看到java的retrofit库之后,决心给.net打造的一款面向切面的httpclient客户端库,在开发过程中陆续发现.net下也有一些HttpClient包装库,WebApiClient库虽然是后起,却有其它库所没有很多优秀特征:

  • 原生的支持面向切面编程;
  • 内置丰富的特性,支持自定义特性;
  • 灵活和Filter、GlobalFilter和IParameterable;
  • 功能强大的序列化工具;
  • 与外部HttpClientHandler无缝衔接;
  • 独一无二的请求异常条件重试功能和异常处理链式语法功能

1. HttpRequestMessage简说

System.Net.Http.HttpRequestMessage表示一个请求消息,一般而言它包含一个完整的请求数据,主要由请求头和请求体组成,对于Post、Delete、Put等请求,其Content属性包含提交的数据体内容。

WebApiClient的ApiActionContex对象有个RequestMessage对象,是派生于HttpRequestMessage,同时实现了多个Addxxx方法用于给其属性Content对象添加数据内容。

2. HttpClientHandler简说

System.Net.Http.HttpClientHandler是一个与tcp层相关的对象,负责与远程服务器进行tcp连接,将HttpRequestMessage转换为http请求包发送给服务端,并等待服务端的响应。(以上这段话是我瞎说,仅供讨论)一般的网络相关配置的证书、代理和认证等在都在这里可以配置。

3. HttpClient简说

System.Net.Http.HttpClient必须与HttpClientHandler关联才能使用,一个HttpRequestMessage经过HttpClient之后,HttpClient的一些默认配置会影响到它,比如默认请求头等。HttpClient是使用关联的HttpClientHandler将HttpRequestMessage发送出去,也就是说,完全可以跳过HttpClient而使用HttpClientHandler来发送请求,方法是写一个类,继承于HttpClientHandler并公开一个方法,调用基类的SendAsync方法就可以发送请求。

4. WebApiClient库的HttpClient配置

WebApiClient库是对HttpClient的封装,所有的配置项在HttpApiConfig对象, 实例化HttpApiConfig对象时有个构造器可以传入IHttpClient的实例,而IHttpClient是对System.Net.Http.HttpClient的一个包装接口定义,WebApiClient.Defaults.HttpClient是对IHttpClient接口的一个实现,才下代码是WebApiCient与System.Net.Http.HttpClient的一个衔接:

IHttpClient client = new WebApiClient.Defaults.HttpClient();
var config = new WebApiClient.HttpApiConfig(client);

5. IHttpClient接口

5.1 IHttpClient的接口定义

/// <summary>
/// 定义HttpClient的接口
/// </summary>
public interface IHttpClient : IDisposable
{
/// <summary>
/// 获取关联的Http处理对象
/// </summary>
HttpClientHandler Handler { get; } /// <summary>
/// 获取默认的请求头管理对象
/// </summary>
HttpRequestHeaders DefaultRequestHeaders { get; } /// <summary>
/// 异步发送请求
/// </summary>
/// <param name="request">请求消息</param>
/// <returns></returns>
Task<HttpResponseMessage> SendAsync(HttpApiRequestMessage request); ...
}

5.2 IHttpClient的接口意图

IHttpClient接口意图将System.Net.Http.HttpClient实例和System.Net.Http.HttpClientHandler实例进行组合封装,隐藏底层的一些细节,同时描述了HttpClient和HttpClientHandler不可分割的关系,其默认实现对象WebApiClient.Defaults.HttpClient将System.Net.Http.HttpClient难用的几个功能也封装了一次:比如设置Cookie和设置代理等。

5.3 更换WebApiClient.Defaults.HttpClient关联的HttpClientHandler

一般而言,HttpClient没有多少扩展的价值,但HttpClientHandler就有很多扩展空间,其中System.Net.Http.WebRequestHandler也派生于HttpClientHandler,多了很一些配置的属性,很多时候,需要替换WebApiClient.Defaults.HttpClient的HttpClientHandler就可以,而不用从头实现IHttpClient接口,以下方式可以替换HttpClientHandler:

class MyHttpClient : WebApiClient.Defaults.HttpClient
{
protected override HttpClientHandler CreateHttpClientHandler()
{
// or return your handler
return new WebRequestHandler();
}
} var config = new HttpApiConfig(new MyHttpClient());
var myWebApi = HttpApiClient.Create(config);

如果是外部的HttpClientHandler实例,可以使用如下方式关联:

var client = new WebApiClient.Defaults.HttpClient(handler);
var config = new HttpApiConfig(client);
var myWebApi = HttpApiClient.Create(config);

6. 扩展JsonFormatter

WebApiClient.Defaults.JsonFormatter使用了json.net,每次序列化或反序列化时都会创建JsonSerializerSettings,可以派生WebApiClient.Defaults.JsonFormatter返回自定义的JsonSerializerSettings:

class MyJsonFormatter : WebApiClient.Defaults.JsonFormatter
{
protected override JsonSerializerSettings CreateSerializerSettings()
{
return new JsonSerializerSettings
{
// your setting
};
}
} var config = new HttpApiConfig
{
JsonFormatter = new MyJsonFormatter()
};
var myWebApi = HttpApiClient.Create(config);

7. 扩展WebApiClient.Defaults.KeyValueFormatter

KeyValueFormatter基于Middleware思想,内部由多个转换器相连组成,随着转换器的增加,支持的类型也更多,KeyValueFormatter默认支持序列化以下类型:

  • 1、常用简单类型及其空类型(byte、int、short、long、doublue、flout、string、decimal、DateTime、Guid、enum、Version和Uri)
  • 2、支持IEnumerable递归拆解,默认最多16层
  • 3、KeyValuePair<,>的任意泛型
  • 4、多属性模型的第一层属性拆解

如果你需要支持更多的类型,需要派生KeyValueFormatter增加功能:

class MyKeValueFormatter : WebApiClient.Defaults.KeyValueFormatter
{
protected override IEnumerable<ConverterBase> GetConverters()
{
// 在原有转换器之前插入DynamicObjectConverter
var addin = new[] { new DynamicObjectConverter() };
return addin.Concat(base.GetConverters());
}
} /// <summary>
/// 表示动态类型转换器
/// </summary>
class DynamicObjectConverter : ConverterBase
{
/// <summary>
/// 执行转换
/// </summary>
/// <param name="context">转换上下文</param>
/// <returns></returns>
public override IEnumerable<KeyValuePair<string, string>> Invoke(ConvertContext context)
{
var dynamicObject = context.Data as DynamicObject;
if (dynamicObject != null)
{
return from name in dynamicObject.GetDynamicMemberNames()
let value = this.GetValue(dynamicObject, name)
let ctx = new ConvertContext(name, value, context.Depths, context.Options)
select ctx.ToKeyValuePair();
} return this.Next.Invoke(context);
} /// <summary>
/// 获取动态类型的值
/// </summary>
/// <param name="dynamicObject">实例</param>
/// <param name="name">名称</param>
/// <returns></returns>
private object GetValue(DynamicObject dynamicObject, string name)
{
object value;
var binder = new MemberBinder(name);
dynamicObject.TryGetMember(binder, out value);
return value;
} /// <summary>
/// 表示成员值的获取绑定
/// </summary>
private class MemberBinder : GetMemberBinder
{
/// <summary>
/// 键的信息获取绑定
/// </summary>
/// <param name="key">键名</param>
public MemberBinder(string key)
: base(key, false)
{
} /// <summary>
/// 在派生类中重写时,如果无法绑定目标动态对象,则执行动态获取成员操作的绑定
/// </summary>
/// <param name="target"></param>
/// <param name="errorSuggestion"></param>
/// <returns></returns>
public override DynamicMetaObject FallbackGetMember(DynamicMetaObject target, DynamicMetaObject errorSuggestion)
{
throw new NotImplementedException();
}
}
}

.net的retrofit--WebApiClient底层篇的更多相关文章

  1. 自己动手写插件底层篇—基于jquery移动插件实现

    序言 本章作为自己动手写插件的第一篇文章,会尽可能的详细描述一些实现的方式和预备知识的讲解,随着知识点积累的一点点深入,可能到了后期讲解也会有所跳跃.所以,希望知识点不是很扎实的读者或者是初学者,不要 ...

  2. 使用WebApiClient请求和管理Restful Api

    前言 本篇文章的内容是WebApiClient应用说明篇,如果你没有了解过WebApiClient,可以先阅读以下相关文章: WebApi client 的面向切面编程 我来给.Net设计一款Http ...

  3. [旧][Android] Retrofit 初步使用

    备注 原发表于2016.04.13,资料已过时,仅作备份,谨慎参考 Retrofit 是什么? Retrofit is a type-safe HTTP client for Android and ...

  4. Retrofit源码研究

    2016-05-06 15:35:27 最近抽空研究了一下Retrofit源码,包括API使用.源码结构.使用到的设计模式.SDK的架构设计.作者设计/实现思路等,会形成一系列文章. 以前Retrof ...

  5. 【Android - 框架】之OkHttp的使用

    OkHttp是一个非常优秀的网络访问框架,当下非常火的Retrofit的底层就是使用OkHttp进行封装的.接下来介绍以下OkHttp的简单使用. 1.导入依赖 在Android Studio中,在M ...

  6. Java 工程师成神之路 | 2019正式版

    本文为转载,原文见以下链接:https://mp.weixin.qq.com/s/4AMzq87V6eW3YPgE0mCdSw 1 基础篇 01 面向对象 → 什么是面向对象 面向对象.面向过程 面向 ...

  7. Android网络编程(一)HTTP协议原理

    相关文章 Android网络编程(一)HTTP协议原理 Android网络编程(二)HttpClient与HttpURLConnection Android网络编程(三)Volley使用方法全解析 A ...

  8. Java进阶步骤

    一.基础篇 面向对象 什么是面向对象 面向对象.面向过程 面向对象的三大基本特征和五大基本原则 平台无关性 Java如何实现的平台无关 JVM还支持哪些语言(Kotlin.Groovy.JRuby.J ...

  9. 1. Retrofit2 -- Getting Started and Create an Android Client

    1. Retrofit2 -- Getting Started and Create an Android Client Retrofit tutorial 什么是 Retrofit 如何申明请求 准 ...

随机推荐

  1. Hibernate--使用xml配置映射关系

    写在前面: 配置实体类与数据库的映射关系,有两种方式: 1.使用*.hbm.xml  2.使用@注解 二:xml的配置方式: eg:员工的xml配置文件: <?xml version=" ...

  2. Visual Studio Code 通过 Chrome插件Type Script断点调试Angular 2

    1. 下载Visual Studio Code (https://code.visualstudio.com/) 2. 安装插件Debugger for chrome 3. 确定tsconfig.js ...

  3. Pipeline in scala——给scala添加管道操作

     linux系统中管道这一功能相信大家肯定使用过,比如现在想找到用户目录下文件名包含db的所有文件,ls ~的结果,作为grep db的参数: ➜ ~ ls ~ | grep db kv.mv.db ...

  4. MST系列

    1.POJ2485 Highways 蛮水的 数组一开始开小了卡了一会儿 我可能是个傻逼 #include<iostream> #include<cstdio> #includ ...

  5. express整合webpack的打包文件dist

    对于我来说,第一次接触前后端整合问题的小白,刚开始是一脸懵逼,这个问题整整坑了我一个晚上加一个早上,现在写出来总结: 前端开发:vue-cli+webpack: 后台开发:nodejs框架expres ...

  6. centOS7 jdk安装

    1.查找需要卸载的OpenJDK: #  rpm -qa | grep java 2:依次卸载 rpm -e --nodeps javapackages-tools-3.4.1-6.el7_0.noa ...

  7. Linux第七节随笔-中 /date / ln /

    4.date link 作用:显示或设定系统的日期与时间 参数: -d<字符串> 显示字符串所指的日期与时间.字符串前后必须加上双引号. -s<字符串> 根据字符串来设置日期与 ...

  8. python 小脚本升级-- 钉钉群聊天机器人

    一则小脚本(工作中用) 在这篇文章中写的监控的脚本,发送监控的时候 是利用的邮箱,其实在实际,邮箱查收有着不方便性,于是乎升级, 我们工作中,经常用钉钉,那么如果要是能用到钉钉多好,这样我们的监控成功 ...

  9. 几个关于js数组方法reduce的经典片段

    以下是个人在工作中收藏总结的一些关于javascript数组方法reduce的相关代码片段,后续遇到其他使用这个函数的场景,将会陆续添加,这里作为备忘. javascript数组那么多方法,为什么我要 ...

  10. Linux文件的复制、删除和移动命令

    cp命令  功能:将给出的文件或目录拷贝到另一文件或目录中,就如同DOS下的copy命令一样,功能非常强大.  语法:cp [选项] 源文件或目录 目标文件或目录  说明:该命令把指定的源文件复制到目 ...