在前面隨筆《ABP開發(fā)框架前后端開發(fā)系列---（9）ABP框架的權(quán)限控制管理》中介紹了基于ABP框架服務(wù)構(gòu)建的Winform客戶端，客戶端通過Web API調(diào)用的方式進(jìn)行獲取數(shù)據(jù)，從而實(shí)現(xiàn)了對組織機(jī)構(gòu)、角色移必、用戶蓄髓、權(quán)限等管理汪茧，其中沒有涉及菜單部分裂垦，本篇隨筆介紹在ABP框架中實(shí)現(xiàn)菜單的管理葡秒，菜單是作為Winform或者Web動(dòng)態(tài)構(gòu)建界面的一個(gè)重要元素魔招，同時(shí)也是作為角色權(quán)限控制的部分資源晰搀。
1、菜單的列表展示和管理
一般情況下办斑，菜單的樹形列表的顯示可以分為多個(gè)節(jié)點(diǎn)外恕，節(jié)點(diǎn)可以收縮也可以展開，當(dāng)然節(jié)點(diǎn)是有不同的圖標(biāo)的了乡翅。這樣就可以把很多功能點(diǎn)整合在一個(gè)樹列表里面了鳞疲，樹的節(jié)點(diǎn)也可以分為很多級別，很多層次
如果我們想按照業(yè)務(wù)的范疇來區(qū)分蠕蚜，也可以分為多個(gè)模塊展示尚洽，類似選項(xiàng)卡的方式，一個(gè)模塊的功能菜單列表集合在一起展示靶累，如下所示腺毫。
上面是我Winform開發(fā)框架和混合式開發(fā)框架的Winform界面中呈現(xiàn)菜單的界面癣疟，對于ABP開發(fā)框架來說，我們也只是獲取數(shù)據(jù)方式不同潮酒，業(yè)務(wù)范疇的管理也沒有什么不一樣争舞，我們依舊可以在服務(wù)器端配置好系統(tǒng)的菜單記錄，然后基于ABP的Winform界面澈灼，同樣管理這些內(nèi)容即可。
下面是ABP框架中對于菜單資源管理的列表界面店溢。
左邊我們通過TreeList列表進(jìn)行展示叁熔，右側(cè)通過分頁控件列表的方式進(jìn)行展示，還是比較標(biāo)準(zhǔn)的Winform界面展示床牧。
編輯或者創(chuàng)建菜單的界面如下所示荣回。
菜單對于角色來說，應(yīng)該是一種界面資源戈咳，可以通過配置進(jìn)行管理對應(yīng)角色用戶的菜單心软。
2、菜單模塊的實(shí)現(xiàn)邏輯
為了開發(fā)菜單模塊著蛙，我們需要先定義好菜單的存儲(chǔ)數(shù)據(jù)表删铃，定義菜單表和角色菜單的中間關(guān)系表如下所示。
這個(gè)菜單模塊定位為Web和Winform都通用的踏堡，因此菜單表中增加多了一些字段信息猎唁。
在數(shù)據(jù)庫里增加這兩個(gè)表后，就可以使用代碼生成工具進(jìn)行框架代碼的生成和Winform界面代碼的生成了顷蟆。
生成框架后诫隅，對應(yīng)的應(yīng)用服務(wù)層類代碼如下所示。
這個(gè)生成的類帐偎，默認(rèn)具有基類的增刪改查分頁等接口方法逐纬，同時(shí)我們也會(huì)生成對應(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)建分頁的條件和查詢條件
pagerDto = new MenuPagedDto(this.winGridViewPager1.PagerInfo)
{
PID = string.Concat(this.tree.FocusedNode.GetValue(Id_FieldName))
};
}
else
{
//構(gòu)建分頁的條件和查詢條件
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;
}
分頁控件的數(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)義
//獲取分頁數(shù)據(jù)列表
var result = await GetData();
//設(shè)置所有記錄數(shù)和列表數(shù)據(jù)源
this.winGridViewPager1.PagerInfo.RecordCount = result.TotalCount; //需先于DataSource的賦值，更新分頁信息
this.winGridViewPager1.DataSource = result.Items;
而TreeList列表是我們后來增加上去的仪际，需要額外進(jìn)行數(shù)據(jù)的綁定和處理围小，初始化樹列表處理代碼如下所示昵骤。
/// <summary>
/// 初始化樹控件
/// </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è)置樹的圖標(biāo)集合及逐級圖標(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;
};
//初始化樹節(jié)點(diǎn)選擇事件
this.tree.FocusedNodeChanged += delegate (object sender, FocusedNodeChangedEventArgs e)
{
this.FocusedNodeChanged();
};
}
獲取列表數(shù)據(jù)并綁定樹列表的數(shù)據(jù)源如下所示
/// <summary>
/// 綁定樹的數(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ù)據(jù)如下代碼所示肯适。
private async void FrmMenu_Load(object sender, EventArgs e)
{
//列表信息
InitTree();
InitSearchControl();
await BindTree();
}
刪除菜單的時(shí)候变秦，我們一般想把當(dāng)前菜單和下面的子菜單一并級聯(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)記刘绣，說明這個(gè)操作的原子性樱溉，全部成功就成功，否則失敗的處理纬凤。
而客戶端的Web API 封裝調(diào)用類福贞，對這個(gè)Web API接口的封裝，根據(jù)上篇隨筆《ABP開發(fā)框架前后端開發(fā)系列---（10）Web API調(diào)用類的簡化處理》簡化后的處理代碼如下所示停士。
3挖帘、角色菜單管理
菜單的管理整體操作和常規(guī)的業(yè)務(wù)表處理一樣，沒有太多特殊的地方恋技，下面介紹一下角色包含菜單的管理操作拇舀。
前面介紹了角色包含菜單的管理界面如下所示。
界面主要是列出所有菜單蜻底，并勾選上該角色可以使用的菜單你稚。這個(gè)角色包含的菜單和角色包含的權(quán)限處理上比較相似。
首先我們需要定義一個(gè)角色DTO對象中的菜單集合屬性朱躺，如下所示刁赖。
在界面上獲取勾選上的權(quán)限和菜單ID集合，存儲(chǔ)在對應(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)建角色對象
/// </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>
/// 更新角色對象
/// </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è)開發(fā)過程主要就是使用代碼生成工具來快速生成框架各個(gè)層的代碼，以及Winform界面的代碼良蛮，這樣在進(jìn)行一定的函數(shù)擴(kuò)展以及界面布局調(diào)整抽碌，就可以非常方便、高效的完整一個(gè)業(yè)務(wù)模塊的開發(fā)工作了决瞳。
