針對ASP.NET MVC的site map ASP.NET MVC SiteMap provider

   使用過傳統asp.net form的開發人員都知道，asp.net中提供了一個sitemap功能，能夠方便的產生導覽功能表或者導航連結，僅需要通過配置即可實現對導航連結的管理。對於site map的配置以及使用，基本上主流的asp.net教材都有典型的例子，比如如何使用site map datasource時，如何配置xml格式sitemap等等。而作為asp.net的新模式應用 asp.net mvc似乎沒有內建的實現sitemap的功能，當然理論上還是可以寫寫入程式碼一些相對路徑到節點中，但是畢竟不能很好的跟mvc中controller和action結合在一起，畢竟sitemap出來的時候還沒有mvc呢。不過作為.net的架構，曆來都是提供了良好的擴充性，經典的策略模式也同樣被應用在sitemap的應用中,僅僅需要實現自己的provider即可。

   最近在codeplex上就看到了一款針對asp.net開發的sitemap provider，不僅附帶了源碼，還展示了如何應用在執行個體中。執行個體採用的一個入門級的mvc應用程式MvcMusicStore，確實比較潮，得裝了vs2010才能跑起來。經過一番簡單研究之後，終於有了些眉目，效果還算滿意。具體的實現方式如下：

   第一步：

   到http://mvcsitemap.codeplex.com/下載最新的dll，最好連帶sample也一起下載，跑起來比較費勁，但研究一下經典的入門範例也不賴。

   第二步：

   在web.config中配置sitemap節點，配置方式在官網有詳細的介紹，主要是提供一個provider，設定一下屬性即可，開起來比較多，其實可以省略不少的

siteMap 配置

        <siteMap defaultProvider="MvcSiteMapProvider" enabled="true">
            <providers>
                <clear/>
                <add name="MvcSiteMapProvider"
                 type="MvcSiteMapProvider.DefaultSiteMapProvider,MvcSiteMapProvider"
                 siteMapFile="~/Web.Sitemap"
                 securityTrimmingEnabled="true"
                 cacheDuration="5"
                 enableLocalization="true"
                 scanAssembliesForSiteMapNodes="true"
                 skipAssemblyScanOn=""
                 attributesToIgnore="bling,visibility"
                 nodeKeyGenerator="MvcSiteMapProvider.DefaultNodeKeyGenerator, MvcSiteMapProvider"
                 controllerTypeResolver="MvcSiteMapProvider.DefaultControllerTypeResolver, MvcSiteMapProvider"
                 actionMethodParameterResolver="MvcSiteMapProvider.DefaultActionMethodParameterResolver, MvcSiteMapProvider"
                 aclModule="MvcSiteMapProvider.DefaultAclModule, MvcSiteMapProvider"
                 siteMapNodeUrlResolver="MvcSiteMapProvider.DefaultSiteMapNodeUrlResolver, MvcSiteMapProvider"
                 siteMapNodeVisibilityProvider="MvcSiteMapProvider.DefaultSiteMapNodeVisibilityProvider, MvcSiteMapProvider"
                 siteMapProviderEventHandler="MvcSiteMapProvider.DefaultSiteMapProviderEventHandler, MvcSiteMapProvider"/>
            </providers>
        </siteMap>

   第三步：

   建立sitemap檔案，建立方式跟傳統的一樣，要更改的只是內容。檔案名稱要跟web.config中配置的一樣，這裡是Web.sitemap。典型的xml級聯配置方式，當然需要瞭解各個屬性的含義以及方式，比如title為標題，controll、action等就不用說了，官網有詳細的配置說明

sitemap檔案

<?xml version="1.0" encoding="utf-8" ?>
<mvcSiteMap xmlns="http://mvcsitemap.codeplex.com/schemas/MvcSiteMap-File-2.0" enableLocalization="true">
    <mvcSiteMapNode title="首頁" controller="Home" action="Index" changeFrequency="Always" updatePriority="Normal">
        <mvcSiteMapNode title="關於" controller="Home" action="About"/>
        <mvcSiteMapNode title="登入" controller="Account" action="LogOn"/>
        <mvcSiteMapNode title="註冊" controller="Account" action="Register"/>
        <mvcSiteMapNode title="產品" controller="Product" action="Index">
            <mvcSiteMapNode title="產品明細" dynamicNodeProvider="MvcSiteMapDemp.ProductDetailsDynamicNodeProvider, MvcSiteMapDemp"/>
        </mvcSiteMapNode>
    </mvcSiteMapNode>
</mvcSiteMap>

   第四步：

   完了之後，配置方面的工作基本完成。接下來是如何去應用的問題。mvc sitemap provider中提供了調用的api，通過擴充htmlhelper的方式提供了展現的方式，主要有以下方式（引用官網的描述）

Html.MvcSiteMap().Menu() - Can be used to generate a menu

Html.MvcSiteMap().SiteMap() - Can be used to generate a list of all pages in your sitemap

Html.MvcSiteMap().SiteMapPath() - Can be used to generate a so-called "breadcrumb trail"

Html.MvcSiteMap().SiteMapTitle() - Can be used to render the current SiteMap node's title  

以上步驟完成之後，基本上可以得到類似如下格式的導覽功能表

首頁 > 產品 > 產品2

   當然我們一般的頁面可以用這種簡單方式配置，如果涉及動態顯示，如本例中的產品明細節點，那麼需要實現自己的產生節點的方式， 即實現自己的 dynamicNodeProvider。實現自訂的NodeProvider的方式如下

DynamicNodeProvider

public class ProductDetailsDynamicNodeProvider : DynamicNodeProviderBase
    {
        public override IEnumerable<DynamicNode> GetDynamicNodeCollection()
        {
            DynamicNode node1 = new DynamicNode();
            node1.Action = "ProductDetails";
            node1.Controller = "Product";
            node1.Title = "產品1";
            node1.RouteValues.Add("name", "產品1");

            DynamicNode node2 = new DynamicNode();
            node2.Action = "ProductDetails";
            node2.Controller = "Product";
            node2.Title = "產品2";
            node2.RouteValues.Add("name", "產品2");

            return new DynamicNode[] { node1, node2 };
        }
    }

   以上僅僅是其中的一個擴充點，mvc sitemap provider提供了多個擴充點使得配置更加的靈活。其中在顯示方面，如果需要改變顯示連結的方式，需要在Views的shared檔案夾下建立DisplayTemplates，裡面放置自訂的模板，完整的模板可從官網下載得到。

   僅對mvc sitemap provider作了簡單的研究，更進階的應用有待後續學習、補充。

   執行個體代碼下載