MANEJO DE FICHEROS XML Versión 1.0

Transcripción

1 MANEJO DE FICHEROS XML Versión 1.0 NOVIEMBRE 2006 Página: 1

2 1 TABLA DE CONTENIDO 1 TABLA DE CONTENIDO INTRODUCCIÓN ELEMENTOS NECESARIOS PARA EL DESARROLLO GENERAR ESQUEMA LECTURA DE XML CREACIÓN DE XML... 6 Página: 2

3 2 INTRODUCCIÓN Este documento indica las pautas básicas sobre la creación y lectura de XML, partiendo del esquema xsd del mismo y usando las librerías aceptadas para el desarrollo por el área de integración y arquitectura de aplicaciones. 3 ELEMENTOS NECESARIOS PARA EL DESARROLLO A parte las librerías y herramientas ya introducidas para el desarrollo, para esta faceta se necesitan los siguientes elementos básicos: - Un editor de XML que permita generar los esquemas y los XML necesarios. En el entorno de trabajo de ICM se usa el XML SPY como herramienta. - El java web service pack 1.3. de sun, cuyo instalable se encuentra accesible en soja_int dentro del apartado de recursos adicionales (Arquitectura de Aplicaciones > Aplicaciones Web > Framework 2 > Recursos Adicionales). Esta versión es la aceptada para desarrollo con las librerías que nombraremos a continuación, ya que sino podremos tener problemas de versión de las mismas. De este elemento se usa la herramienta JAXB. - La librería jaxb_icm_1_3.jar, disponible en la Web de soja_int, que comprende la versión de las librerías a usar. 4 GENERAR ESQUEMA Para el desarrollo de una aplicación que maneje ficheros XML, lo primero es crear un esquema que contemple todos los elementos que lo componen. Es importante que este sea lo más completo posible indicando la obligatoriedad de campos, valores posibles (caso que se muevan dentro de un rango), patrones o alternativas entre elementos. Una vez tengamos ese esquema sobre el que se van a mover todos los XML que vamos a manejar, debemos utilizando la herramienta JAXB generar un paquete de clases con las que seremos capaces de parsear los XML recibidos o generados. Con estas clases tendremos acceso a todos los elementos que componen el fichero. Los pasos a seguir para esto son: 1. ejecutar la instalación del jwsp1.3. en un directorio local, por ejemplo: D:\Producto\jwsdp-1.3. Este directorio de ejemplo es el que vamos a utilizar de referencia, como ruta de instalación del producto. Página: 3

4 2. Copiaremos el esquema que hayamos creado con anterioridad en el directorio, por ejemplo: mod620.xsd. 3. Para generar los paquetes para el manejo de XML hay que ejecutar el programa xjc.bat, siguiendo las instrucciones del producto. Proponemos crear un fichero para esto como el sigue: crearclasesjava.bat D:\Producto\jwsdp-1.3\jaxb\bin\xjc.bat mod620.xsd -p mod620.xml.solicitud -nv En el que se indica cual es el nombre del paquete que queremos generar y la ruta donde se localiza el fichero xjc.bat. 4. Una vez tengamos ya las clases generadas las incorporaremos al proyecto que estemos creando y nos servirán como antes hemos dicho para el uso de XML. Página: 4

5 5 LECTURA DE XML Nota: Este y el siguiente punto supondrá que se esta siguiendo el ejemplo de intercambio de XML disponible en SOJA. Una vez recibido el fichero por los medios propios de la aplicación en concreto, tendremos un InputStream que contiene la información del XML. Esta información se validará con el paquete que contiene la información del esquema (mod620.xml.solicitud) mediante el siguiente trozo de código, insertado en el ejemplo dentro de Mod620Factory.java, y se valida el XML con el esquema xsd: JAXBContext jc = JAXBContext.newInstance("mod620.xml.solicitud"); Unmarshaller u = jc.createunmarshaller(); u.seteventhandler(vec); u.setvalidating(true); CONTROLFICHEROS controlficheros = (CONTROLFICHEROS) u.unmarshal(is); Página: 5

6 Al final de la operación y si no hay errores, tendremos toda la información relativa al esquema dentro de un árbol de clases de fácil acceso. El nodo superior de este árbol en nuestro ejemplo es CONTROLFICHEROS, y a través de él podemos acceder a toda la información contenida dentro del XML parseado. Por otro lado puede que se hayan producido errores a la hora de validar contra el esquema que nosotros tenemos representado en nuestras clases. Entonces nuestra clase CONTROLFICHEROS estará vacía y dispondremos de una lista de eventos de validación que nos informará de lo que esta ocurriendo. 6 CREACIÓN DE XML Con el sistema de clases que hemos construido también podemos crear nuestros propios XML. Para ello debemos usar las clases que se encuentran empaquetadas y para poder crear una instancia de cada clase usaremos el objeto ObjectFactory. Este objeto permite usar los métodos create que nos devolverán las instancias necesarias. Un ejemplo de esto podemos verlo a continuación: mod620.xml.respuesta.controlficheros cf = null; mod620.xml.respuesta.objectfactory of = getobjectfactoryinstance(); try { cf = of.createcontrolficheros(); } catch (JAXBException ex) { throw new Mod620FactoryException(ex.getMessage()); } Una vez tengamos un sistema de clases que completen la estructura que debe tener el XML que deseamos generar, debemos ejecutar el siguiente trozo de código, que se encuentra en Mod620Factory.java: JAXBContext jc = JAXBContext.newInstance("mod620.xml.respuesta"); Marshaller marshall = jc.createmarshaller(); marshall.seteventhandler(new ManejadorValidacion()); ByteArrayOutputStream baos = new ByteArrayOutputStream(); marshall.marshal(controlficheros, baos); byte[] respuestamod620 = baos.tobytearray(); Con el que tendremos, dentro de por ejemplo un array de bytes, el XML ya fusionado siguiendo el esquema indicado por el paquete mod620.xml.respuesta (en nuestro caso). Página: 6

7 NOTA IMPORTANTE: es fundamental comprobar que dentro del directorio de salida de nuestro proyecto se están generando los ficheros bgm.ser y jaxb.properties, justo en el mismo punto en el que se están incluyendo en los fuentes. Sino habrá que copiarlos directamente en él. Página: 7