在前面隨筆《ABP開(kāi)發(fā)框架前后端開(kāi)發(fā)系列---（9）ABP框架的權(quán)限控制管理》中介紹了基于ABP框架服務(wù)構(gòu)建的Winform客戶端，客戶端通過(guò)Web API調(diào)用的方式進(jìn)行獲取數(shù)據(jù)，從而實(shí)現(xiàn)了對(duì)組織機(jī)構(gòu)、角色、用戶、權(quán)限等管理，其中沒(méi)有涉及菜單部分，本篇隨筆介紹在ABP框架中實(shí)現(xiàn)菜單的管理，菜單是作為Winform或者Web動(dòng)態(tài)構(gòu)建界面的一個(gè)重要元素，同時(shí)也是作為角色權(quán)限控制的部分資源。
1、菜單的列表展示和管理
一般情況下，菜單的樹(shù)形列表的顯示可以分為多個(gè)節(jié)點(diǎn)，節(jié)點(diǎn)可以收縮也可以展開(kāi)，當(dāng)然節(jié)點(diǎn)是有不同的圖標(biāo)的了。這樣就可以把很多功能點(diǎn)整合在一個(gè)樹(shù)列表里面了，樹(shù)的節(jié)點(diǎn)也可以分為很多級(jí)別，很多層次
如果我們想按照業(yè)務(wù)的范疇來(lái)區(qū)分，也可以分為多個(gè)模塊展示，類似選項(xiàng)卡的方式，一個(gè)模塊的功能菜單列表集合在一起展示，如下所示。
上面是我Winform開(kāi)發(fā)框架和混合式開(kāi)發(fā)框架的Winform界面中呈現(xiàn)菜單的界面，對(duì)于ABP開(kāi)發(fā)框架來(lái)說(shuō)，我們也只是獲取數(shù)據(jù)方式不同，業(yè)務(wù)范疇的管理也沒(méi)有什么不一樣，我們依舊可以在服務(wù)器端配置好系統(tǒng)的菜單記錄，然后基于ABP的Winform界面，同樣管理這些內(nèi)容即可。
下面是ABP框架中對(duì)于菜單資源管理的列表界面。
左邊我們通過(guò)TreeList列表進(jìn)行展示，右側(cè)通過(guò)分頁(yè)控件列表的方式進(jìn)行展示，還是比較標(biāo)準(zhǔn)的Winform界面展示。
編輯或者創(chuàng)建菜單的界面如下所示。
菜單對(duì)于角色來(lái)說(shuō)，應(yīng)該是一種界面資源，可以通過(guò)配置進(jìn)行管理對(duì)應(yīng)角色用戶的菜單。
2、菜單模塊的實(shí)現(xiàn)邏輯
為了開(kāi)發(fā)菜單模塊，我們需要先定義好菜單的存儲(chǔ)數(shù)據(jù)表，定義菜單表和角色菜單的中間關(guān)系表如下所示。
這個(gè)菜單模塊定位為Web和Winform都通用的，因此菜單表中增加多了一些字段信息。
在數(shù)據(jù)庫(kù)里增加這兩個(gè)表后，就可以使用代碼生成工具進(jìn)行框架代碼的生成和Winform界面代碼的生成了。
生成框架后，對(duì)應(yīng)的應(yīng)用服務(wù)層類代碼如下所示。
這個(gè)生成的類，默認(rèn)具有基類的增刪改查分頁(yè)等接口方法，同時(shí)我們也會(huì)生成對(duì)應(yīng)的Web API Caller層的類代碼，代碼如下所示。
Winform界面生成標(biāo)準(zhǔn)界面后進(jìn)行布局的一定調(diào)整，左側(cè)增加TreeList控件，設(shè)計(jì)界面如下所示。
獲取列表數(shù)據(jù)的函數(shù)定義在GetData函數(shù)里面，函數(shù)代碼如下所示。
/// <summary>
/// 獲取數(shù)據(jù)
/// </summary>
/// <returns></returns>
private async Task<IPagedResult<MenuDto>> GetData()
{
MenuPagedDto pagerDto = null;
if (advanceCondition != null)
{
pagerDto = new MenuPagedDto(this.winGridViewPager1.PagerInfo);
pagerDto = dlg.GetPagedResult(pagerDto);
}
else if(!IsNormalSearch && this.tree.FocusedNode != null)
{
//構(gòu)建分頁(yè)的條件和查詢條件
pagerDto = new MenuPagedDto(this.winGridViewPager1.PagerInfo)
{
PID = string.Concat(this.tree.FocusedNode.GetValue(Id_FieldName))
};
}
else
{
//構(gòu)建分頁(yè)的條件和查詢條件
pagerDto = new MenuPagedDto(this.winGridViewPager1.PagerInfo)
{
//添加所需條件
Name = this.txtName.Text.Trim(),
WinformType = this.txtWinformType.Text.Trim()
};
}
var result = await MenuApiCaller.Instance.GetAll(pagerDto);
return result;
}
分頁(yè)控件的數(shù)據(jù)綁定代碼如下所示，這些都是根據(jù)Winform界面配置自動(dòng)生成的代碼。
this.winGridViewPager1.DisplayColumns = "EmbedIcon,Name,Seq,Visible,Expand,WinformType,Tag,CreationTime";
this.winGridViewPager1.ColumnNameAlias = await MenuApiCaller.Instance.GetColumnNameAlias();//字段列顯示名稱轉(zhuǎn)義
//獲取分頁(yè)數(shù)據(jù)列表
var result = await GetData();
//設(shè)置所有記錄數(shù)和列表數(shù)據(jù)源
this.winGridViewPager1.PagerInfo.RecordCount = result.TotalCount; //需先于DataSource的賦值，更新分頁(yè)信息
this.winGridViewPager1.DataSource = result.Items;
而TreeList列表是我們后來(lái)增加上去的，需要額外進(jìn)行數(shù)據(jù)的綁定和處理，初始化樹(shù)列表處理代碼如下所示。
/// <summary>
/// 初始化樹(shù)控件
/// </summary>
private void InitTree()
{
this.tree.Columns.Clear();
//控件擴(kuò)展函數(shù)封裝處理
this.tree.CreateColumn("Name", "菜單名稱", 160, true);
this.tree.InitTree("Id", "PID", null, false, false);
//設(shè)置樹(shù)的圖標(biāo)集合及逐級(jí)圖標(biāo)
this.tree.SelectImageList = this.imageCollection1;
this.tree.CustomDrawNodeImages += (object sender, CustomDrawNodeImagesEventArgs e) =>
{
int maxCount = this.imageCollection1.Images.Count;
var index = e.Node.Level < maxCount ? e.Node.Level : 0;
e.SelectImageIndex = index;
};
//初始化樹(shù)節(jié)點(diǎn)選擇事件
this.tree.FocusedNodeChanged += delegate (object sender, FocusedNodeChangedEventArgs e)
{
this.FocusedNodeChanged();
};
}
獲取列表數(shù)據(jù)并綁定樹(shù)列表的數(shù)據(jù)源如下所示
/// <summary>
/// 綁定樹(shù)的數(shù)據(jù)源
/// </summary>
private async Task BindTree()
{
var pageDto = new MenuPagedDto();
var result = await MenuApiCaller.Instance.GetAll(pageDto);
this.tree.DataSource = result.Items;
this.tree.ExpandAll();
}
而界面顯示的時(shí)候，加載并顯示左側(cè)樹(shù)列表數(shù)據(jù)如下代碼所示。
private async void FrmMenu_Load(object sender, EventArgs e)
{
//列表信息
InitTree();
InitSearchControl();
await BindTree();
}
刪除菜單的時(shí)候，我們一般想把當(dāng)前菜單和下面的子菜單一并級(jí)聯(lián)刪除，實(shí)現(xiàn)這個(gè)方法，我們需要在服務(wù)端自定義實(shí)現(xiàn)，如下是應(yīng)用服務(wù)層的實(shí)現(xiàn)方法。
/// <summary>
/// 移除節(jié)點(diǎn)和子節(jié)點(diǎn)
/// </summary>
/// <param name="input"></param>
/// <returns></returns>
[UnitOfWork]
public virtual async Task DeleteWithSubNode(EntityDto<string> input)
{
var children = await _repository.GetAllListAsync(ou => ou.PID == input.Id);
foreach (var child in children)
{
await DeleteWithSubNode(new EntityDto<string>(child.Id));//遞歸刪除
}
await _repository.DeleteAsync(input.Id);
}
我們這里顯示聲明了UnitOfWork標(biāo)記，說(shuō)明這個(gè)操作的原子性，全部成功就成功，否則失敗的處理。
而客戶端的Web API 封裝調(diào)用類，對(duì)這個(gè)Web API接口的封裝，根據(jù)上篇隨筆《ABP開(kāi)發(fā)框架前后端開(kāi)發(fā)系列---（10）Web API調(diào)用類的簡(jiǎn)化處理》簡(jiǎn)化后的處理代碼如下所示。
3、角色菜單管理
菜單的管理整體操作和常規(guī)的業(yè)務(wù)表處理一樣，沒(méi)有太多特殊的地方，下面介紹一下角色包含菜單的管理操作。
前面介紹了角色包含菜單的管理界面如下所示。
界面主要是列出所有菜單，并勾選上該角色可以使用的菜單。這個(gè)角色包含的菜單和角色包含的權(quán)限處理上比較相似。
首先我們需要定義一個(gè)角色DTO對(duì)象中的菜單集合屬性，如下所示。
在界面上獲取勾選上的權(quán)限和菜單ID集合，存儲(chǔ)在對(duì)應(yīng)的列表里面。
/// <summary>
/// 編輯或者保存狀態(tài)下取值函數(shù)
/// </summary>
/// <param name="info"></param>
private void SetInfo(RoleDto info)
{
info.DisplayName = txtDisplayName.Text;
info.Name = txtName.Text;
info.Description = txtDescription.Text;
info.Permissions = GetNodeValues(this.tree, "Name");
info.Menus = GetNodeValues(this.treeMenu, "Id");
}
在應(yīng)用服務(wù)層的RoleAppService類里面，我們創(chuàng)建或者更新角色的時(shí)候，需要更新它的權(quán)限和菜單資源，如下代碼是創(chuàng)建角色的函數(shù)。
/// <summary>
/// 創(chuàng)建角色對(duì)象
/// </summary>
/// <param name="input"></param>
/// <returns></returns>
public override async Task<RoleDto> Create(CreateRoleDto input)
{
CheckCreatePermission();
var role = ObjectMapper.Map<Role>(input);
role.SetNormalizedName();
CheckErrors(await _roleManager.CreateAsync(role));
await CurrentUnitOfWork.SaveChangesAsync(); //It's done to get Id of the role.
await UpdateGrantedPermissions(role, input.Permissions);
await UpdateGrantedMenus(role, input.Menus);
return MapToEntityDto(role);
}
同理，更新角色一樣處理這兩個(gè)部分的資源
/// <summary>
/// 更新角色對(duì)象
/// </summary>
/// <param name="input"></param>
/// <returns></returns>
public override async Task<RoleDto> Update(RoleDto input)
{
CheckUpdatePermission();
var role = await _roleManager.GetRoleByIdAsync(input.Id);
ObjectMapper.Map(input, role);
CheckErrors(await _roleManager.UpdateAsync(role));
await UpdateGrantedPermissions(role, input.Permissions);
await UpdateGrantedMenus(role, input.Menus);
return MapToEntityDto(role);
}
以上就是菜單的管理，和角色包含菜單的維護(hù)操作，整個(gè)開(kāi)發(fā)過(guò)程主要就是使用代碼生成工具來(lái)快速生成框架各個(gè)層的代碼，以及Winform界面的代碼，這樣在進(jìn)行一定的函數(shù)擴(kuò)展以及界面布局調(diào)整，就可以非常方便、高效的完整一個(gè)業(yè)務(wù)模塊的開(kāi)發(fā)工作了。
