DIV CSS 佈局教程網

用 Bootstrap Metronic 做後台菜單:無限層級的遞迴拼接筆記
編輯:關於JavaScript     

接續上一篇 Metronic 模板的整理,這次把重點放在菜單欄。Metronic 本身並沒有現成的動態菜單機制,所以我們得自己從資料庫把資料讀出來、再手工拼成 HTML。以下記錄整個流程,包含環境配置、資料表設計,以及最關鍵的遞迴拼接。

一、這次要處理的四件事

1. 環境配置
2. 提取頁面骨架
3. 動態生成菜單(支援無限層級)

二、系統環境

因為菜單需要資料支撐,這裡採用 MVC 5.0 + EF 6.0(搭配 SQL Server)。

· 執行環境:VS2013 + MVC 5.0 + EF 6.1 + SQL Server 2012
· 解決方案名稱:AppSolution
· 專案:App.Web(UI 層)與 App.Models(資料存取層),採用直接存取模式

接著把 theme 資料夾下的所有檔案複製到 MVC 的 Content 目錄,並把 admin 的 index.html 內容搬到 _Layout.cshtml 裡準備改造。

 

三、建立資料庫與資料表

資料庫名稱為 AppDataBase,先建立 SysModule 資料表,再產生 AppDB.edmx。

 USE [AppDataBase]
GO
/****** Object: Table [dbo].[SysModule] Script Date: 2015/9/15 21:03:39 ******/
SET ANSI_NULLS ON
GO
SET QUOTED_IDENTIFIER ON
GO
SET ANSI_PADDING ON
GO
CREATE TABLE [dbo].[SysModule](
 [ID] [varchar](50) NOT NULL,          -- 主鍵 ID
 [Name] [varchar](50) NOT NULL,        -- 菜單名稱
 [ParentID] [varchar](50) NULL,        -- 上級 ID
 [Url] [varchar](200) NULL,            -- URL
 [Iconic] [varchar](200) NULL,         -- 圖示
 [Sort] [int] NULL,                    -- 排序
 [Enable] [bit] NOT NULL,              -- 是否顯示
 [CreateTime] [datetime] NULL,         -- 建立時間
 [IsLast] [bit] NOT NULL               -- 是否為最後一項
 CONSTRAINT [PK_SysModule] PRIMARY KEY CLUSTERED (
 [Id] ASC
 )WITH (PAD_INDEX = OFF, STATISTICS_NORECOMPUTE = OFF, IGNORE_DUP_KEY = OFF,
        ALLOW_ROW_LOCKS = ON, ALLOW_PAGE_LOCKS = ON) ON [PRIMARY]
) ON [PRIMARY]
GO
SET ANSI_PADDING OFF
GO
ALTER TABLE [dbo].[SysModule] WITH NOCHECK
 ADD CONSTRAINT [FK_SysModule_SysModule] FOREIGN KEY([ParentID])
 REFERENCES [dbo].[SysModule] ([Id])
GO
ALTER TABLE [dbo].[SysModule] NOCHECK CONSTRAINT [FK_SysModule_SysModule]
GO

這個設計的關鍵在於 ParentID 自我參照——每筆記錄的父層也是同一張表裡的記錄,這正是樹狀結構在關聯式資料庫中最典型的表達方式。

接著手動塞一些測試資料進去:

 INSERT INTO [SysModule] ([ID],[Name],[ParentID],[Url],[Iconic],[Sort],[Enable],[CreateTime],[IsLast]) values ('0','root','root','Index','icon-settings',NULL,0,NULL,0)
 INSERT INTO [SysModule] ([ID],[Name],[ParentID],[Url],[Iconic],[Sort],[Enable],[CreateTime],[IsLast]) values ('1','一級菜單01','0','Index','icon-settings',NULL,0,NULL,0)
 INSERT INTO [SysModule] ([ID],[Name],[ParentID],[Url],[Iconic],[Sort],[Enable],[CreateTime],[IsLast]) values ('11','二級菜單01-01','1','Index','icon-settings',NULL,0,NULL,0)
 INSERT INTO [SysModule] ([ID],[Name],[ParentID],[Url],[Iconic],[Sort],[Enable],[CreateTime],[IsLast]) values ('111','三級菜單01-01-01','11','Index','icon-link',NULL,0,NULL,1)
 INSERT INTO [SysModule] ([ID],[Name],[ParentID],[Url],[Iconic],[Sort],[Enable],[CreateTime],[IsLast]) values ('112','三級菜單01-01-02','11','Index','icon-settings',NULL,0,NULL,1)
 INSERT INTO [SysModule] ([ID],[Name],[ParentID],[Url],[Iconic],[Sort],[Enable],[CreateTime],[IsLast]) values ('12','二級菜單01-02','1','Index','icon-link',NULL,0,NULL,1)
 INSERT INTO [SysModule] ([ID],[Name],[ParentID],[Url],[Iconic],[Sort],[Enable],[CreateTime],[IsLast]) values ('13','二級菜單01-03','1','Index','icon-link',NULL,0,NULL,1)
 INSERT INTO [SysModule] ([ID],[Name],[ParentID],[Url],[Iconic],[Sort],[Enable],[CreateTime],[IsLast]) values ('2','一級菜單02','0','Index','icon-settings',NULL,0,NULL,0)
 INSERT INTO [SysModule] ([ID],[Name],[ParentID],[Url],[Iconic],[Sort],[Enable],[CreateTime],[IsLast]) values ('21','二級菜單02-01','2','Index','icon-settings',NULL,0,NULL,0)
 INSERT INTO [SysModule] ([ID],[Name],[ParentID],[Url],[Iconic],[Sort],[Enable],[CreateTime],[IsLast]) values ('211','三級菜單02-01-01','5','Index','icon-link',NULL,0,NULL,1)
 INSERT INTO [SysModule] ([ID],[Name],[ParentID],[Url],[Iconic],[Sort],[Enable],[CreateTime],[IsLast]) values ('212','三級菜單02-01-02','5','Index','icon-link',NULL,0,NULL,1)
 INSERT INTO [SysModule] ([ID],[Name],[ParentID],[Url],[Iconic],[Sort],[Enable],[CreateTime],[IsLast]) values ('22','二級菜單02-02','2','Index','icon-link',NULL,0,NULL,1)
 INSERT INTO [SysModule] ([ID],[Name],[ParentID],[Url],[Iconic],[Sort],[Enable],[CreateTime],[IsLast]) values ('23','二級菜單02-03','2','Index','icon-link',NULL,0,NULL,1)
 INSERT INTO [SysModule] ([ID],[Name],[ParentID],[Url],[Iconic],[Sort],[Enable],[CreateTime],[IsLast]) values ('3','一級菜單03','0','Index','icon-settings',NULL,0,NULL,0)
 INSERT INTO [SysModule] ([ID],[Name],[ParentID],[Url],[Iconic],[Sort],[Enable],[CreateTime],[IsLast]) values ('31','二級菜單03-01','3','Index','icon-settings',NULL,0,NULL,0)
 INSERT INTO [SysModule] ([ID],[Name],[ParentID],[Url],[Iconic],[Sort],[Enable],[CreateTime],[IsLast]) values ('311','三級菜單03-01-01','31','Index','icon-link',NULL,0,NULL,1)
 INSERT INTO [SysModule] ([ID],[Name],[ParentID],[Url],[Iconic],[Sort],[Enable],[CreateTime],[IsLast]) values ('312','三級菜單03-01-02','31','Index','icon-link',NULL,0,NULL,1)
 INSERT INTO [SysModule] ([ID],[Name],[ParentID],[Url],[Iconic],[Sort],[Enable],[CreateTime],[IsLast]) values ('32','二級菜單03-02','3','Index','icon-link',NULL,0,NULL,1)
 INSERT INTO [SysModule] ([ID],[Name],[ParentID],[Url],[Iconic],[Sort],[Enable],[CreateTime],[IsLast]) values ('33','二級菜單03-03','3','Index','icon-link',NULL,0,NULL,1)
 INSERT INTO [SysModule] ([ID],[Name],[ParentID],[Url],[Iconic],[Sort],[Enable],[CreateTime],[IsLast]) values ('4','一級菜單04','0','Index','icon-settings',NULL,0,NULL,0)
 INSERT INTO [SysModule] ([ID],[Name],[ParentID],[Url],[Iconic],[Sort],[Enable],[CreateTime],[IsLast]) values ('41','二級菜單04-01','4','Index','icon-link',NULL,0,NULL,1)
 INSERT INTO [SysModule] ([ID],[Name],[ParentID],[Url],[Iconic],[Sort],[Enable],[CreateTime],[IsLast]) values ('42','二級菜單04-02','4','Index','icon-link',NULL,0,NULL,1)
(22 行受影響)

四、提取頁面骨架

後台系統通常保留四個區塊:top(頁首)、left menu(側邊選單)、content(內容)、foot(頁尾)。Metronic 的 index.html 相當長,這裡只保留改造時真正需要動到的部分:

 <!DOCTYPE html>
<html lang="en" class="no-js">
<head>
 <meta charset="utf-8" />
 <title>Metronic | 版面展示</title>
 <meta http-equiv="X-UA-Compatible" content="IE=edge">
 <meta content="width=device-width, initial-scale=1" name="viewport" />

 <!-- 全域樣式 -->
 <link href="~/Content/assets/global/plugins/font-awesome/css/font-awesome.min.css" rel="stylesheet" type="text/css" />
 <link href="~/Content/assets/global/plugins/bootstrap/css/bootstrap.min.css" rel="stylesheet" type="text/css" />

 <!-- 主題樣式 -->
 <link href="~/Content/assets/global/css/components.css" id="style_components" rel="stylesheet" type="text/css" />
 <link href="~/Content/assets/admin/layout/css/layout.css" rel="stylesheet" type="text/css" />
 <link href="~/Content/assets/admin/layout/css/themes/darkblue.css" rel="stylesheet" type="text/css" id="style_color" />
 <link href="~/Content/assets/admin/layout/css/custom.css" rel="stylesheet" type="text/css" />
</head>
<body class="page-header-fixed page-quick-sidebar-over-content
             page-sidebar-closed-hide-logo page-container-bg-solid">

 <!-- ========== HEADER ========== -->
 <div class="page-header navbar navbar-fixed-top">
 <div class="page-header-inner">
 <div class="page-logo">
 <a href="index.html">
 <img src="~/Content/assets/admin/layout/img/logo.png" alt="logo" class="logo-default" />
 </a>
 <div class="menu-toggler sidebar-toggler hide"></div>
 </div>
 <!-- 此處省略通知、收件匣、待辦、使用者選單等 dropdown,結構皆為
 <ul class="nav navbar-nav pull-right"> 底下的一串 <li class="dropdown"> -->
 </div>
 </div>

 <div class="clearfix"></div>

 <!-- ========== CONTAINER ========== -->
 <div class="page-container">

 <!-- SIDEBAR:菜單就換掉這一段 -->
 <div class="page-sidebar-wrapper">
 <div class="page-sidebar navbar-collapse collapse">
 <ul class="page-sidebar-menu" data-keep-expanded="false"
 data-auto-scroll="true" data-slide-speed="200">
 <li class="sidebar-toggler-wrapper">
 <div class="sidebar-toggler"></div>
 </li>
 @Html.Raw(ViewBag.Menus)
 </ul>
 </div>
 </div>

 <!-- CONTENT -->
 <div class="page-content-wrapper">
 <div class="page-content">
 <div class="page-bar">
 <ul class="page-breadcrumb">
 <li><i class="fa fa-home"></i> <a href="index.html">Home</a>
 <i class="fa fa-angle-right"></i></li>
 <li><a href="#">版面展示</a></li>
 </ul>
 </div>
 <h3 class="page-title">版面展示</h3>
 @RenderBody()
 </div>
 </div>
 </div>

 <!-- ========== FOOTER ========== -->
 <div class="page-footer">
 <div class="page-footer-inner">2014 © Metronic by keenthemes.</div>
 <div class="scroll-to-top"><i class="icon-arrow-up"></i></div>
 </div>

 <!-- 核心 JS,放在頁面底部以縮短載入時間 -->
 <script src="~/Content/assets/global/plugins/jquery.min.js" type="text/javascript"></script>
 <script src="~/Content/assets/global/plugins/jquery-migrate.min.js" type="text/javascript"></script>
 <!-- 務必在 bootstrap.min.js 之前載入 jquery-ui,以避開 tooltip 衝突 -->
 <script src="~/Content/assets/global/plugins/jquery-ui/jquery-ui.min.js" type="text/javascript"></script>
 <script src="~/Content/assets/global/plugins/bootstrap/js/bootstrap.min.js" type="text/javascript"></script>
 <script src="~/Content/assets/global/scripts/metronic.js" type="text/javascript"></script>
 <script src="~/Content/assets/admin/layout/scripts/layout.js" type="text/javascript"></script>
 <script>
 jQuery(document).ready(function() {
 Metronic.init();
 Layout.init();
 });
 </script>
</body>
</html>

(原始模板另含 quick sidebar 的聊天、通知、設定等大量 HTML,與菜單改造無關,此處從略。)

五、菜單的 HTML 結構規律

把選單那一段單獨抽出來看,會發現規律非常單純:<li> 裡可以包含 <ul>,而 <ul> 裡又是一串 <li>。這種自我重複的結構,正是遞迴最理想的適用場景。

 <li class="start active open">
 <a href="javascript:;">
 <i class="icon-folder"></i>
 <span class="title">Multi Level Menu</span>
 <span class="arrow "></span>
 </a>
 <ul class="sub-menu">
 <li>
 <a href="javascript:;">
 <i class="icon-settings"></i> Item 1 <span class="arrow"></span>
 </a>
 <ul class="sub-menu">
 <li>
 <a href="javascript:;">
 <i class="icon-user"></i> Sample Link 1 <span class="arrow"></span>
 </a>
 <ul class="sub-menu">
 <li><a href="#"><i class="icon-power"></i> Sample Link 1</a></li>
 <li><a href="#"><i class="icon-paper-plane"></i> Sample Link 1</a></li>
 <li><a href="#"><i class="icon-star"></i> Sample Link 1</a></li>
 </ul>
 </li>
 <li><a href="#"><i class="icon-camera"></i> Sample Link 1</a></li>
 <li><a href="#"><i class="icon-link"></i> Sample Link 2</a></li>
 <li><a href="#"><i class="icon-pointer"></i> Sample Link 3</a></li>
 </ul>
 </li>
 <li>
 <a href="javascript:;">
 <i class="icon-globe"></i> Item 2 <span class="arrow"></span>
 </a>
 <ul class="sub-menu">
 <li><a href="#"><i class="icon-tag"></i> Sample Link 1</a></li>
 <li><a href="#"><i class="icon-pencil"></i> Sample Link 1</a></li>
 <li><a href="#"><i class="icon-graph"></i> Sample Link 1</a></li>
 </ul>
 </li>
 <li><a href="#"><i class="icon-bar-chart"></i> Item 3</a></li>
 </ul>
</li>

六、遞迴拼接菜單

建立 Home 的 Index 檢視並套用 _Layout.cshtml。因為 Metronic 沒有現成的 Ajax 菜單模式,只能自己讀資料、自己拼 HTML。做法是從資料表取出最上層節點,再透過遞迴往下展開。

 using App.Models;
 using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Web;
 using System.Web.Mvc;
 using System.Text;

 namespace App.Web.Controllers
 {
    public class HomeController : Controller
    {
        AppDBContainer db = new AppDBContainer();

        public ActionResult Index()
        {
            // 先取出所有最上層節點
            IQueryable<SysModule> menus = db.SysModule.AsQueryable().Where(a => a.ParentID == "0");

            StringBuilder sb = new StringBuilder();
            bool firstFlag = true;   // 第一個節點預設展開

            GetChildMenus(ref sb, menus, firstFlag);   // 處理二級以上的菜單

            ViewBag.Menus = sb.ToString();
            return View();
        }

        // 遞迴:處理二級以上的菜單
        public void GetChildMenus(ref StringBuilder sb, IQueryable<SysModule> menus, bool firstFlag)
        {
            int count = 0;

            if (!firstFlag) sb.Append("<ul class='sub-menu'>");

            foreach (var m in menus)
            {
                // 找出目前節點底下還有沒有子節點
                IQueryable<SysModule> menusChild =
                    db.SysModule.AsQueryable().Where(a => a.ParentID == m.ID);
                count = menusChild.Count();

                sb.AppendFormat("<li class='{0}'>", firstFlag ? "start actove open" : "");

                // 有子節點時 href 給 javascript:; 並附上一個 arrow 元素作為展開箭頭
                sb.AppendFormat(
                    "<a href='{0}'><i class='{1}'></i><span class='title'>{2}</span>{3}</a>",
                    count > 0 ? "javascript:;" : m.Url,
                    m.Iconic,
                    m.Name,
                    count > 0 ? "<span class='arrow '></span>" : "");

                firstFlag = false;

                // 有子節點就遞迴下去
                if (count > 0) GetChildMenus(ref sb, menusChild, firstFlag);

                sb.Append("</li>");
            }

            if (!firstFlag) sb.Append("</ul>");
        }
    }
 }

最後把模板裡原本的 <li>...</li> 整段換成:

 @Html.Raw(ViewBag.Menus)

這裡一定要用 Html.Raw,因為 Razor 預設會對輸出內容做 HTML 編碼,不加的話畫面上就會看到一堆 <li> 字樣。

幾個實作上的觀察

1. 每次遞迴都重新查一次資料庫。這個寫法直白易懂,但在節點多、層數深的時候會產生 N+1 的查詢問題。比較好的做法是一次把整張表撈出來,在記憶體中先用 ToLookup(a => a.ParentID) 分組,再拿分組結果去遞迴。

2. 用 StringBuilder 而非字串串接。這一步是對的。字串在 .NET 中是不可變的,用 += 大量拼接會產生大量中間物件。

3. firstFlag 的設計有點微妙。它同時被當作「是否為最上層」與「是否為第一個元素」使用,遞迴時往下傳 false 才得以正確收尾。這段邏輯建議搭配注释多讀兩次,因為它的行為並不那麼一目了然。

4. 記得處理 Sort 欄位。資料表裡明明有排序欄位,但範例的查詢並沒有用它排序,實際上線前應該補上 OrderBy(a => a.Sort)。

結語

前端這種東西最考驗人的耐心——資料、後端邏輯都對了,最後還得跟一層又一層的 class 名稱和巢狀結構纏鬥。但一旦遞迴跑通,之後菜單要加到幾層都不用再改程式,這份投入算是相當值得。

作者:YmNets
出處:https://ymnets.cnblogs.com/

以上就是這次 Bootstrap Metronic 菜單欄的實作筆記,希望對你的後台開發有所幫助。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved