在前面幾篇隨筆介紹了我對ABP框架的改造，包括對ABP總體的介紹，以及對各個(gè)業(yè)務(wù)分層的簡化，Web API 客戶端封裝層的設(shè)計(jì)，使得我們基于ABP框架的整體方案越來越清晰化， 也越來越接近實(shí)際的項(xiàng)目開發(fā)需求，一旦整個(gè)模式比較成熟，并以一種比較固化的模式來指導(dǎo)開發(fā)，那么就可以很方便的應(yīng)用在實(shí)際項(xiàng)目開發(fā)當(dāng)中了。本篇隨筆是基于前面幾篇的基礎(chǔ)上，在Winform項(xiàng)目上進(jìn)一步改造為實(shí)際項(xiàng)目的場景，把我原來基于微軟企業(yè)庫底層的數(shù)據(jù)庫訪問方式的Winform框架或者混合框架的字典模塊界面改造為基于ABP框架基礎(chǔ)上的字典應(yīng)用模塊。
1）APICaller層接口的回顧
在上一篇隨筆《ABP開發(fā)框架前后端開發(fā)系列---（4）Web API調(diào)用類的封裝和使用》中，我介紹了Web API調(diào)用類的封裝和使用，并介紹了在.net 控制臺程序中，測試對ApiCaller層的調(diào)用，并能夠順利返回我們所需要的數(shù)據(jù)。測試代碼如下所示。
#region DictType
using (var client = bootstrapper.IocManager.ResolveAsDisposable<DictTypeApiCaller>())
{
var caller = client.Object;
Console.WriteLine("Logging in with TOKEN based auth...");
var token = caller.Authenticate("admin", "123qwe").Result;
Console.WriteLine(token.ToJson());
caller.RequestHeaders.Add(new NameValue("Authorization", "Bearer " + token.AccessToken));
Console.WriteLine("Get All ...");
var pagerDto = new DictTypePagedDto() { SkipCount = 0, MaxResultCount = 10 };
var result = caller.GetAll(pagerDto).Result;
Console.WriteLine(result.ToJson());
Console.WriteLine("Get All by condition ...");
var pagerdictDto = new DictTypePagedDto() { Name = "民族" };
result = caller.GetAll(pagerdictDto).Result;
Console.WriteLine(result.ToJson());
Console.WriteLine("Get count by condition ...");
pagerdictDto = new DictTypePagedDto() {};
var count = caller.Count(pagerdictDto).Result;
Console.WriteLine(count);
Console.WriteLine();
Console.WriteLine("Create DictType...");
var createDto = new CreateDictTypeDto { Id = Guid.NewGuid().ToString(), Name = "Test", Code = "Test" };
var dictDto = caller.Create(createDto).Result;
Console.WriteLine(dictDto.ToJson());
Console.WriteLine("Update DictType...");
dictDto.Code = "testcode";
var updateDto = caller.Update(dictDto).Result;
Console.WriteLine(updateDto.ToJson());
if (updateDto != null)
{
Console.WriteLine("Delete DictType...");
caller.Delete(new EntityDto<string>() { Id = dictDto.Id });
}
}
#endregion
這些ApiCaller對象的接口測試代碼，包括了授權(quán)登錄，獲取所有記錄，獲取條件查詢記錄，創(chuàng)建、更新、刪除這些接口都成功執(zhí)行，驗(yàn)證了我們對整體架構(gòu)的設(shè)計(jì)改良，并通過對ApiCaller層基類的設(shè)計(jì)，減少我們對常規(guī)增刪改查接口的編碼，我們只需要編寫我們的自定義業(yè)務(wù)接口代碼封裝類即可。
其中基類的代碼如下所示。
針對Web API接口的封裝，為了適應(yīng)客戶端快速調(diào)用的目的，這個(gè)封裝作為一個(gè)獨(dú)立的封裝層，以方便各個(gè)模塊之間進(jìn)行共同調(diào)用。
也就是說，上面我們?nèi)渴腔诨惤涌诘恼{(diào)用，還不需要為我們自定義接口編寫任何一行代碼，已經(jīng)具備了常規(guī)的各種查詢和數(shù)據(jù)處理功能了。
我們完整的字典類型ApiCaller類的代碼如下所示。
namespace MyProject.Caller
{
/// <summary>
/// 字典類型對象的Web API調(diào)用處理
/// </summary>
public class DictTypeApiCaller : AsyncCrudApiCaller<DictTypeDto, string, DictTypePagedDto, CreateDictTypeDto, DictTypeDto>, IDictTypeAppService
{
/// <summary>
/// 提供單件對象使用
/// </summary>
public static DictTypeApiCaller Instance
{
get
{
return Singleton<DictTypeApiCaller>.Instance;
}
}
/// <summary>
/// 默認(rèn)構(gòu)造函數(shù)
/// </summary>
public DictTypeApiCaller()
{
this.DomainName = "DictType";//指定域?qū)ο竺Q，用于組裝接口地址
}
public async Task<Dictionary<string, string>> GetAllType(string dictTypeId)
{
AddRequestHeaders();//加入認(rèn)證的token頭信息
string url = GetActionUrl(MethodBase.GetCurrentMethod());//獲取訪問API的地址（未包含參數(shù)）
url += string.Format("?dictTypeId={0}", dictTypeId);
var result = await apiClient.GetAsync<Dictionary<string, string>>(url);
return result;
}
public async Task<IList<DictTypeNodeDto>> GetTree(string pid)
{
AddRequestHeaders();//加入認(rèn)證的token頭信息
string url = GetActionUrl(MethodBase.GetCurrentMethod());//獲取訪問API的地址（未包含參數(shù)）
url += string.Format("?pid={0}", pid);
var result = await apiClient.GetAsync<IList<DictTypeNodeDto>>(url);
return result;
}
}
這里面的函數(shù)定義才是我們需要根據(jù)實(shí)際的自定義接口封裝的調(diào)用類函數(shù)代碼。
前面我們介紹了，我們把ApiCaller層的項(xiàng)目設(shè)計(jì)為.net Standard的類庫項(xiàng)目，因此可以在.net core或者在.net framework中進(jìn)行使用，并且也在基于.net core的控制臺程序中測試成功了。
下面就重點(diǎn)介紹一下，基于.net framework的Winfrom程序中對ABP框架的Web API接口的調(diào)用，如果以后Winform支持.net core了（據(jù)說9月份出的.net core3就包含了），那么也一樣的模式進(jìn)行調(diào)用。
2）Winform對ApiCaller層的調(diào)用
我們先來看看字典模塊，通過封裝對ABP框架的Web API調(diào)用后，實(shí)際的功能界面效果吧。
先設(shè)計(jì)一個(gè)授權(quán)登錄的界面獲取訪問令牌信息。
字典管理界面，列出字典類型，并對字典類型下的字典數(shù)據(jù)進(jìn)行分頁展示，分頁展示利用分頁控件展示。
新增或者編輯窗體界面如下
這個(gè)界面是來自于我的框架里面的字典模塊界面，不過里面對數(shù)據(jù)的處理代碼確實(shí)已經(jīng)更改為適應(yīng)ABP框架的Web API接口的調(diào)用的了（基于ApiCaller 層的調(diào)用）。
我們下面來一一進(jìn)行分析即可。
登陸界面，我們看看主要的邏輯就是調(diào)用獲取授權(quán)令牌的接口，并存儲起來供后續(xù)界面中的業(yè)務(wù)類進(jìn)行調(diào)用即可。
由于我們自己封裝的ApiCaller類，都是基于異步的方式封裝的，因此我們可以看到很多地方調(diào)用都使用await的關(guān)鍵字，這個(gè)是異步調(diào)用的關(guān)鍵字，如果方法需要定義為異步，就需要增加async關(guān)鍵字，一般這兩個(gè)關(guān)鍵字是配套使用的。
如果我們在事件處理代碼里面使用了異步，那么事件的函數(shù)也需要標(biāo)記為async，如下是字典管理模塊窗體的加載函數(shù)，也是用了async聲明 和await調(diào)用異步方法標(biāo)記。
private async void FrmDictionary_Load(object sender, EventArgs e)
{
await InitTreeView();
this.lblDictType.Text = "";
await BindData();
//分頁控件事件處理代碼
this.winGridViewPager1.OnPageChanged += new EventHandler(winGridViewPager1_OnPageChanged);
this.winGridViewPager1.OnStartExport += new EventHandler(winGridViewPager1_OnStartExport);
this.winGridViewPager1.OnEditSelected += new EventHandler(winGridViewPager1_OnEditSelected);
this.winGridViewPager1.OnAddNew += new EventHandler(winGridViewPager1_OnAddNew);
this.winGridViewPager1.OnDeleteSelected += new EventHandler(winGridViewPager1_OnDeleteSelected);
this.winGridViewPager1.OnRefresh += new EventHandler(winGridViewPager1_OnRefresh);
this.winGridViewPager1.AppendedMenu = this.contextMenuStrip2;
this.winGridViewPager1.BestFitColumnWith = false;
this.winGridViewPager1.gridView1.DataSourceChanged += new EventHandler(gridView1_DataSourceChanged);
}
我們的數(shù)據(jù)，主要是在BindData里面實(shí)現(xiàn)，這個(gè)函數(shù)是我們自己加的，由于使用了異步方法，因此也用async進(jìn)行聲明。
整個(gè)對于分頁的數(shù)據(jù)獲取和控件的數(shù)據(jù)綁定過程，代碼如下所示。
/// <summary>
/// 獲取數(shù)據(jù)
/// </summary>
/// <returns></returns>
private async Task<IPagedResult<DictDataDto>> GetData()
{
//構(gòu)建分頁的條件和查詢條件
var pagerDto = new DictDataPagedDto(this.winGridViewPager1.PagerInfo)
{
DictType_ID = string.Concat(this.lblDictType.Tag)
};
var result = await DictDataApiCaller.Instance.GetAll(pagerDto);
return result;
}
/// <summary>
/// 綁定數(shù)據(jù)
/// </summary>
private async Task BindData()
{
#region 添加別名解析
this.winGridViewPager1.DisplayColumns = "Name,Value,Seq,Remark,EditTime";
this.winGridViewPager1.AddColumnAlias(Id_FieldName, "編號");
this.winGridViewPager1.AddColumnAlias("DictType_ID", "字典大類");
this.winGridViewPager1.AddColumnAlias("Name", "項(xiàng)目名稱");
this.winGridViewPager1.AddColumnAlias("Value", "項(xiàng)目值");
this.winGridViewPager1.AddColumnAlias("Seq", "字典排序");
this.winGridViewPager1.AddColumnAlias("Remark", "備注");
this.winGridViewPager1.AddColumnAlias("Editor", "修改用戶");
this.winGridViewPager1.AddColumnAlias("EditTime", "更新日期");
#endregion
if (this.lblDictType.Tag != null)
{
var result = await GetData();
//設(shè)置所有記錄數(shù)和列表數(shù)據(jù)源
this.winGridViewPager1.DataSource = result.Items;
this.winGridViewPager1.PagerInfo.RecordCount = result.TotalCount;
}
}
其中注意的是GetAll方式是傳入一個(gè)條件查詢的對象，這個(gè)就是DictDataPagedDto是我們定義的，放入我們DictDataDto里面的常見屬性，方便我們根據(jù)屬性匹配精確或者模糊查詢。
/// <summary>
/// 用于根據(jù)條件查詢
/// </summary>
public class DictDataPagedDto : PagedResultRequestDto
{
/// <summary>
/// 字典類型ID
/// </summary>
public virtual string DictType_ID { get; set; }
/// <summary>
/// 類型名稱
/// </summary>
public virtual string Name { get; set; }
/// <summary>
/// 指定值
/// </summary>
public virtual string Value { get; set; }
/// <summary>
/// 備注
/// </summary>
public virtual string Remark { get; set; }
}
我們在調(diào)用的時(shí)候，讓它限定為一個(gè)類型的ID進(jìn)行精確查詢，如下代碼
//構(gòu)建分頁的條件和查詢條件
var pagerDto = new DictDataPagedDto(this.winGridViewPager1.PagerInfo)
{
DictType_ID = string.Concat(this.lblDictType.Tag)
};
這個(gè)精確或者模糊查詢，則是在應(yīng)用服務(wù)層里面定義規(guī)則的，這個(gè)之前沒有詳細(xì)介紹了，這里稍微補(bǔ)充說明一下。
在應(yīng)用服務(wù)層接口類里面，重寫CreateFilteredQuery可以設(shè)置GetAll的查詢規(guī)則，重寫ApplySorting則可以指定列表的排序順序。
再次回到Winform界面的調(diào)用上來，刪除類型下面字典數(shù)據(jù)的事件的處理函數(shù)如下所示。
private async void menu_ClearData_Click(object sender, EventArgs e)
{
TreeNode selectedNode = this.treeView1.SelectedNode;
if (selectedNode != null && selectedNode.Tag != null)
{
string typeId = selectedNode.Tag.ToString();
var dict = await DictDataApiCaller.Instance.GetDictByTypeID(typeId);
int count = dict.Count;
var format = "您確定要?jiǎng)h除節(jié)點(diǎn)：{0}，該節(jié)點(diǎn)下面有【{1}】項(xiàng)數(shù)據(jù)";
format = JsonLanguage.Default.GetString(format);
string message = string.Format(format, selectedNode.Text, count);
if (MessageDxUtil.ShowYesNoAndWarning(message) == DialogResult.Yes)
{
try
{
await DictDataApiCaller.Instance.DeleteByTypeID(typeId);
await InitTreeView();
await BindData();
}
catch (Exception ex)
{
LogTextHelper.Error(ex);
MessageDxUtil.ShowError(ex.Message);
}
}
}
}
我們看看編輯窗體界面的后臺處理，編輯和更新數(shù)據(jù)的邏輯代碼如下所示。
#region 編輯大類
var info = await DictTypeApiCaller.Instance.Get(new EntityDto<string>(ID));
if (info != null)
{
SetInfo(info);
try
{
var updatedDto = await DictTypeApiCaller.Instance.Update(info);
if (updatedDto != null)
{
MessageDxUtil.ShowTips("保存成功");
this.DialogResult = DialogResult.OK;
}
}
catch (Exception ex)
{
LogTextHelper.Error(ex);
MessageDxUtil.ShowError(ex.Message);
}
}
#endregion
最后來一段gif動圖，展示程序的操作功能吧。
好了，這些事件的使用規(guī)則一旦確定了，我們好利用代碼生成工具對窗體界面的代碼進(jìn)行統(tǒng)一規(guī)則的生成，就好像我前面對于我Winform框架和混合框架里面的Winform窗體界面的生成一樣，我們只需要稍微修改一下代碼生成工具的NVelocity模板，利用上數(shù)據(jù)庫表的元數(shù)據(jù)就可以快速生成整個(gè)框架所需要的代碼了。
這樣基于整個(gè)ABP框架，而快速應(yīng)用起來的項(xiàng)目，其實(shí)開發(fā)項(xiàng)目的工作量看起來也不會很多，而且我們可以把字典、權(quán)限控制、整體框架等基礎(chǔ)設(shè)施建設(shè)好，就會形成一整套的開發(fā)方法和思路了，這樣對于我們利用ABP框架來開發(fā)業(yè)務(wù)系統(tǒng)，是不是有事半功倍的感覺。
一旦某個(gè)東西你很喜歡，你就會用的越來越好。
