釘釘舊版服務端SDK支持非同步方法的升級改造

来源:https://www.cnblogs.com/bossma/archive/2023/09/13/17698430.html
-Advertisement-
Play Games

最近項目中需要對接釘釘,有些釘釘 API 的訪問需要使用舊版服務端 SDK 才能搞定,但是這個 SDK 使用的還是 .NET Framework 2.0 框架,不能跨平臺部署,也不支持 async\await 的非同步操作方法,Nuget 上也有其它用戶改造的 .NET Core 版本,但是都不支持異 ...


最近項目中需要對接釘釘,有些釘釘 API 的訪問需要使用舊版服務端 SDK 才能搞定,但是這個 SDK 使用的還是 .NET Framework 2.0 框架,不能跨平臺部署,也不支持 async\await 的非同步操作方法,Nuget 上也有其它用戶改造的 .NET Core 版本,但是都不支持非同步方法,於是就想自己改造一下,經過若幹小時的改造,最終發現完全可行,這篇文章就把改造的結果分享給大家。

主要包括兩項改造:調整框架為 .netstandard 2.0;支持非同步的Get/Post方法。

代碼已經上傳到了公共倉庫,需要的請自取。

https://github.com/bosima/TopSdk

https://gitee.com/bosima/TopSdk

安裝方法

兩種方法:

  • 直接下載源代碼,然後編譯安裝。
  • 通過 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才支持。不過也有解決辦法,有開發者將這個類單獨提了出來:https://github.com/TalAloni/StandardSocketsHttpHandler

到這裡 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、雖然本人使用正常,但未做全面測試,正式使用前請謹慎測試評估,因使用此倉庫代碼造成的損失,本人概不負責。

  • 本文作者: 螢火架構
  • 本文鏈接: https://www.cnblogs.com/bossma/p/17698430.html
  • 關於博主: 使用微信掃描左側二維碼關註我的訂閱號,每天獲取新知識
  • 版權聲明: 本博客所有文章除特別聲明外,均採用 BY-NC-SA 許可協議。轉載請註明出處!

  • 您的分享是我們最大的動力!

    -Advertisement-
    Play Games
    更多相關文章
    • 基於java學生考勤管理系統設計與實現,可適用於學生考勤系統,校園考勤,大學考勤管理,企業考勤系統,公司考勤系統,學校考勤系統。 ...
    • 隨著JDK19的發佈,虛擬線程也逐漸被大家瞭解和使用,然而,主流java框架是否支持虛擬線程這一特性呢?咱們應用開發者如何通過框架使用虛擬線程特性?經過精心準備,欣宸原創在第一時間為您帶來詳細的實戰系列,與您共同學習 ...
    • 大家好,又見面了。 在此前我的文章中,曾分2篇詳細探討了下JAVA中Stream流的相關操作,2篇文章收穫了累計 10w+閱讀、2k+點贊以及 5k+收藏的記錄。能夠得到眾多小伙伴的認可,是技術分享過程中最開心的事情。 吃透JAVA的Stream流操作,多年實踐總結 講透JAVA Stream的co ...
    • 作者:美得讓人心動 來源:https://blog.csdn.net/gu131007416553/article/details/120934738 面試官在面試候選人時,如果發現候選人的簡歷中寫了在項目中使用了 MQ 技術(如 Kafka、RabbitMQ、RocketMQ),基本都會拋出一個問 ...
    • 以下內容均來自Gitee的開源倉庫,具體的使用請移步Gitee:https://gitee.com/pojianbing/lazy-captcha 以下是我自己使用的具體方式 首先安裝NuGet包: Microsoft.Extensions.Caching.StackExchangeRedis La ...
    • 首先需要安裝的NuGet包有: Microsoft.AspNetCore.Authentication.JwtBearer Swashbuckle.AspNetCore Swashbuckle.AspNetCore.Filters jose-jwt 大致是這些代碼放到項目中如果有報錯信息再去具體解決 ...
    • 在我們創建界面元素的時候,不管在Vue3+ElementPlus的前端上,還是Winform桌面端上,都是會利用自定義用戶控制項來快速重用一些自定義的界面內容,對自定義用戶控制項的封裝處理,也是我們開發WPF應用需要熟悉的一環。本篇隨筆繼續深入介紹介紹基於CommunityToolkit.Mvvm 和H... ...
    • 開發中偶爾會用到使用c#代碼給控制項賦值,這裡需要通過F12找到控制項的賦值類型,然後在看控制項可以使用那種方式賦值,花點時間研究一下,基本都可以通過c#代碼給控制項賦值的。 頁面代碼: <StackPanel> <Path Data="M0 0 10 10" Stroke="Red" StrokeThic ...
    一周排行
      -Advertisement-
      Play Games
    • 示例項目結構 在 Visual Studio 中創建一個 WinForms 應用程式後,項目結構如下所示: MyWinFormsApp/ │ ├───Properties/ │ └───Settings.settings │ ├───bin/ │ ├───Debug/ │ └───Release/ ...
    • [STAThread] 特性用於需要與 COM 組件交互的應用程式,尤其是依賴單線程模型(如 Windows Forms 應用程式)的組件。在 STA 模式下,線程擁有自己的消息迴圈,這對於處理用戶界面和某些 COM 組件是必要的。 [STAThread] static void Main(stri ...
    • 在WinForm中使用全局異常捕獲處理 在WinForm應用程式中,全局異常捕獲是確保程式穩定性的關鍵。通過在Program類的Main方法中設置全局異常處理,可以有效地捕獲並處理未預見的異常,從而避免程式崩潰。 註冊全局異常事件 [STAThread] static void Main() { / ...
    • 前言 給大家推薦一款開源的 Winform 控制項庫,可以幫助我們開發更加美觀、漂亮的 WinForm 界面。 項目介紹 SunnyUI.NET 是一個基於 .NET Framework 4.0+、.NET 6、.NET 7 和 .NET 8 的 WinForm 開源控制項庫,同時也提供了工具類庫、擴展 ...
    • 說明 該文章是屬於OverallAuth2.0系列文章,每周更新一篇該系列文章(從0到1完成系統開發)。 該系統文章,我會儘量說的非常詳細,做到不管新手、老手都能看懂。 說明:OverallAuth2.0 是一個簡單、易懂、功能強大的許可權+可視化流程管理系統。 有興趣的朋友,請關註我吧(*^▽^*) ...
    • 一、下載安裝 1.下載git 必須先下載並安裝git,再TortoiseGit下載安裝 git安裝參考教程:https://blog.csdn.net/mukes/article/details/115693833 2.TortoiseGit下載與安裝 TortoiseGit,Git客戶端,32/6 ...
    • 前言 在項目開發過程中,理解數據結構和演算法如同掌握蓋房子的秘訣。演算法不僅能幫助我們編寫高效、優質的代碼,還能解決項目中遇到的各種難題。 給大家推薦一個支持C#的開源免費、新手友好的數據結構與演算法入門教程:Hello演算法。 項目介紹 《Hello Algo》是一本開源免費、新手友好的數據結構與演算法入門 ...
    • 1.生成單個Proto.bat內容 @rem Copyright 2016, Google Inc. @rem All rights reserved. @rem @rem Redistribution and use in source and binary forms, with or with ...
    • 一:背景 1. 講故事 前段時間有位朋友找到我,說他的窗體程式在客戶這邊出現了卡死,讓我幫忙看下怎麼回事?dump也生成了,既然有dump了那就上 windbg 分析吧。 二:WinDbg 分析 1. 為什麼會卡死 窗體程式的卡死,入口門檻很低,後續往下分析就不一定了,不管怎麼說先用 !clrsta ...
    • 前言 人工智慧時代,人臉識別技術已成為安全驗證、身份識別和用戶交互的關鍵工具。 給大家推薦一款.NET 開源提供了強大的人臉識別 API,工具不僅易於集成,還具備高效處理能力。 本文將介紹一款如何利用這些API,為我們的項目添加智能識別的亮點。 項目介紹 GitHub 上擁有 1.2k 星標的 C# ...