Mapeo entre JSON y XML

Los sistemas de lectura y escritura generados por el JsonReaderWriterFactory proporcionan una API de XML sobre contenido de notación de objetos JavaScript (JSON) JSON codifica datos mediante un subconjunto de literales de objeto de JavaScript. También se utilizan los lectores y escritores producidos por esta fábrica cuando las aplicaciones de Windows Communication Foundation (WCF) envían o reciben contenido JSON utilizando WebMessageEncodingBindingElement o WebHttpBinding.

Cuando se inicializa con contenido de JSON, el lector de JSON se comporta del mismo modo que un lector XML textual sobre una instancia de XML. El sistema de escritura de JSON, cuando se proporciona una secuencia de llamadas que en un lector XML textual genera una cierta instancia XML, escribe contenido JSON. El mapeo entre esta instancia de XML y el contenido JSON se describe en este documento para su uso en escenarios avanzados.

Internamente, JSON se representa como un conjunto de información XML cuando WCF lo procesa. Normalmente no tiene que preocuparse por esta representación interna, puesto que el mapeo solo es una representación lógica: JSON no se convierte normalmente en XML en memoria ni se transforma desde XML a JSON. La asignación significa que API XML se utilizan para obtener acceso al contenido de JSON.

Cuando WCF usa JSON, el escenario habitual es que DataContractJsonSerializer sea conectado automáticamente mediante el comportamiento WebScriptEnablingBehavior o el comportamiento WebHttpBehavior, cuando sea apropiado. DataContractJsonSerializer entiende la asignación entre JSON y los conjuntos de información XML y actúa como si tratase directamente con JSON. (Es posible utilizar el DataContractJsonSerializer con cualquier sistema de lectura o escritura XML, siempre que se comprenda que el XML cumple la asignación siguiente).

En escenarios avanzados, puede volverse necesario acceder directamente a la siguiente asignación. Estos escenarios se producen cuando desea serializar y deserializar JSON de maneras personalizadas, sin basarse en el DataContractJsonSerializer, o cuando se trata directamente con el tipo Message para mensajes que contienen JSON. La asignación JSON-XML también se utiliza para el registro de mensajes. Al usar la característica de registro de mensajes en WCF, los mensajes JSON se registran como XML de acuerdo con la asignación descrita en la siguiente sección.

Para aclarar el concepto de asignación, se proporciona el siguiente ejemplo, que procede de un documento JSON.

{"product":"pencil","price":12}

Para leer este documento JSON mediante uno de los lectores previamente mencionados, utilice la misma secuencia de llamadas a XmlDictionaryReader que utilizaría para leer el siguiente documento XML.

<root type="object">
    <product type="string">pencil</product>
    <price type="number">12</price>
</root>

Es más, si WCF recibe el mensaje JSON del ejemplo y lo registra, vería el fragmento XML en el registro anterior.

Mapeo entre JSON y el conjunto de información XML

Formalmente, la asignación se produce entre JSON, tal como se describe en RFC 4627 (excepto con ciertas restricciones relajadas y ciertas otras restricciones añadidas), y el infoset XML (y no XML textual), como se describe en XML Information Set. Consulte este tema para ver las definiciones de los elementos de información y los campos entre [corchetes].

Un documento JSON en blanco se asigna a un documento XML en blanco, y un documento XML en blanco se asigna a un documento JSON en blanco. En la asignación de XML a JSON, no se permiten espacios en blanco al comienzo ni al final del documento.

La asignación se define entre un elemento de información de documento (DII) o un elemento de información de elemento (EII) y JSON. El EII o la propiedad [document element] (elemento de documento) del DII, se conoce como el elemento JSON raíz. Tenga en cuenta que los fragmentos de documentos (XML con varios elementos raíz) no se admiten en este mapeo.

Ejemplo: el documento siguiente:

<?xml version="1.0"?>
<root type="number">42</root>

Y el siguiente elemento:

<root type="number">42</root>

Ambos tienen un mapeo a JSON. El elemento <root> es el elemento JSON raíz en ambos casos.

Además, en el caso de un DII, se debería considerar lo siguiente:

• Algunos elementos en la lista [children] no deben estar presentes. No confíe en este hecho al leer XML mapeado desde JSON.

• La lista [children] no contiene ningún elemento de información de comentario.

• La lista [children] no contiene elementos de información de DTD.

• La lista [children] no conserva elementos de información personal (PI) (la declaración <?xml…> no está considerada como un elemento de información PI).

• El conjunto [notations] está vacío.

• El conjunto [unparsed entities] (entidades no analizadas) está vacío.

Ejemplo: el siguiente documento no tiene ningún mapeo a JSON porque [children] contiene un PI y un comentario.

<?xml version="1.0"?>
<!--comment--><?pi?>
<root type="number">42</root>

El EII del elemento JSON raíz tiene las siguientes características:

• [local name] (nombre local) tiene el valor "root" (raíz).

• [nombre de espacio de nombres] no tiene ningún valor.

• [prefix] (prefijo) no tiene ningún valor.

• [children] puede contener elementos EII (que representan los elementos internos, tal y como se describe más adelante) o elementos CII (elementos de información de caracteres, tal y como se describe más adelante) o ninguno de éstos, pero no ambos.

• [attributes] pueden contener los siguientes elementos de información de atributos opcionales (AII)

• El atributo de tipo JSON ("type"), tal y como se describe más adelante. Este atributo se utiliza para conservar el tipo JSON (cadena, número, booleano, objeto, matriz o nulo) en el XML asignado.

• El atributo de nombre del contrato de datos ("__type") tal y como se describe más adelante. Este atributo solo puede estar presente si el atributo de tipo de JSON también está presente y su [normalized value] (valor normalizado) es "object". DataContractJsonSerializer utiliza este atributo para conservar información del tipo de contrato de datos; por ejemplo, en casos polimórficos donde se serializa un tipo derivado y donde se espera un tipo base. Si no está trabajando con el DataContractJsonSerializer, en la mayoría de los casos, se pasa por alto este atributo.

• [in-scope namespaces] contiene el enlace de "xml" a http://www.w3.org/XML/1998/namespace tal y como requiere la especificación del conjunto de información.

• [children], [attributes] e [in-scope namespaces] no deben tener elementos distintos de los especificados previamente y [namespace attributes] no deben tener ningún miembro, pero no confíe en estos hechos al leer XML asignado a partir de JSON.

Ejemplo: el siguiente documento no tiene ningún mapeo a JSON porque [namespace attributes] no está vacío.

<?xml version="1.0"?>
<root xmlns:a="myattributevalue">42</root>

El AII para el atributo de tipo JSON tiene las siguientes características:

• [namespace name] no tiene valor.
• [prefix] (prefijo) no tiene ningún valor.
• [local name] es "tipo".
• [normalized value] es uno de los valores de tipo posibles descritos en la siguiente sección.
• [specified] es true.
• [attribute type] (tipo de atributo) no tiene valor.
• [references] (referencias) no tiene valor.

El AII para el atributo de nombre del contrato de datos tiene las siguientes características:

• [namespace name] no tiene valor.
• [prefix] (prefijo) no tiene ningún valor.
• [local name] es "__type" (dos caracteres de subrayado y, a continuación, "type").
• [normalized value] (valor normalizado) es cualquier cadena Unicode válida (la asignación de esta cadena a JSON se describe en la siguiente sección).
• [specified] es true.
• [attribute type] (tipo de atributo) no tiene valor.
• [references] no tienen valor.

Los elementos internos contenidos dentro del elemento JSON raíz u otros elementos internos tienen las siguientes características:

• [local name] puede tener cualquier valor, como se describe más adelante.
• [namespace name], [prefix], [children], [attributes], [namespace attributes] e [in-scope namespaces] están sujetos a las mismas reglas que el elemento JSON raíz.

En el elemento JSON raíz y los elementos internos, el atributo de tipo JSON define el mapeo a JSON y los posibles elementos hijos y su interpretación. El valor normalizado del atributo distingue entre mayúsculas y minúsculas, debe estar en minúsculas y no puede contener espacios.

Los registros de miembros funcionan de la siguiente manera:

• El [local name] del elemento interno se asigna a la parte de string del member, según se define en la sección 2.2 del RFC de JSON.

Ejemplo: el siguiente elemento se corresponde con un fragmento de JSON.

<root type="object">
    <myLocalName type="string">aaa</myLocalName>
</root>

Se muestra el siguiente fragmento de JSON.

{"myLocalName":"aaa"}

• En la asignación de XML a JSON, los caracteres que deben escaparse en JSON se escapan, y el resto no se escapan. El carácter "/", aunque no es un carácter que deba ser escapado, lo es de todas formas (no es necesario que sea escapado en la asignación de JSON a XML). Esto es necesario para admitir el formato AJAX de ASP.NET para los datos DateTime en JSON.

• En la asignación de JSON a XML, todos los caracteres (incluidos los que no tienen escape, si fuese necesario) se toman para formar una string que genera un [local name].

• Los elementos internos [children] se asignan al valor en la sección 2.2, de acuerdo con el JSON Type Attribute de la misma manera que para el Root JSON Element. Se permiten varios niveles de anidación de EII (incluida la anidación dentro de matrices).

Ejemplo: el siguiente elemento corresponde a un fragmento de JSON.

<root type="object">
    <myLocalName1 type="string">myValue1</myLocalName1>
    <myLocalName2 type="number">2</myLocalName2>
    <myLocalName3 type="object">
        <myNestedName1 type="boolean">true</myNestedName1>
        <myNestedName2 type="null"/>
    </myLocalName3>
</root >

El siguiente fragmento de JSON es al que se asigna.

{"myLocalName1":"myValue1","myLocalName2":2,"myLocalName3":{"myNestedName1":true,"myNestedName2":null}}

La situación inversa (caracteres válidos en XML, pero no en JSON) no produce ningún problema, puesto que la asignación anterior incluye pasos de escape/sin escape de JSON.

Los registros de matrices funcionan de la siguiente manera:

• El nombre local del elemento interno es "item".

• Los [children] (elementos secundarios) del elemento interno se asignan al valor en la sección 2.3, según el atributo de tipo JSON, de la misma manera que se hace para el elemento JSON raíz. Se permiten varios niveles de anidación de EII (incluida la anidación dentro de objetos).

Ejemplo: el elemento siguiente se asigna a un fragmento de JSON.

<root type="array">
    <item type="string">myValue1</item>
    <item type="number">2</item>
    <item type="array">
    <item type="boolean">true</item>
    <item type="null"/></item>
</root>

A continuación, se muestra el fragmento JSON.

["myValue1",2,[true,null]]

Consulte también

• JsonReaderWriterFactory
• DataContractJsonSerializer
• Serialización independiente de JSON