在Winform混合式框架中整合外部API介面的調用

来源:https://www.cnblogs.com/wuhuacong/archive/2018/04/02/8691008.html
-Advertisement-
Play Games

在我們常規的業務處理中，一般內部處理的介面多數都是以資料庫相關的，基於混合式開發的Winform開發框架，雖然在客戶端調用的時候，一般選擇也是基於Web API的調用，不過後端我們可能不僅僅是針對我們業務資料庫的處理，也可以能是調用其他外部介面，如物流、供應商介面等介面，本隨筆就是主要介紹基於混合式... ...


在我們常規的業務處理中，一般內部處理的介面多數都是以資料庫相關的，基於混合式開發的Winform開發框架，雖然在客戶端調用的時候，一般選擇也是基於Web API的調用，不過後端我們可能不僅僅是針對我們業務資料庫的處理，也可以能是調用其他外部介面，如物流、供應商介面等介面，本隨筆就是主要介紹基於混合式開發框架如何整合外部API介面的調用。

1、混合式框架的結構介紹

 我們知道，混合式的框架是可以在客戶端訪問Web API服務、WCF服務或者直接連接資料庫幾種方式的綜合，而尤以Web API為最廣泛的應用，它的整個框架的結構如下所示。

在客戶端中，通過統一的工廠類CallerFactory<T>對相應的介面進行訪問，這裡主要就是伺服器端Web API服務介面的處理，以及客戶端對Web API介面的封裝，兩部分通過一些基類進行簡化處理，可以極大提高開發效率。

對於外部第三方的Web API介面，我們也可以在自己的Web API介面中進行包裝，使得客戶端通過相應的介面進行交互即可，不需要理會內部還是外部的介面，從而實現透明的介面調用。

 2、RFID外部介面的整合處理

 在一個客戶的應用案例中，需要整合服務商RFID介面實現相應的數據交互，本篇隨筆也是基於這個案例進行整個過程的分析和操作，使得我們瞭解在混合框架中如何整合第三方Web API介面為我們內部框架所用。

一般來說，Web API介面，需要明確API的URL、數據提交方式（POST/GET）、提交參數、返回集合，以及一些特殊的數據等，而一般介面的操作，也是需要一個訪問令牌的，這些都是Web API介面調用的關鍵。

基本上我們有了上面Web API的1/2/3步驟的信息就可以進行介面編程了，這些是Web API開發非常重要的信息。

我們需要特別主要到，步驟1中的信息

這裡面的token是額外的介面信息，是需要設置Http Request請求的頭部信息裡面的，是用戶身份的重要信息，所以我們一般需要先通過指定的授權介面獲取這個token信息。

在這個外部的介面集合裡面，我們找到統一登錄驗證的介面定義如下所示。

 通過上面的分析，我們首先需要需要處理好登錄驗證介面，然後通過介面傳遞令牌token給其他介面進行數據處理的。

結合我們的混合框架結構，這裡我以測試項目TestProject項目為例進行介紹，我們調整WHC.TestProject.Caller項目的對應類，如下所示。

其中Facade層介面類IRFIDService.cs代碼如下所示。

    /// <summary>
    /// RFID服務外部介面
    /// </summary>
    [ServiceContract]
    public interface IRFIDService 
    {

        /// <summary>
        /// 終端用戶統一登錄驗證
        /// </summary>
        [OperationContract]
        CheckinResult CheckIn(string username, string password, string device_uuid, string device_type, string last_app_version, string app_id);

        /// <summary>
        /// 獲取標簽發貨通知單批量
        /// </summary>
        [OperationContract]
        TagOrderAsnResult TagOrderAsn(int brand_id, string factcode, string start_time, string end_time, PagerInfo pagerInfo, string token);

        /// <summary>
        /// 標簽訂單出庫物流信息回寫
        /// </summary>
        [OperationContract]
        CommonResult TagOutPost(string docno_asn, string factcode, string dest_factcode, List<FreightInfo> freight, string token);
    }

這裡面的介面定義，我們是根據輸入參數、輸出參數進行定義的，另外token是額外增加的令牌參數，用於請求頭部寫入信息的。

這個介面的定義其實和我們常規的Web API介面定義沒有太多的不同，如下是一個內部客戶信息介面定義。

    /// <summary>
    /// 客戶信息的服務介面
    /// </summary>
    [ServiceContract]
    public interface ICustomerService : IBaseService<CustomerInfo>
    {               
        /// <summary>
        /// 根據客戶名稱獲取客戶列表
        /// </summary>
        /// <param name="name">客戶名稱</param>
        /// <returns></returns>
        [OperationContract]
        List<CustomerInfo> FindByName(string name);
    }

差別就是它們介面繼承類有所不同，外部介面由於不需要和資料庫打交道，我們不需要繼承IBaseService介面

根據這些介面的定義，我們還需要實現我們具體的Web API 服務，邏輯上它是對外部Web API介面的封裝，但是對於客戶端來說，並不需要知道是內部還是外部介面，客戶端只需要知道如果提交參數或者結果即可。

由於Web API涉及多個參數的數據提交，一般來說這種情況都是以POST方式處理的，數據參數則統一在Web API端通過定義一個JObject對象來傳遞即可，登錄認證的Web API介面定義如下所示。

    /// <summary>
    /// 基於RFID的應用介面
    /// </summary>
    public class RFIDController : BaseApiController
    {
        /// <summary>
        /// 終端用戶統一登錄驗證
        /// </summary>
        /// <param name="param">包含多個屬性的對象</param>
        /// <param name="token">訪問令牌</param>
        [HttpPost]
        public CheckinResult CheckIn(JObject param)
        {
            CheckinResult result = null;
            dynamic obj = param;
            if (obj != null)
            {
                //使用POST數據
                var postData = param.ToJson();
                //使用具體的URL
                var queryUrl = "https://***.***.***/api/v6/rfid/terminal/checkin/post";

                var helper = new HttpHelper();
                helper.ContentType = "application/json";
                var content = helper.GetHtml(queryUrl, postData, true);
                RFIDBaseData<CheckinResult> jsonResult = JsonConvert.DeserializeObject<RFIDBaseData<CheckinResult>>(content);
                if (jsonResult != null && jsonResult.code == 0)
                {
                    result = jsonResult.data;
                }
                return result;
            }
            else
            {
                throw new MyApiException("傳遞參數錯誤");
            }
        }

其中輸入的參數這裡用了JObject param的參數，我們提交給外部Web API介面的時候，我們把這個參數再次序列號為JSON格式的字元串即可：

var postData = param.ToJson();

其中CheckinResult和RFIDBaseData是根據輸入參數、輸出結果進行的實體類定義，目的是序列化為強類型的實體類，方便數據處理操作。

在客戶端，我們只需要對接好和Web API服務端的介面，那麼調用起來就非常方便，其中對應的Web API介面客戶端封裝類 RFIDCaller 如下所示。

    /// <summary>
    /// 對RFID控制的介面調用封裝
    /// </summary>
    public class RFIDCaller : NormalApiService, IRFIDService
    {
        public RFIDCaller()
        {
            this.ConfigurationPath = ApiConfig.ConfigFileName; //Web API配置文件
            this.configurationName = ApiConfig.RFID;
        }

        public CheckinResult CheckIn(string username, string password, string device_uuid, string device_type, string last_app_version, string app_id)
        {
            var action = System.Reflection.MethodBase.GetCurrentMethod().Name;
            string url = GetNormalUrl(action);
            var postData = new
            {
                username = username,
                password = password,
                device_uuid = device_uuid,
                device_type = device_type,
                last_app_version = last_app_version,
                app_id = app_id,
            }.ToJson();

            var result = JsonHelper<CheckinResult>.ConvertJson(url, postData);
            return result;
        }

有了這些，我們直接在客戶端的界面裡面，就可以通過調用CallerFactory<T>進行處理操作了，如下是客戶端窗體獲取驗證身份令牌數據的代碼

        private string token = null;//訪問RFID介面的token
        /// <summary>
        /// 根據終端用戶統一登錄驗證獲取相關訪問token
        /// </summary>
        /// <returns></returns>
        private string GetRFIDToken()
        {
            string username = "wuhuacong";
            string password = "123456";
            string device_uuid = "aaaaaaa";
            string device_type = "iphone";
            string last_app_version = "xxxxxxx";
            string app_id = "ntdf5543581a2f066e74cf2fe456";
            
            var result = CallerFactory<IRFIDService>.Instance.CheckIn(username, password, device_uuid, device_type, last_app_version, app_id);
            if(result != null)
            {
                token = result.token;
            }
            return token;
        }

 

 上面是認證身份的介面，其他類型的介面類似的處理方式，如增加了一個

獲取標簽發貨通知單批量

操作後，對應的客戶端封裝類如下所示。

    /// <summary>
    /// 對RFID控制的介面調用封裝
    /// </summary>
    public class RFIDCaller : NormalApiService, IRFIDService
    {
        public RFIDCaller()
        {
            this.ConfigurationPath = ApiConfig.ConfigFileName; //Web API配置文件
            this.configurationName = ApiConfig.RFID;
        }

        public CheckinResult CheckIn(string username, string password, string device_uuid, string device_type, string last_app_version, string app_id)
        {
            var action = System.Reflection.MethodBase.GetCurrentMethod().Name;
            string url = GetNormalUrl(action);
            var postData = new
            {
                username = username,
                password = password,
                device_uuid = device_uuid,
                device_type = device_type,
                last_app_version = last_app_version,
                app_id = app_id,
            }.ToJson();

            var result = JsonHelper<CheckinResult>.ConvertJson(url, postData);
            return result;
        }

        public TagOrderAsnResult TagOrderAsn(int brand_id, string factcode, string start_time, string end_time, Pager.Entity.PagerInfo pagerInfo, string token)
        {
            var action = System.Reflection.MethodBase.GetCurrentMethod().Name;
            string url = GetNormalUrl(action) + string.Format("?token={0}", token);
            var postData = new
            {
                page = pagerInfo.CurrenetPageIndex,
                pagesize = pagerInfo.PageSize,
                brand_id = brand_id,
                factcode = factcode,
                start_time = start_time,
                end_time = end_time,
            }.ToJson();

            var result = JsonHelper<TagOrderAsnResult>.ConvertJson(url, postData);
            return result;
        }

獲取標簽發貨通知單批量

 的Web API介面如下代碼定義

 

        /// <summary>
        /// 獲取標簽發貨通知單批量
        /// </summary>
        /// <param name="param"></param>
        /// <param name="token"></param>
        /// <returns></returns>
        [HttpPost]
        public TagOrderAsnResult TagOrderAsn(JObject param, string token)
        {
            TagOrderAsnResult result = null;
            dynamic obj = param;
            if (obj != null)
            {
                //使用POST方式
                var postData = param.ToJson();
                var queryUrl = "https://***.***.***/api/v6/rfid/tag/tag_order_asn/get";
                                
                var helper = new HttpHelper();
                helper.ContentType = "application/json";
                helper.Header.Add("token", token); 
                var content = helper.GetHtml(queryUrl, postData, true);

                RFIDBaseData<TagOrderAsnResult> jsonResult = JsonConvert.DeserializeObject<RFIDBaseData<TagOrderAsnResult>>(content);
                if (jsonResult != null && jsonResult.code == 0)
                {
                    result = jsonResult.data;
                }

                return result;
            }
            else
            {
                throw new MyApiException("傳遞參數錯誤");
            }

其中表頭信息，我們通過下麵的代碼指定，設置特殊的token表頭信息

                var helper = new HttpHelper();
                helper.ContentType = "application/json";
                helper.Header.Add("token", token);

而在客戶端的調用窗體裡面，我們調用對應的介面就可以獲取該介面的數據了。

        private TagOrderAsnResult asnResult;
        /// <summary>
        /// 根據參數獲取標簽生產訂單批量信息
        /// </summary>
        /// <returns></returns>
        private TagOrderAsnResult GetResult()
        {
            PagerInfo pagerInfo = new PagerInfo() { PageSize = 50, CurrenetPageIndex = 1 };//初始化一個分頁條件
            var brand_id = this.txtbrand_id.Text.ToInt32();
            var factcode = this.txtfactcode.Text;
            var start_time = this.txtstart_time.DateTime.ToString("yyyy-MM-dd HH:mm:ss");
            var end_time = this.txtend_time.DateTime.ToString("yyyy-MM-dd HH:mm:ss");

            asnResult = CallerFactory<IRFIDService>.Instance.TagOrderAsn(brand_id, factcode, start_time, end_time, pagerInfo, Token);
            return asnResult;
        }

通過上面的代碼演示，我們瞭解了在混合框架基礎上增加外部Web API介面的方法，通過增加Facade層介面，增加Web API介面，以及對應的客戶端封裝類，具體處理參數根據Web API介面的輸入參數、輸出數據等信息進行綜合處理即可。

最後我們來看看數據的展示界面。

 


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

-Advertisement-
Play Games
更多相關文章
  • 如何使用ILAsm與ILDasm修改.Net exe(dll)文件
    本文將用簡單的示例讓你瞭解如何通過ILAsm與ILDasm修改你的exe、dll文件 ...
  • C# socket demo
    1. 伺服器端代碼 2. 客戶端代碼 3. 運行截圖 ...
  • git本地倉庫關聯多個remote,怎麼用本地一個分支向不同remote不同分支推送代碼
    我想這個問題，是大家關註的問題，這個問題，我非常關註。 背景：在公司開發項目，我們一般都要把項目推送到公司領導創建的一個遠程倉庫裡邊去，但是我們同時也有自己的小倉庫，這樣的話，如何方便的將我們的代碼，給公司倉庫推送一次，然後給自己的倉庫推送一份呢？ 1.在我們項目根目錄打開git 終端 現在這個項目 ...
  • C# LINQ
    1. 自定義 Master，Kongfu 類 2. 測試代碼 ...
  • UWP 使用Windows.Media.FaceAnalysis.FaceDetector檢測人臉
    話說現在檢測人臉的技術有很多。有線上AI服務，比如Megvii Face++，Microsoft Cognitive Services，Tencent AI等等。還有本地的庫實現的，比如OpenCV。 但是這些這篇文章都不討論，微軟在 .NETCore裡面也提供了一種本地檢測人臉的API，那就是Wi ...
  • 從PRISM開始學WPF（一）WPF？
    我最近打算學習 WPF ，在尋找 MVVM 框架的時候發現了 PRISM ，在此之前還從一些博客上瞭解了其他的 MVVM 框架，比如 "淺談WPF中的MVVM框架 MVVMFoundation" 中提到的 MVVMFoundation ，再比如 "ViewModel從未如此清爽 輕量級WPF MVV ...
  • .NET Core2.0學習記錄（1）
    微軟發佈asp.net core已經過去很長的時間了，我還沒有接觸，從現在開始一點點去學習。 一、Db_First 1、新建一個asp.net core mvc的項目 2、通過NuGet，安裝Entity Framework Core Install-Package Microsoft.Entity ...
  • 微信通過openID發送消息/後臺post、get提交並接收數據
    控制器：下麵是post發送消息（微信不支持從前臺發送數據，之前試過，報錯，需要跨域，跨域的問題解決後還不行，最後發現之後後端提交 WXApi類： #region 驗證Token是否過期 /// /// 驗證Token是否過期 /// public static bool TokenExpired(s... ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類