THE .NET WAY » XML – – The .Net Way

Serialización: Cambiar el valor del XmlIgnore en runtime

Emilio Torrens — Tue, 15 Nov 2011 09:59:13 +0000

Aquí dejo un ejemplo de código que muestra como cambiar el valor del atributo [XmlIgnore] en tiempo de ejecución para evitar que se serialicen campos a nuestra conveniencia.

public class Person
 {
     [XmlIgnore]        
     public string Name { get; set; }
 
     [XmlIgnore]        
     public int Age { get; set; }
 }
 
 class Program
 {
     static void Main(string[] args)
     {
         Person p = new Person { Name = "El Nombre", Age = 35 };
 
         XmlAttributeOverrides xOverAtt = new XmlAttributeOverrides();
 
         //Hacermos que no serialize el Nombre
         XmlAttributes attrIgnoreTrue = new XmlAttributes();
         attrIgnoreTrue.XmlIgnore = true;
         xOverAtt.Add(typeof(Person), "Name", attrIgnoreTrue);
 
         XmlAttributes attrIgnoreFalse = new XmlAttributes();
         attrIgnoreFalse.XmlIgnore = false;
         xOverAtt.Add(typeof(Person), "Age", attrIgnoreFalse);
         
 
         XmlSerializer xSer = new XmlSerializer(typeof(Person), xOverAtt);
         xSer.Serialize(Console.Out,p);
         
         Console.ReadLine();
     }
 }

Cambiar el “element name” del tipo devuelto en los servicios web

Emilio Torrens — Thu, 10 Nov 2011 12:18:10 +0000

Los servicios web de ASP.NET tienen eso, que cuando quieres devolver tu objeto Person te lo renombran al nombre del método + result y te lo meten dentro de un método + response, así este código:

public class Person
{
    public string Name { get; set; }
}
 
[WebService(Namespace = "http://tempuri.org/")]
public class Service : System.Web.Services.WebService
{
    public Service () {
    }
 
    [WebMethod]
    public Person Get() {
        return new Person { Name = "Pepito" };
    }
    
}

Te generara esto:

Sin embargo usando atributos de Serializacion en la clase Person, definiéndole el nombre y el tipo, y de Soap en la clase Service conseguiremos que nos devuelva el objeto como lo hemos definido.

Así que este código:

[System.Xml.Serialization.XmlRootAttribute(ElementName = "Person", DataType = "Person")]
public class Person
{
    public string Name { get; set; }
}
 
[SoapDocumentService(Use=SoapBindingUse.Literal, ParameterStyle=SoapParameterStyle.Bare), WebService(Namespace = "http://tempuri.org/")]
public class Service : System.Web.Services.WebService
{
    public Service () {
    }
 
    [WebMethod]
    public Person Get() {
        return new Person { Name = "Pepito" };
    }
    
}

Te genera esto:

Serialización: Ignorar campos en tiempo ejecución

Mario Andujar — Tue, 08 Nov 2011 12:58:09 +0000

Aquí dejo un código de ejemplo para ignorar campos en tiempo de ejecución. La clave es crear un método llamado ShouldSerialized mas el nombre del campo.

public class ClassWithNullableElements
    {
 
        private Nullable endField;
 
        private Nullable startField;
 
        [System.Xml.Serialization.XmlAttributeAttribute(DataType = "date", AttributeName = "End")]
        public DateTime EndSerialized
        {
            get { return endField.Value; }
            set { endField = value; }
        }
        public bool ShouldSerializeEndSerialized()
        {
            return End.HasValue;
        }
        [XmlIgnore]
        public Nullable End
        {
            get
            {
                return this.endField;
            }
            set
            {
                this.endField = value;
            }
        }
 
        [System.Xml.Serialization.XmlAttributeAttribute(DataType = "date", AttributeName = "Start")]
        public DateTime StartSerialized
        {
            get { return startField.Value; }
            set { startField = value; }
        }
        public bool ShouldSerializeStartSerialized()
        {
            return Start.HasValue;
        }
        [XmlIgnore]
        public Nullable Start
        {
            get
            {
                return this.startField;
            }
            set
            {
                this.startField = value;
            }
        }
    }

Serializar y DeSerializar json y xml en .NET

Emilio Torrens — Wed, 05 Oct 2011 11:22:47 +0000

Aquí dejo una clase para hacer las serializaciones, la única dependencia es la librería Json.NET

public class Serializer
{
    public enum Format
    {
        json,xml
    }
    
    public static string Serialize(object data, Format format)
    {
        if (format == Format.json)
            return JsonConvert.SerializeObject(data);
        else
        {                
            using (StringWriter sw = new StringWriter())
            {
                XmlSerializer ser = new XmlSerializer(data.GetType());
                ser.Serialize(sw, data);
                sw.Flush();
                sw.Close();
                return sw.ToString();
            }
        }
    }
 
    public static T DeSerialize(string data, Format format)
    {
        if (format == Format.json)
            return JsonConvert.DeserializeObject(data);
        else
        {
            using (StringReader sr = new StringReader(data))
            {
                XmlSerializer ser = new XmlSerializer(typeof(T));
                return (T)ser.Deserialize(sr);
            }
        }
    }
 
}

Rest Services JSON y XML con ASP.NET MVC

Emilio Torrens — Thu, 19 May 2011 12:38:43 +0000

Aquí dejo un ejemplo de como usar MVC para hacer servicios rest utilizando diferentes formatos para transportar los datos, para la serializacion Json utilizo la librería Json.NET, es la única dependencia.

Las url de los servicios de este ejemplo serán estas:

http://localhost/RestServices/MyClass/All.json
http://localhost/RestServices/MyClass/All.xml
http://localhost/RestServices/MyClass/Get/1.json
http://localhost/RestServices/MyClass/Get/1.xml
http://localhost/RestServices/MyClass/GetByName/Nombre%201.json
http://localhost/RestServices/MyClass/GetByName/Nombre%201.xml
http://localhost/RestServices/MyClass/Put.json
http://localhost/RestServices/MyClass/Put.xml
http://localhost/RestServices/MyClass/Delete.json
http://localhost/RestServices/MyClass/Delete.xml

Lo único que tienes que hacer es crear un nuevo proyecto MVC, modificar el Global.asax con las rutas y añadir el controlador.

El código de ejemplo:

Esta clase es de ayuda para el ejemplo, nada especial

public class MyClassHelper
{
    private static List DataList = null;
 
    public class MyClass
    {
        public string Id { get; set; }
        public string Name { get; set; }
    }
 
    public static List Data 
    {
        get 
        {
            if (DataList == null)
            {
                DataList = new List();
                for (int i = 0; i < 10; i++)
                {
                    DataList.Add(new MyClass { Id = i.ToString(), Name = "Nombre " + i });
                }
            }
            return DataList;
        }
    }
 
    public static string MyClassToXml(MyClass c)
    {
        XmlSerializer ser = new XmlSerializer(typeof(MyClass));
        StringWriter sw = new StringWriter();
 
        ser.Serialize(sw, c);
 
        sw.Flush();
        sw.Close();
        return sw.ToString();
    }
 
    public static string MyClassToXml(List c)
    {
        XmlSerializer ser = new XmlSerializer(typeof(List));
        StringWriter sw = new StringWriter();
 
        ser.Serialize(sw, c);
 
        sw.Flush();
        sw.Close();
        return sw.ToString();
    }
 
    public static MyClass XmlToMyClass(string xml)
    {
        StringReader sr = new StringReader(xml);
        XmlSerializer ser = new XmlSerializer(typeof(MyClass));
        return (MyClass)ser.Deserialize(sr);
    }
 
    public static string MyClassToJson(MyClass c)
    {
        return JsonConvert.SerializeObject(c);
    }
 
    public static string MyClassToJson(List c)
    {
        return JsonConvert.SerializeObject(c);
    }
 
    public static MyClass JsonToMyClass(string Json)
    {
        return JsonConvert.DeserializeObject(Json);
    }
 
}

Esta es la clase del Global.asax, aquí es donde se definen las rutas, veas que hay dos, una para el All, Put y Delete y otra para el Get y GetByName, con el id

public static void RegisterRoutes(RouteCollection routes)
{
    routes.IgnoreRoute("{resource}.axd/{*pathInfo}");
 
    routes.MapRoute(
       "Default", // Route name
       "{controller}/{action}.{format}", // URL with parameters
       new { controller = "Home", action = "Index", format = UrlParameter.Optional } // Parameter defaults
   );
 
    routes.MapRoute(
        "WithID", // Route name
        "{controller}/{action}/{id}.{format}", // URL with parameters
        new { controller = "Home", action = "Index", id = UrlParameter.Optional, format = UrlParameter.Optional } // Parameter defaults
    );
 
}

Este es el controlador, aquí definimos los metodos que reciben los parámetros que hemos definido en el Global.asax

public class MyClassController : Controller
{
 
    public string All(string format)
    {
        List result = MyClassHelper.Data;
        if (format.ToLower() == "xml")
        {
            return MyClassHelper.MyClassToXml(result);
        }
        else
        {
            return MyClassHelper.MyClassToJson(result);
        }
        
    }
 
    public string Get(string id, string format)
    {
        MyClassHelper.MyClass result = MyClassHelper.Data.Where(c => c.Id == id).FirstOrDefault();
        if (format.ToLower() == "xml")
        {
            return MyClassHelper.MyClassToXml(result);
        }
        else
        {
            return MyClassHelper.MyClassToJson(result);
        }
 
 
    }
 
    public string GetByName(string id, string format)
    {
        List result = MyClassHelper.Data.Where(c => c.Name == id).ToList();
        if (format.ToLower() == "xml")
        {
            return MyClassHelper.MyClassToXml(result);
        }
        else
        {
            return MyClassHelper.MyClassToJson(result);
        }
    }
 
    public string Put(string format)
    {
        MyClassHelper.MyClass c;
        using (var reader = new StreamReader(Request.InputStream))
        {
            if (format.ToLower() == "xml")
            {
                c = MyClassHelper.XmlToMyClass(reader.ReadToEnd());
            }
            else
            {
               c = MyClassHelper.JsonToMyClass(reader.ReadToEnd());
            }
        }
 
        var v = from myc in MyClassHelper.Data where myc.Id == c.Id select myc;
 
        if (v.Count() == 0)
            MyClassHelper.Data.Add(c);
        else
            v.First().Name = c.Name;
 
        return "OK";
 
    }
 
    public string Delete(string format)
    {
        MyClassHelper.MyClass c;
        using (var reader = new StreamReader(Request.InputStream))
        {
            if (format.ToLower() == "xml")
            {
                c = MyClassHelper.XmlToMyClass(reader.ReadToEnd());
            }
            else
            {
                c = MyClassHelper.JsonToMyClass(reader.ReadToEnd());
            }
        }
 
        MyClassHelper.Data.Remove(c);
 
        return "OK";
 
    }
 
}

Y listo, eso es todo

Obtener los datos XML de un Documento SOAP

Emilio Torrens — Fri, 09 Jan 2009 08:23:00 +0000

Mas de mi servicio "impersonal" …

Resulta que ahora también recibe documentos SOAP, así que tengo que extraer los datos del mensaje SOAP con este código:

private XmlDocument GetSOAPBody(XmlDocument xmlSoap)
    {

              const string SOAP_NAMESPACE = "http://schemas.xmlsoap.org/soap/envelope/";
              XmlNodeList nodes = xmlSoap.GetElementsByTagName("Body", SOAP_NAMESPACE);

          if (nodes.Count == 0) return xmlSoap;

          XmlElement body = (XmlElement)nodes.Item(0);

          nodes = body.ChildNodes;
          for (int i = 0; i < nodes.Count; i++)
          {
              XmlNode node = nodes.Item(i);
              if (node is XmlElement)
              {
                  xmlSoap = new XmlDocument();
                  xmlSoap.LoadXml(node.OuterXml);
                  IsSOAP = true;
                  return xmlSoap;
              }
          }

          return xmlSoap;
      }

Funciona bastante bien, ahora estoy con el de generar las respuestas de OK y de Error, ya lo publicare

Cliente SOAP para servicios PHP o Java AXIS

Emilio Torrens — Mon, 14 Apr 2008 14:08:00 +0000

Aquí dejo una clase para consumir servicios web vía SOAP en los que no tengamos el WSDL o que el Wizard nos de problemas:

using System;
using System.Text;
using System.IO;
using System.Net;
using System.Xml;

namespace Test
    {
    class SOAPClient
        {

        public static XmlDocument SendMsg(XmlDocument xmlRQ)
            {
                byte[] byte1;
                Stream myStream;
                StreamReader readStream;

                HttpWebRequest wr =
                    (HttpWebRequest)WebRequest.
                    Create("http://laurl.com/ws.php");

                byte1 =
                Encoding.GetEncoding(1252).GetBytes(xmlRQ.OuterXml);
                wr.Method = "POST";
                wr.Headers.Add("SOAPAction", "");
                wr.ContentType = "text/xml; charset=\"utf-8\"";
                wr.Accept = "text/xml";

                myStream = wr.GetRequestStream();
                myStream.Write(byte1, 0, byte1.Length);
                myStream.Close();

                myStream = wr.GetResponse().GetResponseStream();
                readStream = new StreamReader(myStream);
                XmlDocument xmlDoc = new XmlDocument();
                xmlDoc.Load(readStream);
                myStream.Close();

                return getSOAPPayload(xmlDoc, "body");
            }

          private static XmlDocument getSOAPPayload(XmlDocument rs,
                                                    string Tag)
            {

                XmlNode xmlNode =
                    rs.GetElementsByTagName(Tag)[0].FirstChild;
                XmlDocument xmlResult = new XmlDocument();
                xmlResult.LoadXml(xmlNode.Value);
                return xmlResult;
            }

        }
    }