VB XML Literals

Desde la versión 9.0 de VB .Net existe una característica llamada XML Literals la cual consiste en poder escribir XML directamente en el código VB y manejar el xml como parte del lenguaje.

Actualmente cuando en una solución necesito trabajar con XML, donde generalmente hay puros proyectos de C#, también agrego un proyecto en VB.Net solo para el manejo de XML por que se me facilita con XML Literals.

Para mostrar como se utiliza XML Literals mostraré un ejemplo (el clásico ejemplo de una orden) el cual consiste en una clase que exporta e importa ordenes a/desde XML.

Para esto creo una solución con 3 proyectos uno de tipo C# Windows library con el nombre XmlLiteralsExample.Domain el cual contiene las clases Order y OrderItem con esta definición

namespace XmlLiteralsExample.Domain
{
 public class Order
 {
     public int Id { get; set; }
     public string Customer { get; set; }
     public List<OrderItem> Items { get; set; }

     public Order()
     {
         Items = new List<OrderItem>();
     }
 }

 public class OrderItem
 {
     public int ProductId { get; set; }
     public int Quantity { get; set; }
     public string Description { get; set; }
     public decimal Price { get; set; }
 }
}

Ahora agrego el proyecto de tipo VB Class library llamado XmlLiteralsExample.Tasks en el cual agregaré la clase en VB que me ayudará con el XML

Imports XmlLiteralsExample.Domain

Public Class OrderXmlTasks
 Public Function ReadFromFile(ByVal FileName As String) As Order
     Throw New NotImplementedException()
 End Function

 Public Sub SaveToFile(ByVal FileName As String)
     Throw New NotImplementedException()
 End Sub

 Public Function FindOrderItem(ByVal FileName As String, _
                               ByVal ProductId As Integer) As OrderItem

     Throw New NotImplementedException()
 End Function

End Class

Y por último agrego un proyecto para las pruebas unitarias en C# llamado XmlLiteralsExample.Tasks.Test en el cual agregaré las pruebas unitarias para nuestra clase OrderXmlTasks y un archivo xml para las pruebas.

El proyecto XmlLiteralsExample.Test tiene referencias al proyecto Domain así como el proyecto XmlLiteralsExample.Tasks.Test tiene referencias a los otros 2 proyectos de la solución

Además el proyecto de prueba incluye una referencia a las extensiones SharpTestsEx

El Archivo Order.xml contiene una orden de prueba

<?xml version="1.0" encoding="utf-8" ?>
<order id="123" xmlns="urn:schemas-developeando-com:xmlLiterals">
<customer>Homer Simpson</customer>
<items>
 <item productID="1" quantity="2" price="1.50">product desc 1</item>
 <item productID="2" quantity="4" price="2.60">product desc 2</item>
 <item productID="3" quantity="6" price="3.80">product desc 3</item>
</items>
</order>

A partir del archivo de prueba (Order.xml) genero el xml schema utilizando la opción del menú XML de VisualStudio y la guardo en el folder del proyecto Tasks y después agrego el archivo al proyecto. Con esto puedo importar el xml namespace en el archivo OrderXmlTasks.vb como si fuera un namespace de .net

Imports <xmlns="urn:schemas-developeando-com:xmlLiterals">

Esto me ayudará a que visual studio conozca la estructura de mi xml y así pueda darme opciones a través de intellisense

Ahora que tengo los datos de prueba iniciamos con con la funcionalidad, para ello escribo mi primer test en la clase OrderXmlTasksTest (dentro del proyecto de prueba)

[TestMethod]
public void should_load_order_from_file()
{
 var orderXmlTasks = new OrderXmlTasks();
 var order = orderXmlTasks.ReadFromFile(@"C:\..\..\Order.xml");

 order.Id.Should().Be.EqualTo(123);
 order.Customer.Should().Be.EqualTo("Homer Simpson");
 order.Items.Count.Should().Be.EqualTo(3);         
}

Ahora el código para pasar esta prueba:

Public Function ReadFromFile(ByVal FileName As String) As Order
 Dim orderXml = XElement.Load(FileName)

 Dim order = New Order()
 With order
     .Id = orderXml.@id
        .Customer = orderXml.<customer>.Value         
 End With

 For Each itemXml In orderXml.<items>.<item>         
     Dim item = New OrderItem()
     With item
         .ProductId = itemXml.@productID
            .Quantity = itemXml.@quantity
            .Price = itemXml.@price
            .Description = itemXml.Value
     End With
     order.Items.Add(item)
 Next

 Return order
End Function

Ahora explico un poco lo que hace el código; la primer línea carga el xml a un objeto. En este ejemplo uso la clase XElement la cual carga el xml a partir del elemento raíz (en este caso la etiqueta Order). Por lo tanto el objeto orderXml me representa la etiqueta Order del archivo xml. Después creo un objeto order que después lleno con los datos del archivo xml cargados en el objeto orderXml.

En XML Literals para accesar a los atributos de un elemento xml utilizamos la @ es por eso que podemos ver que de carga en la propiedad Id, del objeto order, el valor del atributo id del elemento order del xml. Después se puede notar que para tener acceso a los elementos hijos solo hace falta escribir las etiquetas tal y como lo haríamos en un archivo xml y gracias a que importe el namespace xml también tengo intellisense

de igual forma en una ciclo for each acceso a la colección de items. En este caso acceso al elemento item a través de toda la ruta de elementos hijos.

Pero además XML literals me permite accesar a elementos hijos sin tener que seguir la ruta usando tres puntos entre el objeto y la etiqueta.

Para obtener al texto dentro de una etiqueta se utiliza la propiedad Value del objeto XElement. Así es como obtengo el nombre del cliente y la descripción de los ítems.

Bueno este post ya se extendió y tengo que dividirlo, seguiré con el ejemplo en otro post.