c#生成站点地图（SiteMapPath）文件示例程序

当我们在建立一个网站时，通常需要建立一个站点地图文件 (SiteMapPath) 来帮助用户更好的理解我们网站的目录结构，帮助用户更好的导航。

下面我将详细讲解如何用 C# 生成站点地图文件，同时提供两个示例程序：

站点地图文件的基础

什么是站点地图文件

站点地图文件是一种可供搜索引擎和网站访问者使用的页面列表，其中包含了站点中的所有页面和与每个页面相关的元数据。站点地图文件可用于了解站点中所有页面的结构，并且可以帮助搜索引擎更好地了解网站的结构和内容，从而更快、更准确地搜寻到您的页面。

站点地图文件的格式

ASP.NET 使用一个特殊的 XML 格式来定义站点地图文件。该 XML 文件中包含了站点中每个页面的 URL、标题、描述和其他有用的元数据。

C# 生成站点地图文件

步骤1：定义站点地图节点

在 ASP.NET 中，使用 SiteMapPath 控件来显示站点地图。要在代码中生成站点地图文件，您需要定义一个 SiteMapNode 对象。该对象表示站点地图节点，其中包含 XML 中的所有节点。要创建 SiteMapNode 对象，请使用 SiteMapNode 类的一个构造函数。例如，以下代码创建了一个 SiteMapNode 对象：

SiteMapNode node = new SiteMapNode(null, "Home.aspx", "Home", "This is the home page.");

代码中，第一个参数为节点的父节点，由于该节点是根节点，所以此值为 null。第二个参数为节点的 URL。第三个参数为节点的标题，第四个参数为节点的描述。

步骤2：创建站点地图文件

在 C# 中生成站点地图文件可以使用 SiteMap 类提供的静态方法 SiteMap.BuildSiteMap()，这个方法会返回一个 SiteMap 对象，就是一个包含所有站点节点的对象。然后我们利用 SiteMap 对象中的 SaveAsXml() 方法，将所有节点保存到一个 XML 文件中，作为站点地图文件。

SiteMapNode node = new SiteMapNode(null, "Home.aspx", "Home", "This is the home page.");
SiteMap.AddNode(node);
SiteMap.BuildSiteMap();
SiteMap.SaveAsXml(Server.MapPath("~/sitemap.xml"));

上面代码中，首先创建了一个 SiteMapNode 节点对象，然后使用 SiteMap.AddNode() 方法将该节点添加到站点地图中。最后使用 SiteMap.SaveAsXml() 方法将站点地图文件保存到指定的目录。

示例1：生成站点地图文件

以下为生成 StationMap.xml 的示例代码：

SiteMapNode node1 = new SiteMapNode(null, "Home.aspx", "Home", "This is the home page.");
SiteMapNode node2 = new SiteMapNode(node1, "Page1.aspx", "Page1", "This is page 1.");
SiteMapNode node3 = new SiteMapNode(node1, "Page2.aspx", "Page2", "This is page 2.");
SiteMapNode node4 = new SiteMapNode(node2, "Page3.aspx", "Page3", "This is page 3.");
SiteMapNode node5 = new SiteMapNode(node3, "Page4.aspx", "Page4", "This is page 4.");

SiteMap.AddNode(node1);
SiteMap.AddNode(node2);
SiteMap.AddNode(node3);
SiteMap.AddNode(node4);
SiteMap.AddNode(node5);
SiteMap.BuildSiteMap();
SiteMap.SaveAsXml(Server.MapPath("~/StationMap.xml"));

在这里我们设置了根节点 node1，node2 和 node3 分别为根节点 node1 的子节点，node4 和 node5 分别为 node2 和 node3 的子节点。以上节点信息为我们站点地图中的所有节点。

示例2：使用站点地图文件

创建一个名为 SiteMapPathDemo 的Web应用程序。在 Web 应用程序中添加一个 Master Page，设置站点地图路径控件以显示站点地图，然后在每个内容页面中使用站点地图路径控件。

• 在 Master Page 中添加代码

SiteMapDataSource siteMapDataSource = new SiteMapDataSource();
siteMapDataSource.ShowStartingNode = false;
SiteMapPath siteMapPath = new SiteMapPath();

siteMapPath.DataSource = siteMapDataSource;
siteMapPath.PathSeparator = " > "; // 此处为路径分隔符，可以自定义。
siteMapPath.CssClass = "siteMapPath";

this.sitemap.Controls.Add(siteMapPath);

在这里我们创建了一个 SiteMapPath 的实例，使用了一个数据源，分割符为  > ，样式名为 siteMapPath。

• 在 web 上添加代码

<asp:Content ID="Content2" ContentPlaceHolderID="MainContent" runat="server">
    <asp:SiteMapPath
        ID="siteMapPath"
        runat="server"
        SiteMapProvider="XmlSiteMapProvider"
        PathSeparator="&nbsp;&gt;&nbsp;"
        CssClass="siteMapPath"
    />
</asp:Content>

在需要展示路径的 Web 页面中，可以使用 SiteMapPath 控件的 ASPX 标记。

通过以上代码，我们就可以轻松的生成站点地图文件以及利用站点地图路径控件来展示站点地图。