SiteMapProvider Класс

Определение

Пространство имен:

System.Web

Сборка:

System.Web.dll

Предоставляет общий базовый класс для всех поставщиков данных карты сайта и способ реализации пользовательских поставщиков данных карты сайта, которые можно использовать с инфраструктурой карты сайта ASP.NET в качестве постоянных хранилищ для SiteMap объектов.

public ref class SiteMapProvider abstract : System::Configuration::Provider::ProviderBase

public abstract class SiteMapProvider : System.Configuration.Provider.ProviderBase

type SiteMapProvider = class
    inherit ProviderBase

Public MustInherit Class SiteMapProvider
Inherits ProviderBase

Наследование

Object

ProviderBase

SiteMapProvider

Производный

System.Web.StaticSiteMapProvider

Примеры

В следующем примере кода показано, как написать класс, реализующий абстрактный SiteMapProvider класс. Этот пример включает только пример SiteMapProvider и пример текстового файла, который работает с ним. Для запуска примера также требуется запись в файле Web.config и странице .aspx. Их можно найти в документации по свойству SiteMapDataSource.SiteMapProvider .

В примере используется файл с разделителями-запятыми, который следует ожидаемой структуре для загрузки сведений карты сайта. Первая строка файла представляет корневой узел карты сайта, а последующие строки — подмножения. Каждый вложенный узел определяет родительский узел по URL-адресу. Ниже показан пример файла, соответствующего этим критериям.

default.aspx,Home,MyCompany Home Page,
sale.aspx,Now On Sale,Check Out These Great Deals!,default.aspx
catalog.aspx,Online Catalog,Browse Our Many Great Items!,default.aspx

В SimpleTextSiteMapProvider этом примере приведены примеры реализаций всех SiteMapProvider свойств и методов.

using System;
using System.Configuration.Provider;
using System.Collections;
using System.Collections.Specialized;
using System.IO;
using System.Security.Permissions;
using System.Web;

namespace Samples.AspNet.CS
{

  [AspNetHostingPermission(SecurityAction.Demand, Level = AspNetHostingPermissionLevel.Minimal)]
  public class SimpleTextSiteMapProvider : SiteMapProvider
  {
    private SiteMapProvider parentSiteMapProvider = null;
    private string simpleTextProviderName = null;
    private string sourceFilename = null;
    private SiteMapNode rootNode = null;
    private ArrayList siteMapNodes = null;
    private ArrayList childParentRelationship = null;

    // A default constructor. The Name property is initialized in the
    // Initialize method.
    public SimpleTextSiteMapProvider()
    {
    }
    // Implement the CurrentNode property.
    public override SiteMapNode CurrentNode
    {
      get
      {
        string currentUrl = FindCurrentUrl();
        // Find the SiteMapNode that represents the current page.
        SiteMapNode currentNode = FindSiteMapNode(currentUrl);
        return currentNode;
      }
    }

    // Implement the RootNode property.
    public override SiteMapNode RootNode
    {
      get
      {
        return rootNode;
      }
    }
    // Implement the ParentProvider property.
    public override SiteMapProvider ParentProvider
    {
      get
      {
        return parentSiteMapProvider;
      }
      set
      {
        parentSiteMapProvider = value;
      }
    }

    // Implement the RootProvider property.
    public override SiteMapProvider RootProvider
    {
      get
      {
        // If the current instance belongs to a provider hierarchy, it
        // cannot be the RootProvider. Rely on the ParentProvider.
        if (this.ParentProvider != null)
        {
          return ParentProvider.RootProvider;
        }
        // If the current instance does not have a ParentProvider, it is
        // not a child in a hierarchy, and can be the RootProvider.
        else
        {
          return this;
        }
      }
    }
    // Implement the FindSiteMapNode method.
    public override SiteMapNode FindSiteMapNode(string rawUrl)
    {

      // Does the root node match the URL?
      if (RootNode.Url == rawUrl)
      {
        return RootNode;
      }
      else
      {
        SiteMapNode candidate = null;
        // Retrieve the SiteMapNode that matches the URL.
        lock (this)
        {
          candidate = GetNode(siteMapNodes, rawUrl);
        }
        return candidate;
      }
    }
    // Implement the GetChildNodes method.
    public override SiteMapNodeCollection GetChildNodes(SiteMapNode node)
    {
      SiteMapNodeCollection children = new SiteMapNodeCollection();
      // Iterate through the ArrayList and find all nodes that have the specified node as a parent.
      lock (this)
      {
        for (int i = 0; i < childParentRelationship.Count; i++)
        {

          string nodeUrl = ((DictionaryEntry)childParentRelationship[i]).Key as string;

          SiteMapNode parent = GetNode(childParentRelationship, nodeUrl);

          if (parent != null && node.Url == parent.Url)
          {
            // The SiteMapNode with the Url that corresponds to nodeUrl
            // is a child of the specified node. Get the SiteMapNode for
            // the nodeUrl.
            SiteMapNode child = FindSiteMapNode(nodeUrl);
            if (child != null)
            {
              children.Add(child as SiteMapNode);
            }
            else
            {
              throw new Exception("ArrayLists not in sync.");
            }
          }
        }
      }
      return children;
    }
    protected override SiteMapNode GetRootNodeCore()
    {
      return RootNode;
    }
    // Implement the GetParentNode method.
    public override SiteMapNode GetParentNode(SiteMapNode node)
    {
      // Check the childParentRelationship table and find the parent of the current node.
      // If there is no parent, the current node is the RootNode.
      SiteMapNode parent = null;
      lock (this)
      {
        // Get the Value of the node in childParentRelationship
        parent = GetNode(childParentRelationship, node.Url);
      }
      return parent;
    }

    // Implement the ProviderBase.Initialize property.
    // Initialize is used to initialize the state that the Provider holds, but
    // not actually build the site map.
    public override void Initialize(string name, NameValueCollection attributes)
    {

      lock (this)
      {

        base.Initialize(name, attributes);

        simpleTextProviderName = name;
        sourceFilename = attributes["siteMapFile"];
        siteMapNodes = new ArrayList();
        childParentRelationship = new ArrayList();

        // Build the site map in memory.
        LoadSiteMapFromStore();
      }
    }
    // Private helper methods

    private SiteMapNode GetNode(ArrayList list, string url)
    {
      for (int i = 0; i < list.Count; i++)
      {
        DictionaryEntry item = (DictionaryEntry)list[i];
        if ((string)item.Key == url)
          return item.Value as SiteMapNode;
      }
      return null;
    }

    // Get the URL of the currently displayed page.
    private string FindCurrentUrl()
    {
      try
      {
        // The current HttpContext.
        HttpContext currentContext = HttpContext.Current;
        if (currentContext != null)
        {
          return currentContext.Request.RawUrl;
        }
        else
        {
          throw new Exception("HttpContext.Current is Invalid");
        }
      }
      catch (Exception e)
      {
        throw new NotSupportedException("This provider requires a valid context.",e);
      }
    }
    protected virtual void LoadSiteMapFromStore()
    {
      string pathToOpen;

      lock (this)
      {
        // If a root node exists, LoadSiteMapFromStore has already
        // been called, and the method can return.
        if (rootNode != null)
        {
          return;
        }
        else
        {
          pathToOpen = HttpContext.Current.Server.MapPath("~" + "\\" + sourceFilename);

          if (File.Exists(pathToOpen))
          {
            // Open the file to read from.
            using (StreamReader sr = File.OpenText(pathToOpen))
            {

              // Clear the state of the collections and rootNode
              rootNode = null;
              siteMapNodes.Clear();
              childParentRelationship.Clear();

              // Parse the file and build the site map
              string s = "";
              string[] nodeValues = null;
              SiteMapNode temp = null;

              while ((s = sr.ReadLine()) != null)
              {

                // Build the various SiteMapNode objects and add
                // them to the ArrayList collections. The format used
                // is: URL,TITLE,DESCRIPTION,PARENTURL

                nodeValues = s.Split(',');

                temp = new SiteMapNode(this,
                    HttpRuntime.AppDomainAppVirtualPath + "/" + nodeValues[0],
                    HttpRuntime.AppDomainAppVirtualPath + "/" + nodeValues[0],
                    nodeValues[1],
                    nodeValues[2]);

                // Is this a root node yet?
                if (null == rootNode &&
                    string.IsNullOrEmpty(nodeValues[3]))
                {
                  rootNode = temp;
                }

              // If not the root node, add the node to the various collections.
                else
                {
                  siteMapNodes.Add(new DictionaryEntry(temp.Url, temp));
                  // The parent node has already been added to the collection.
                  SiteMapNode parentNode =
                           FindSiteMapNode(HttpRuntime.AppDomainAppVirtualPath + "/" + nodeValues[3]);
                  if (parentNode != null)
                  {
                    childParentRelationship.Add(new DictionaryEntry(temp.Url, parentNode));
                  }
                  else
                  {
                    throw new Exception("Parent node not found for current node.");
                  }
                }
              }
            }
          }
          else
          {
            throw new Exception("File not found");
          }
        }
      }
      return;
    }
  }
}

Imports System.Collections
Imports System.Collections.Specialized
Imports System.Configuration.Provider
Imports System.IO
Imports System.Security.Permissions
Imports System.Web

Namespace Samples.AspNet.VB

  <AspNetHostingPermission(SecurityAction.Demand, Level:=AspNetHostingPermissionLevel.Minimal)> _
  Public Class SimpleTextSiteMapProvider
    Inherits SiteMapProvider

    Private parentSiteMapProvider As SiteMapProvider = Nothing
    Private simpleTextProviderName As String = Nothing
    Private sourceFilename As String = Nothing
    Private aRootNode As SiteMapNode = Nothing
    Private siteMapNodes As ArrayList = Nothing
    Private childParentRelationship As ArrayList = Nothing

    ' A default constructor. The Name property is initialized in the
    ' Initialize method.
    Public Sub New()
    End Sub

    ' Implement the CurrentNode property.
    Public Overrides ReadOnly Property CurrentNode() As SiteMapNode
      Get
        Dim currentUrl As String = FindCurrentUrl()
        ' Find the SiteMapNode that represents the current page.
        Dim aCurrentNode As SiteMapNode = FindSiteMapNode(currentUrl)
        Return aCurrentNode
      End Get
    End Property

    ' Implement the RootNode property.
    Public Overrides ReadOnly Property RootNode() As SiteMapNode
      Get
        Return aRootNode
      End Get
    End Property

    ' Implement the ParentProvider property.
    Public Overrides Property ParentProvider() As SiteMapProvider
      Get
        Return parentSiteMapProvider
      End Get
      Set(ByVal value As SiteMapProvider)
        parentSiteMapProvider = Value
      End Set
    End Property

    ' Implement the RootProvider property.
    Public Overrides ReadOnly Property RootProvider() As SiteMapProvider
      Get
        ' If the current instance belongs to a provider hierarchy, it
        ' cannot be the RootProvider. Rely on the ParentProvider.
        If Not (Me.ParentProvider Is Nothing) Then
          Return ParentProvider.RootProvider
          ' If the current instance does not have a ParentProvider, it is
          ' not a child in a hierarchy, and can be the RootProvider.
        Else
          Return Me
        End If
      End Get
    End Property

    ' Implement the FindSiteMapNode method.
    Public Overrides Function FindSiteMapNode(ByVal rawUrl As String) As SiteMapNode
      ' Does the root node match the URL?
      If RootNode.Url = rawUrl Then
        Return RootNode
      Else
        Dim candidate As SiteMapNode = Nothing
        ' Retrieve the SiteMapNode that matches the URL.
        SyncLock Me
          candidate = GetNode(siteMapNodes, rawUrl)
        End SyncLock
        Return candidate
      End If
    End Function 'FindSiteMapNode

    ' Implement the GetChildNodes method.
    Public Overrides Function GetChildNodes(ByVal node As SiteMapNode) As SiteMapNodeCollection
      Dim children As New SiteMapNodeCollection()
      ' Iterate through the ArrayList and find all nodes that have the specified node as a parent.
      SyncLock Me
        Dim i As Integer
        For i = 0 To childParentRelationship.Count - 1

          Dim de As DictionaryEntry = CType(childParentRelationship(i), DictionaryEntry)
          Dim nodeUrl As String = CType(de.Key, String)

          Dim parent As SiteMapNode = GetNode(childParentRelationship, nodeUrl)

          If Not (parent Is Nothing) AndAlso node.Url = parent.Url Then
            ' The SiteMapNode with the Url that corresponds to nodeUrl
            ' is a child of the specified node. Get the SiteMapNode for
            ' the nodeUrl.
            Dim child As SiteMapNode = FindSiteMapNode(nodeUrl)
            If Not (child Is Nothing) Then
              children.Add(CType(child, SiteMapNode))
            Else
              Throw New Exception("ArrayLists not in sync.")
            End If
          End If
        Next i
      End SyncLock
      Return children
    End Function 'GetChildNodes

    Protected Overrides Function GetRootNodeCore() As SiteMapNode
      Return RootNode
    End Function ' GetRootNodeCore()

    ' Implement the GetParentNode method.
    Public Overrides Function GetParentNode(ByVal node As SiteMapNode) As SiteMapNode
      ' Check the childParentRelationship table and find the parent of the current node.
      ' If there is no parent, the current node is the RootNode.
      Dim parent As SiteMapNode = Nothing
      SyncLock Me
        ' Get the Value of the node in childParentRelationship
        parent = GetNode(childParentRelationship, node.Url)
      End SyncLock
      Return parent
    End Function 'GetParentNode

    ' Implement the ProviderBase.Initialize method.
    ' Initialize is used to initialize the state that the Provider holds, but
    ' not actually build the site map.
    Public Overrides Sub Initialize(ByVal name As String, ByVal attributes As NameValueCollection)
      SyncLock Me
        MyBase.Initialize(name, attributes)
        simpleTextProviderName = name
        sourceFilename = attributes("siteMapFile")
        siteMapNodes = New ArrayList()
        childParentRelationship = New ArrayList()
        ' Build the site map in memory.
        LoadSiteMapFromStore()
      End SyncLock
    End Sub

    ' Private helper methods
    Private Function GetNode(ByVal list As ArrayList, ByVal url As String) As SiteMapNode
      Dim i As Integer
      For i = 0 To list.Count - 1
        Dim item As DictionaryEntry = CType(list(i), DictionaryEntry)
        If CStr(item.Key) = url Then
          Return CType(item.Value, SiteMapNode)
        End If
      Next i
      Return Nothing
    End Function 'GetNode


    ' Get the URL of the currently displayed page.
    Private Function FindCurrentUrl() As String
      Try
        ' The current HttpContext.
        Dim currentContext As HttpContext = HttpContext.Current
        If Not (currentContext Is Nothing) Then
          Return currentContext.Request.RawUrl
        Else
          Throw New Exception("HttpContext.Current is Invalid")
        End If
      Catch e As Exception
        Throw New NotSupportedException("This provider requires a valid context.", e)
      End Try
    End Function 'FindCurrentUrl

    Protected Overridable Sub LoadSiteMapFromStore()
      Dim pathToOpen As String
      SyncLock Me
        ' If a root node exists, LoadSiteMapFromStore has already
        ' been called, and the method can return.
        If Not (aRootNode Is Nothing) Then
          Return
        Else
          pathToOpen = HttpContext.Current.Server.MapPath("~" & "\\" & sourceFilename)
          If File.Exists(pathToOpen) Then
            ' Open the file to read from.
            Dim sr As StreamReader = File.OpenText(pathToOpen)
            Try

              ' Clear the state of the collections and aRootNode
              aRootNode = Nothing
              siteMapNodes.Clear()
              childParentRelationship.Clear()

              ' Parse the file and build the site map
              Dim s As String = ""
              Dim nodeValues As String() = Nothing
              Dim temp As SiteMapNode = Nothing

              Do
                s = sr.ReadLine()

                If Not s Is Nothing Then
                  ' Build the various SiteMapNode objects and add
                  ' them to the ArrayList collections. The format used
                  ' is: URL,TITLE,DESCRIPTION,PARENTURL
                  nodeValues = s.Split(","c)

                  temp = New SiteMapNode(Me, _
                      HttpRuntime.AppDomainAppVirtualPath & "/" & nodeValues(0), _
                      HttpRuntime.AppDomainAppVirtualPath & "/" & nodeValues(0), _
                      nodeValues(1), _
                      nodeValues(2))

                  ' Is this a root node yet?
                  If aRootNode Is Nothing AndAlso _
                    (nodeValues(3) Is Nothing OrElse _
                     nodeValues(3) = String.Empty) Then
                    aRootNode = temp

                    ' If not the root node, add the node to the various collections.
                  Else

                    siteMapNodes.Add(New DictionaryEntry(temp.Url, temp))

                    ' The parent node has already been added to the collection.
                    Dim parentNode As SiteMapNode = _
                        FindSiteMapNode(HttpRuntime.AppDomainAppVirtualPath & "/" & nodeValues(3))

                    If Not (parentNode Is Nothing) Then
                      childParentRelationship.Add(New DictionaryEntry(temp.Url, parentNode))
                    Else
                      Throw New Exception("Parent node not found for current node.")
                    End If
                  End If
                End If
              Loop Until s Is Nothing
            Finally
              sr.Close()
            End Try
          Else
            Throw New Exception("File not found")
          End If
        End If
      End SyncLock
      Return
    End Sub
  End Class
End Namespace

Комментарии

XmlSiteMapProvider Классы StaticSiteMapProvider представляют реализации абстрактного SiteMapProvider класса по умолчанию. Использует XmlSiteMapProvider XML-файл с именем Web.sitemap для хранения данных карты сайта. Дополнительные сведения о файле web.sitemap см. в разделе ASP.NET Карты сайтов.

Класс SiteMapProvider поддерживает концепцию иерархии поставщика карты сайта, объявляя RootProvider их и ParentProvider свойства. Может SiteMapProvider быть дочерним или родительским объектом другого поставщика. Это позволяет сценариям, когда различные области контента сайта принадлежат или реализуются различными группами разработки, которые поддерживают собственные карты сайтов и поставщики карт сайта.

Все SiteMapProvider объекты настраиваются в файлах Web.config. Все поставщики карт сайта, объявленные в этих файлах конфигурации, загружаются во время выполнения и используются для загрузки и обработки данных навигации сайта. Объект SiteMap , который отслеживает всех поставщиков, доступных для него через коллекцию свойств Providers , предоставляет программный доступ к данным навигации, управляемым поставщиками. В следующем примере кода показан формат, используемый для объявления поставщика карты сайта в файле Web.config.

<siteMap defaultProvider="<name>">
  <providers>
    <add
      name="<friendly name>"
      type="<fully qualified class name>, <assembly name (optional)>"
      siteMapFile = "<file name>" />
  </providers>
</siteMap>

Данные навигации сайта, загруженные этими поставщиками, используются другими компонентами инфраструктуры карты сайта, такими как SiteMapPath и TreeView элементы управления, для отображения сведений о карте сайта для пользователей.

Если вы реализуете собственный поставщик карты сайта, вы можете поместить исходный файл в каталог App_Code приложения ASP.NET, а затем сборка будет скомпилирована автоматически. Вы также можете разместить собственный поставщик карты сайта в глобальном кэше сборок (GAC) и указать полную ссылку на него в файле Web.config. Дополнительные сведения о службах компилятора см. в статье "Работа с сборками и глобальным кэшем сборок".

Примечания для тех, кто реализует этот метод

При наследовании от SiteMapProvider класса необходимо переопределить следующие члены: GetRootNodeCore(), , FindSiteMapNode(String)GetChildNodes(SiteMapNode)и GetParentNode(SiteMapNode).

Конструкторы

Имя	Описание
SiteMapProvider()	Инициализирует новый экземпляр класса SiteMapProvider.

Свойства

Имя	Описание
CurrentNode	SiteMapNode Возвращает объект, представляющий запрошенную в данный момент страницу.
Description	Получает краткое понятное описание, подходящее для отображения в средствах администрирования или других пользовательских интерфейсах (UIs). (Унаследовано от ProviderBase)
EnableLocalization	Возвращает или задает логическое значение, указывающее, возвращаются ли локализованные значения атрибутов SiteMapNode .
Name	Возвращает понятное имя, используемое для ссылки на поставщика во время настройки. (Унаследовано от ProviderBase)
ParentProvider	Возвращает или задает родительский SiteMapProvider объект текущего поставщика.
ResourceKey	Получение или установка ключа ресурса, используемого для локализации SiteMapNode атрибутов.
RootNode	Возвращает корневой SiteMapNode объект данных карты сайта, которые представляет текущий поставщик.
RootProvider	Возвращает корневой SiteMapProvider объект в текущей иерархии поставщика.
SecurityTrimmingEnabled	Возвращает логическое значение, указывающее, фильтрует ли поставщик карты сайта узлы карты сайта на основе роли пользователя.

Методы

Имя	Описание
AddNode(SiteMapNode, SiteMapNode)	SiteMapNode Добавляет объект в коллекцию узлов, поддерживаемую поставщиком карты сайта, и указывает родительский SiteMapNode объект.
AddNode(SiteMapNode)	SiteMapNode Добавляет объект в коллекцию узлов, которая поддерживается поставщиком карты сайта.
Equals(Object)	Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object)
FindSiteMapNode(HttpContext)	Извлекает объект, представляющий запрошенную SiteMapNode в данный момент страницу с помощью указанного HttpContext объекта.
FindSiteMapNode(String)	При переопределении в производном классе извлекает SiteMapNode объект, представляющий страницу по указанному URL-адресу.
FindSiteMapNodeFromKey(String)	Извлекает SiteMapNode объект на основе указанного ключа.
GetChildNodes(SiteMapNode)	При переопределении в производном классе извлекает дочерние узлы определенного SiteMapNodeкласса.
GetCurrentNodeAndHintAncestorNodes(Int32)	Предоставляет оптимизированный метод подстановки для поставщиков карт сайта при получении узла для запрошенной страницы и получении узлов карты родительского и предка для текущей страницы.
GetCurrentNodeAndHintNeighborhoodNodes(Int32, Int32)	Предоставляет оптимизированный метод поиска для поставщиков карт сайта при получении узла для запрошенной страницы и получении узлов карты сайта в близости от текущего узла.
GetHashCode()	Служит хэш-функцией по умолчанию. (Унаследовано от Object)
GetParentNode(SiteMapNode)	При переопределении в производном классе извлекает родительский узел определенного SiteMapNode объекта.
GetParentNodeRelativeToCurrentNodeAndHintDownFromParent(Int32, Int32)	Предоставляет оптимизированный метод поиска для поставщиков карт сайта при получении узла-предка для запрошенной страницы и получении потомков для предка.
GetParentNodeRelativeToNodeAndHintDownFromParent(SiteMapNode, Int32, Int32)	Предоставляет оптимизированный метод поиска для поставщиков карт сайта при получении узла-предка для указанного SiteMapNode объекта и получении дочерних узлов.
GetRootNodeCore()	При переопределении в производном классе извлекает корневой узел всех узлов, управляемых текущим поставщиком.
GetRootNodeCoreFromProvider(SiteMapProvider)	Извлекает корневой узел всех узлов, управляемых в настоящее время указанным поставщиком карты сайта.
GetType()	Возвращает Type текущего экземпляра. (Унаследовано от Object)
HintAncestorNodes(SiteMapNode, Int32)	Предоставляет метод, который поставщики карты сайта могут переопределить для выполнения оптимизированного извлечения одного или нескольких уровней родительских и предки узлов относительно указанного SiteMapNode объекта.
HintNeighborhoodNodes(SiteMapNode, Int32, Int32)	Предоставляет метод, который поставщики карт сайта могут переопределить для выполнения оптимизированного извлечения узлов, найденных в близком расположении указанного узла.
Initialize(String, NameValueCollection)	Инициализирует реализацию SiteMapProvider , включая все ресурсы, необходимые для загрузки данных карты сайта из постоянного хранилища.
IsAccessibleToUser(HttpContext, SiteMapNode)	Извлекает логическое значение, указывающее, можно ли просматривать указанный SiteMapNode объект пользователем в указанном контексте.
MemberwiseClone()	Создает неглубокую копию текущей Object. (Унаследовано от Object)
RemoveNode(SiteMapNode)	Удаляет указанный SiteMapNode объект из коллекции узлов, поддерживаемой поставщиком карты сайта.
ResolveSiteMapNode(HttpContext)	Вызывает событие SiteMapResolve.
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)

События

Имя	Описание
SiteMapResolve	Происходит при вызове CurrentNode свойства.

См. также раздел

• SiteMapProvider
• XmlSiteMapProvider
• Обзор навигации по сайту ASP.NET
• карты сайтов ASP.NET
• поставщики навигации по сайтам ASP.NET
• Защита ASP.NET навигации по сайтам
• Работа с сборками и глобальным кэшем сборок