1. 程式人生 > >ABP開發框架前後端開發系列---(10)Web API呼叫類的簡化處理

ABP開發框架前後端開發系列---(10)Web API呼叫類的簡化處理

在較早期的隨筆《ABP開發框架前後端開發系列---(5)Web API呼叫類在Winform專案中的使用》已經介紹了Web API呼叫類的封裝處理,雖然這些呼叫類我們可以使用程式碼生成工具快速生成,不過自定義介面,還是需要我們對這些介面進行實現,以便發起對Web API的呼叫,並獲得相應的資料返回。本篇隨筆介紹使用API呼叫類的封裝類,進行函式的抽象,根據方法名稱的推斷,構建URL或者WebClient的請求型別,從而實現所有API呼叫函式的簡化處理。

1、ABP框架服務端和客戶端的處理

ABP框架的架構圖示,如下圖所示(以字典模組為例說明)

針對Web API介面呼叫的封裝,為了適應客戶端快速呼叫的目的,這個封裝作為一個獨立的封裝層,以方便各個模組之間進行共同呼叫。

而ABP的Web API呼叫類則需要對Web API介面呼叫進行封裝,如下所示。

如對於字典模組的API封裝類,它們繼承一個相同的基類,然後實現特殊的自定義介面即可,這樣可以減少常規的Create、Get、GetAll、Update、Delete等操作的程式碼,這些全部由呼叫基類進行處理,而只需要實現自定義的介面呼叫即可。

 

2、Web API呼叫類的簡化處理

我們對於常規的Web API呼叫介面處理,如下程式碼所示。

        public async virtual Task<AuthenticateResult> Authenticate(string username, string password)
        {
            var url = string.Format("{0}/api/TokenAuth/Authenticate", ServerRootAddress);
            var input = new
            {
                UsernameOrEmailAddress = username,
                Password = password
            };

            var result = await apiClient.PostAsync<AuthenticateResult>(url, input);
            return result;
        }

這種方法的處理,就需要自己拼接URL地址,以及傳遞相關的引數,一般情況下,我們的Web API Caller層類的函式和Web API控制器的方法是一一對應的,因此方法名稱可以通過對當前介面名稱的推斷進行獲得,如下所示。

        public async Task<bool> ChangePassword(ChangePasswordDto input)
        {
            AddRequestHeaders();//加入認證的token頭資訊
            string url = GetActionUrl(MethodBase.GetCurrentMethod());//獲取訪問API的地址(未包含引數)

            return await apiClient.PostAsync<bool>(url, input);
        }

函式AddRequestHeaders 通過在呼叫前增加對應的AccessToken資訊,然後URL通過當前方法的推斷即可構建一個完整的URL,但是這個也僅僅是針對POST的方法,因為ABP框架根據方法的名稱字首的不同,而採用POST、GET、Delete、PUT等不同的HTTP處理操作。

如GET方法,則是需要使用GET請求

        public async Task<List<RoleDto>> GetRolesByUser(EntityDto<long> input)
        {
            AddRequestHeaders();//加入認證的token頭資訊
            string url = GetActionUrl(MethodBase.GetCurrentMethod());//獲取訪問API的地址(未包含引數)
            url = GetUrlParam(input, url);

            var result = await apiClient.GetAsync<List<RoleDto>>(url);
            return result;
        }

而對於刪除方法,則使用下面的DELETE請求,DELETE 和PUT操作,需要把引數串聯成GET的URL形式,類似 url += string.Format("?Id={0}", id); 這樣方式

        public virtual async Task Delete(TDeleteInput input)
        {
            AddRequestHeaders();//加入認證的token頭資訊
            string url = GetActionUrl(MethodBase.GetCurrentMethod());//獲取訪問API的地址(未包含引數)
            url += GetUrlParam(input, url);
            var result = await apiClient.DeleteAsync(url);
            return result;
        }

對於更新的操作,使用了PUT方法

        public async virtual Task<TEntityDto> Update(TUpdateInput input)
        {
            AddRequestHeaders();//加入認證的token頭資訊
            string url = GetActionUrl(MethodBase.GetCurrentMethod());//獲取訪問API的地址(未包含引數)
            var result = await apiClient.PutAsync<TEntityDto>(url, input, null);
            return result;
        }

上面這些方法,我們根據規律,其實可以進一步進行簡化,因為這些操作大多數類似的。

首先我們看到變化的地方,就是根據方法的字首採用GET、POST、DELETE、PUT方法,還有就是URL串聯字串的不同,對於GET、Delete方法,引數使用的是組成URL方式,引數使用的是JSON提交內容方式。

根據這些變化,我們在基類提煉一個統一的處理方法DoActionAsync 來處理這些不同的操作。

        /// <summary>
        /// 根據方法名稱自動執行GET/POST/PUT/DELETE請求方法
        /// </summary>
        /// <param name="method"></param>
        /// <param name="input"></param>
        protected virtual async Task DoActionAsync(MethodBase method, object input = null)
        {
            await DoActionAsync<object>(method, input);
        }
        /// <summary>
        /// 根據方法名稱自動執行GET/POST/PUT/DELETE請求方法
        /// </summary>
        /// <param name="method"></param>
        /// <param name="input"></param>
        protected virtual async Task<TResult> DoActionAsync<TResult>(MethodBase method, object input = null)
        {
            AddRequestHeaders();//加入認證的token頭資訊

            string action = GetMethodName(method);
            var url = string.Format("{0}/api/services/app/{1}/{2}", ServerRootAddress, DomainName, action);//獲取訪問API的地址(未包含引數)
            var httpVerb = DynamicApiVerbHelper.GetConventionalVerbForMethodName(action);
            if(httpVerb == HttpVerb.Get || httpVerb == HttpVerb.Delete)
            {
                if (input != null)
                {
                    //Get和Delete的操作,需要組裝URL引數
                    url = GetUrlParam(input, url);
                }
            }

            int? timeout = null;
            return await apiClient.DoActionAsync<TResult>(url, timeout, httpVerb.ToString().ToLower(), input);
        }

這樣,有了這兩個函式的支援,我們可以簡化很多操作程式碼了。

例如對於Update方法,簡化的程式碼如下所示。

        public async virtual Task<TEntityDto> Update(TUpdateInput input)
        {
            return await DoActionAsync<TEntityDto>(MethodBase.GetCurrentMethod(), input);
        }

對於刪除操作,簡化的程式碼依舊也是一行程式碼

        public virtual async Task Delete(TDeleteInput input)
        {
            await DoActionAsync(MethodBase.GetCurrentMethod(), input);
        }

GET操作,也是一行程式碼

        public async virtual Task<TEntityDto> Get(TGetInput input)
        {
            return await DoActionAsync<TEntityDto>(MethodBase.GetCurrentMethod(), input);
        }

現在你看到,所有的客戶端API封裝類呼叫,都已經非常簡化,大同小異了,主要就是交給基類函式進行推斷呼叫處理即可。

如使用者操作的APICaller類的程式碼如下所示。

這樣我們再多的介面,都一行程式碼呼叫解決問題,非常簡單,從此客戶端封裝類的實現就非常簡單了,只需要注意有沒有返回值即可,其他的都沒有什麼不同。

只需要注意的是,我們定義介面的時候,儘可能使用複雜型別物件,這樣就可以根據物件屬性名稱和值進行構建URL或者JSON的了。

&n