造轮子之菜单管理

合集 - asp.net core入门到造轮子(34)

1.asp.net core入门到造轮子-目录07-242.asp.net core之Startup07-243.asp.net core之依赖注入07-254.asp.net core之中间件07-265.asp.net core之Host07-276.asp.net core之Kestrel07-277.asp.net core之配置07-278.asp.net core之Options07-319.asp.net core之日志08-0110.asp.net core之路由08-0211.asp.net core之异常处理08-0312.asp.net core之HttpClient08-0413.asp.net core之实时应用08-0414.asp.net core之EfCore08-0715.造轮子之自动依赖注入10-0816.造轮子之日志10-0817.造轮子之统一业务异常处理10-0818.造轮子之统一请求响应格式10-0819.造轮子之缓存10-0820.造轮子之ORM集成10-0821.造轮子之asp.net core identity10-0922.造轮子之自定义授权策略10-0923.造轮子之权限管理10-1024.造轮子之多语言管理10-1125.造轮子之角色管理10-1226.造轮子之用户管理10-12

27.造轮子之菜单管理10-12

28.造轮子之属性注入配合懒加载构建服务抽象基类10-1229.造轮子之EventBus10-1230.造轮子之消息实时推送10-1331.造轮子之种子数据10-1632.造轮子之集成GraphQL10-1633.造轮子之设置管理10-1934.造轮子之文件管理10-23

收起

前面完成了基础管理的相关API，接下来就得做一个菜单管理了，用于对接管理后台前端界面。

设计菜单结构#

菜单是一个多级结构，所以我们得设计一个树形的。包含自己上级和下级的属性。同时预留Permission用于做可选的权限限制。

namespace Wheel.Domain.Menus
{
    /// 

    /// 菜单
    /// 
    public class Menu : Entity<Guid>
    {
        /// 

        /// 名称
        /// 
        public string Name { get; set; }
        /// 

        /// 显示名称
        /// 
        public string DisplayName { get; set; }
        /// 

        /// 菜单类型
        /// 
        public MenuType MenuType { get; set; }
        /// 

        /// 菜单路径
        /// 
        public string? Path { get; set; }
        /// 

        /// 权限名称
        /// 
        public string? Permission { get; set; }
        /// 

        /// 图标
        /// 
        public string? Icon { get; set; }
        /// 

        /// 排序
        /// 
        public int Sort { get; set; }
        /// 

        /// 上级菜单Id
        /// 
        public virtual Guid? ParentId { get; set; }
        /// 

        /// 上级菜单
        /// 
        public virtual Menu? Parent { get; set; }
        /// 

        /// 子菜单
        /// 
        public virtual List Children { get; set; }
    }
}

然后菜单和角色关联。创建RoleMenu表。

namespace Wheel.Domain.Menus
{
    public class RoleMenu
    {
        public virtual string RoleId { get; set; }
        public virtual Role Role { get; set; }
        public virtual Guid MenuId { get; set; }
        public virtual Menu Menu { get; set; }
    }
}

修改DbContext#

接下来还是老套路，修改WheelDbContext
添加代码：

#region Menu
public DbSet Menus { get; set; }
public DbSet RoleMenus { get; set; }
#endregion

protected override void OnModelCreating(ModelBuilder builder)
{
    base.OnModelCreating(builder);

    ConfigureIdentity(builder);
    ConfigureLocalization(builder);
    ConfigurePermissionGrants(builder);
    ConfigureMenus(builder);
}

void ConfigureMenus(ModelBuilder builder)
{
    builder.Entity(b =>
    {
        b.HasKey(o => o.Id);
        b.Property(o => o.Permission).HasMaxLength(128);
        b.Property(o => o.Path).HasMaxLength(128);
        b.Property(o => o.Name).HasMaxLength(128);
        b.Property(o => o.Icon).HasMaxLength(128);
        b.Property(o => o.DisplayName).HasMaxLength(128);
        b.HasMany(o => o.Children).WithOne(o => o.Parent);
        b.HasIndex(o => o.ParentId);
    });
    builder.Entity(b =>
    {
        b.HasKey(o => new { o.MenuId, o.RoleId });
        b.Property(o => o.RoleId).HasMaxLength(36);
    });
}

然后执行数据库迁移命令即可完成表创建。

实现菜单管理#

接下来就可以来实现我们的菜单管理相关功能了。

实现MenuAppService#

IMenuAppService

namespace Wheel.Services.Menus
{
    public interface IMenuAppService : ITransientDependency
    {
        Task Create(CreateOrUpdateMenuDto dto);
        Task Update(Guid id, CreateOrUpdateMenuDto dto);
        Task Delete(Guid id);
        Task> GetById(Guid id);
        Task>> GetList();
        Task>> GetRoleMenuList(string roleId);
        Task>> GetCurrentMenu();
        Task UpdateRoleMenu(string roleId, UpdateRoleMenuDto dto);
    }
}

MenuAppService

namespace Wheel.Services.Menus
{
    public class MenuAppService : WheelServiceBase, IMenuAppService
    {
        private readonly IBasicRepository _menuRepository;
        private readonly IBasicRepositorystring> _roleRepository;
        private readonly IBasicRepository _roleMenuRepository;

        public MenuAppService(IBasicRepository menuRepository)
        {
            _menuRepository = menuRepository;
        }

        public async Task Create(CreateOrUpdateMenuDto dto)
        {
            var menu = Mapper.Map(dto);
            menu.Id = GuidGenerator.Create();
            await _menuRepository.InsertAsync(menu, true);
            return new R();
        }

        public async Task Update(Guid id,CreateOrUpdateMenuDto dto)
        {
            var menu = await _menuRepository.FindAsync(id);
            if(menu != null) 
            {
                Mapper.Map(dto, menu);
                await _menuRepository.UpdateAsync(menu, true);
            }
            return new R();
        }
        public async Task Delete(Guid id)
        {
            await _menuRepository.DeleteAsync(id, true);
            return new R();
        }
        public async Task> GetById(Guid id)
        {
            var menu = await _menuRepository.FindAsync(id);

            var dto = Mapper.Map(menu);
            return new R(dto);
        }
        public async Task>> GetList()
        {
            var items = await _menuRepository.GetListAsync(
                a => a.ParentId == null,
                propertySelectors: a=>a.Children
                );
            items.ForEach(a => a.Children = a.Children.OrderBy(b => b.Sort).ToList());
            items = items.OrderBy(a => a.Sort).ToList();
            var resultItems = Mapper.Map>(items);
            return new R>(resultItems);
        }
        public async Task UpdateRoleMenu(string roleId, UpdateRoleMenuDto dto)
        {
            using (var uow = await UnitOfWork.BeginTransactionAsync())
            {
                if (await _roleMenuRepository.AnyAsync(a => a.RoleId == roleId))
                {
                    await _roleMenuRepository.DeleteAsync(a => a.RoleId == roleId);
                }
                if(dto.MenuIds.Any())
                {
                    var roleMenus = dto.MenuIds.Select(a => new RoleMenu { RoleId = roleId, MenuId = a });
                    await _roleMenuRepository.InsertManyAsync(roleMenus.ToList());
                }
                await uow.CommitAsync();
            }
            return new R();
        }
        public async Task>> GetRoleMenuList(string roleId)
        {
            var items = await _roleMenuRepository.SelectListAsync(a => a.RoleId == roleId && a.Menu.ParentId == null, a => a.Menu, propertySelectors: a => a.Menu.Children);
            items.ForEach(a => a.Children = a.Children.OrderBy(b => b.Sort).ToList());
            items = items.OrderBy(a => a.Sort).ToList();
            var resultItems = Mapper.Map>(items);
            return new R>(resultItems);
        }

        public async Task>> GetCurrentMenu()
        {
            if (CurrentUser.IsInRoles("admin"))
            {
                var menus = await _menuRepository.GetListAsync(a => a.ParentId == null);
                return new R>(MaptoAntdMenu(menus));
            }
            else
            {
                var roleIds = await _roleRepository.SelectListAsync(a => CurrentUser.Roles.Contains(a.Name), a => a.Id);
                var menus = await _roleMenuRepository.SelectListAsync(a => roleIds.Contains(a.RoleId) && a.Menu.ParentId == null, a => a.Menu, propertySelectors: a => a.Menu.Children);

                return new R>(MaptoAntdMenu(menus.DistinctBy(a=>a.Id).ToList()));
            }
        }

        private List MaptoAntdMenu(List menus)
        {
            return menus.OrderBy(m => m.Sort).Select(m =>
            {
                var result = new AntdMenuDto
                {
                    Name = m.Name,
                    Icon = m.Icon,
                    Path = m.Path,
                    Access = m.Permission
                };
                if(m.Children != null && m.Children.Count > 0)
                {
                    result.Children = MaptoAntdMenu(m.Children);
                }
                return result;
            }).ToList();
        }
    }
}

实现MenuController#

namespace Wheel.Controllers
{
    /// 

    /// 菜单管理
    /// 
    [Route("api/[controller]")]
    [ApiController]
    public class MenuController : WheelControllerBase
    {
        private readonly IMenuAppService _menuAppService;

        public MenuController(IMenuAppService menuAppService)
        {
            _menuAppService = menuAppService;
        }
        /// 

        /// 新增菜单
        /// 
        /// 
        /// 
        [HttpPost()]
        public Task Create(CreateOrUpdateMenuDto dto)
        {
            return _menuAppService.Create(dto);
        }
        /// 

        /// 删除菜单
        /// 
        /// 
        /// 
        [HttpDelete("{id}")]
        public Task Delete(Guid id)
        {
            return _menuAppService.Delete(id);
        }
        /// 

        /// 获取单个菜单详情
        /// 
        /// 
        /// 
        [HttpGet("{id}")]
        public Task> GetById(Guid id)
        {
            return _menuAppService.GetById(id);
        }
        /// 

        /// 查询菜单列表
        /// 
        /// 
        [HttpGet]
        public Task>> GetList()
        {
            return _menuAppService.GetList();
        }
        /// 

        /// 修改菜单
        /// 
        /// 
        /// 
        /// 
        [HttpPut("{id}")]
        public Task Update(Guid id, CreateOrUpdateMenuDto dto)
        {
            return _menuAppService.Update(id, dto);
        }
        /// 

        /// 修改角色菜单
        /// 
        /// 
        /// 
        /// 
        [HttpPut("role/{roleId}")]
        public Task UpdateRoleMenu(string roleId, UpdateRoleMenuDto dto)
        {
            return _menuAppService.UpdateRoleMenu(roleId, dto);
        }
        /// 

        /// 获取角色菜单列表
        /// 
        /// 
        /// 
        [HttpGet("role/{roleId}")]
        public Task>> GetRoleMenuList(string roleId)
        {
            return _menuAppService.GetRoleMenuList(roleId);
        }
    }
}

就这样我们就完成了菜单管理相关的API功能，包含菜单的增删查改和角色菜单绑定功能。
到这里我们最基础的后台管理功能API基本开发完成。

轮子仓库地址https://github.com/Wheel-Framework/Wheel
欢迎进群催更。