XStream - Convertidor personalizado

XStream permite escribir un convertidor desde cero, de modo que el desarrollador pueda escribir una implementación completamente nueva sobre cómo serializar un objeto en XML y viceversa. Una interfaz de convertidor proporciona tres métodos:

canConvert - Es una comprobación de la serialización del tipo de objeto admitido.
marshal - serializa un objeto a XML.
unmarshal - Desserializa un objeto de XML.

Paso 1: Implementar la interfaz del convertidor

class StudentConverter implements Converter {

   public boolean canConvert(Class object) {
      return object.equals(Student.class);
   }
   
   public void marshal(Object value, HierarchicalStreamWriter writer, MarshallingContext context) {
      Student student = (Student) value;
      writer.startNode("name");
      writer.setValue(student.getName().getFirstName() + "," + student.getName().getLastName());
      writer.endNode();
   }
   
   public Object unmarshal(HierarchicalStreamReader reader, UnmarshallingContext context) {
      reader.moveDown();
      String[] nameparts = reader.getValue().split(",");
      Student student = new Student(nameparts[0],nameparts[1]);
      reader.moveUp();
      return student;
   }
}

Paso 2: Registrar convertidor

xstream.registerConverter(new StudentConverter());

Probemos ahora el código con convertidor en XStream.

Cree un archivo de clase java llamado XStreamTester en C:\>XStream_WORKSPACE\com\tutorialspoint\xstream.

Archivo: XStreamTester.java

package com.tutorialspoint.xstream;

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;

import javax.xml.transform.OutputKeys;
import javax.xml.transform.Source;
import javax.xml.transform.Transformer;
import javax.xml.transform.sax.SAXSource;
import javax.xml.transform.sax.SAXTransformerFactory;
import javax.xml.transform.stream.StreamResult;

import org.xml.sax.InputSource;

import com.thoughtworks.xstream.XStream;
import com.thoughtworks.xstream.annotations.XStreamAlias;
import com.thoughtworks.xstream.converters.Converter;
import com.thoughtworks.xstream.converters.MarshallingContext;
import com.thoughtworks.xstream.converters.UnmarshallingContext;
import com.thoughtworks.xstream.io.HierarchicalStreamReader;
import com.thoughtworks.xstream.io.HierarchicalStreamWriter;
import com.thoughtworks.xstream.io.xml.StaxDriver;

public class XStreamTester {

   public static void main(String args[]) {
      XStreamTester tester = new XStreamTester();
      XStream xstream = new XStream(new StaxDriver());
      Student student = tester.getStudentDetails();		
      xstream.autodetectAnnotations(true);
      xstream.registerConverter(new StudentConverter());
      
      //Object to XML Conversion
      String xml = xstream.toXML(student);
      System.out.println(formatXml(xml));		
   }	

   private Student getStudentDetails() {
      Student student = new Student("Mahesh","Parashar");		
      return student;
   }

   public static String formatXml(String xml) {
      try {
         Transformer serializer = SAXTransformerFactory.newInstance().newTransformer();
         serializer.setOutputProperty(OutputKeys.INDENT, "yes");
         serializer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "2");
         Source xmlSource = new SAXSource(new InputSource(
            new ByteArrayInputStream(xml.getBytes())));
         StreamResult res =  new StreamResult(new ByteArrayOutputStream());            
         serializer.transform(xmlSource, res);
         return new String(((ByteArrayOutputStream)res.getOutputStream()).toByteArray());
      } catch(Exception e) {
         return xml;
      }
   }   
}

@XStreamAlias("student")
class Student {

   @XStreamAlias("name")
   private Name studentName;

   public Student(String firstName, String lastName) {
      this.studentName = new Name(firstName, lastName);
   }

   public Name getName() {
      return studentName;
   }	
}

class Name {
   private String firstName;
   private String lastName;

   public Name(String firstName, String lastName) {
      this.firstName = firstName;
      this.lastName = lastName;
   }

   public String getFirstName() {
      return firstName;
   }

   public String getLastName() {
      return lastName;
   }     
}

class StudentConverter implements Converter {

   public void marshal(Object value, HierarchicalStreamWriter writer,
      MarshallingContext context) {
      Student student = (Student) value;
      writer.startNode("name");
      writer.setValue(student.getName().getFirstName() + "," + student.getName().getLastName());
      writer.endNode();
   }

   public Object unmarshal(HierarchicalStreamReader reader,
      UnmarshallingContext context) {
      reader.moveDown();
      String[] nameparts = reader.getValue().split(",");
      Student student = new Student(nameparts[0],nameparts[1]);
      reader.moveUp();
      return student;
   }

   public boolean canConvert(Class object) {
      return object.equals(Student.class);
   }
}

Verificar el resultado

Compila las clases usando javac compilador de la siguiente manera:

C:\XStream_WORKSPACE\com\tutorialspoint\xstream>javac XStreamTester.java

Ahora ejecute XStreamTester para ver el resultado:

C:\XStream_WORKSPACE\com\tutorialspoint\xstream>java XStreamTester

Verifique la salida de la siguiente manera:

<?xml version = "1.0" encoding = "UTF-8"?>
<student>
   <name>Mahesh,Parashar</name>
</student>

↰ Previous page