在較早期的隨筆《ABP開發(fā)框架前后端開發(fā)系列---（5）Web API調(diào)用類在Winform項(xiàng)目中的使用》已經(jīng)介紹了Web API調(diào)用類的封裝處理，雖然這些調(diào)用類我們可以使用代碼生成工具快速生成抖坪，不過自定義接口损肛，還是需要我們對這些接口進(jìn)行實(shí)現(xiàn)踊餐，以便發(fā)起對Web API的調(diào)用，并獲得相應(yīng)的數(shù)據(jù)返回茎芋。本篇隨筆介紹使用API調(diào)用類的封裝類且叁，進(jìn)行函數(shù)的抽象，根據(jù)方法名稱的推斷啊易，構(gòu)建URL或者WebClient的請求類型吁伺，從而實(shí)現(xiàn)所有API調(diào)用函數(shù)的簡化處理。
1租谈、ABP框架服務(wù)端和客戶端的處理
ABP框架的架構(gòu)圖示篮奄，如下圖所示（以字典模塊為例說明）
針對Web API接口調(diào)用的封裝，為了適應(yīng)客戶端快速調(diào)用的目的割去，這個(gè)封裝作為一個(gè)獨(dú)立的封裝層窟却，以方便各個(gè)模塊之間進(jìn)行共同調(diào)用。
而ABP的Web API調(diào)用類則需要對Web API接口調(diào)用進(jìn)行封裝呻逆，如下所示夸赫。
如對于字典模塊的API封裝類，它們繼承一個(gè)相同的基類咖城，然后實(shí)現(xiàn)特殊的自定義接口即可茬腿，這樣可以減少常規(guī)的Create、Get宜雀、GetAll切平、Update、Delete等操作的代碼辐董，這些全部由調(diào)用基類進(jìn)行處理悴品，而只需要實(shí)現(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地址邦蜜，以及傳遞相關(guān)的參數(shù)，一般情況下亥至，我們的Web API Caller層類的函數(shù)和Web API控制器的方法是一一對應(yīng)的悼沈，因此方法名稱可以通過對當(dāng)前接口名稱的推斷進(jìn)行獲得贱迟，如下所示。
public async Task<bool> ChangePassword(ChangePasswordDto input)
{
AddRequestHeaders();//加入認(rèn)證的token頭信息
string url = GetActionUrl(MethodBase.GetCurrentMethod());//獲取訪問API的地址（未包含參數(shù)）
return await apiClient.PostAsync<bool>(url, input);
}
函數(shù)AddRequestHeaders 通過在調(diào)用前增加對應(yīng)的AccessToken信息絮供，然后URL通過當(dāng)前方法的推斷即可構(gòu)建一個(gè)完整的URL衣吠，但是這個(gè)也僅僅是針對POST的方法，因?yàn)锳BP框架根據(jù)方法的名稱前綴的不同，而采用POST、GET欺税、Delete频祝、PUT等不同的HTTP處理操作。
如GET方法盔憨，則是需要使用GET請求
public async Task<List<RoleDto>> GetRolesByUser(EntityDto<long> input)
{
AddRequestHeaders();//加入認(rèn)證的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();//加入認(rèn)證的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();//加入認(rèn)證的token頭信息
string url = GetActionUrl(MethodBase.GetCurrentMethod());//獲取訪問API的地址（未包含參數(shù)）
var result = await apiClient.PutAsync<TEntityDto>(url, input, null);
return result;
}
上面這些方法刹缝，我們根據(jù)規(guī)律，其實(shí)可以進(jìn)一步進(jìn)行簡化颈将，因?yàn)檫@些操作大多數(shù)類似的梢夯。
首先我們看到變化的地方，就是根據(jù)方法的前綴采用GET晴圾、POST颂砸、DELETE、PUT方法疑务，還有就是URL串聯(lián)字符串的不同沾凄，對于GET、Delete方法知允，參數(shù)使用的是組成URL方式撒蟀，參數(shù)使用的是JSON提交內(nèi)容方式。
根據(jù)這些變化温鸽，我們在基類提煉一個(gè)統(tǒng)一的處理方法DoActionAsync 來處理這些不同的操作保屯。
/// <summary>
/// 根據(jù)方法名稱自動(dòng)執(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ù)方法名稱自動(dòng)執(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();//加入認(rèn)證的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);
}
這樣涤垫，有了這兩個(gè)函數(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ù)進(jìn)行推斷調(diào)用處理即可什黑。
如用戶操作的APICaller類的代碼如下所示。
這樣我們再多的接口堪夭，都一行代碼調(diào)用解決問題愕把，非常簡單，從此客戶端封裝類的實(shí)現(xiàn)就非常簡單了森爽，只需要注意有沒有返回值即可恨豁，其他的都沒有什么不同。
只需要注意的是拗秘，我們定義接口的時(shí)候圣絮，盡可能使用復(fù)雜類型對象祈惶，這樣就可以根據(jù)對象屬性名稱和值進(jìn)行構(gòu)建URL或者JSON的了雕旨。
