基於華為物聯網IOT的應用開發 ---介面管理開發
在前面隨筆《基於華為物聯網IOT的應用開發 --- 基於.net 的SDK封裝》介紹過IOT中應用側SDK的封裝,主要就是基於華為IOT的應用側封裝,以便在應用系統中進行呼叫。應用側SDK的封裝是一切應用開發的基礎,不過華為並沒有提供對應.net的SDK封裝,不過SDK都是基於Web API 的JSON資料進行互動,因此花了一點時間進行了華為.net 的SDK進行了全面封裝,本篇隨筆介紹如何基於封裝好的IOT 應用側的SDK進行介面管理的開發,實現對IOT業務資料的管理等。
1、應用側SDK封裝回顧
應用側的開發介面一般雲平臺都會提供不同平臺的SDK,如阿里雲開源提供Java SDK/C# SDK等;而華為則提供了Java、PHP等SDK,沒有包含.net 的SDK。華為物聯網雲的應用側API介面包括:
基於對應應用側API介面的定義,我們使用C#進行了對應介面的封裝。
包含了一個測試介面專案、一個SDK封裝介面專案,以及一個訂閱的訊息推送介面的解析和處理,例如新增裝置、裝置資訊變化、裝置繫結啟用等。
對於事件的通知,我們一般是在應用端被動的進行相應的處理,因此需要對它們的訊息進行轉換和處理。
類似在管理後臺訂閱這些事件,然後這些事件觸發後會推送給應用伺服器。
2、介面的測試使用
根據IOT的應用側API的定義,我們編寫一個快速測試SDK工作情況的Winform程式來測試,如獲取授權資訊,以及查詢產品、註冊裝置、修改裝置、獲取裝置狀態和詳細等等介面的正常與否,然後再在Web應用中進行整合,這樣可以減少返工除錯的問題。
按照業務介面的歸類測試,我們編寫如下程式用來測試對應SDK介面。
在使用SDK介面前,我們需要知道,華為IOT的API介面,基本上全部需要證書的對接的,這個和我們開發微信API有所差異。例如,我們的Winform測試程式,讓它帶有一個Cert目錄下的證書檔案,這個證書檔案可以在API的Demo裡面找到,或者在華為IOT平臺上下載。
我們最終用到的是cert/outgoing.CertwithKey.pkcs12這個證書檔案。
我們建立一個HTTPRequest物件獲取資料的時候,需要指定這個證書,如下所示。
helper.ContentType = "application/json"; helper.ClientCertificates = new X509CertificateCollection() { new X509Certificate2(Constants.CertFilePath, Constants.CertPassword) };
其他部分就是對API介面封裝的呼叫測試了。
如首先是授權的測試,用來獲取AccessToken的,這個是呼叫其他介面的前提。
private void btnLogin_Click(object sender, EventArgs e) { var result = basicApi.Authentication(); Console.WriteLine(result != null ? "accessToken:" + result.ToJson() : "獲取結果出錯"); if (result != null) { var refreshResult = basicApi.RefreshToken(result.refreshToken); Console.WriteLine(refreshResult != null ? "accessToken:" + refreshResult.ToJson() : "獲取結果出錯"); this.accessToken = refreshResult.accessToken;//記錄待用 } }
華為IOT介面很多沒有全部整合在一起,有的在https://support.huaweicloud.com/api-IoT/iot_06_0003.html ,而有的則在https://support.huaweicloud.com/api-iothub/iot_06_0008.html, 就拿授權來說,還有另外一個版本的介面可以獲取,兩個介面獲得的token都可以通用。
var url = Constants.AppBaseUrl + "/iocm/app/sec/v1.1.0/login";
var url = Constants.AppBaseUrl + "/api/v3.0/auth/tokens";
這兩個地址都可以獲取AccessToken,如裝置建立,也是有多個介面,版本不同。
我們針對各個介面的封裝,對相關介面進行測試,如基於產品、產品下面的列表等資訊,可以在一個介面測試程式碼裡面進行測試,如下所示。
/// <summary> /// 產品相關介面測試 /// </summary> private void btnProduct_Click(object sender, EventArgs e) { if (string.IsNullOrEmpty(accessToken)) { MessageUtil.ShowTips("請先鑑權獲取AccessToken"); return; } try { var productApi = new ProductApi(); var deviceApi = new DataCollectionApi(); //查詢產品列表 var queryJson = new QueryProductJson { ownerAppId = Constants.AppId }; var result = productApi.QueryProduct(accessToken, queryJson); Console.WriteLine(result != null ? result.ToJson() : "no result"); if (result != null && result.products != null) { //遍歷產品,根據產品ID獲取產品資訊 foreach (var p in result.products) { var detailResult = productApi.QueryProduct(accessToken, p.productId, Constants.AppId); Console.WriteLine(detailResult != null ? detailResult.ToJson() : "no result"); } //遍歷產品下面的裝置資訊 foreach (var p in result.products) { var deviceJson = new QueryDeviceJson { ownerAppId = Constants.AppId, productId = p.productId }; var deviceResult = deviceApi.BatchQueryDevice2(accessToken, deviceJson); Console.WriteLine(deviceResult != null ? deviceResult.ToJson() : "no result"); } } } catch (Exception ex) { MessageUtil.ShowError(ex.Message); } }
對於裝置,產品、裝置組,都屬於裝置的入口之一,因此裝置組也是管理介面裝置的一個類別,我們可以根據SDK對裝置組介面進行測試,如下程式碼所示。
/// <summary> /// 裝置分組測試 /// </summary> private void btnDeviceGroup_Click(object sender, EventArgs e) { if (string.IsNullOrEmpty(accessToken)) { MessageUtil.ShowTips("請先鑑權獲取AccessToken"); return; } try { //根據自己資料修改 var deviceId = "64bf5869-b271-4007-8db8-fab185e19c10"; var groupName = "testGroup"; var groupApi = new DeviceGroupApi(); var groupJson = new CreateDeviceGroupJson() { appId = Constants.AppId, name = groupName, description = "測試裝置分組", deviceIds = { deviceId } }; //建立裝置組 var result = groupApi.CreateDeviceGroup(accessToken, groupJson); Console.WriteLine(result != null ? result.ToJson() : "no result"); //查詢裝置組 var queryJson = new QueryDeviceGroupJson() { accessAppId = Constants.AppId, name = groupName }; var queryResult = groupApi.QueryDeviceGroup(accessToken, queryJson); Console.WriteLine(queryResult != null ? queryResult.ToJson() : "no result"); //查詢裝置組成員 if (queryResult != null && queryResult.list != null) { foreach (var group in queryResult.list) { //裝置明細 var groupResult = groupApi.GetDeviceGroup(accessToken, group.id, Constants.AppId); Console.WriteLine(groupResult != null ? groupResult.ToJson() : "no result"); //裝置組成員 var queryMemberJson = new QueryDeviceGroupMemberJson() { appId = Constants.AppId, devGroupId = group.id }; var queryMemberResult = groupApi.QueryDeviceGroupMember(accessToken, queryMemberJson); Console.WriteLine(queryMemberResult != null ? queryMemberResult.ToJson() : "no result"); } } } catch (Exception ex) { MessageUtil.ShowError(ex.Message); } }
3、IOT業務介面管理開發
當我們把大多數介面都跑一遍,並解決相關問題後,我們就可以根據這些介面進行Web應用的開發了。
為了方便,我們把IOT相關的業務,定義在一個控制器裡面,方便管理,以後如果有需要,可以拆分進行管理。
例如,對於資料提供,主要就是分頁JSON資料的處理,方便介面控制元件通過Ajax進行獲取資料顯示。
例如,對於產品列表,我們構建了一個控制器方法,如下所示。
/// <summary> /// 根據條件查詢產品列表,並返回物件集合(用於分頁資料顯示) /// </summary> /// <returns>指定物件的集合</returns> public virtual ActionResult FindProductWithPager() { var pagerInfo = GetPagerInfo(); var sort = GetSortOrder(); var accessToken = GetAccessToken(); var queryJson = new QueryProductJson(pagerInfo) { ownerAppId = Constants.AppId }; var result = productApi.QueryProduct(accessToken, queryJson); var list = result != null ? result.products : null; var totalCount = result != null ? result.totalCount : 0; //Json格式的要求{total:22,rows:{}} var jsonResult = new { total = totalCount, rows = list }; return ToJsonContent(jsonResult); }
其他,如裝置組、裝置列表等類似的處理,都是先通過介面獲取資料,然後組裝為對應的JSON格式提供給檢視即可。
有時候,除了列表展示外,我們可能還需要對檢視中建立、刪除、獲取單個明細的介面進行處理,如下所示是裝置分組的管理介面。
其他的業務物件也是類似的封裝,有了這些介面,我們就可以處理分頁、獲取詳細、編輯、刪除等介面的處理了。
在Web應用中定義幾個業務選單,用來管理產品資訊、裝置組和裝置資訊。
產品管理介面如下所示。
如果我們要檢視產品明細,呼叫對應介面進行展示即可。
包含裝置列表,我們根據產品ID獲取對應裝置列表返回到介面進行展示即可,如下所示效果。
裝置分組如下所示。
而裝置列表展示可以通過產品和裝置組進行限定查詢,我們如下管理這個裝置列表的展示的。
同樣,裝置詳細資訊,通過對應ID呼叫SDK介面獲取資料,並返回到檢視即可展示出來了。裝置的相關資訊,如下歷史資料、歷史命令等,我們也可以通過對應介面進行資料獲取返回,在介面的Tab控制元件進行展示即可。
如裝置歷史命令,可以獲取到相關歷史命令資訊。
以上就是對IOT應用側API介面的封裝和應用介面的管理開發,不過使用過程中,對於IOT的介面還是不夠完善,希望華為在這方便能夠繼續完善和提供良好的開發人員支援,我們也繼續關注,以便在後續專案中整合物聯網的硬體裝置進行使用。