在較早期的隨筆《ABP開發(fā)框架前后端開發(fā)系列---（5）Web API調(diào)用類在Winform項目中的使用》已經(jīng)介紹了Web API調(diào)用類的封裝處理，雖然這些調(diào)用類我們可以使用代碼生成工具快速生成，不過自定義接口，還是需要我們對這些接口進行實現(xiàn)，以便發(fā)起對Web API的調(diào)用，并獲得相應的數(shù)據(jù)返回。本篇隨筆介紹使用API調(diào)用類的封裝類，進行函數(shù)的抽象，根據(jù)方法名稱的推斷，構建URL或者WebClient的請求類型，從而實現(xiàn)所有API調(diào)用函數(shù)的簡化處理。

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

ABP框架的架構圖示，如下圖所示（以字典模塊為例說明）

image

針對Web API接口調(diào)用的封裝，為了適應客戶端快速調(diào)用的目的，這個封裝作為一個獨立的封裝層，以方便各個模塊之間進行共同調(diào)用。

image

而ABP的Web API調(diào)用類則需要對Web API接口調(diào)用進行封裝，如下所示。

image

如對于字典模塊的API封裝類，它們繼承一個相同的基類，然后實現(xiàn)特殊的自定義接口即可，這樣可以減少常規(guī)的Create、Get、GetAll、Update、Delete等操作的代碼，這些全部由調(diào)用基類進行處理，而只需要實現(xiàn)自定義的接口調(diào)用即可。

2、Web API調(diào)用類的簡化處理

我們對于常規(guī)的Web API調(diào)用接口處理，如下代碼所示。

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地址，以及傳遞相關的參數(shù)，一般情況下，我們的Web API Caller層類的函數(shù)和Web API控制器的方法是一一對應的，因此方法名稱可以通過對當前接口名稱的推斷進行獲得，如下所示。

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

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

函數(shù)AddRequestHeaders 通過在調(diào)用前增加對應的AccessToken信息，然后URL通過當前方法的推斷即可構建一個完整的URL，但是這個也僅僅是針對POST的方法，因為ABP框架根據(jù)方法的名稱前綴的不同，而采用POST、GET、Delete、PUT等不同的HTTP處理操作。

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

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

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

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

        public virtual async Task Delete(TDeleteInput input)
        {
            AddRequestHeaders();//加入認證的token頭信息
            string url = GetActionUrl(MethodBase.GetCurrentMethod());//獲取訪問API的地址（未包含參數(shù)）
            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的地址（未包含參數(shù)）
            var result = await apiClient.PutAsync<TEntityDto>(url, input, null);
            return result;
        }

上面這些方法，我們根據(jù)規(guī)律，其實可以進一步進行簡化，因為這些操作大多數(shù)類似的。

首先我們看到變化的地方，就是根據(jù)方法的前綴采用GET、POST、DELETE、PUT方法，還有就是URL串聯(lián)字符串的不同，對于GET、Delete方法，參數(shù)使用的是組成URL方式，參數(shù)使用的是JSON提交內(nèi)容方式。

根據(jù)這些變化，我們在基類提煉一個統(tǒng)一的處理方法DoActionAsync 來處理這些不同的操作。

        /// <summary>
        /// 根據(jù)方法名稱自動執(zhí)行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>
        /// 根據(jù)方法名稱自動執(zhí)行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的地址（未包含參數(shù)）
            var httpVerb = DynamicApiVerbHelper.GetConventionalVerbForMethodName(action);
            if(httpVerb == HttpVerb.Get || httpVerb == HttpVerb.Delete)
            {
                if (input != null)
                {
                    //Get和Delete的操作，需要組裝URL參數(shù)
                    url = GetUrlParam(input, url);
                }
            }

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

這樣，有了這兩個函數(shù)的支持，我們可以簡化很多操作代碼了。

例如對于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);
        }

現(xiàn)在你看到，所有的客戶端API封裝類調(diào)用，都已經(jīng)非常簡化，大同小異了，主要就是交給基類函數(shù)進行推斷調(diào)用處理即可。

如用戶操作的APICaller類的代碼如下所示。

image

這樣我們再多的接口，都一行代碼調(diào)用解決問題，非常簡單，從此客戶端封裝類的實現(xiàn)就非常簡單了，只需要注意有沒有返回值即可，其他的都沒有什么不同。

只需要注意的是，我們定義接口的時候，盡可能使用復雜類型對象，這樣就可以根據(jù)對象屬性名稱和值進行構建URL或者JSON的了。