Tutorial XSD (XML Schema Definition)

07/07/2023

El Tutorial de XSD (XML Schema Definition, Definición de Esquema XML) es una excelente continuación después de aprender sobre XML, DTD y XPath. XSD es un lenguaje de esquema que se utiliza para definir la estructura y las restricciones de un documento XML.

Contenidos del artículo

En este tutorial, exploraremos los conceptos fundamentales de XSD y cómo se utiliza para validar y describir la estructura de un documento XML. Aprenderás a definir elementos, atributos, tipos de datos, restricciones, etc.

Con el conocimiento de XSD, podrás crear esquemas sólidos y precisos para tus documentos XML, lo que te proporcionará un mayor control y garantía de calidad en tus proyectos.

1. Tutorial: Introducción a XSD

El XSD es un estándar del World Wide Web Consortium (W3C) que se utiliza para definir la estructura de los documentos XML, permitiendo su validación. Proporciona un conjunto de reglas que permiten especificar los elementos, atributos, tipos de datos y relaciones entre ellos en un documento XML.

Permite establecer la estructura jerárquica de los elementos, especificar los tipos de datos que pueden contener y definir restricciones como valores mínimos y máximos, formatos de datos, entre otros.

Al utilizar XSD, se puede garantizar la consistencia y la integridad de los datos en los documentos XML, lo que resulta especialmente útil en aplicaciones como intercambio de datos, integración de sistemas y validación de entradas en aplicaciones web.

En la actualidad existen dos formas principales de definir la estructura de los documentos XML: mediante DTD y con XSD. Veamos sus diferencias.

2. Diferencias entre DTD y XSD

Los esquemas XSD tienen una forma diferente a los DTD de crear reglas para validar archivos XML. Las diferencias principales son las siguientes:

Los esquemas XSD admiten tipos de datos con verificación, como enteros, fechas y otros tipos.
Los esquemas XSD permiten agregar restricciones, como valores mínimos y máximos para un número, o especificar el patrón que debe seguir una cadena válida.

3. Creación de un XSD

Para crear un documento XSD sigue los siguientes pasos:

Identifica la estructura: Determina la estructura que deseas definir en el esquema XSD. Esto incluye los elementos raíz, elementos secundarios, atributos y sus relaciones. Si existe, podemos examinar un archivo XML de ejemplo para comprender su estructura y los elementos , atributos y tipos de datos que contiene.
Crea el archivo XSD: Utiliza un editor de texto o una herramienta de desarrollo XML para crear un nuevo archivo XSD. Puedes nombrar este archivo según tu preferencia, pero es necesaio usar una extensión «.xsd» a la hora de guardarlo (por ejemplo, «esquema.xsd»).
Define los elementos y tipos de datos: En el archivo XSD, utiliza elementos del lenguaje XSD para definir los elementos del XML y sus tipos de datos. Puedes usar elementos como <xs:element>, <xs:complexType>, <xs:simpleType>, <xs:sequence>, etc.
Asocia el esquema al XML: En el XML, agrega los atributos xmlns:xsi y xsi:noNamespaceSchemaLocation al elemento raíz para declarar el espacio de nombres XML del esquema de instancia y especificar la ubicación del archivo XSD. Por ejemplo:

   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xsi:noNamespaceSchemaLocation="esquema.xsd"

Define las restricciones y validaciones: En el archivo XSD, puedes definir restricciones y validaciones adicionales según sea necesario. Esto incluye restricciones de longitud, valores permitidos, relaciones entre elementos, etc.
Valida el esquema: Utiliza herramientas de validación XML para verificar que el archivo XSD sea válido y no contenga errores de sintaxis.

Ten en cuenta que la creación de un esquema XSD adecuado requiere un buen conocimiento de la estructura del XML y las necesidades específicas de validación de tus datos. Es importante diseñar el esquema de manera precisa para garantizar que el XML cumpla con las restricciones y reglas definidas.

3.1 Estructura de un schema

Para crear un XSD, se utiliza un nodo raíz que contiene todo el esquema y se define mediante el uso del prólogo, que incluye la versión XML. El nodo «schema» contiene todos los elementos y atributos que definen la estructura del documento y las restricciones que se deben cumplir. Por ejemplo, se puede utilizar el siguiente prólogo:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
 ...
</xs:schema>

Como se puede observar, el nodo raíz se define utilizando el espacio de nombres XML «http://www.w3.org/2001/XMLSchema». Esto se especifica utilizando el atributo «xmlns:xs» (o «xmlns:xsd») en el nodo «schema«. El prefijo «xs» (o «xsd») se utiliza como una abreviatura para referirse al espacio de nombres en el resto del esquema.

Es importante destacar que la URL utilizada en el atributo «xmlns:xs» no implica que se deba estar conectado a Internet para trabajar con XML. Simplemente se utiliza como una referencia a la definición de elementos y atributos que se pueden utilizar en el esquema.

3.2. Cómo vincular un esquema XSD a un documento XML

Para vincular un esquema XSD externo en un documento XML, se utiliza un mecanismo que asocia el documento con su esquema correspondiente. Esto es útil para validar que el documento cumple con las reglas y estructuras definidas en el esquema. Veamos cómo se hace:

xmlns:xsi: Se agrega este atributo al elemento raíz del documento XML. Su propósito es declarar el espacio de nombres XML del esquema de instancia (XSI).

xsi:noNamespaceSchemaLocation: Este atributo se agrega también al elemento raíz y se utiliza para especificar la ubicación del archivo XSD que contiene las definiciones del esquema. El valor de este atributo es la URL o ruta relativa del archivo XSD.

<?xml version="1.0" encoding="UTF-8"?>
<root xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="esquema.xsd">
    ...
</root>

Cuando se añaden estos atributos al elemento raíz del documento XML, se está indicando que el documento debe ser validado utilizando el esquema XSD especificado en xsi:noNamespaceSchemaLocation. Veamos un ejemplo:

Ejemplo de archivo XML (documento.xml):

<?xml version="1.0" encoding="UTF-8"?>
<libro xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="esquema.xsd">
    <titulo>Cien años de soledad</titulo>
    <autor>Gabriel García Márquez</autor>
    <anio>1967</anio>
    <genero>Realismo mágico</genero>
</libro>

Ejemplo de archivo XSD (esquema.xsd):

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="libro">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="titulo" type="xs:string"/>
                <xs:element name="autor" type="xs:string"/>
                <xs:element name="anio" type="xs:integer"/>
                <xs:element name="genero" type="xs:string"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>
</xs:schema>

En este ejemplo:

El archivo XML (documento.xml) contiene información sobre un libro, incluyendo título, autor, año y género. Se utiliza el atributo xmlns:xsi para declarar el espacio de nombres XML del esquema de instancia y xsi:noNamespaceSchemaLocation para especificar la ubicación del archivo XSD.
El archivo XSD (esquema.xsd) define la estructura del elemento libro, especificando que debe contener los elementos titulo, autor, anio y genero, con los tipos de datos apropiados.

4. Definición de un elemento

Para declarar o definir un elemento tenemos dos tipos de estructuras:

a) Estructura vacía

<xs:tipoelemento/> <!-- Se puede usar también el prefijo xsd -->

b) Estructura llena

<xs:tipoelemento> <!-- Se puede usar también el prefijo xsd -->
 ...
</xs:tipoelemento>

Un elemento puede contener atributos cuyos valores siempre van entre comillas. Los tipos de atributos que podemos utilizar en los elementos son los siguientes:

Atributo	Descripción
name	Nombre del elemento
type	Tipo simple predefinido, ya sean los estándares o unos propios
maxOccurs	Número máximo de veces que puede aparecer el elemento (p. ej., [0..unbounded])
minOccurs	Número mínimo de veces que puede aparecer el elemento

Tabla 1. Atributos de los elementos XSD

*unbouded=ilimitado

Por defecto, si no definimos maxOccurs ni minOccurs, el elemento aparece una sola vez.

Ejemplo:

Vamos a crear un ejemplo sencillo para ilustrar cómo se utilizan algunos de los atributos anteriores. En este ejemplo, definiremos un elemento <peliculas> que puede contener múltiples elementos <pelicula>.

Ejemplo XSD con maxOccurs:

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <!-- Definición del elemento "peliculas" que puede contener múltiples elementos "pelicula" -->
  <xs:element name="peliculas">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="pelicula" type="xs:string" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

</xs:schema>

En este ejemplo, hemos utilizado el atributo maxOccurs="unbounded" en el elemento <pelicula>. Esto significa que el elemento <peliculas> puede contener múltiples elementos <pelicula>, y el valor «unbounded» indica que no hay un límite superior en la cantidad de veces que el elemento <pelicula> puede aparecer.

Ejemplo de XML que sigue el esquema XSD:

<peliculas>
  <pelicula>Matrix</pelicula>
  <pelicula>Inception</pelicula>
  <pelicula>Interstellar</pelicula>
</peliculas>

En este documento XML, se cumplen las restricciones definidas en el esquema XSD. La etiqueta <peliculas> contiene múltiples elementos <pelicula>, y no hay un límite específico en la cantidad de películas que pueden aparecer.

En resumen, el atributo maxOccurs se utiliza para especificar el número máximo de veces que un elemento puede aparecer. En este caso, hemos utilizado «unbounded» para indicar que el elemento puede aparecer un número ilimitado de veces. Esto es útil cuando se quiere permitir la presencia de un elemento un número indefinido de veces en un contexto específico.

5. Tipos de elementos

En XSD distinguimos entre dos tipos de elementos: simples y complejos.

5.1. Elementos simples <xs:element>

Los elementos simples son aquellos que contienen un solo valor sin subelementos. Estos elementos se definen utilizando el elemento <xs:element> junto con el atributo type para especificar el tipo de datos del elemento.

A continuación se muestra un ejemplo de cómo se define un elemento simple en XSD:

<xs:element name="texto" type="xs:string" />

Existen varios tipos de datos predefinidos en XSD que se pueden utilizar para definir elementos simples mediante el atributo type, como:

Tipo de Datos	Descripción
xs:string	Representa una cadena de texto.
xs:integer	Representa un número entero.
xs:positiveInteger	Representa un número entero positivo.
xs:negativeInteger	Representa un número entero negativo.
xs:boolean	Representa un valor booleano (true o false).
xs:date	Representa una fecha en formato YYYY-MM-DD.
xs:time	Representa una hora en formato HH:MM:SS.
xs:decimal	Representa un número decimal.
xs:float	Representa números de punto flotante de 32 bits de precisión simple.
xs:double	Representa números de punto flotante de 64 bits de doble precisión.

Tabla 2. Tipos de datos simples en XSD (valores del atributo type)

5.2. Elementos complejos <xs:complexType>

El elemento <xs:complexType> se utiliza para definir tipos de datos complejos que tienen sub-elementos y/o atributos. Los tipos de datos complejos permiten especificar la estructura interna de un elemento XML, es decir, sus atributos y elementos hijos.

Dentro del elemento <xs:complexType>, se pueden agregar elementos como los siguientes:

Elemento	Descripción
`<xs:sequence>`	Se utiliza para especificar una secuencia ordenada de elementos hijos. Los elementos deben aparecer en el orden indicado.
`<xs:choice>`	Se utiliza para especificar que solo uno de los elementos hijos puede estar presente en un momento dado. Solo uno de los elementos enumerados dentro de `<xs:choice>` puede aparecer en el XML válido.
`<xs:all>`	Se utiliza para especificar que los elementos hijos pueden estar en cualquier orden. Todos los elementos enumerados dentro de `<xs:all>` pueden aparecer en cualquier orden en el XML válido.
`<xs:attribute>`	Se utiliza para agregar atributos a un tipo complejo. Se puede especificar el nombre (name) y el tipo de atributo (type).

Tabla 4. Elementos que se pueden definir en los elementos complejos

Veamos algunos ejemplos de uso:

1. Ejemplo <xs:sequence>: En este ejemplo, se define un tipo complejo llamado «Person» que contiene dos elementos hijos: «FirstName» y «LastName». Ambos elementos tienen un tipo de dato simple «xs:string».

<xs:complexType name="Person">
  <xs:sequence>
    <xs:element name="FirstName" type="xs:string"/>
    <xs:element name="LastName" type="xs:string"/>
  </xs:sequence>
</xs:complexType>