循序漸進VUE+Element 前端應用開發(14)--- 根據ABP後端介面實現前端介面展示
在前面隨筆《循序漸進VUE+Element 前端應用開發(12)--- 整合ABP框架的前端登入處理》簡單的介紹了一個結合ABP後端的登陸介面實現前端系統登陸的功能,本篇隨筆繼續深化這一主題,著重介紹基於ABP後端介面資訊,實現對前端介面的開發工作。
ABP(ASP.NET Boilerplate)框架主要是基於.net core 進行的後端Web API的開發,結合Swagger的管理介面我們可以看到釋出的 API 的介面明細資訊,這樣前端技術人員可以很容易整合前端的API應用。Vue + Element的前端應用,是目前較為流行的前端技術整合,Vue提供了前端框架很好的支援,Element提供了非常不錯的介面元件封裝和處理,通過ABP後端API介面和前端Vue+Element的整合,可以很好實現前後端的分離處理,同時又極大提高各自開發過程,並利用最新、應用廣泛的技術來實現最好的技術應用。
1、ABP介面和前端對接處理
ABP框架主要還是基於領域驅動的理念來構建整個架構的,其中領域驅動包含的概念有 域物件Entities、倉儲物件Repositories、域服務介面層Domain Services、域事件Domain Events、應用服務介面Application Services、資料傳輸物件DTOs等。
ABP官方網站:http://www.aspnetboilerplate.com,從裡面可以檢視很詳細的案例和文件說明,可以根據需要下載不同型別的基礎框架。
ABP GitHub原始碼地址:https://github.com/aspnetboilerplate,可以下載整個基礎的框架內容,以及相關的樣板案例程式碼。
關於ABP框架使用,如果不知道,請自行補習一下我的隨筆:ABP框架使用。
整理後的ABP快速開發框架的架構圖示,如下圖所示(以字典模組為例說明)
針對Web API介面呼叫的封裝,為了適應客戶端快速呼叫的目的,這個封裝作為一個獨立的封裝層,以方便各個模組之間進行共同呼叫。
在基於VUE+Element 前端應用中,上圖的ApiCaller元件,其實就是我們封裝的API的JS類,同時也有相關的繼承封裝處理,類似C#中類的繼承關係了。
在JS裡面引入了ES6的語法,JS函式就可以使用類的方式來實現各種基礎介面的封裝和子類的繼承關係了。
例如我們先定義好JS中常規的API封裝介面BaseApi類,然後定義子類有DIctType、DictData等業務類,那麼這些類繼承BaseApi,就會具有相關的介面了,如下所示繼承關係。
這些API類的檔案檢視如下所示。
有了這些業務類的準備,那麼我們和後端ABP的API介面對接,就很容易了,如下圖所示。
一般來說,我們頁面模組可能會涉及到Store模組,用來儲存對應的狀態資訊,也可能是直接訪問API模組,實現資料的呼叫並展示。在頁面開發過程中,多數情況下,不需要Store模組進行互動,一般只需要儲存對應頁面資料為全域性資料狀態的情況下,才可能啟用Store模組的處理。
通過WebProxy代理的處理,我們可以很容易在前端中實現跨域的處理,不同的路徑呼叫不同的域名地址API都可以,最終轉換為本地的API呼叫,這就是跨域的處理操作。
2、ABP介面資訊和前端介面處理
有了上面的一些知識準備,相信對ABP+Vue+Element的前端對接有了一個大概的認識了。
ABP+Swagger負責API介面的開發和公佈,如下是API介面的管理介面。
進一步檢視GetAll的API介面說明,我們可以看到對應的條件引數,如下所示。
這些是作為查詢條件的處理,用來給後端獲取對應的條件資訊,從而過濾返回的資料記錄的。
那麼我們前端介面也需要根據這些引數來構造查詢介面,我們可以通過部分條件進行處理即可,其中MaxResultCount和SkipCount是用於分頁定位的引數。
前端介面程式碼如下所示。
主要就是構造一個條件查詢的表單如下所示。
其中定義了一個searchForm的屬性,那麼我們可以瞭解下它的定義。
然後我們在查詢處理的函式getlist裡面,就可以根據這些條件,以及分頁引數進行資料的請求查詢了,如下程式碼所示。
getlist() { // 列表資料獲取 var param = { // 構造常規的分頁查詢條件 SkipCount: (this.pageinfo.pageindex - 1) * this.pageinfo.pagesize, MaxResultCount: this.pageinfo.pagesize, // 過濾條件 Name: this.searchForm.name, Remark: this.searchForm.remark, DictType_ID: this.searchForm.dictType_ID }; // 獲取產品列表,繫結到模型上,並修改分頁數量 this.listLoading = true dictdata.GetAll(param).then(data => { this.list = data.result.items this.pageinfo.total = data.result.totalCount this.listLoading = false }) },
其中的dictdata.GetAll就是呼叫API模組裡面的函式進行處理,是我們在檢視頁面類中匯入這些API類的定義的。
// 業務API物件 import dicttype from '@/api/dicttype' import dictdata from '@/api/dictdata'
我們對於DictDataApi的JS類定義如下所示。
其中JS類的BaseApi具有常規的增刪改查介面,如下所示。
其中list是列表的資料,pageinfo是分頁資訊,那麼我們在前端的列表展示介面程式碼如下所示。
<el-table v-loading="listLoading" :data="list" border fit stripe highlight-current-row :header-cell-style="{background:'#eef1f6',color:'#606266'}" @selection-change="selectionChange" @row-dblclick="rowDbclick" > <el-table-column type="selection" width="55" /> <el-table-column label="字典名稱"> <template slot-scope="scope"> {{ scope.row.name }} </template> </el-table-column> <el-table-column align="center" label="字典值"> <template slot-scope="scope"> {{ scope.row.value }} </template> </el-table-column> <el-table-column label="備註"> <template slot-scope="scope"> {{ scope.row.remark }} </template> </el-table-column> <el-table-column align="center" label="排序" width="80"> <template slot-scope="scope"> {{ scope.row.seq }} </template> </el-table-column> <el-table-column label="操作" width="140"> <template scope="scope"> <el-row> <el-tooltip effect="light" content="檢視" placement="top-start"> <el-button icon="el-icon-search" type="success" circle size="mini" @click="showView(scope.row.id)" /> </el-tooltip> <el-tooltip effect="light" content="編輯" placement="top-start"> <el-button icon="el-icon-edit" type="primary" circle size="mini" @click="showEdit(scope.row.id)" /> </el-tooltip> <el-tooltip effect="light" content="刪除" placement="top-start"> <el-button icon="el-icon-delete" type="danger" circle size="mini" @click="showDelete(scope.row.id)" /> </el-tooltip> </el-row> </template> </el-table-column> </el-table> <div class="block" style="height:70px;"> <el-pagination :current-page="pageinfo.pageindex" :page-size="pageinfo.pagesize" :total="pageinfo.total" :page-sizes="[10,20,30,40]" layout="total, sizes, prev, pager, next" @size-change="sizeChange" @current-change="currentChange" /> </div>
這樣就可以簡單實現列表的查詢和展示了。
當然我們一般情況下,可能有一些列表用來進行資料過濾處理的,如這裡的字典型別,可以通過樹列表的進行展示,從而可以友好的管理不同型別的字典資料,如下是整合了樹形列表的查詢處理過程,介面相對複雜一些,不過原理差不多,都是根據條件進行API資料的請求,然後展示在列表中即可。
完整的對字典管理介面的實現。
其中包括對字典大類的維護,以及對應字典大類的資料列表資料的新增處理。
為了方便讀者理解,我列出一下前面幾篇隨筆的連線,供參考:
循序漸進VUE+Element 前端應用開發(1)--- 開發環境的準備工作
循序漸進VUE+Element 前端應用開發(2)--- Vuex中的API、Store和View的使用
循序漸進VUE+Element 前端應用開發(3)--- 動態選單和路由的關聯處理
循序漸進VUE+Element 前端應用開發(4)--- 獲取後端資料及產品資訊頁面的處理
循序漸進VUE+Element 前端應用開發(5)--- 表格列表頁面的查詢,列表展示和欄位轉義處理
循序漸進VUE+Element 前端應用開發(6)--- 常規Element 介面元件的使用
循序漸進VUE+Element 前端應用開發(7)--- 介紹一些常規的JS處理函式
循序漸進VUE+Element 前端應用開發(8)--- 樹列表元件的使用
循序漸進VUE+Element 前端應用開發(9)--- 介面語言國際化的處理
循序漸進VUE+Element 前端應用開發(11)--- 圖示的維護和使用
循序漸進VUE+Element 前端應用開發(12)--- 整合ABP框架的前端登入處理
循序漸進VUE+Element 前端應用開發(13)--- 前端API介面的封裝處理
&n