誰說.net core不好動態訪問webservice？看這篇文章，C#快速實現動態訪問webservice，相容.net framework和.net core+

WeskyNet發表於2024-06-10
WebC#Framework
前言：訪問webservice，大多數人都是用服務引用的方式，但是這種方式比較麻煩，例如遇到服務更新了，你還需要手動更新你的服務引用，再重新發布，很麻煩。或者已有的一些例子，至少我看到的很多案例，動態訪問也只能止步於使用.net framework環境，沒看到有啥.net core上面動態訪問的案例。於是我就來拋磚引玉一下，自己寫一個支援.net framework也可以支援.netcore或以上環境使用的動態訪問webservice服務介面的方法，供大家使用或參考。
先建立一個webservice服務，用來測試使用。提供三個服務介面，一個無引數、一個字串引數、一個含有多個實體類引數(實體類引數也含有巢狀和集合)以及返回帶有巢狀和集合的返回資料，用來做測試使用，基本上可以涵蓋幾乎所有的webservice服務的情況了。
0
有關測試實體類
0
啟動webservice服務備用
0
請求端程式，支援.netframework 4.6.1+、.net core+和.net 5+所有版本，都可以透過nuget來引用 Wesky.Net.OpenTools 包。需要引用最新的版本，以保證功能完善。我此處使用.net 8的控制檯來引用，大佬們可以根據自己程式情況進行引用，framework4.6以下版本不適用。
0
為了方便使用，我本地也直接編寫幾個實體類，用來傳參和做返回值接收使用：
0
先例項化一個WebserviceHelper物件，如果有用IOC容器的大佬，比如說使用asp.net core程式等，可以對該介面和類進行依賴注入的註冊。如果沒用IOC容器的大佬，可以直接這樣new一個使用。此處我用new一個物件的使用方式來使用。並且獲取到asmx的url地址，地址此處需要新增?wsdl字尾。
0
申明要訪問的服務的名稱，例如HelloWorld，然後直接呼叫。由於沒有引數，所以引數直接設為null
0
執行程式進行呼叫，可以看到獲取到了返回值的xml文件。
0
直接呼叫的時候，返回值是一個 OpenToolResult型別，型別定義如下：
0
由於咱們的返回值就一個基礎型別string，所以需要呼叫解析基礎型別值的方法，得到最終的返回訊息為 Hello World。
0
基礎型別值解析方法定義如下：
0
傳入引數為：獲取到的返回值、節點名稱(一般是方法名稱+“Result”)、名稱空間，名稱空間在呼叫的時候，會被儲存到型別OpenWebserviceInfo的屬性OpenWebservice集合(是一個OpenWebserviceDocCache型別的集合)裡面去，透過url地址和介面方法名字可以匹配到對應的名稱空間。
OpenWebserviceDocCache型別定義如下：
0
接著試一下傳入一個基礎型別引數的情況。訪問Hola方法，傳入Wesky字串，成功獲取到返回值 Wesky World。
0
接下來試一下傳入多個實體類引數，並且按照上面webservice的內容，會返回一個其他一個實體類訊息。
0
回看一下TestService服務介面的實現，說明動態訪問是成功的。
0
訪問webservice方法定義說明。引數可以傳0個或多個引數，會用來和解析度wsdl地址的同名方法服務引數個數做匹配，如果不匹配，則會提示錯誤資訊。返回值Result.IsSuccess如果是true，代表傳送請求成功；如果解析錯誤或者傳送請求失敗等，則提示false，並且Message屬性會有具體錯誤資訊描述。
0
返回值為實體類的解析方法定義說明。以上請求TestSevice服務介面時候，返回值是實體類，如果需要匹配本地的實體類，需要訪問 ExtractCustomerValueFromXml方法進行解析處理。例如上面傳入的是ResultInfo型別作為返回值接收類。
0
一些核心程式碼：
  /// <summary>
  /// 呼叫Web服務
  /// Calls a web service.
  /// </summary>
  /// <param name="url">服務URL / Service URL</param>
  /// <param name="apiName">API名稱 / API name</param>
  /// <param name="expireSecond">過期時間（秒）/ Expiration time in seconds</param>
  /// <param name="parameters">呼叫引數 / Invocation parameters</param>
  /// <returns>呼叫結果 / Invocation result</returns>
  public OpenToolResult<string> CallWebservice(string url, string apiName,long expireSecond = 86400,params object[] parameters)
  {
      OpenToolResult<string> result = new HttpExtensions.OpenToolResult<string>();

      CheckExpireTime(url, apiName, expireSecond);

      var wsInfo = OpenWebserviceInfo.OpenWebservice.FirstOrDefault(x => x.WebserviceUrl == url && x.OperationName == apiName);

      if (wsInfo == null)
      {
          result.IsSuccess = false;
          result.Message = "本地無法載入遠端webservice服務。Cannot load the remote webservice locally.";
          return result;
      }

      if ((parameters == null && wsInfo.ParameterNames.Count > 0) || (parameters!=null && parameters.Length != wsInfo.ParameterNames.Count))
      {
          result.IsSuccess = false;
          result.Message = $"遠端服務介面引數個數和你傳入的引數個數不匹配。遠端服務引數個數:{wsInfo.ParameterNames.Count}, 本地傳入引數個數： {parameters?.Length ?? 0}。Parameter count mismatch: remote service has {wsInfo.ParameterNames.Count}, provided {parameters?.Length ?? 0}.";
          return result;
      }


      Dictionary<string, string> dicParams = new Dictionary<string, string>();
      if (parameters != null)
      {
          for (int i = 0; i < wsInfo.ParameterNames.Count; i++)
          {
              dicParams.Add(wsInfo.ParameterNames[i], XmlConvertor.SerializeObjectToXml(parameters[i]));
          }
      }
      var response = InvokeService(url, apiName, dicParams,wsInfo.Namespace);

      result.Result = response;
      result.IsSuccess = true;
      result.Message = "success";

      return result;
  }

如果以上內容對你有幫助，歡迎點贊、轉發、在看和關注我的個人公眾號：【Dotnet Dancer】
如果需要以上演示程式碼和webservice測試原始碼，可以在公眾號【Dotnet Dancer】後臺回覆“動態介面”進行下載。
OpenTools系列文章快捷連結【新版本完全相容舊版本，不需要更新任何程式碼均可使用】：
1.0.11版本
如何一行C#程式碼實現解析型別的Summary註釋(可用於資料字典快速生成)
https://mp.weixin.qq.com/s/CWqubRRMoYVQIQJSyjIUXg
1.0.10版本：
C#/.NET一行程式碼把實體類型別轉換為Json資料字串
https://mp.weixin.qq.com/s/nVcURD0lf5-AQOVzwHqcxw
1.0.8版本：
上位機和工控必備！用.NET快速搞定Modbus通訊的方法
https://mp.weixin.qq.com/s/Yq6kuXzFglHfNUqrHcQO9w
1.0.7版本：
大揭秘！.Net如何在5分鐘內快速實現物聯網掃碼器通用掃碼功能？
https://mp.weixin.qq.com/s/-5VuLAS6HlElgDQXRY9-BQ
1.0.6版本：
.NET實現獲取NTP伺服器時間並同步(附帶Windows系統啟用NTP服務功能)
https://mp.weixin.qq.com/s/vMW0vYC-D9z0Dp6HFSBqyg
1.0.5版本：
C#使用P/Invoke來實現登錄檔的增刪改查功能
https://mp.weixin.qq.com/s/LpsjBhDDzkwyLU_tIpF-lg
1.0.3版本：
C#實現圖片轉Base64字串，以及base64字串在Markdown檔案內復原的演示
https://mp.weixin.qq.com/s/n9VtTCIiVUbHJk7OfoCcvA
1.0.2版本：
​C#實現Ping遠端主機功能(支援IP和域名)
https://mp.weixin.qq.com/s/d-2HcIM1KaLo-FrrTLkwEw
1.0.1版本：
開始開源專案OpenTools的創作(第一個功能：AES加密解密)
https://mp.weixin.qq.com/s/78TA-mst459AuvAHwQViqQ
【備註】包版本完全開源，並且沒有任何第三方依賴。使用.net framework 4.6+、任意其他跨平臺.net版本環境，均可直接引用。

相關文章