Efetuando o cache de Views no ASP.NET MVC

O tratamento de requisi��es enviadas a uma aplica��o Web envolve, basicamente, o processamento de cada solicita��o recebida e a produ��o dos resultados correspondentes. Sem sombra de d�vidas, a��es deste tipo podem exigir, em determinados momentos, muito da infraestrutura associada a um website, sobretudo se considerada a performance do sistema em quest�o.

Em aplica��es voltadas � Internet um aumento incomum no n�mero de acessos pode, em muitos casos, comprometer seriamente a continuidade das opera��es. Dentre os prov�veis desdobramentos disto est�o falhas inesperadas durante o processamento de requisi��es ou, at� mesmo, usu�rios que abandonam tais sistemas em virtude de problemas de lentid�o.

Procurando uma melhor performance na consulta a informa��es acessadas com frequ�ncia, muitos servidores Web disp�e de mecanismos que possibilitam o armazenamento e o reuso de dados processados anteriormente, sendo esta t�cnica conhecida pelo nome de "caching". Na plataforma ASP.NET isto n�o � diferente, com as tecncologias Web Forms e MVC dispondo de recursos que permitem efetuar o cache de p�ginas ou, at� mesmo, objetos para posterior reutiliza��o.

O objetivo deste artigo � descrever como o cache de dados pode ser efetuado em aplica��es ASP.NET MVC. Para isto, ser� implementado um exemplo que consome informa��es de um feed de not�cias, de maneira que a atualiza��o disto aconte�a apenas em intervalos regulares de tempo.

Criando a solu��o de exemplo

A aplica��o apresentada neste artigo foi criada a partir do Visual Studio 2012 Professional, fazendo uso para isto do .NET Framework 4.5 e da vers�o 4.0 do ASP.NET MVC. O exemplo aqui discutido procura abordar a constru��o de uma View em que ser� exibido um resumo das manchetes mais recentes disponibilizadas por um site de not�cias. A atualiza��o de tais dados ocorrer� periodicamente, de forma a evitar um novo processamento a cada vez que um usu�rio acessar a p�gina inicial do Web site que estaremos implementando.

Para gerar o projeto de testes ser� necess�rio, dentro do Visual Studio, acessar o menu File, op��o New e, por fim, op��o Project. Dentro da tela New Project (Figura 1) selecionar o template ASP.NET MVC 4 Web Application, preenchendo o campo Name com o nome da aplica��o a ser gerada (�TesteCacheMVC�, neste caso); no campo Location � poss�vel ainda definir o diret�rio no qual ser�o criados os arquivos para este projeto.

Figura 1: Criando um projeto ASP.NET MVC 4 para testes

Aparecer� ent�o uma janela como a que consta na Figura 2. Dever�o ser escolhidos o template para a cria��o do projeto (selecionar �Internet Application�), assim como o Engine utilizado para a gera��o das Views (marcar a op��o �Razor�).

Figura 2: Criando um projeto ASP.NET MVC 4 para testes

Cria��o dos tipos utilizados na manipula��o do feed de not�cias

Com o projeto TestePartialViews j� criado, chega o momento de prosseguir com a constru��o das classes utilizadas na manipula��o das not�cias que ser�o apresentadas aos usu�rios do site. As estruturas aqui criadas pertencer�o � camada Model (namespace TesteCacheMVC.Models).

Muitos portais t�m como pr�tica comum disponibilizar servi�os contendo um resumo de suas principais manchetes num determinado momento, utilizando para tanto um formato de dados conhecido como RSS. A partir disto, aplica��es dos mais variados tipos podem consumir tais informa��es, oferecendo a seus respectivos usu�rios uma s�ntese do que pode estar acontecendo em um determinado canal de comunica��o.

O formato RSS (sigla do ingl�s �Really Simple Syndication�) pode ser definido, em termos gerais, como uma implementa��o espec�fica do padr�o XML. Servi�os baseados em RSS (e conhecidos popularmente como �feeds�) costumam ser empregados para a gera��o de notifica��es de atualiza��es em blogs, sites de not�cias, dentre outros �rg�os de informa��o.

Para o exemplo abordado por este artigo, estar� sendo usado o feed de not�cias econ�micas do portal Yahoo: http://br.noticias.yahoo.com/rss/economia.

Primeiramente ser� implementada a classe Noticia (Listagem 1). Conforme pode ser observado, este tipo conta com uma estrutura bastante simples, servindo de base para a exibi��o de dados como o t�tulo, o link para acesso, a data de publica��o, al�m de um resumo sobre as not�cias mais recentes para o site considerado.

Listagem 1: Classe Noticia


using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;

namespace TesteCacheMVC.Models
{
    public class Noticia
    {
        public string Titulo { get; set; }
        public string Link { get; set; }
        public DateTime DataPublicacao { get; set; }
        public string Resumo { get; set; }
    }
}

Como pr�ximo passo, adicionar ao projeto uma refer�ncia ao assembly System.ServiceModel (Figura 3). Este procedimento tornar� o poss�vel a utiliza��o de classes voltadas � manipula��o de feeds RSS e que se encontram definidas nesta biblioteca.

Figura 3: Adicionando uma refer�ncia � biblioteca System.ServiceModel

J� na Listagem 2 est� o c�digo que define a classe est�tica NoticiasReader. Este tipo ser� empregado na leitura de not�cias de um feed, devolvendo atrav�s da opera��o ObterNoticias uma cole��o de inst�ncias da classe Noticia.

Quanto ao m�todo est�tico ObterNoticias, o mesmo foi estruturado para funcionar da seguinte maneira:

Inicialmente � gerada uma cole��o de objetos do tipo Noticia;
Uma nova refer�ncia para a classe SyndicationFeed (namespace System.ServiceModel.Syndication) � gerada, invocando para isto o m�todo est�tico Load. Esta �ltima opera��o recebe como par�metro um objeto do tipo XmlTextReader (namespace System.Xml), com a gera��o deste �ltimo tomando como base o endere�o do feed RSS a ser consumido;
Com a inst�ncia do tipo SyndicationFeed, o conte�do da propriedade Items deste objeto ser� lido dentro de um loop foreach. Esta propriedade nada mais � do que uma cole��o de objetos baseados na classe SyndicationItem (namespace System.ServiceModel.Syndication); por meio destas refer�ncias ser�o geradas as inst�ncias do tipo Noticia, as quais correspondem ao conjunto de resultados esperado ao se acionar o m�todo ObterNoticias;
Quanto aos objetos da classe SyndicationItem manipulados dentro da opera��o ObterNoticias, � poss�vel observar o uso das propriedades Title (t�tulo de uma not�cia), Links (endere�o/link da not�cia em quest�o), PublishDate (data em que a not�cia foi publicada) e Summary (texto resumido descrevendo o conte�do abordado por tal not�cia).

Listagem 2: Classe NoticiasReader


using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.ServiceModel.Syndication;
using System.Xml;

namespace TesteCacheMVC.Models
{
    public static class NoticiasReader
    {
        public static List<Noticia> ObterNoticias(
            string enderecoFeed)
        {
            List<Noticia> noticias = new List<Noticia>();
            
            SyndicationFeed feed = SyndicationFeed
                .Load(new XmlTextReader(enderecoFeed));
            foreach (SyndicationItem item in feed.Items)
            {
                noticias.Add(new Noticia()
                {
                    Titulo = item.Title.Text,
                    Link = item.Links.Count > 0 ?
                        item.Links[0].Uri.ToString() : null,
                    DataPublicacao = item.PublishDate.LocalDateTime,
                    Resumo = item.Summary.Text
                });
            }

            return noticias;
        }
    }
}

Ajustando o Controller que ir� processar as Views da aplica��o

Com os tipos da camada Model j� definidos, deve-se proceder agora com o acerto do Controller respons�vel pelo processamento das diferentes Views deste projeto de exemplo (classe HomeController).

O primeiro passo ser� incluir uma configura��o chamada �EnderecoFeedNoticias� na se��o appSettings do arquivo Web.config (Listagem 3). Definir como valor deste item o endere�o do feed de not�cias a ser utilizado pela aplica��o.

Listagem 3: Ajustes no arquivo Web.config


<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <appSettings>

    ...

    <add key="EnderecoFeedNoticias"
         value="http://br.noticias.yahoo.com/rss/economia"/>
  </appSettings>

  ...

</configuration>

Na Listagem 4 encontra-se o c�digo que implementa o tipo HomeController.

Listagem 4: Classe HomeController


using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Mvc;
using System.Configuration;
using TesteCacheMVC.Models;

namespace TesteCacheMVC.Controllers
{
    public class HomeController : Controller
    {
        public ActionResult Index()
        {
            return View();
        }

        [OutputCache(Duration = 120)]
        public PartialViewResult Noticias()
        {
            string enderecoFeed = ConfigurationManager
                .AppSettings["EnderecoFeedNoticias"];
            ViewBag.EnderecoFeedNoticias = enderecoFeed;
            return PartialView(NoticiasReader.ObterNoticias(
                enderecoFeed));
        }

        public ActionResult About()
        {
            return View();
        }

        public ActionResult Contact()
        {
            return View();
        }
    }
}

Est�o definidas neste Controller as Actions:

Index:
Noticias: Partial View que ser� processada e armazenada em cache durante dois minutos, evitando assim novos reprocessamentos a cada vez em que a View Index for acessada. Logo, um benef�cio direto da ado��o de tal pr�tica est� em melhorar a performance na utiliza��o da aplica��o;
About: permite a visualiza��o da p�gina �Sobre�, a qual cont�m uma descri��o resumida dos objetivos deste projeto de exemplo; Contact: respons�vel pelo processamento da View em que ser�o exibidas as informa��es para contato.

Diferente das demais opera��es implementadas em HomeController, a Action Noticias foi constru�da levando em conta os seguintes aspectos:

O resultado da execu��o da Action Noticias � um objeto do tipo PartialViewResult (namespace System.Web.Mvc), o qual � obtido ao se invocar o m�todo PartialView. Uma Partial View � um tipo de estrutura cujo resultado de seu processamento (trechos de c�digo HTML) pode ser utilizado dentro de uma outra View convencional;
O endere�o do feed de not�cias definido no arquivo Web.config � repassado ao m�todo ObterNoticias da classe NoticiasReader, bem como associado a uma nova propriedade (�EnderecoFeedNoticias�) pertencente ao objeto din�mico ViewBag;
� poss�vel observar ainda que a cole��o de inst�ncias do tipo Noticia � fornecida como par�metro � opera��o PartialView, a fim de que tais objetos possam ser utilizados posteriormente pela Partial View de nome �Noticias� (com o intuito de gerar uma visualiza��o das manchetes mais recentes que constam no feed RSS);
Por fim, o uso do atributo OutputCacheAttribute (namespace System.Web.Mvc) permite que o resultado da Partial View seja armazenado em cache por um per�odo de dois minutos, especificando-se para isto o valor 120 (segundos) � propriedade Duration. Requisi��es subsequentes, ao longo do per�odo especificado em Duration, retornar�o a sa�da produzida ainda no processamento inicial. Expirado o tempo de dois minutos, o resultado em quest�o � descartado do cache, a fim de que uma nova solicita��o force o reprocessamento da Partial View Noticias.

Na Tabela 1 est�o relacionadas outras propriedades que podem ser configuradas ao se fazer uso do tipo OutputCacheAttribute:

Propriedade	Tipo	Descri��o
VaryByParam	String	Quando utilizado, determina que ser�o armazenadas diferentes entradas em cache para cada combina��o de valores constantes nos objetos Request.QueryString e Request.Form. O valor default �none� indica que o cache n�o ir� variar com base em entradas de query strings ou formul�rios; j� �*� especifica que o cache ir� variar com base em quaisquer valores definidos em Request.QueryString e Request.Form.
VaryByHeader	String	Entradas no cache ser�o geradas com base em diferentes combina��es de headers HTTP.
VaryByCustomString		Permite o uso de caching de uma forma customizada, dependendo para isto do m�todo GetVaryByCustomString definido dentro do arquivo Global.asax.
Location	OutputCacheLocation (enumeration)	Define em que local os dados ser�o armazenados em cache. S�o valores poss�veis para o enum OutputCacheLocation: Server (apenas na mem�ria do servidor); Client (somente no browser do usu�rio que est� acessando o recurso); Downstream (no browser do visitante ou, ainda, em um dispositivo intermedi�rio como um servidor proxy); ServerAndClient (combina��o de servidor e browser do cliente); Any (combina��o dos padr�es Server e Downstream); None (sem cache). Caso n�o seja especificado um valor para a propriedade Location, o ASP.NET MVC assumir� como default o valor Any.

Tabela 1: Algumas propriedades da classe OutputCacheAttribute

Implementa��o das Views da aplica��o

Finalmente, ser�o criadas/codificadas as Views utilizadas na exibi��o das not�cias.

No caso da Partial View Noticias, a cria��o da estrutura que conter� o resultado da execu��o da Action de mesmo nome pode ser feita clicando-se com o bot�o direito do mouse sobre o m�todo correspondente; no menu de atalho apresentado selecionar a op��o Add View.

Com a janela �Add View� ativa, certificar-se de que o campo �View Engine� est� preenchido com o valor �Razor (CSHTML)�. Marcar ent�o a op��o �Create a strongly typed-view�, selecionando em �Model class� o tipo Noticia; j� em �Scaffold template�, escolher o valor �List�, a fim de que seja gerada uma listagem com as diferentes not�cias. Concluindo este processo, selecionar ainda a op��o �Create as a partial view�. Na Figura 4 est�o ilustrados todos esses ajustes.

Figura 4: Cria��o de uma Partial View

Ao se acionar o bot�o Add da janela Add View ser� criado o arquivo Noticias.cshtml. Trata-se de uma View �fortemente tipada�, ou seja, atrav�s da propriedade Model desta estrutura � poss�vel acessar uma cole��o de objetos de um tipo espec�fico (no caso, a classe Noticia).

Na Listagem 5 est� o c�digo corresponde � Partial View Noticias. Nota-se nesse arquivo:

A presen�a de uma instru��o imprimindo a data em que o resultado dessa estrutura foi processado; este artif�cio foi empregado aqui com o objetivo de se facilitar o teste do mecanismo de caching provido pelo ASP.NET MVC;

O uso do objeto ViewBag e da propriedade Model, consumindo assim os dados gerados durante o processamento da Action Noticias;

Uma chamada ao m�todo Raw do objeto Html; esta a��o tem por finalidade gerar o conte�do em HTML correspondente ao resumo de uma not�cia, considerando para isto meios que garantam a correta visualiza��o de prov�veis tags no texto (imagens e/ou refer�ncias a outros links, por exemplo).

Listagem 5: Partial View Noticias.cshtml


@model IEnumerable<TesteCacheMVC.Models.Noticia>
<h3>�ltimo acesso ao servi�o de not�cias: 
    @DateTime.Now.ToString("dd/MM/yyyy HH:mm:ss")</h3>
<br />
Fonte: <a href="@ViewBag.EnderecoFeedNoticias">Yahoo! Economia</a>
@foreach (var item in Model) {
    <p>
        <b><a href="@item.Link">
            @item.DataPublicacao.ToString("dd/MM/yyyy HH:mm:ss") -
            @item.Titulo
        </a></b>
        <br />
        @Html.Raw(item.Resumo)
    </p>
}

Ajustes precisar�o ser realizados agora na View Index (Listagem 6).

Ao ser visualizada, a ideia � que a View Index produza como resultado um documento HTML em que constem as diferentes not�cias do feed RSS j� mencionado anteriormente. Para que isto seja poss�vel, o m�todo Action do objeto Html foi acionado, tendo sido fornecido como par�metro ao mesmo o nome da Partial View (�Noticias�) cujo conte�do ser� incorporado dentro da View principal.

Al�m disso, a data atual tamb�m constar� no c�digo HTML a ser gerado para a View Index. A inclus�o desta informa��o teve como objetivo demonstrar que enquanto a View principal � processada novamente (durante um novo acesso, ou mesmo, atrav�s de um refresh a partir de um browser), o resultado da Partial View Noticias sempre estar� atrelado ao cache da aplica��o (o que for�ar� a uma atualiza��o sempre que existir algo armazenado e que expirou o limite de dois minutos).

Listagem 6: View Index.cshtml


@section featured {
    <section class="featured">
        <div class="content-wrapper">
            <hgroup class="title">
                <h1>Principais not�cias -
                    @DateTime.Now.ToString("dd/MM/yyyy HH:mm:ss")</h1>
            </hgroup>
        </div>
    </section>
}
@Html.Action("Noticias")

Executando a aplica��o de testes

Iniciando a execu��o da aplica��o criada neste artigo, ser� exibida uma tela como a que consta na Figura 5.

Figura 5: Aplica��o TesteCacheMVC em execu��o

Acionando a fun��o �Atualizar� do Internet Explorer t�o logo aconte�a este primeiro acesso, aparecer� um resultado similar ao da Figura 6. � poss�vel observar que o hor�rio no cabe�alho da p�gina variou, ao passo que a mesma informa��o constante na Partial View Noticias permaneceu inalterada (j� que o resultado disto foi recuperado do cache da aplica��o).

Figura 6: Mecanismo de cache do ASP.NET MVC em a��o

Sem que o tempo inicial de dois minutos tenha se encerrado, proceder com um teste a partir do navegador Google Chrome. Conforme indicado na Figura 7, o resultado da Partial View continua armazenado em cache.

Figura 7: Acessando a aplica��o de testes a partir do Google Chrome

Esgotado este primeiro per�odo de dois minutos, uma nova atualiza��o da p�gina dentro do Internet Explorer for�ar� a atualiza��o do conte�do associado � Partial View (e, consequentemente, a substitui��o do que estava no cache pelo resultado deste novo processamento). A Figura 8 exemplifica todo este fluxo.

Figura 8: Teste efetuado ap�s a expira��o do conte�do em cache

Conclus�o

A t�cnica conhecida como caching � empregada em solu��es Web para armazenar dados e p�ginas em mem�ria, visando com isso tornar mais r�pido o acesso a tais recursos. Trata-se de uma pr�tica importante, uma vez que ao evitar repetidos acessos a bancos de dados, arquivos, Web Services ou outros dispositivos pode contribuir para uma melhor performance durante a utiliza��o de um site.

A fim de possibilitar o armazenamento tempor�rio dos resultados processados por Actions de um Controller, o ASP.NET MVC conta com o atributo OutputCacheAttribute. Essa estrutura conta com diversas propriedades, permitindo que o processo de caching possa ser executado levando em conta variados fatores (tempo, par�metros existentes em uma query string etc.).

Espero que o conte�do aqui apresentado possa ser �til no seu dia a dia. At� uma pr�xima oportunidade!

Tecnologias:

Confira outros conte�dos:

Teste unit�rio com NUnit

Como migrar projetos do ASP.NET MVC...

Crie relat�rios com o Stimulsoft...

Assista grátis a nossa aula inaugural

Perguntas frequentes

Quem somos?

Por que a programação se tornou a profissão mais promissora da atualidade?

Como faço para começar a estudar?

Em quanto tempo de estudo vou me tornar um programador?

Sim, você pode se tornar um programador e não precisa ter diploma de curso superior!

O que eu irei aprender estudando pela DevMedia?

Principais diferenciais da DevMedia

Qual o investimento financeiro que preciso fazer para me tornar um programador?

Como funciona a forma de pagamento da DevMedia?

Por Renato Em 2013

Coment�rios nesta publica��o Escrever um coment�rio sobre conte�do

Rodrigo Brzoski

N�vel

Parab�ns pelos posts... (y)

há +1 ano

Renato Groffe

N�vel 0

Rodrigo/Renato,

Agrade�o pelo feedback e fico feliz que tenham gostado.

há +1 ano

Renato Aranda

N�vel

Muito bom.. Parabens!

há +1 ano

Thiago Inacio

N�vel

Show de bola o Post. Parab�ns!

há +1 ano

Renato Groffe

N�vel 0

Opa Thiago, obrigado pelo feedback!

Minha id�ia � trabalhar nesse m�s e no pr�ximo em v�rios temas relacionados ao ASP.NET MVC, aproveitando at� o gancho com os meus estudos dessa tecnologia.

Renato

há +1 ano

Nossos casos de sucesso

Leonardo Carlos

Eu sabia pouqu�ssimas coisas de programa��o antes de come�ar a estudar com voc�s, fui me especializando em v�rias �reas e ferramentas que tinham na plataforma, e com essa bagagem consegui um est�gio logo no in�cio do meu primeiro per�odo na faculdade.

Lucas Rodrigues

Estudo aqui na Dev desde o meio do ano passado! Nesse per�odo a Dev me ajudou a crescer muito aqui no trampo.
Fui o primeiro desenvolvedor contratado pela minha empresa. Hoje eu lidero um time de desenvolvimento!
Minha meta � continuar estudando e praticando para ser um Full-Stack Dev!

Her�clito J�nior

Economizei 3 meses para assinar a plataforma e sendo sincero valeu muito a pena, pois a plataforma � bem intuitiva e muuuuito did�tica a metodologia de ensino. Sinto que estou EVOLUINDO a cada dia. Muito obrigado!

Julio Cablen

Nossa! Plataforma maravilhosa. To amando o curso de desenvolvimento front-end, tinha coisas que eu ainda n�o tinha visto. A did�tica � do jeito que qualquer pessoa consegue aprender. S�rio, to apaixonado, adorando demais.

Joelberth Sena

Adquiri o curso de voc�s e logo percebi que s�o os melhores do Brasil. � um passo a passo incr�vel. S� n�o aprende quem n�o quer. Foi o melhor investimento da minha vida!

Felipe Nunes

Foi um dos melhores investimentos que j� fiz na vida e tenho aprendido bastante com a plataforma. Voc�s est�o fazendo parte da minha jornada nesse mundo da programa��o, irei assinar meu contrato como programador gra�as a plataforma.

Wanderson Oliveira

Comprei a assinatura tem uma semana, aprendi mais do que 4 meses estudando outros cursos. Exerc�cios pr�ticos que n�o tem como n�o aprender, est�o de parab�ns!

Jos� Lucas

Obrigado DevMedia, nunca presenciei uma plataforma de ensino t�o presente na vida acad�mica de seus alunos, parab�ns!

Eduardo Dorneles

Aprendi React na plataforma da DevMedia h� cerca de 1 ano e meio... Hoje estou h� 1 ano empregado trabalhando 100% com React!

Adauto Junior

J� fiz alguns cursos na �rea e nenhum � t�o bom quanto o de voc�s. Estou aprendendo muito, muito obrigado por existirem. Est�o de parab�ns... Espero um dia conseguir um emprego na �rea.

Ver todos os casos de sucesso

Efetuando o cache de Views no ASP.NET MVC

Veja neste artigo como aplicar t�cnicas de caching em Views no ASP.NET MVC. A partir do armazenamento tempor�rio de informa��es, este tipo de pr�tica pode contribuir de forma significativa para uma melhor performance no acesso a sites.

Criando a solu��o de exemplo

Cria��o dos tipos utilizados na manipula��o do feed de not�cias

Ajustando o Controller que ir� processar as Views da aplica��o

Implementa��o das Views da aplica��o

Conclus�o

Confira outros conte�dos:

Teste unit�rio com NUnit

Como migrar projetos do ASP.NET MVC...

Crie relat�rios com o Stimulsoft...

Perguntas frequentes

Nossos casos de sucesso