钉钉旧版服务端SDK支持异步方法的升级改造

2023-09-13 07:54:50

最近项目中需要对接钉钉,有些钉钉 API 的访问需要使用旧版服务端 SDK 才能搞定,但是这个 SDK 使用的还是 .NET Framework 2.0 框架,不能跨平台部署,也不支持 async\await 的异步操作方法,Nuget 上也有其它用户改造的 .NET Core 版本,但是都不支持异步方法,于是就想自己改造一下,经过若干小时的改造,最终发现完全可行,这篇文章就把改造的结果分享给大家。

主要包括两项改造:调整框架为 .netstandard 2.0;支持异步的Get/Post方法。

代码已经上传到了公共仓库,需要的请自取。

GitHub - bosima/TopSdk: 钉钉旧版服务端SDK改造版:项目框架调整为 .netstandard 2.0;增加异步请求接口。

TopSdk: 钉钉旧版服务端SDK改造版:项目框架调整为 .netstandard 2.0;增加异步请求接口。

安装方法

两种方法:

  • 直接下载源代码,然后编译安装。
  • 通过 Nuget 公共仓库安装:FireflySoft.TopSdk

使用方法

所有业务类的定义都没有改变,而且原来的同步方法可以继续使用。

这里重点看下异步方法的使用,只需要替换几个名字:

  • IDingTalkClient 替换为 IAsyncDingTalkClient。
  • DefaultDingTalkClient 替换为 AsyncDefaultDingTalkClient 。
  • Execute 替换为 ExecuteAsync。

下面是代码示例:

IAsyncDingTalkClient client = new AsyncDefaultDingTalkClient("https://oapi.dingtalk.com/user/get");
OapiUserGetRequest req = new OapiUserGetRequest();
req.Userid = "userid1";
req.SetHttpMethod("GET");
OapiUserGetResponse rsp = await client.ExecuteAsync(req, accessToken)

相关改造

给大家分享下具体怎么做的。

修改框架

修改框架为 .netstandard 2.0 ,这个网上有很多介绍,基本上没有什么难度。

我用了一个 Visual Studio  的插件升级的,有兴趣的可以看看:.NET Upgrade Assistant – Visual Studio Marketplace

支持异步

这个部分比较麻烦一些,因为要支持 async/await 的编写方式。

SDK原来的网络请求都是通过 HttpWebRequest 实现的,这个类十分基础,虽然也支持异步,但还是比较老旧的异步回调方式。所以我使用了 HttpClient这个新的 HTTP 操作类来替换它。

原来的 HTTP 操作都封装在 Util/WebUtils.cs 这个文件中,我模仿这个类创建了一个新的  Util/AsyncWebUtils.cs 。相关的属性和公开方法都保留了下来,只是方法改成了异步方法,方法名后边都加上了 Async。

这里有一点很重要的问题:HttpClient 存在DNS缓存的问题,也就是使用它访问某个域名的时候,它会把这个域名对应的IP缓存下来,默认情况下永远不更新,如果网站更换了DNS解析,原来的IP可能就访问不了了。

为了解决这个问题,微软官方在 HttpHandler 中新增了一个属性设置 PooledConnectionLifetime,它的本来意思是设置连接池中连接的生命周期,然后通过它也可以解决DNS缓存的问题,因为重新连接就要重新解析域名,就可以缓解上面这个问题。

同时为了兼容原来的一些网络超时和代理的设置,我这里选择的 HttpHandler 是 SocketsHttpHandler。但是但是又有新的问题了,.netstandard 2.0 不支持 SocketsHttpHandler,这个要到 .NET Core 2.1才支持。不过也有解决办法,有开发者将这个类单独提了出来:GitHub - TalAloni/StandardSocketsHttpHandler: StandardSocketsHttpHandler is a backport of SocketsHttpHandler to .NET Standard 2.0

到这里 HTTP 的基本异步操作问题就都解决了,看看  HttpClient 的初始化方法,这里用了一个双检索来实现单例,因为 HttpClient 内部会创建一个连接池,所以我们没必要每次new一个,每次new还会导致底层网络端口释放不及时的问题。

private HttpClient GetHttpClient()
{
	if (_httpClient == null)
	{
		lock (_lock)
		{
			if (_httpClient == null)
			{
				// https://github.com/TalAloni/StandardSocketsHttpHandler
				var handler = new StandardSocketsHttpHandler
				{
					PooledConnectionLifetime = TimeSpan.FromMinutes(3), // Recreate every 3 minutes
					ConnectTimeout = TimeSpan.FromMilliseconds(_timeout),
					ResponseDrainTimeout = TimeSpan.FromMilliseconds(_readWriteTimeout),
					UseProxy = _disableWebProxy,
				};

				if (this._ignoreSSLCheck)
				{
					handler.SslOptions.RemoteCertificateValidationCallback = new RemoteCertificateValidationCallback(TrustAllValidationCallback);
				}

				_httpClient = new HttpClient(handler);
			}
		}
	}

	return _httpClient;
}

其它就是异步Get、Post的实现,Post的实现又需要实现Json请求和上传文件的处理,最后是返回值的解码处理,这些比较繁琐,但是没什么大问题,大家有兴趣的看代码就可以了。

注意

1、源代码是从钉钉开放平台页面公开下载的(点此前往),其中没有 License 文件,但是从公开下载的行为看,应该是允许修改的,且本人也没有售卖此代码。如有侵权,请联系删除此仓库。

2、虽然本人使用正常,但未做全面测试,正式使用前请谨慎测试评估,因使用此仓库代码造成的损失,本人概不负责。

更多推荐

开始在 Windows 上将 Python 用于脚本和自动化

🎬岸边的风:个人主页🔥个人专栏:《VUE》《javaScript》⛺️生活的理想,就是为了理想的生活!目录设置开发环境安装Python安装VisualStudioCode安装MicrosoftPython扩展在VSCode中打开集成PowerShell终端安装Git(可选)用于显示文件系统目录结构的示例脚本用于修改

rust数组

一、定义数组(一)一维数组1.指定所有元素语法格式letvariable_name:[dataType;size]=[value1,value2,value3];例如letarr:[i32;4]=[10,20,30,40];2.指定初始值和长度所有元素具有相同的值语法格式letvariable_name:[dataTy

二叉树的遍历

Ⅰ、二叉树基本介绍1.1、二叉树的定义二叉树(binarytree)是指树中节点的度不大于2的有序树,它是一种最简单且最重要的树。二叉树的递归定义为:二叉树是一棵空树,或者是一棵由一个根节点和两棵互不相交的,分别称作根的左子树和右子树组成的非空树;左子树和右子树又同样都是二叉树。1.2、特殊的二叉树1、满二叉树:如果一

【算法训练-二叉树 三】【最大深度与直径】求二叉树的最大深度、求二叉树的直径

废话不多说,喊一句号子鼓励自己:程序员永不失业,程序员走向架构!本篇Blog的主题是【求二叉树的直径】,使用【二叉树】这个基本的数据结构来实现,这个高频题的站点是:CodeTop,筛选条件为:目标公司+最近一年+出现频率排序,由高到低的去牛客TOP101去找,只有两个地方都出现过才做这道题(CodeTop本身汇聚了Le

JavaWeb 学习笔记 5:JSP

JavaWeb学习笔记5:JSP简单的说,JSP就是Java+Html,JSP的出现是为了让JavaWeb应用生成动态页面更容易。1.快速开始1.1.依赖添加JSP依赖:<dependency><groupId>javax.servlet.jsp</groupId><artifactId>jsp-api</artifa

元素全排列问题的新思路(DFS,递归,计数器)

目录前言1,普通DFS实现1~n的元素全排列2,计数器+DFS实现重复元素全排列总结前言我们之前看到的全排列问题的解法都是通过交换法达到的,去重的效果也是通过判断当前元素前是否有相同元素来实现,今天我们带来一个全新的思路,使我们直接进行深度优先搜索+一个计数器就可以实现,不用交换。1,普通DFS实现1~n的元素全排列我

数据结构 | 数据结构的“基本概念”和“术语”

数据结构的“基本概念”和“术语”:1.数据(Data)2.数据元素(DataElement)3.数据项(DateItem)4.数据、数据元素、数据项三者之间的关系5.数据对象(DataObject)6.数据结构(DataStructure)6.1数据结构(DataStructure)的种类/两个层次:逻辑结构逻辑结构的

数据结构入门 — 二叉树的概念、性质及结构

本文属于数据结构专栏文章,适合数据结构入门者学习,涵盖数据结构基础的知识和内容体系,文章在介绍数据结构时会配合上动图演示,方便初学者在学习数据结构时理解和学习,了解数据结构系列专栏点击下方链接。博客主页:DuckBro博客主页系列专栏:数据结构专栏关注博主,后期持续更新系列文章如果有错误感谢请大家批评指出,及时修改感谢

Mysql高级——索引优化和查询优化(1)

索引优化1.数据准备学员表插50万条,班级表插1万条。建表CREATETABLE`class`(`id`INT(11)NOTNULLAUTO_INCREMENT,`className`VARCHAR(30)DEFAULTNULL,`address`VARCHAR(40)DEFAULTNULL,`monitor`INTN

数据科学中的数据库简介

推荐:使用NSDT场景编辑器快速搭建3D应用场景用于高效视频、AI和图形的通用加速器数据科学中的数据库简介数据科学涉及从大量数据中提取价值和见解,以推动业务决策。它还涉及使用历史数据构建预测模型。数据库有助于对如此大量的数据进行有效的存储、管理、检索和分析。因此,作为一名数据科学家,您应该了解数据库的基础知识。因为它们

安卓页面绘制流程(3)Window注册

前言:本文属于安卓页面绘制流程的第3篇,主要介绍应用是如何把APP侧的Window向system进行注册的。主要分为2大块:第一块,APP侧在resume周期时向系统侧申请绑定。第二块,系统侧收到请求后处理绑定的流程。一.APP侧Window注册在上一篇文章中,我们已经讲过,在Activity的create周期内,其所

热文推荐