基於DDD的現代ASP.NET開發框架--ABP系列之22、ABP展現層——導航欄設定

ABP是“ASP.NET Boilerplate Project (ASP.NET樣板專案)”的簡稱。

每一個WEB應用程式都有導航選單，Abp也為使用者提供了通用的建立和顯示選單方式。

建立選單

一個應用程式可能包含不同的模組，而每個模組都可能有它自己的選單項。在Abp中，需要建立一個派生自NavigationProvider的類來定義一個選單項。

假設我們有一個這樣的主選單：

• Tasks
• Reports
• Administration 1 User Management 2 Role Management

由上可知，Administration選單項有兩個子選單項。對應的生成方法如下：

public class SimpleTaskSystemNavigationProvider : NavigationProvider
{
    public override void SetNavigation(INavigationProviderContext context)
    {
        context.Manager.MainMenu
            .AddItem(
                new MenuItemDefinition(
                    
 
"Tasks",
                    new LocalizableString("Tasks", "SimpleTaskSystem"),
                    url: "/Tasks",
                    icon: "fa fa-tasks"
                    )
            ).AddItem(
                new MenuItemDefinition(
                    "Reports",
                    new
 
 LocalizableString("Reports", "SimpleTaskSystem"),
                    url: "/Reports",
                    icon: "fa fa-bar-chart"
                    )
            ).AddItem(
                new MenuItemDefinition(
                    "Administration",
                    new LocalizableString("Administration", "SimpleTaskSystem"),
                    icon: "fa fa-cogs"
                    ).AddItem(
                        new MenuItemDefinition(
                            "UserManagement",
                            new LocalizableString("UserManagement", "SimpleTaskSystem"),
                            url: "/Administration/Users",
                            icon: "fa fa-users",
                            requiredPermissionName: "SimpleTaskSystem.Permissions.UserManagement"
                            )
                    ).AddItem(
                        new MenuItemDefinition(
                            "RoleManagement",
                            new LocalizableString("RoleManagement", "SimpleTaskSystem"),
                            url: "/Administration/Roles",
                            icon: "fa fa-star",
                            requiredPermissionName: "SimpleTaskSystem.Permissions.RoleManagement"
                            )
                    )
            );
    }
}

MenuItemDefinition可以有一個唯一的名字，一個用於本地化顯示的名字，一個url和一個icon，此外，選單項可能需要與特定使用者許可權相結合（相關許可權系統正在開發，暫時還沒有說明文件）。

InavigationProviderContext方法能夠獲取現有的選單項、新增選單或選單項。因此，不同的模組可以新增各自的選單。

建立完成導航後，還需要在對應模組預初始化時註冊到Abp配置檔案中：

Configuration.Navigation.Providers.Add<SimpleTaskSystemNavigationProvider>(); 

顯示選單

IuserNavigationManager可以注入、獲取和顯示選單。可以在伺服器端建立選單。

Abp自動生成的javascript API使得使用者能夠在客戶端獲取選單，對應的方法和物件在名稱空間abp.nav中。例如，在客戶端使用abp.nav.menus.MainMenu可以用來獲取主選單。

以上文件展示了Abp如何給使用者建立和顯示選單，你可以嘗試建立模版、檢視原始碼以便更深入的學習。

希望更多國內的架構師能關注到ABP這個專案，也許這其中有能幫助到您的地方，也許有您的參與，這個專案可以發展得更好。

歡迎加QQ群：

ABP架構設計交流群：134710707       ABP架構設計交流2群： 579765441