VB.NET - Gerando RSS para compartilhar informações

RSS é o acrônimo para Really Simple Syndication - e pode ser considerado uma forma padrão para compartilhar o conteúdo do seu web site.

(Este sistema também é conhecido como Feeds.O termo Feed vem do verbo em inglês "alimentar". Na internet, os "RSS feeds" são listas de atualização de conteúdo de um determinado site.)

No fundo , o RSS é um padrão XML com tags pré-definidas que descreve as informações que você pode compartilhar.

Segundo o WIkipédia - http://pt.wikipedia.org/wiki/RSS , temos as seguintes definições e conceitos relacionados com RSS.

O RSS é um descendente do RDF (Resource Description Framework) e segue as definições da W3C para RDF, que é descendente do XML (Extensible Markup Language) e segue as especificações da W3C para o XML, que por sua vez é descendente do SGML (Standard Generalized Markup Language).

No arquivo RSS são incluídas informações como título, página (endereço exato de onde há algo novo), descrição da alteração, data, autor, etc... de todas as últimas atualizações do site ao qual ele está agregado. De poucos em poucos minutos o arquivo RSS é atualizado mostrando as atualizações recentes.

O RSS é um formato padronizado mundialmente, que funciona com linguagem XML (Extensible Markup Language), e é usado para compartilhar conteúdo Web. Ele permite, por exemplo, que o administrador de um site de notícias crie um arquivo XML com as últimas manchetes publicadas, a fim de compartilhá-las mais rapidamente com seus leitores. Este arquivo poderá ser lido através de qualquer ferramenta que seja capaz de entender o formato XML do RSS.

Serve para receber uma lista de atualizações dos sites escolhidos, no momento em que elas ocorram. Muito usado em sites de notícias, sites de previsão do tempo, informações sobre o trânsito, informações econômicas e blogs. O Gmail (Serviço de Email do Google) também utiliza RSS no seu mecanismo.

Para usar o RSS, você precisa de um programa que leia os arquivos XML, criando um índice das atualizações ocorridas em cada site escolhido. Uma das maneiras é baixar gratuitamente um programa chamado agregador de conteúdo, que funciona de forma semelhante à de um leitor de e-mail.

No frigir dos ovos , RSS é apenas um arquivo XML com tags definidas que pode ser lido de forma compartilhar informação. Abaixo temos um exemplo de um arquivo RSS padrão:

Dando uma olhada nas tags principais temos:(algumas não foram usadas no exemplo acima.)

Além destas tags pode haver uma ou mais tags <item> . Esta tag representa o item atual que você deseja compartilhar.

A esta altura você ja deve estar se perguntando : "Quando esse cara vai falar sobre como gerar um RSS no vb.net" ?

Na verdade a plataforma .NET possui diversas classes para tratar o formato XML, e ,  neste artigo eu vou usar a classe TextWriter para gerar o nosso RSS.

Para poder desenvolver algo que sirva como uma solução genérica e funcione com qualquer web site vamos criar uma classe no VS.NET. A fonte para as nossas tags <item> RSS será um DataSet geralmente preenchido a partir de uma tabela de um banco de dados.

Obs: A classe foi adaptada de alguns exemplos que pequisei na web.

Esta classe terá as seguintes propriedades e métodos :

Propriedades :

• OutputStream - um objeto stream onde a alimentação será disparada.
• RssTitulo - Define o valor da tag <title>
• editorURL - representa o a tag <link>
• Descricao - representa a tag <description>
• CopyRight - define a tag <copyright>
• Generator - define a tag <generator>
• ItemFonte - define um objeto DataSet que contem os ítens.
• ItemTituloCampo - nome da DataColumn que representa a tag <title>
• ItemURLCampo - DataColumn que representa a tag <link>
• ItemDescricaoCampo - DataColumn que representa a tag <description>
• ItemPublicacaoCampo - DataColumn que representa a tag <pubDate>

Métodos:

• publicarRSS :  Método estático que escreve a marcação RSS para o OutPutStream.

A seguir temos um código em VB.NET sobre as propriedades e métodos.

Public Class geraRss

   'propriedades públicas (o correto seria usar Property)

    Public OutputStream As Stream

    Public RssTitulo As String

    Public EditorURL As String

    Public Descricao As String

    Public Copyright As String

    Public Generator As String

    Public ItemFonte As DataSet

    Public ItemTituloCampo As String

    Public ItemURLCampo As String

    Public ItemDescricaoCampo As String

    Public ItemPublicacaoCampo As String

   Public Shared Function publicarRss(ByVal r As Rss)

        Dim writer As New XmlTextWriter(r.OutputStream,System.Text.Encoding.ASCII)

        writer.WriteStartElement("rss")

        writer.WriteAttributeString("version", "2.0")

        writer.WriteStartElement("channel")

        writer.WriteElementString("title", r.RssTitulo)

        writer.WriteElementString("link", r.EditorUrl)

        writer.WriteElementString("description", r.Descricao)

        writer.WriteElementString("copyright", r.Copyright)

        writer.WriteElementString("generator", r.Generator)

        For Each row As DataRow In r.ItemSource.Tables(0).Rows

            writer.WriteStartElement("item")

            writer.WriteElementString("title", row(r.ItemTituloCampo))

            writer.WriteElementString("link", row(r.ItemUrlCampo))

            writer.WriteElementString("description", row(r.ItemDescricaoCampo))

            writer.WriteElementString("pubDate", CType(row(r.ItemPublicacaoCampo), DateTime).ToString("ddd, dd MMM yyyy"))

            writer.WriteEndElement()

        Next

        writer.WriteEndElement()

        writer.WriteEndElement()

        writer.Flush()

     End Function

End Class

No código acima o método publicarRss() é o mais importante.

1. Criamos uma instância da classe  system.XML.XmlTextWriter. Esta classe é usada para escrever documentos XML.
2. Passamos o OutPutStream e definimos o modo ASCII para o exemplo.

Os métodos da classe XmlTextWriter que usamos são :

• WriteStartElement - escreve uma tag aberta para a tag definida;
• WriteAttributeString - escreve um atributo para a tag atual aberta;
• WriteElementString - escreve tag inicial seguida pelo texto e fecha a tag.
• WriteEndElement - escreve o fim da tag recentemente aberta.
• Flush - libera toda saida do buffer para o destino.

Gerando RSS

A classe foi criada e esta pronta , só falta mostrar como usar , certo ?

Vamos supor que os dados do seu site que você quer compartilhar via RSS esteja em uma tabela com a seguinte estrutura:

(Na verdade a estrutura abaixo é a estrutura da tabela artigo do banco de dados jcmsoft.mdb do meu site)

Teremos que criar um código que obtenha o dataset gerado a partir desta tabela. Para fazer isto criamos uma função chamada geraDataSet() que acessa a tabela do banco de dados , seleciona todos os registros e preenche um dataset a partir de um objeto DataAdpater.

O código para fazer esta tarefa pode ser o seguinte :

Function geraDataSet() as DataSet

Dim cnn as New OleDbConnection("Provider=Microsoft.Jet.OLEDB.4.0;Data Source=d:\teste\jcmsoft.mdb")

sql = "select * from artigos order by ArtigoID desc"

Dim da As New OleDbDataAdapter(sql,cnn)
Dim ds as New DataSet()

da.Fill(ds,"artigos")

Return ds

End Function

Nota: A função acima será agregada a classe Rss.

 Juntando todas as partes vamos criar uma aplicação ASP.NET onde na página principal iremos criar uma instância da classe geraRSS() e definir as suas propriedades para finalmente chamar o método geraDataSet().

  Private Sub Page_Load(ByVal sender As System.Object,  ByVal e As System.EventArgs) Handles MyBase.Load

        Dim r As New Rss

        Dim ds As DataSet = geraDataSet()

        r.OutputStream = Response.OutputStream

        r.RssTitulo = "Macoratti.net últimos artigos"

        r.EditorURL = Request.Url.Host

        r.Description = "Macoratti.net - Tudo para VB e VB.NET"

        r.Copyright = "Copyright (C) - www.macoratti.net"

        r.Generator = "Gerador de RSS"

        r.ItemFonte = ds

        r.ItemTituloCampo = "Artigo"

        r.ItemDescricaoCampo = "Descricao"

        r.ItemPublicacaoCampo = "Data"

        r.ItemURLCampo = "local"

        Response.ContentEncoding = System.Text.Encoding.UTF8

        Response.ContentType = "text/xml"

        Rss.PublicarRss(r)

        Response.End()

    End Sub

Agora vamos criar um projeto do tipo ASP.NET web Application com o nome de geraRss1 usando a linguagem VB.NET

A localização do projeto é o diretório virtual padrão inetpub/wwwroot/geraRss1. (para a minha máquina)

Após o projeto ser iniciado inclua uma classe no menu Project opção Add Class e altere o nome do arquivo para geraRss.vb

Após isto inclua o código conforme abaixo :
 

Imports System.Xml

Imports System.io

Imports System.Data.oledb

Public Class Rss

    'propriedades públicas (o correto seria usar Property)

    Public OutputStream As Stream

    Public RssTitulo As String

    Public EditorURL As String

    Public Descricao As String

    Public Copyright As String

    Public Generator As String

    Public ItemFonte As DataSet

    Public ItemTituloCampo As String

    Public ItemURLCampo As String

    Public ItemDescricaoCampo As String

    Public ItemPublicacaoCampo As String

    Public Shared Function publicarRss(ByVal r As Rss)

        Dim writer As New XmlTextWriter(r.OutputStream, System.Text.Encoding.ASCII)

        writer.WriteStartElement("rss")

        writer.WriteAttributeString("version", "2.0")

        writer.WriteStartElement("channel")

        writer.WriteElementString("title", r.RssTitulo)

        writer.WriteElementString("link", r.EditorUrl)

        writer.WriteElementString("description", r.Descricao)

        writer.WriteElementString("copyright", r.Copyright)

        writer.WriteElementString("generator", r.Generator)

        For Each row As DataRow In r.ItemFonte.Tables(0).Rows

            writer.WriteStartElement("item")

            writer.WriteElementString("title", row(r.ItemTituloCampo))

            writer.WriteElementString("link", row(r.ItemURLCampo))

            writer.WriteElementString("description", row(r.ItemDescricaoCampo))

            'writer.WriteElementString("pubDate", CType(row(r.ItemPublicacaoCampo), DateTime).ToString("ddd, dd MMM yyyy"))

            writer.WriteElementString("pubDate", CType(Now, DateTime).ToString("ddd, dd MMM yyyy"))

            writer.WriteEndElement()

        Next

        writer.WriteEndElement()

        writer.WriteEndElement()

        writer.Flush()

    End Function

    Function geraDataSet() As DataSet

        Dim cnn As New OleDbConnection("Provider=Microsoft.Jet.OLEDB.4.0;Data Source=d:\teste\jcmsoft.mdb")

        Dim sql As String = "select * from artigos order by ArtigoID desc"

        Dim da As New OleDbDataAdapter(sql, cnn)

        Dim ds As New DataSet

        da.Fill(ds, "artigos")

        Return ds

    End Function

End Class

Nota: Estou gravando a data como sendo a data de hoje.(now) . Temos também um novo método chamado geraDataSet().

Agora no formulário padrão inclua um botão de comando e inclua o código abaixo no evento Click. Altere também o nome do formulário para geraRss.aspx

Private Sub Button1_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles Button1.Click

        Dim r As New Rss

        Dim ds As DataSet = r.geraDataSet()

        r.OutputStream = Response.OutputStream

        r.RssTitulo = "Macoratti.net últimos artigos"

        r.EditorURL = Request.Url.Host

        r.Descricao = "Macoratti.net - Tudo para VB e VB.NET"

        r.Copyright = "Copyright (C) - www.macoratti.net"

        r.Generator = "Gerador de RSS"

        r.ItemFonte = ds

        r.ItemTituloCampo = "Artigo"

        r.ItemDescricaoCampo = "Descricao"

        r.ItemPublicacaoCampo = "Data"

        r.ItemURLCampo = "local"

        Response.ContentEncoding = System.Text.Encoding.UTF8

        Response.ContentType = "text/xml"

        Rss.PublicarRss(r)

        Response.End()

    End Sub   

Abaixo temos a figura exibindo o layout da pagina os arquivos do projeto:
 

Executando o projeto em localhost e usando o IIS temos o seguinte resultado:

Pronto ! o seu gerador de RSS esta funcionando que é uma beleza. Não esqueça de fazer os ajustes para o seu caso alterando os nomes da tabela e dos campos.

Pegue o projeto completo aqui: geraRss1.zip

Eu sei é apenas VB.NET mas eu gosto !!!

José Carlos Macoratti