Serializa��o de objetos em XML com C#

Atualmente, e cada vez mais, tem se observado a necessidade de diferentes aplicaç�es interagirem, enviando e recebendo dados em diversos formatos. E � exatamente neste ponto que muitos esbarram, por n�o conhecerem ou utilizarem um formato que possa ser aproveitado por diversos tipos de sistema, independente da linguagem ou plataforma em que tenham sido desenvolvidos.

Para suprir essa necessidade e facilitar essa comunicaç�o, surgiu a XML, linguagem de representaç�o de dados que se apresentou como uma soluç�o multiplataforma, independente de IDE ou linguagem de programaç�o. A XML organiza os dados em tags, definindo elementos e atributos delimitados pelos caracteres < e >.

Hoje, praticamente todas (sen�o todas) as linguagens de programaç�o oferecem suporte � criaç�o e leitura de arquivos XML e o .NET Framework, como n�o poderia deixar de ser, possui diversas classes que tornam essa tarefa bastante simples.

Neste artigo, veremos como seriailizar e deserializar objetos para e do formato XML utilizando a linguagem C#, simulando a comunicaç�o entre duas aplicaç�es atrav�s da exportaç�o e importaç�o de arquivos nesse formato.

Entendendo a Serializaç�o

Serializar um objeto significa criar uma representaç�o dele em um determinado formato e com um determinado objetivo. Geralmente esse processo � utilizado, como j� foi citado aqui, para exportar esses objetos em um certo formato. As formas mais comuns de serializaç�o, pelo menos no .NET Framework, s�o a serializaç�o em XML e a serializaç�o bin�ria.

No primeiro formato, os objetos s�o convertidos em representaç�o XML, de f�cil leitura e interpretaç�o n�o s� pelas classes do framework, como tamb�m por qualquer pessoa que tenha acesso ao arquivo/c�digo XML gerado e tenha algum conhecimento sobre esse tipo representaç�o.

Na serializaç�o bin�ria, por sua vez, os objetos s�o convertidos para uma representaç�o em bits, que geralmente n�o � poss�vel de ser lida por humanos. Caso se deseje maior sigilo na exportaç�o dos objetos, a serializaç�o bin�ria pode ser mais adequada.

Neste artigo utilizaremos a serializaç�o XML, de forma que possamos analisar a estrutura do XML gerado ao serializar um objeto.

Serializaç�o XML no .NET Framework

No .NET Framework contamos com a classe XmlSerializer, que encontra-se no namespace System.Xml.Serialization e, para o escopo deste artigo, possui dois m�todos de maior relev�ncia:

Serialize: este m�todo recebe o objeto a ser serializado e o stream que representa e controla o arquivo onde o objeto serializado ser� salvo. Apesar de possuir 8 sobrecargas, apenas a primeira delas ser� utilizada neste artigo.
Deserialize: funcionando de forma inversa ao anterior, este m�todo recebe um stream que representa e referencia o arquivo a ser lido, que depois de desserializado, gerar� um retorno do tipo object. Geralmente ser� necess�rio efetuar o cast desse objeto para o tipo esperado, como veremos mais adiante.

Criando a aplicaç�o de exemplo

Para o exemplo que ser� desenvolvido aqui, utilizaremos uma aplicaç�o do tipo Console, para que possamos concentrar a atenç�o no processo de serializaç�o sem se preocupar com interface.

Nossa aplicaç�o simular� um pequeno cadastro de clientes onde o usu�rio ter� duas opç�es:

Cadastrar cliente: nesta opç�o ele informar� os dados do cliente e exportar� o objeto criado para um arquivo XML.
Importar cadastro: aqui o usu�rio poder� importar um arquivo XML com o cadastro de um cliente e visualizar seus dados na tela.

Ent�o, ap�s criar uma Console Application, o primeiro passo ser� criar a classe Cliente, que ficar� respons�vel por serializar e deserializar objetos desse mesmo tipo.

O c�digo dessa classe � apresentado na Listagem 1.

Listagem 1: Classe Cliente

public class Cliente
{
    public string Nome { get; set; }
    public string Email { get; set; }

    public bool Exportar(string caminho)
    {
        try
        {
            FileStream stream = new FileStream(caminho, FileMode.Create);
            XmlSerializer serializador = new XmlSerializer(typeof(Cliente));
            serializador.Serialize(stream, this);
            return true;
        }
        catch
        {
            return false;
        }
    }

    public static Cliente Importar(string caminho)
    {
        try
        {
            FileStream stream = new FileStream(caminho, FileMode.Open);
            XmlSerializer desserializador = new XmlSerializer(typeof(Cliente));
            Cliente cliente = (Cliente)desserializador.Deserialize(stream);
            return cliente;
        }
        catch
        {
            return null;
        }
    }
}

Para manter a simplicidade do exemplo e foco do artigo, esta classe possui apenas duas propriedades e dois m�todos, um para serializar e outro para deserializar o objeto.

Em ambos os m�todos o caminho do arquivo � recebido como par�metro, mas no primeiro este caminho ser� utilizado para criar o arquivo, enquanto no segundo ele ser� utilizado para ler o arquivo j� existente.

Nos dois m�todos tamb�m foi criado um objeto do tipo XmlSerialializer, respons�vel por exportar e importar o objeto. No constructor dessa classe informamos o tipo com o qual ele trabalhar�, que neste caso � a classe Cliente. Tal informaç�o � necess�ria para que o XmlSerializer saiba como representar o objeto quando export�-lo e como efetuar sua leitura no processo de deserializaç�o.

No m�todo Exportar passamos como par�metro para o m�todo Serialize, al�m do FileStream criado, o pr�prio objeto que invoca o m�todo (atrav�s da palavra reservada this).

J� no m�todo Importar, passamos apenas o FileStream como para a funç�o Deserialize, por�m, foi necess�rio efetuar o cast do retorno deste m�todo para o tipo com o qual estamos trabalhando.

Agora podemos partir para o m�todo Main da aplicaç�o e escrever o c�digo principal da aplicaç�o, que trata da interaç�o com o usu�rio, conforme a Listagem 2.

Listagem 2: C�digo do m�todo Main da aplicaç�o

static void Main(string[] args)
{
    while (true)
    {
        Console.WriteLine("--------------------");
        Console.WriteLine("Escolha uma opç�o (digite o n�mero correspondente):");
        Console.WriteLine("1 - CADASTRAR CLIENTE 2 - IMPORTAR CADASTRO; 0 - SAIR");
        Console.WriteLine("--------------------");
        string opc = Console.ReadLine();
        switch (opc)
        {
            case "1":
                Cliente novoCliente = new Cliente();
                Console.Write("Nome: ");
                novoCliente.Nome = Console.ReadLine();
                Console.Write("Email: ");
                novoCliente.Email = Console.ReadLine();
                Console.WriteLine("Informe o caminho do arquivo para exportar o
cadastro do cliente:");
                string caminhoExportacao = Console.ReadLine();
                if(novoCliente.Exportar(caminhoExportacao))
                    Console.WriteLine("Cadastro exportado com sucesso.");
                break;
            case "2":
                Console.WriteLine("Informe o caminho do arquivo para importar o
cadastro do cliente:");
                string caminhoImportacao = Console.ReadLine();
                Cliente cliente = Cliente.Importar(caminhoImportacao);
                if (cliente != null)
                {
                    Console.WriteLine("Nome: " + cliente.Nome);
                    Console.WriteLine("Email: " + cliente.Email);
                }                        
                break;
            default:
                return;  
        }
    }
}

Caso o usu�rio escolha a opç�o 1, ele ser� solicitado a preencher as informaç�es do cliente e definir o caminho do arquivo no qual ser� salvo o objeto serializado no formato XML. Esta operaç�o pode ser vista na Figura 1.

Figura 1: Cliente cadastrado e exportado para arquivo

Podemos ent�o abrir o arquivo que foi gerado para analisar seu conte�do, que para o caso deste exemplo, � apresentado na Listagem 3.

Listagem 3: Conte�do do arquivo XML gerado

<?xml version="1.0"?>
<Cliente xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Nome>Joel</Nome>
  <Email>joelrlneto@gmail.com</Email>
</Cliente>

Vemos que s�o inseridas algumas inscriç�es padr�o de namespace e vers�o do XML, informaç�es que geralmente est�o presentes em arquivos deste tipo. Al�m disso, e o que � o principal para nosso entendimento, percebemos que o objeto do tipo Cliente foi representado como uma tag Cliente com duas tags internas, Nome e Email. Essa estrutura, como fora dito acima, � bastante simples e clara, podendo ser lida com facilidade.

Agora vamos utilizar a opç�o de importar cadastro para deserializar este mesmo arquivo e ver se os dados s�o realmente lidos da forma correta. Para isso, executamos novamente a aplicaç�o e selecionamos a opç�o 2, conforme ilustra a Figura 2.

Figura 2: Objeto importado do arquivo XML

Como vemos, o arquivo foi importado corretamente e nosso objeto Cliente foi desserializado da forma esperada, tendo seus campos preenchidos com os valores salvos no arquivo XML.

Aqui n�o foi feito tratamento de erros, de forma a n�o estender desnecessariamente o c�digo, mas isso pode ser feito facilmente nos m�todos Exportar e Importar.

Conclus�o

A serializaç�o de objetos em formato XML � um processo bastante simples de ser executado, tudo graças � facilidade que o .NET Framework nos oferece para efetuar essa e outras tarefas comuns no dia a dia.

O exemplo desenvolvido aqui � de fato simples, mas serve como base para extens�o e desenvolvimento de procedimentos de exportaç�o e importaç�o de dados em sistemas reais. Por exemplo, � poss�vel importar n�o s� um objeto, como tamb�m uma coleç�o de objetos (utilizando a classe List, por exemplo). Basta ver a documentaç�o da classe XmlSerializer, entender o formato XML e desenvolver suas rotinas de serializaç�o.

Serializa��o de objetos em XML com C#

Veja neste artigo como serializar objetos em C# para o formato XML, através de um exemplo prático de exportação e importação de objetos para e de arquivos XML.

Entendendo a Serializaç�o

Serializaç�o XML no .NET Framework

Criando a aplicaç�o de exemplo

Conclus�o

Links

Artigos relacionados