在我們常規(guī)的業(yè)務(wù)處理中，一般內(nèi)部處理的接口多數(shù)都是以數(shù)據(jù)庫相關(guān)的，基于混合式開發(fā)的Winform開發(fā)框架，雖然在客戶端調(diào)用的時(shí)候，一般選擇也是基于Web API的調(diào)用，不過后端我們可能不僅僅是針對(duì)我們業(yè)務(wù)數(shù)據(jù)庫的處理，也可以能是調(diào)用其他外部接口，如物流、供應(yīng)商接口等接口，本文主要介紹基于混合式開發(fā)框架如何整合外部API接口的調(diào)用。

PS：給大家推薦一個(gè)C#開發(fā)可以用到的界面組件——DevExpress WinForms，它能完美構(gòu)建流暢、美觀且易于使用的應(yīng)用程序，無論是Office風(fēng)格的界面，還是分析處理大批量的業(yè)務(wù)數(shù)據(jù)，它都能輕松勝任！

DevExpress技術(shù)交流群9：909157416      歡迎一起進(jìn)群討論

1. 混合式框架的結(jié)構(gòu)介紹

混合式的框架是可以在客戶端訪問Web API服務(wù)、WCF服務(wù)或者直接連接數(shù)據(jù)庫幾種方式的綜合，而尤以Web API為最廣泛的應(yīng)用，它的整個(gè)框架的結(jié)構(gòu)如下所示。

在客戶端中，通過統(tǒng)一的工廠類CallerFactory<T>對(duì)相應(yīng)的接口進(jìn)行訪問，這里主要就是服務(wù)器端Web API服務(wù)接口的處理，以及客戶端對(duì)Web API接口的封裝，兩部分通過一些基類進(jìn)行簡化處理，可以極大提高開發(fā)效率。

對(duì)于外部第三方的Web API接口，我們也可以在自己的Web API接口中進(jìn)行包裝，使得客戶端通過相應(yīng)的接口進(jìn)行交互即可，不需要理會(huì)內(nèi)部還是外部的接口，從而實(shí)現(xiàn)透明的接口調(diào)用。

2. RFID外部接口的整合處理

在一個(gè)客戶的應(yīng)用案例中，需要整合服務(wù)商RFID接口實(shí)現(xiàn)相應(yīng)的數(shù)據(jù)交互，本文也是基于這個(gè)案例進(jìn)行整個(gè)過程的分析和操作，使得我們了解在混合框架中如何整合第三方Web API接口為我們內(nèi)部框架所用。

一般來說，Web API接口，需要明確API的URL、數(shù)據(jù)提交方式（POST/GET）、提交參數(shù)、返回集合，以及一些特殊的數(shù)據(jù)等，而一般接口的操作，也是需要一個(gè)訪問令牌的，這些都是Web API接口調(diào)用的關(guān)鍵。

基本上我們有了上面Web API的1/2/3步驟的信息就可以進(jìn)行接口編程了，這些是Web API開發(fā)非常重要的信息。

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

這里面的token是額外的接口信息，是需要設(shè)置Http Request請(qǐng)求的頭部信息里面的，是用戶身份的重要信息，所以我們一般需要先通過指定的授權(quán)接口獲取這個(gè)token信息。

在這個(gè)外部的接口集合里面，我們找到統(tǒng)一登錄驗(yàn)證的接口定義如下所示。

通過上面的分析，我們首先需要需要處理好登錄驗(yàn)證接口，然后通過接口傳遞令牌token給其他接口進(jìn)行數(shù)據(jù)處理的。

結(jié)合我們的混合框架結(jié)構(gòu)，這里我以測(cè)試項(xiàng)目TestProject項(xiàng)目為例進(jìn)行介紹，我們調(diào)整WHC.TestProject.Caller項(xiàng)目的對(duì)應(yīng)類，如下所示。

其中Facade層接口類IRFIDService.cs代碼如下所示。

/// <summary>
/// RFID服務(wù)外部接口
/// </summary>
[ServiceContract]
public interface IRFIDService
{

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

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

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

這里面的接口定義，我們是根據(jù)輸入?yún)?shù)、輸出參數(shù)進(jìn)行定義的，另外token是額外增加的令牌參數(shù)，用于請(qǐng)求頭部寫入信息的。

這個(gè)接口的定義其實(shí)和我們常規(guī)的Web API接口定義沒有太多的不同，如下是一個(gè)內(nèi)部客戶信息接口定義。

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

差別就是它們接口繼承類有所不同，外部接口由于不需要和數(shù)據(jù)庫打交道，我們不需要繼承IBaseService接口。

根據(jù)這些接口的定義，我們還需要實(shí)現(xiàn)我們具體的Web API 服務(wù)，邏輯上它是對(duì)外部Web API接口的封裝，但是對(duì)于客戶端來說，并不需要知道是內(nèi)部還是外部接口，客戶端只需要知道如果提交參數(shù)或者結(jié)果即可。

由于Web API涉及多個(gè)參數(shù)的數(shù)據(jù)提交，一般來說這種情況都是以POST方式處理的，數(shù)據(jù)參數(shù)則統(tǒng)一在Web API端通過定義一個(gè)JObject對(duì)象來傳遞即可，登錄認(rèn)證的Web API接口定義如下所示。

/// <summary>
/// 基于RFID的應(yīng)用接口
/// </summary>
public class RFIDController : BaseApiController
{
/// <summary>
/// 終端用戶統(tǒng)一登錄驗(yàn)證
/// </summary>
/// <param name="param">包含多個(gè)屬性的對(duì)象</param>
/// <param name="token">訪問令牌</param>
[HttpPost]
public CheckinResult CheckIn(JObject param)
{
CheckinResult result = null;
dynamic obj = param;
if (obj != null)
{
//使用POST數(shù)據(jù)
var postData = param.ToJson();
//使用具體的URL
var queryUrl = "http://***.***.***/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("傳遞參數(shù)錯(cuò)誤");
}
}

其中輸入的參數(shù)這里用了JObject param的參數(shù)，我們提交給外部Web API接口的時(shí)候，我們把這個(gè)參數(shù)再次序列號(hào)為JSON格式的字符串即可：

var postData = param.ToJson();

其中CheckinResult和RFIDBaseData是根據(jù)輸入?yún)?shù)、輸出結(jié)果進(jìn)行的實(shí)體類定義，目的是序列化為強(qiáng)類型的實(shí)體類，方便數(shù)據(jù)處理操作。

在客戶端，我們只需要對(duì)接好和Web API服務(wù)端的接口，那么調(diào)用起來就非常方便，其中對(duì)應(yīng)的Web API接口客戶端封裝類 RFIDCaller 如下所示。

/// <summary>
/// 對(duì)RFID控制的接口調(diào)用封裝
/// </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;
}

有了這些，我們直接在客戶端的界面里面，就可以通過調(diào)用CallerFactory<T>進(jìn)行處理操作了，如下是客戶端窗體獲取驗(yàn)證身份令牌數(shù)據(jù)的代碼：

private string token = null;//訪問RFID接口的token
/// <summary>
/// 根據(jù)終端用戶統(tǒng)一登錄驗(yàn)證獲取相關(guān)訪問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;
}

上面是認(rèn)證身份的接口，其他類型的接口類似的處理方式，如增加了一個(gè)

獲取標(biāo)簽發(fā)貨通知單批量

操作后，對(duì)應(yīng)的客戶端封裝類如下所示。

/// <summary>
/// 對(duì)RFID控制的接口調(diào)用封裝
/// </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;
}

獲取標(biāo)簽發(fā)貨通知單批量

的Web API接口如下代碼定義

/// <summary>
/// 獲取標(biāo)簽發(fā)貨通知單批量
/// </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 = "http://***.***.***/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("傳遞參數(shù)錯(cuò)誤");
}

其中表頭信息，我們通過下面的代碼指定，設(shè)置特殊的token表頭信息。

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

而在客戶端的調(diào)用窗體里面，我們調(diào)用對(duì)應(yīng)的接口就可以獲取該接口的數(shù)據(jù)了。

private TagOrderAsnResult asnResult;
/// <summary>
/// 根據(jù)參數(shù)獲取標(biāo)簽生產(chǎn)訂單批量信息
/// </summary>
/// <returns></returns>
private TagOrderAsnResult GetResult()
{
PagerInfo pagerInfo = new PagerInfo() { PageSize = 50, CurrenetPageIndex = 1 };//初始化一個(gè)分頁條件
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;
}

通過上面的代碼演示，我們了解了在混合框架基礎(chǔ)上增加外部Web API接口的方法，通過增加Facade層接口，增加Web API接口，以及對(duì)應(yīng)的客戶端封裝類，具體處理參數(shù)根據(jù)Web API接口的輸入?yún)?shù)、輸出數(shù)據(jù)等信息進(jìn)行綜合處理即可。

最后我們來看看數(shù)據(jù)的展示界面。

本文轉(zhuǎn)載自：