Criando um fornecedor de sitemap personalizado Database-Driven (C#)

por Scott Mitchell

Descarregar PDF

O provedor de mapa do site padrão no ASP.NET 2.0 recupera seus dados de um arquivo XML estático. Embora o provedor baseado em XML seja adequado para muitos sites de pequeno e médio porte, os aplicativos Web maiores exigem um mapa do site mais dinâmico. Neste tutorial, criaremos um provedor de mapa do site personalizado que recupera seus dados da Camada de Lógica de Negócios, que, por sua vez, recupera dados do banco de dados.

Introdução

A funcionalidade de mapa do site do ASP.NET 2.0 permite que um desenvolvedor de páginas defina o mapa do site de uma aplicação Web em um meio persistente, como um ficheiro XML. Uma vez definidos, os dados do mapa do site podem ser acessados programaticamente por meio SiteMap da classe no System.Web namespace ou por meio de uma variedade de controles da Web de navegação, como os controles SiteMapPath, Menu e TreeView. O sistema de mapa do site usa o modelo de provedor para que diferentes implementações de serialização de mapa do site possam ser criadas e conectadas a um aplicativo Web. O provedor de mapa do site padrão que acompanha o ASP.NET 2.0 persiste a estrutura do mapa do site em um arquivo XML. De volta ao tutorial Páginas Mestras e Navegação no Site , criamos um arquivo chamado Web.sitemap que continha essa estrutura e atualizamos seu XML a cada nova seção do tutorial.

O provedor de mapa do site baseado em XML padrão funciona bem se a estrutura do mapa do site for bastante estática, como para esses tutoriais. Em muitos cenários, no entanto, é necessário um mapa do site mais dinâmico. Considere o mapa do site mostrado na Figura 1, onde cada categoria e produto aparecem como seções na estrutura do site. Com este mapa do site, visitar a página da Web correspondente ao nó raiz pode listar todas as categorias, enquanto visitar a página da Web de uma categoria específica listaria os produtos dessa categoria e visualizar a página da Web de um determinado produto mostraria os detalhes do produto.

Figura 1: As categorias e produtos compõem a estrutura do mapa do site (Clique para visualizar a imagem em tamanho real)

Embora esta estrutura baseada em categoria e produto pudesse ser hard-coded no arquivo Web.sitemap, o arquivo precisaria ser atualizado sempre que uma categoria ou produto fosse adicionado, removido ou renomeado. Consequentemente, a manutenção do mapa do site seria muito simplificada se sua estrutura fosse recuperada do banco de dados ou, idealmente, da camada de lógica de negócios da arquitetura do aplicativo. Dessa forma, à medida que produtos e categorias fossem adicionados, renomeados ou excluídos, o mapa do site seria atualizado automaticamente para refletir essas alterações.

Como a serialização do mapa do site do ASP.NET 2.0 s é construída sobre o modelo do provedor, podemos criar nosso próprio provedor de mapa do site personalizado que captura seus dados de um armazenamento de dados alternativo, como o banco de dados ou a arquitetura. Neste tutorial, criaremos um provedor personalizado que recupera seus dados da BLL. Vamos começar!

Observação

O provedor de mapa do site personalizado criado neste tutorial está fortemente acoplado à arquitetura e ao modelo de dados do aplicativo. Os artigos de Jeff Prosise Storing Site Maps in SQL Server e The SQL Site Map Provider You've Been Waiting For examinam uma abordagem generalizada para armazenar dados de mapa do site no SQL Server.

Etapa 1: Criando as páginas da Web do provedor de sitemap personalizadas

Antes de começarmos a criar um provedor de mapa do site personalizado, vamos primeiro adicionar as ASP.NET páginas necessárias para este tutorial. Comece adicionando uma nova pasta chamada SiteMapProvider. Em seguida, adicione as seguintes páginas ASP.NET a essa pasta, certificando-se de associar cada página à Site.master página mestra:

• Default.aspx
• ProductsByCategory.aspx
• ProductDetails.aspx

Adicione também uma CustomProviders subpasta à App_Code pasta.

Figura 2: Adicionar as páginas ASP.NET para os tutoriais do Mapa do Site Provider-Related

Como há apenas um tutorial para esta seção, não precisamos Default.aspx listar os tutoriais da seção. Em vez disso, Default.aspx exibirá as categorias em um controle GridView. Abordaremos isso na Etapa 2.

Em seguida, atualize Web.sitemap para incluir uma referência à Default.aspx página. Especificamente, adicione a seguinte marcação após o componente de cache <siteMapNode>:

<siteMapNode 
    title="Customizing the Site Map" url="~/SiteMapProvider/Default.aspx" 
    description="Learn how to create a custom provider that retrieves the site map 
                 from the Northwind database." />

Após a atualização Web.sitemap, reserve um momento para visualizar o site de tutoriais através de um navegador. O menu à esquerda agora inclui um item para o único tutorial do provedor de mapa do site.

Figura 3: O mapa do site agora inclui uma entrada para o tutorial do provedor de mapa do site

O foco principal deste tutorial é ilustrar a criação de um provedor de mapa do site personalizado e a configuração de um aplicativo Web para usar esse provedor. Em particular, criaremos um provedor que retorna um mapa do site que inclui um nó raiz junto com um nó para cada categoria e produto, conforme mostrado na Figura 1. Em geral, cada nó no mapa do site pode especificar uma URL. Para o nosso mapa do site, o URL do nó raiz será ~/SiteMapProvider/Default.aspx, que listará todas as categorias no banco de dados. Cada nó de categoria no mapa do site terá uma URL que aponta para ~/SiteMapProvider/ProductsByCategory.aspx?CategoryID=categoryID, que listará todos os produtos no categoryID especificado. Finalmente, cada nó do mapa do site do produto apontará para ~/SiteMapProvider/ProductDetails.aspx?ProductID=productID, que exibirá os detalhes específicos do produto.

Para começar, precisamos criar as páginas Default.aspx, ProductsByCategory.aspx e ProductDetails.aspx. Estas páginas são preenchidas nos Passos 2, 3 e 4, respetivamente. Como o foco deste tutorial está nos fornecedores de mapas de site, e como tutoriais anteriores abordaram a criação desses tipos de relatórios mestres/detalhados de várias páginas, passaremos rapidamente pelas Etapas 2 a 4. Se você precisar de uma atualização sobre a criação de relatórios mestres/detalhados que abrangem várias páginas, consulte novamente o tutorial Filtragem mestre/detalhe em duas páginas .

Etapa 2: Exibindo uma lista de categorias

Abra a página Default.aspx na pasta SiteMapProvider e arraste um GridView da Caixa de Ferramentas para o Designer, definindo o seu ID como Categories. A partir da tag inteligente do GridView, vincule-o a um novo ObjectDataSource chamado CategoriesDataSource e configure-o para que recupere seus dados usando o método CategoriesBLL da classe GetCategories. Como este GridView apenas exibe as categorias e não oferece recursos de modificação de dados, configure as listas suspensas nas guias UPDATE, INSERT e DELETE como (Nenhuma).

Figura 4: Configurar o ObjectDataSource para retornar categorias usando o método (GetCategories imagem em tamanho real)

Figura 5: Defina as listas de Drop-Down nas guias UPDATE, INSERT e DELETE como (Nenhuma) (Clique para visualizar a imagem em tamanho normal)

Depois de concluir o assistente Configurar Fonte de Dados, o Visual Studio adicionará um BoundField para CategoryID, CategoryName, Description, NumberOfProductse BrochurePath. Edite o GridView para que contenha apenas os BoundFields CategoryName e Description e atualize a propriedade CategoryName do BoundField HeaderText para Categoria.

Em seguida, adicione um HyperLinkField e posicione-o de modo que seja o campo mais à esquerda. Defina a DataNavigateUrlFields propriedade como CategoryID e a DataNavigateUrlFormatString propriedade como ~/SiteMapProvider/ProductsByCategory.aspx?CategoryID={0}. Defina a propriedade Text como Ver Produtos.

Figura 6: Adicionar um HyperLinkField ao Categories GridView

Depois de criar o ObjectDataSource e personalizar os campos de GridView, a marcação declarativa dos dois controles terá a seguinte aparência:

<asp:GridView ID="Categories" runat="server" AutoGenerateColumns="False" 
    DataKeyNames="CategoryID" DataSourceID="CategoriesDataSource" 
    EnableViewState="False">
    <Columns>
        <asp:HyperLinkField DataNavigateUrlFields="CategoryID" 
            DataNavigateUrlFormatString=
                "~/SiteMapProvider/ProductsByCategory.aspx?CategoryID={0}"
            Text="View Products" />
        <asp:BoundField DataField="CategoryName" HeaderText="Category" 
            SortExpression="CategoryName" />
        <asp:BoundField DataField="Description" HeaderText="Description" 
            SortExpression="Description" />
    </Columns>
</asp:GridView>
<asp:ObjectDataSource ID="CategoriesDataSource" runat="server" 
    OldValuesParameterFormatString="original_{0}" SelectMethod="GetCategories" 
    TypeName="CategoriesBLL"></asp:ObjectDataSource>

A Figura 7 mostra Default.aspx quando visualizada através de um navegador. Ao clicar no link Exibir Produtos de uma categoria, você será direcionado para o ProductsByCategory.aspx?CategoryID=categoryID, que será criado na Etapa 3.

Figura 7: Cada categoria é listada junto com um link Exibir produtos (Clique para visualizar a imagem em tamanho real)

Etapa 3: Listando os produtos da categoria selecionada

Abra a ProductsByCategory.aspx página e adicione um GridView, nomeando-o ProductsByCategory. Utilize a sua etiqueta inteligente para vincular o GridView a um novo ObjectDataSource chamado ProductsByCategoryDataSource. Configure o ObjectDataSource para usar a classe ProductsBLL com o método GetProductsByCategoryID(categoryID) e defina as listas suspensas como (Nenhum) nas guias UPDATE, INSERT e DELETE.

Figura 8: Usar o método Class s ProductsBLL (GetProductsByCategoryID(categoryID) imagem em tamanho real)

A etapa final do assistente Configurar Fonte de Dados solicita uma fonte de parâmetro para categoryID. Como essas informações são passadas pelo campo CategoryID querystring, selecione QueryString na lista suspensa e digite CategoryID na caixa de texto QueryStringField, como mostrado na Figura 9. Clique em Concluir para finalizar o assistente.

Figura 9: Use o campo Querystring para o parâmetro CategoryID (Clique para visualizar a imagem em tamanho real)

Depois de concluir o assistente, o Visual Studio adicionará BoundFields correspondentes e um CheckBoxField ao GridView para os campos de dados do produto. Remova todos, exceto o ProductName, UnitPrice e SupplierName BoundFields. Personalize essas três propriedades BoundFields HeaderText para ler Produto, Preço e Fornecedor, respectivamente. Formate o UnitPrice BoundField como uma moeda.

Em seguida, adicione um HyperLinkField e mova-o para a posição mais à esquerda. Defina sua Text propriedade como View Details, sua DataNavigateUrlFields propriedade como ProductID, e sua DataNavigateUrlFormatString propriedade como ~/SiteMapProvider/ProductDetails.aspx?ProductID={0}.

Figura 10: Adicionar um HyperLinkField de detalhes de exibição que aponta para ProductDetails.aspx

Depois de fazer essas personalizações, a marcação declarativa de GridView e ObjectDataSource deve ser semelhante à seguinte:

<asp:GridView ID="ProductsByCategory" runat="server" AutoGenerateColumns="False"
    DataKeyNames="ProductID" DataSourceID="ProductsByCategoryDataSource" 
    EnableViewState="False">
    <Columns>
        <asp:HyperLinkField DataNavigateUrlFields="ProductID" 
            DataNavigateUrlFormatString=
                "~/SiteMapProvider/ProductDetails.aspx?ProductID={0}"
            Text="View Details" />
        <asp:BoundField DataField="ProductName" HeaderText="Product"
            SortExpression="ProductName" />
        <asp:BoundField DataField="UnitPrice" DataFormatString="{0:c}" 
            HeaderText="Price" HtmlEncode="False" 
            SortExpression="UnitPrice" />
        <asp:BoundField DataField="SupplierName" HeaderText="Supplier" 
            ReadOnly="True" SortExpression="SupplierName" />
    </Columns>
</asp:GridView>
<asp:ObjectDataSource ID="ProductsByCategoryDataSource" runat="server" 
    OldValuesParameterFormatString="original_{0}"
    SelectMethod="GetProductsByCategoryID" TypeName="ProductsBLL">
    <SelectParameters>
        <asp:QueryStringParameter Name="categoryID" 
            QueryStringField="CategoryID" Type="Int32" />
    </SelectParameters>
</asp:ObjectDataSource>

Volte à visualização Default.aspx através de um navegador e clique no link Ver produtos para bebidas. Isso o levará ao ProductsByCategory.aspx?CategoryID=1, exibindo os nomes, preços e fornecedores dos produtos no banco de dados Northwind que pertencem à categoria Bebidas (consulte a Figura 11). Sinta-se à vontade para aprimorar ainda mais esta página para incluir um link para retornar os usuários à página de listagem de categorias (Default.aspx) e um controle DetailsView ou FormView que exibe o nome e a descrição da categoria selecionada.

Figura 11: Os nomes, preços e fornecedores de bebidas são exibidos (Clique para visualizar a imagem em tamanho real)

Etapa 4: Mostrando os detalhes de um produto

A página final, ProductDetails.aspx, exibe os detalhes dos produtos selecionados. Abra ProductDetails.aspx e arraste um DetailsView da Caixa de Ferramentas para o Designer. Defina a propriedade ID de DetailsView para ProductInfo e limpe os valores das suas propriedades Height e Width. A partir de sua marca inteligente, vincule o DetailsView a um novo ObjectDataSource chamado ProductDataSource, configurando o ObjectDataSource para extrair seus dados do ProductsBLL método s GetProductByProductID(productID) da classe. Tal como acontece com as páginas Web anteriores criadas nos Passos 2 e 3, defina as listas pendentes nos separadores UPDATE, INSERT e DELETE como (Nenhum) .

Figura 12: Configurar o ObjectDataSource para usar o método (GetProductByProductID(productID) imagem em tamanho real)

A última etapa do assistente Configurar Fonte de Dados solicita a origem do parâmetro productID . Como esses dados vêm através do campo ProductIDquerystring, defina a lista suspensa como QueryString e a caixa de texto QueryStringField como ProductID. Por fim, clique no botão Concluir para concluir o assistente.

Figura 13: Configurar o parâmetro productID para extrair seu valor do campo Querystring (ProductID imagem em tamanho real)

Depois de concluir o assistente Configurar Fonte de Dados, o Visual Studio criará os BoundFields correspondentes e um CheckBoxField na DetailsView para os campos de dados do produto. Remova o ProductID, SupplierIDe CategoryID BoundFields e configure os campos restantes como achar melhor. Depois de algumas configurações estéticas, a marcação declarativa do meu DetailsView e ObjectDataSource ficou semelhante à seguinte:

<asp:DetailsView ID="ProductInfo" runat="server" AutoGenerateRows="False" 
    DataKeyNames="ProductID" DataSourceID="ProductDataSource" 
    EnableViewState="False">
    <Fields>
        <asp:BoundField DataField="ProductName" HeaderText="Product" 
            SortExpression="ProductName" />
        <asp:BoundField DataField="CategoryName" HeaderText="Category" 
            ReadOnly="True" SortExpression="CategoryName" />
        <asp:BoundField DataField="SupplierName" HeaderText="Supplier" 
            ReadOnly="True" SortExpression="SupplierName" />
        <asp:BoundField DataField="QuantityPerUnit" HeaderText="Qty/Unit" 
            SortExpression="QuantityPerUnit" />
        <asp:BoundField DataField="UnitPrice" DataFormatString="{0:c}" 
            HeaderText="Price" HtmlEncode="False" 
            SortExpression="UnitPrice" />
        <asp:BoundField DataField="UnitsInStock" HeaderText="Units In Stock" 
            SortExpression="UnitsInStock" />
        <asp:BoundField DataField="UnitsOnOrder" HeaderText="Units On Order" 
            SortExpression="UnitsOnOrder" />
        <asp:BoundField DataField="ReorderLevel" HeaderText="Reorder Level" 
            SortExpression="ReorderLevel" />
        <asp:CheckBoxField DataField="Discontinued" HeaderText="Discontinued" 
            SortExpression="Discontinued" />
    </Fields>
</asp:DetailsView>
<asp:ObjectDataSource ID="ProductDataSource" runat="server" 
    OldValuesParameterFormatString="original_{0}"
    SelectMethod="GetProductByProductID" TypeName="ProductsBLL">
    <SelectParameters>
        <asp:QueryStringParameter Name="productID" 
            QueryStringField="ProductID" Type="Int32" />
    </SelectParameters>
</asp:ObjectDataSource>

Para testar esta página, volte para Default.aspx e clique em Visualizar Produtos para a categoria Bebidas. Na lista de produtos de bebidas, clique no link Ver detalhes do chá Chai. Isto irá levá-lo para ProductDetails.aspx?ProductID=1, que mostra os detalhes de um Chai Tea (ver Figura 14).

Figura 14: Fornecedor, categoria, preço e outras informações da Chai Tea são exibidas (Clique para visualizar a imagem em tamanho real)

Etapa 5: Compreendendo o funcionamento interno de um provedor de mapa do site

O mapa do site é representado na memória do servidor Web como um conjunto de SiteMapNode instâncias que formam uma hierarquia. Deve haver exatamente uma raiz, todos os outros nós devem ter exatamente um nó de pai e todos os nós podem ter um número arbitrário de filhos. Cada SiteMapNode objeto representa uma seção na estrutura do site, essas seções geralmente têm uma página da Web correspondente. Consequentemente, a SiteMapNode classe tem propriedades como Title, Urle Description, que fornecem informações para a seção que representa SiteMapNode . Há também uma propriedade que identifica exclusivamente cada Key na hierarquia, bem como propriedades usadas para estabelecer essa hierarquia SiteMapNode, ChildNodes, ParentNode, NextSibling, e assim por diante.

A Figura 15 mostra a estrutura geral do mapa do site da Figura 1, mas com os detalhes da implementação esboçados com mais detalhes.

Figura 15: Cada SiteMapNode um tem propriedades como Title, Url, Keye assim por diante (Clique para visualizar a imagem em tamanho real)

O mapa do site é acessível através da SiteMap classe no System.Web namespace. A propriedade da classe RootNode retorna a instância raiz SiteMapNode do mapa do site; CurrentNode retorna a instância SiteMapNode cuja propriedade Url corresponde à URL da página solicitada no momento. Essa classe é usada internamente pelos controles da Web de navegação do ASP.NET 2.0.

Quando as propriedades da SiteMap classe s são acessadas, ela deve serializar a estrutura do mapa do site de algum meio persistente na memória. No entanto, a lógica de serialização do mapa do site não é codificada na classe SiteMap. Em vez disso, a classe SiteMap determina qual fornecedor de mapa do site usar para serialização em tempo de execução. Por padrão, a XmlSiteMapProvider classe é usada, que lê a estrutura do mapa do site a partir de um arquivo XML formatado corretamente. No entanto, com um pouco de trabalho, podemos criar nosso próprio provedor de mapa do site personalizado.

Todos os provedores de mapa do site devem ser derivados da SiteMapProvider classe, que inclui os métodos e propriedades essenciais necessários para os provedores de mapa do site, mas omite muitos dos detalhes da implementação. Uma segunda classe, StaticSiteMapProvider, estende a SiteMapProvider classe e contém uma implementação mais robusta da funcionalidade necessária. Internamente, o StaticSiteMapProvider armazena as instâncias SiteMapNode do mapa do site num Hashtable e fornece métodos como AddNode(child, parent), RemoveNode(siteMapNode), e Clear() que adicionam e removem SiteMapNode s ao Hashtable interno. XmlSiteMapProvider deriva de StaticSiteMapProvider.

Ao criar um provedor de mapa do site personalizado que estende StaticSiteMapProvider, há dois métodos abstratos que devem ser sobrescritos: BuildSiteMap e GetRootNodeCore. BuildSiteMap, como o próprio nome indica, é responsável por carregar a estrutura do mapa do site a partir do armazenamento persistente e construí-la na memória. GetRootNodeCore Retorna o nó raiz no mapa do site.

Antes que um aplicativo Web possa usar um provedor de mapa do site, ele deve ser registrado na configuração do aplicativo. Por padrão, a XmlSiteMapProvider classe é registrada usando o nome AspNetXmlSiteMapProvider. Para registrar outros provedores de mapa do site, adicione a seguinte marcação a Web.config:

<configuration>
    <system.web>
        ...
        <siteMap defaultProvider="defaultProviderName">
          <providers>
            <add name="name" type="type" />
          </providers>
        </siteMap>
    </system.web>
</configuration>

O valor name atribui um nome legível por humanos ao provedor, enquanto type especifica o nome de tipo totalmente qualificado do provedor de mapa do site. Exploraremos valores concretos para os valores de nome e tipo na Etapa 7, depois de criarmos nosso provedor de mapa do site personalizado.

A classe do provedor de mapa do site é instanciada na primeira vez que é acedida a partir da classe SiteMap e permanece na memória durante toda a vida útil da aplicação web. Como há apenas uma instância do provedor de mapa do site que pode ser invocada de vários visitantes simultâneos do site, é imperativo que os métodos do provedor sejam thread-safe.

Por motivos de desempenho e escalabilidade, é importante armazenar em cache a estrutura do mapa do site na memória e retornar essa estrutura em cache, em vez de recriá-la sempre que o BuildSiteMap método for invocado. BuildSiteMap pode ser chamado várias vezes por solicitação de página por usuário, dependendo dos controles de navegação em uso na página e da profundidade da estrutura do mapa do site. Em qualquer caso, se não armazenarmos em cache a estrutura BuildSiteMap do mapa do site, cada vez que ela for invocada, precisaremos recuperar novamente as informações do produto e da categoria da arquitetura (o que resultaria em uma consulta ao banco de dados). Como discutimos nos tutoriais de cache anteriores, os dados armazenados em cache podem se tornar obsoletos. Para combater isso, podemos usar expirações baseadas em dependência de cache de tempo ou SQL.

Observação

Um provedor de mapa do site pode, opcionalmente, substituir o Initialize método. Initialize é invocado quando o provedor de mapa do site é instanciado pela primeira vez e qualquer atributo personalizado atribuído ao provedor é passado no elemento Web.config<add> como: <add name="name" type="type" customAttribute="value" />. É útil se você quiser permitir que um desenvolvedor de página especifique várias configurações relacionadas ao provedor de mapa do site sem ter que modificar o código do provedor. Por exemplo, se estivéssemos lendo os dados de categoria e produtos diretamente do banco de dados em vez de através da arquitetura, provavelmente gostaríamos de permitir que o desenvolvedor da página especificasse a cadeia de conexão do banco de dados em Web.config vez de usar um valor codificado no código do provedor. O provedor de mapa do site personalizado que criaremos na Etapa 6 não substitui esse Initialize método. Para obter um exemplo de como usar o método Initialize, consulte o artigo de Jeff Prosise intitulado Storing Site Maps in SQL Server (Armazenando Mapas do Site no SQL Server).

Etapa 6: Criando o provedor de mapa do site personalizado

Para criar um provedor de mapa do site personalizado que cria o mapa do site a partir das categorias e produtos no banco de dados Northwind, precisamos criar uma classe que se estenda StaticSiteMapProvider. Na Etapa 1, pedi que você adicionasse uma CustomProviders pasta na App_Code pasta - adicione uma nova classe a esta pasta chamada NorthwindSiteMapProvider. Adicione o seguinte código à NorthwindSiteMapProvider classe:

using System;
using System.Data;
using System.Configuration;
using System.Web;
using System.Web.Security;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;
using System.Web.UI.HtmlControls;
using System.Web.Caching;
public class NorthwindSiteMapProvider : StaticSiteMapProvider
{
    private readonly object siteMapLock = new object();
    private SiteMapNode root = null;
    public const string CacheDependencyKey = 
        "NorthwindSiteMapProviderCacheDependency";
    public override SiteMapNode BuildSiteMap()
    {
        // Use a lock to make this method thread-safe
        lock (siteMapLock)
        {
            // First, see if we already have constructed the
            // rootNode. If so, return it...
            if (root != null)
                return root;
            // We need to build the site map!
            
            // Clear out the current site map structure
            base.Clear();
            // Get the categories and products information from the database
            ProductsBLL productsAPI = new ProductsBLL();
            Northwind.ProductsDataTable products = productsAPI.GetProducts();
            // Create the root SiteMapNode
            root = new SiteMapNode(
                this, "root", "~/SiteMapProvider/Default.aspx", "All Categories");
            AddNode(root);
            // Create SiteMapNodes for the categories and products
            foreach (Northwind.ProductsRow product in products)
            {
                // Add a new category SiteMapNode, if needed
                string categoryKey, categoryName;
                bool createUrlForCategoryNode = true;
                if (product.IsCategoryIDNull())
                {
                    categoryKey = "Category:None";
                    categoryName = "None";
                    createUrlForCategoryNode = false;
                }
                else
                {
                    categoryKey = string.Concat("Category:", product.CategoryID);
                    categoryName = product.CategoryName;
                }
                SiteMapNode categoryNode = FindSiteMapNodeFromKey(categoryKey);
                // Add the category SiteMapNode if it does not exist
                if (categoryNode == null)
                {
                    string productsByCategoryUrl = string.Empty;
                    if (createUrlForCategoryNode)
                        productsByCategoryUrl = 
                            "~/SiteMapProvider/ProductsByCategory.aspx?CategoryID=" 
                            + product.CategoryID;
                    categoryNode = new SiteMapNode(
                        this, categoryKey, productsByCategoryUrl, categoryName);
                    AddNode(categoryNode, root);
                }
                // Add the product SiteMapNode
                string productUrl = 
                    "~/SiteMapProvider/ProductDetails.aspx?ProductID=" 
                    + product.ProductID;
                SiteMapNode productNode = new SiteMapNode(
                    this, string.Concat("Product:", product.ProductID), 
                    productUrl, product.ProductName);
                AddNode(productNode, categoryNode);
            }
            
            // Add a "dummy" item to the cache using a SqlCacheDependency
            // on the Products and Categories tables
            System.Web.Caching.SqlCacheDependency productsTableDependency = 
                new System.Web.Caching.SqlCacheDependency("NorthwindDB", "Products");
            System.Web.Caching.SqlCacheDependency categoriesTableDependency = 
                new System.Web.Caching.SqlCacheDependency("NorthwindDB", "Categories");
            // Create an AggregateCacheDependency
            System.Web.Caching.AggregateCacheDependency aggregateDependencies = 
                new System.Web.Caching.AggregateCacheDependency();
            aggregateDependencies.Add(productsTableDependency, categoriesTableDependency);
            // Add the item to the cache specifying a callback function
            HttpRuntime.Cache.Insert(
                CacheDependencyKey, DateTime.Now, aggregateDependencies, 
                Cache.NoAbsoluteExpiration, Cache.NoSlidingExpiration, 
                CacheItemPriority.Normal, 
                new CacheItemRemovedCallback(OnSiteMapChanged));
            // Finally, return the root node
            return root;
        }
    }
    protected override SiteMapNode GetRootNodeCore()
    {
        return BuildSiteMap();
    }
    protected void OnSiteMapChanged(string key, object value, CacheItemRemovedReason reason)
    {
        lock (siteMapLock)
        {
            if (string.Compare(key, CacheDependencyKey) == 0)
            {
                // Refresh the site map
                root = null;
            }
        }
    }
    public DateTime? CachedDate
    {
        get
        {
            return HttpRuntime.Cache[CacheDependencyKey] as DateTime?;
        }
    }
}

Vamos começar a explorar o método da BuildSiteMap classe, que começa com uma lock declaração. A lock instrução só permite que um thread de cada vez entre, serializando assim o acesso ao seu código e impedindo que dois threads simultâneos pisem nos dedos um do outro.

A variável de nível de classe SiteMapNoderoot é usada para armazenar em cache a estrutura do mapa do site. Quando o mapa do site é construído pela primeira vez, ou pela primeira vez após os dados subjacentes terem sido modificados, root será null e a estrutura do mapa do site será construída. O nó raiz do mapa do site é atribuído a root durante o processo de construção, para que, na próxima vez que esse método for chamado, root não seja null. Consequentemente, enquanto root não for null, a estrutura do mapa do site será devolvida ao chamador sem necessidade de a recriar.

Se root for null, a estrutura do mapa do site será criada a partir das informações do produto e da categoria. O mapa do site é construído criando as instâncias SiteMapNode e, em seguida, formando a hierarquia por meio de chamadas para o método StaticSiteMapProvider da classe AddNode. AddNode executa a contabilidade interna, armazenando as instâncias sortidas SiteMapNode num Hashtable. Antes de começarmos a construir a hierarquia, começamos chamando o Clear método, que limpa os elementos do interno Hashtable. Em seguida, o método da classe ProductsBLLGetProducts e o resultado ProductsDataTable são armazenados em variáveis locais.

A construção do mapa do site começa com a criação do nó raiz e sua atribuição ao root. A sobrecarga do construtor SiteMapNode usada aqui e ao longo deste BuildSiteMap é passada a seguinte informação:

• Uma referência ao provedor de mapa do site (this).
• O SiteMapNode s Key. Esse valor necessário deve ser exclusivo para cada SiteMapNode.
• O SiteMapNode s Url. Url é opcional, mas se fornecido, cada SiteMapNode valor s Url deve ser exclusivo.
• O SiteMapNode s Title, que é obrigatório.

A chamada do método AddNode(root) adiciona SiteMapNoderoot ao mapa do site como raiz. Em seguida, cada ProductRow no ProductsDataTable é enumerado. Se já existir um SiteMapNode para a categoria de produto atual, ele é referenciado. Caso contrário, um novo SiteMapNode para a categoria é criado e adicionado como um filho da SiteMapNode``root através da chamada do método AddNode(categoryNode, root). Depois que o nó de categoria SiteMapNode apropriado tiver sido encontrado ou criado, um SiteMapNode será criado para o produto atual e adicionado como filho da categoria SiteMapNode via AddNode(productNode, categoryNode). Observe que o valor da propriedade da categoria SiteMapNode é Url, enquanto a propriedade do produto ~/SiteMapProvider/ProductsByCategory.aspx?CategoryID=categoryID é atribuída SiteMapNode.

Observação

Os produtos que têm um valor de banco de dados NULL para seus CategoryID são agrupados em uma categoria SiteMapNode cuja Title propriedade está definida como Nenhum e cuja Url propriedade está definida como uma cadeia de caracteres vazia. Decidi definir Url para uma cadeia de caracteres vazia, uma vez que o ProductBLL método de classe s GetProductsByCategory(categoryID) atualmente não tem a capacidade de retornar apenas os produtos com um NULLCategoryID valor. Além disso, eu queria demonstrar como os controles de navegação renderizam um SiteMapNode que não tem um valor para sua Url propriedade. Eu encorajo que amplie este tutorial para que a propriedade None SiteMapNode s Url aponte para ProductsByCategory.aspx, mas exiba apenas os produtos com valores NULLCategoryID.

Depois de construir o mapa do site, adiciona-se um objeto arbitrário ao cache de dados através de uma dependência de cache SQL nas tabelas Categories e Products, utilizando um objeto AggregateCacheDependency. Exploramos o uso de dependências de cache SQL no tutorial anterior, Usando dependências de cache SQL. No entanto, o provedor de mapa do site personalizado utiliza uma sobrecarga do método de cache de dados Insert que ainda não explorámos. Essa sobrecarga aceita como parâmetro de entrada final um delegado que é chamado quando o objeto é removido do cache. Explicitamente, introduzimos um novo CacheItemRemovedCallback delegado que aponta para o método OnSiteMapChanged definido mais abaixo na classe NorthwindSiteMapProvider.

Observação

A representação na memória do mapa do site é armazenada em cache por meio da variável rootde nível de classe. Como há apenas uma instância da classe de provedor de mapa de site personalizado e como essa instância é compartilhada entre todos os threads no aplicativo Web, essa variável de classe serve como um cache. O BuildSiteMap método também usa o cache de dados, mas apenas como um meio de receber notificação quando os dados do banco de dados subjacente nas Categories tabelas ou Products mudam. Observe que o valor colocado no cache de dados é apenas a data e hora atuais. Os dados reais do mapa do site não são colocados no cache de dados.

O método BuildSiteMap é concluído ao retornar o nó raiz do mapa do site.

Os restantes métodos são bastante simples. GetRootNodeCore é encarregado de retornar o nó raiz. Uma vez que BuildSiteMap retorna a raiz, GetRootNodeCore simplesmente retorna BuildSiteMap s valor de retorno. O OnSiteMapChanged método volta root para null quando o item de cache é removido. Com a raiz redefinida para null, da próxima vez que BuildSiteMap for invocado, a estrutura do mapa do site será reconstruída. Por fim, a CachedDate propriedade retorna o valor de data e hora armazenado no cache de dados, se esse valor existir. Essa propriedade pode ser usada por um desenvolvedor de página para determinar quando os dados do mapa do site foram armazenados em cache pela última vez.

Passo 7: Registar oNorthwindSiteMapProvider Siga estes passos:

Para que a nossa aplicação web utilize o provedor de mapa do site NorthwindSiteMapProvider criado na Etapa 6, temos de o registar na secção <siteMap> de Web.config. Especificamente, adicione a seguinte marcação dentro do <system.web> elemento em Web.config:

<siteMap defaultProvider="AspNetXmlSiteMapProvider">
  <providers>
    <add name="Northwind" type="NorthwindSiteMapProvider" />
  </providers>
</siteMap>

Essa marcação faz duas coisas: primeiro, indica que o AspNetXmlSiteMapProvider incorporado é o fornecedor padrão de mapas do sítio; segundo, regista o fornecedor de mapas do sítio personalizado criado na Etapa 6 com o nome humano amigável Northwind.

Observação

Para provedores de mapa do site localizados na pasta do App_Code aplicativo, o valor do atributo é simplesmente o nome da type classe. Como alternativa, o provedor de mapa do site personalizado poderia ter sido criado num projeto separado de Biblioteca de Classes com o assembly compilado colocado no diretório da aplicação Web /Bin. Nesse caso, o valor do type atributo seria Namespace.ClassName, AssemblyName .

Após a atualização Web.config, reserve um momento para visualizar qualquer página dos tutoriais em um navegador. Observe que a interface de navegação à esquerda ainda mostra as seções e tutoriais definidos em Web.sitemap. Isso ocorre porque mantivemos AspNetXmlSiteMapProvider como o provedor padrão. Para criar um elemento de interface do usuário de navegação que use o NorthwindSiteMapProvider, precisaremos especificar explicitamente que o provedor de mapa do site Northwind deve ser usado. Veremos como fazer isso na Etapa 8.

Etapa 8: Exibindo informações do mapa do site usando o provedor de mapa do site personalizado

Com o fornecedor de mapa do site personalizado criado e registado em Web.config, estamos prontos para adicionar controlo de navegação às páginas Default.aspx, ProductsByCategory.aspx, e ProductDetails.aspx na pasta SiteMapProvider. Comece abrindo a Default.aspx página e arraste um SiteMapPath da Caixa de Ferramentas para o Designer. O controle SiteMapPath está localizado na seção Navegação da Caixa de Ferramentas.

Figura 16: Adicionar um SiteMapPath Default.aspx (Clique para visualizar a imagem em tamanho real)

O controlo SiteMapPath exibe um caminho de navegação, indicando a localização da página atual no mapa do site. Adicionamos um SiteMapPath à parte superior da página mestra no tutorial Páginas mestras e navegação do site .

Reserve um momento para visualizar esta página através de um navegador. O SiteMapPath adicionado na Figura 16 usa o provedor de mapa do site padrão, extraindo seus dados do Web.sitemap. Portanto, o breadcrumb mostra Home > Customizing the Site Map, assim como o breadcrumb no canto superior direito.

Figura 17: O caminho de navegação utiliza o fornecedor de mapa do site padrão (Clique para visualizar a imagem em tamanho real)

Para que o SiteMapPath seja adicionado na Figura 16, use o provedor de mapa do site personalizado que criamos na Etapa 6, defina sua SiteMapProvider propriedade como Northwind, o nome que atribuímos ao NorthwindSiteMapProvider in Web.config. Infelizmente, o Designer continua a usar o provedor de mapa do site padrão, mas se você visitar a página por meio de um navegador depois de fazer essa alteração de propriedade, verá que a trilha agora usa o provedor de mapa do site personalizado.

Figura 18: O caminho agora utiliza o fornecedor de mapa do site personalizado NorthwindSiteMapProvider (Clique para ver a imagem em tamanho real)

O controlador SiteMapPath exibe uma interface de utilizador mais funcional nas páginas ProductsByCategory.aspx e ProductDetails.aspx. Adicione um SiteMapPath a essas páginas, definindo a SiteMapProvider propriedade em ambas como Northwind. A partir de Default.aspx clique no link Ver produtos para bebidas e, em seguida, no link Ver detalhes para chá Chai. Como mostra a Figura 19, a migalha de pão inclui a seção atual do mapa do site (Chai Tea) e os seus ancestrais: Bebidas e Todas as Categorias.

Figura 19: O breadcrumb agora utiliza o fornecedor de mapa do site personalizado NorthwindSiteMapProvider (Clique para ver a imagem em tamanho real)

Outros elementos da interface do usuário de navegação podem ser usados além do SiteMapPath, como os controles Menu e TreeView. As páginas Default.aspx, ProductsByCategory.aspx e ProductDetails.aspx no ficheiro de download deste tutorial, por exemplo, incluem controlos de Menu (consulte a Figura 20). Consulte Recursos sofisticados de navegação no site do ASP.NET 2.0 e a seção Usando controles de navegação do site do ASP.NET 2.0 QuickStarts para obter uma visão mais detalhada dos controles de navegação e do sistema de mapa do site no ASP.NET 2.0.

Figura 20: O controle de menu lista cada uma das categorias e produtos (Clique para visualizar a imagem em tamanho real)

Como mencionado anteriormente neste tutorial, a estrutura do mapa do site pode ser acessada programaticamente através da SiteMap classe. O código a seguir retorna a raiz SiteMapNode do provedor padrão:

SiteMapNode root = SiteMap.RootNode;

Como o AspNetXmlSiteMapProvider é o provedor padrão para nosso aplicativo, o código acima retornaria o nó raiz definido em Web.sitemap. Para fazer referência a um provedor de mapa do site diferente do padrão, use a SiteMap da Providers classe da seguinte forma:

SiteMapNode root = SiteMap.Providers["name"].RootNode;

Onde nome é o nome do provedor de mapa do site personalizado (Northwind, para nossa aplicação web).

Para aceder a um membro específico de um fornecedor de mapa do site, utilize SiteMap.Providers["name"] para recuperar a instância do fornecedor e convertê-la para o tipo apropriado. Por exemplo, para exibir a NorthwindSiteMapProvider propriedade s em uma página ASP.NET CachedDate , use o seguinte código:

NorthwindSiteMapProvider customProvider = 
    SiteMap.Providers["Northwind"] as NorthwindSiteMapProvider;
if (customProvider != null)
{
    DateTime? lastCachedDate = customProvider.CachedDate;
    if (lastCachedDate != null)
        LabelID.Text = "Site map cached on: " + lastCachedDate.Value.ToString();
    else
        LabelID.Text = "The site map is being reconstructed!";
}

Observação

Certifique-se de testar o recurso de dependência de cache SQL. Depois de visitar as Default.aspx, ProductsByCategory.aspx e ProductDetails.aspx páginas, vá para um dos tutoriais na seção Edição, Inserção e Exclusão e edite o nome de uma categoria ou produto. Em seguida, volte para uma das páginas da SiteMapProvider pasta. Supondo que tenha passado tempo suficiente para que o mecanismo de sondagem observe a alteração no banco de dados subjacente, o mapa do site deve ser atualizado para mostrar o nome do novo produto ou categoria.

Resumo

As funcionalidades do mapa do site do ASP.NET 2.0 incluem uma classe SiteMap, vários controlos de navegação na Web incorporados e um fornecedor de mapa do site padrão que espera armazenar as informações do mapa do site num ficheiro XML. Para usar informações de mapa do site de alguma outra fonte, como de um banco de dados, da arquitetura do aplicativo ou de um serviço Web remoto, precisamos criar um provedor de mapa do site personalizado. Isso envolve a criação de uma classe que deriva, direta ou indiretamente, da SiteMapProvider classe.

Neste tutorial, vimos como criar um provedor de mapa do site personalizado que baseou o mapa do site nas informações de produto e categoria retiradas da arquitetura do aplicativo. Nosso provedor estendeu a StaticSiteMapProvider classe e implicou a criação de um BuildSiteMap método que recuperava os dados, construía a hierarquia do mapa do site e armazenava em cache a estrutura resultante em uma variável de nível de classe. Usamos uma dependência de cache SQL com uma função de retorno de chamada para invalidar a estrutura armazenada em cache quando os dados subjacentes Categories ou Products são modificados.

Feliz Programação!

Leitura adicional

Para obter mais informações sobre os tópicos discutidos neste tutorial, consulte os seguintes recursos:

• Armazenar mapas do site no SQL Server e o provedor de mapa do site SQL que sempre esperaste
• O Kit de Ferramentas do Provedor
• Recursos sofisticados de navegação no site do ASP.NET 2.0

Sobre o Autor

Scott Mitchell, autor de sete livros sobre ASP/ASP.NET e fundador da 4GuysFromRolla.com, trabalha com tecnologias Web da Microsoft desde 1998. Scott trabalha como consultor, formador e escritor independente. Seu último livro é Sams Teach Yourself ASP.NET 2.0 in 24 Hours. Ele pode ser contatado em mitchell@4GuysFromRolla.com.

Um agradecimento especial a

Esta série de tutoriais foi revisada por muitos revisores úteis. Os principais revisores deste tutorial foram Dave Gardner, Zack Jones, Teresa Murphy e Bernadette Leigh. Interessado em rever meus próximos artigos do MSDN? Se for o caso, envie-me uma mensagem para mitchell@4GuysFromRolla.com.

Próximo