XSL-Transformation für java.beans.XMLDecoder

vorhergehende Artikel in: Java Komponenten Markup
27.08.2022

Ich habe mich vor einigen Wochen in einer Diskussion in einem meiner $dayjob-Projekte von einer konkreten Aufgabe zum Nachdenken anregen lassen: Wie schaffe ich es, Daten zwischen zwei Softwareinstanzen zu übertragen, wenn sich die Version und damit die Struktur des Schemas zwischen beiden unterscheidet?

Im $dayjob-Projekt wurde diese Aufgabe über konkrete Implementierungen in extra dafür geschaffenen Java-Klassen erledigt, die innerhalb des dort eingesetzten proprietären Frameworks in den Serialisierungs- bzw. Deserialisierungspipeliness entsprechend getrigert wurden.

Kann man so machen aber ich bin ja immer einer, der sich für die Variante einsetzt, die bereits millionenfach bewährt hat ihne extra etwas Neues erfinden zu müssen. Ich habe bereits seit Jahren immer sehr gerne die entsprechenden Klassen XMLDecoder und XMLEncoder für die De/Serialisierung von Datenobjekten von und nach XML eingesetzt.

Unter anderem in der sQLshell oder in dWb+ konnte ich damit verschiedenste Aufgaben erfolgreich und mit wenig Aufwand umsetzen.

Allerdings ist auch hier der erfolgreiche Einsatz davon abhängig, dass auf der Seite dessen, der serialisiert genau dieselbe Version der Klasse existiert, wie auf der Seite, die sie serialisierten Daten bei der Deserialisierung interpretieren muss - sobald hier eine Abweichung auftritt, funktioniert die Kommunikation nicht mehr - die serialisierten Daten müssten über entsprechende Regeln in das Format konvertiert werden, das bei der Deserialisierung erwartet wird.

Da es sich hier um XML handelt, liegt nahe, eine solche Anpassung automatisiert durch Transformationen mittels XSL-Templates zu erledigen. Und da stellte sich mir die Frage, ob man das nicht einfach integriert in XMLDecoder bzw. XMLEncoder erledigen ließe.

Durch einen entsprechenden Link stieß ich auf die Idee für die prinzipielle Vorgehensweise, woraus eine Utility-Klasse entstand:

/*
 * Copyright (c) 2022.
 *
 * Juergen Key. Alle Rechte vorbehalten.
 *
 * Weiterverbreitung und Verwendung in nichtkompilierter oder kompilierter Form,
 * mit oder ohne Veraenderung, sind unter den folgenden Bedingungen zulaessig:
 *
 *    1. Weiterverbreitete nichtkompilierte Exemplare muessen das obige Copyright,
 * die Liste der Bedingungen und den folgenden Haftungsausschluss im Quelltext
 * enthalten.
 *    2. Weiterverbreitete kompilierte Exemplare muessen das obige Copyright,
 * die Liste der Bedingungen und den folgenden Haftungsausschluss in der
 * Dokumentation und/oder anderen Materialien, die mit dem Exemplar verbreitet
 * werden, enthalten.
 *    3. Weder der Name des Autors noch die Namen der Beitragsleistenden
 * duerfen zum Kennzeichnen oder Bewerben von Produkten, die von dieser Software
 * abgeleitet wurden, ohne spezielle vorherige schriftliche Genehmigung verwendet
 * werden.
 *
 * DIESE SOFTWARE WIRD VOM AUTOR UND DEN BEITRAGSLEISTENDEN OHNE
 * JEGLICHE SPEZIELLE ODER IMPLIZIERTE GARANTIEN ZUR VERFUEGUNG GESTELLT, DIE
 * UNTER ANDEREM EINSCHLIESSEN: DIE IMPLIZIERTE GARANTIE DER VERWENDBARKEIT DER
 * SOFTWARE FUER EINEN BESTIMMTEN ZWECK. AUF KEINEN FALL IST DER AUTOR
 * ODER DIE BEITRAGSLEISTENDEN FUER IRGENDWELCHE DIREKTEN, INDIREKTEN,
 * ZUFAELLIGEN, SPEZIELLEN, BEISPIELHAFTEN ODER FOLGENDEN SCHAEDEN (UNTER ANDEREM
 * VERSCHAFFEN VON ERSATZGUETERN ODER -DIENSTLEISTUNGEN; EINSCHRAENKUNG DER
 * NUTZUNGSFAEHIGKEIT; VERLUST VON NUTZUNGSFAEHIGKEIT; DATEN; PROFIT ODER
 * GESCHAEFTSUNTERBRECHUNG), WIE AUCH IMMER VERURSACHT UND UNTER WELCHER
 * VERPFLICHTUNG AUCH IMMER, OB IN VERTRAG, STRIKTER VERPFLICHTUNG ODER
 * UNERLAUBTE HANDLUNG (INKLUSIVE FAHRLAESSIGKEIT) VERANTWORTLICH, AUF WELCHEM
 * WEG SIE AUCH IMMER DURCH DIE BENUTZUNG DIESER SOFTWARE ENTSTANDEN SIND, SOGAR,
 * WENN SIE AUF DIE MOEGLICHKEIT EINES SOLCHEN SCHADENS HINGEWIESEN WORDEN SIND.
 *
 */
import javax.xml.transform.*;
import javax.xml.transform.stream.StreamResult;
import javax.xml.transform.stream.StreamSource;
import java.beans.XMLEncoder;
import java.io.IOException;
import java.io.PipedInputStream;
import java.io.PipedOutputStream;

public class BeanTransformer
{
	private static final DefaultEncoderProvider defaultEncoderProvider=new DefaultEncoderProvider();

	protected BeanTransformer()
	{
		super();
	}
	public interface EncoderProvider
	{
		XMLEncoder create(PipedOutputStream pipedOutputStream);
	}
	static class DefaultEncoderProvider extends java.lang.Object implements EncoderProvider
	{
		@Override
		public XMLEncoder create(PipedOutputStream pipedOutputStream)
		{
			return new XMLEncoder( pipedOutputStream );
		}
	}
	public static void transformSerialize(java.lang.Object toSerialize, java.io.OutputStream os, java.io.InputStream template) throws IOException, TransformerException
	{
		transformSerialize(defaultEncoderProvider,toSerialize,os,template);
	}
	public static void transformSerialize(java.lang.Object toSerialize, javax.xml.transform.Result result, javax.xml.transform.Source template) throws IOException, TransformerException
	{
		transformSerialize(defaultEncoderProvider,toSerialize,result,template);
	}
	public static void transformSerialize(EncoderProvider encoderProvider,java.lang.Object toSerialize, java.io.OutputStream os, java.io.InputStream template) throws IOException, TransformerException
	{
		StreamSource xslsource = new StreamSource(template);
		StreamResult xmlresult = new StreamResult( os );
		transformSerialize(encoderProvider,toSerialize,xmlresult,xslsource);
		os.close();
		template.close();
	}
	public static void transformSerialize(EncoderProvider encoderProvider,java.lang.Object toSerialize, javax.xml.transform.Result result, javax.xml.transform.Source template) throws IOException, TransformerException
	{
		PipedInputStream inpipe = new PipedInputStream();
		PipedOutputStream outpipe = new PipedOutputStream( inpipe );
		XMLEncoder enc=encoderProvider.create(outpipe);
		enc.writeObject(toSerialize);
		enc.flush();
		enc.close();
		TransformerFactory tFactory = TransformerFactory.newInstance();
		Transformer transformer = tFactory.newTransformer( template );
		StreamSource xmlsource = new StreamSource( inpipe );
		transformer.transform( xmlsource, result );
	}
	public static java.lang.Object transformDeserialize(java.io.InputStream is, java.io.InputStream template) throws IOException, TransformerException
	{
		StreamSource xmlsource = new StreamSource(is);
		StreamSource xslsource = new StreamSource(template);
		java.lang.Object rv=transformDeserialize(xmlsource,xslsource);
		is.close();
		template.close();
		return rv;
	}
	public static java.lang.Object transformDeserialize(javax.xml.transform.Source input, javax.xml.transform.Source template) throws IOException, TransformerException
	{
		PipedInputStream inpipe=startDeserializatioThread(input,template);
		java.beans.XMLDecoder dec=new java.beans.XMLDecoder(inpipe);
		java.lang.Object rv=dec.readObject();
		dec.close();
		inpipe.close();
		return rv;
	}

	protected static PipedInputStream startDeserializatioThread(Source input, Source template) throws IOException
	{
		PipedOutputStream outpipe = new PipedOutputStream( );
		PipedInputStream inpipe = new PipedInputStream(outpipe);
		new Thread()
		{
			public void run()
			{
				TransformerFactory tFactory = TransformerFactory.newInstance();
				Transformer transformer = null;
				try
				{
					transformer = tFactory.newTransformer(template);
					StreamResult xmlresult = new StreamResult(outpipe);
					transformer.transform(input, xmlresult);
					outpipe.close();
				} catch (TransformerConfigurationException e)
				{
					e.printStackTrace();
				} catch (TransformerException e)
				{
					e.printStackTrace();
				} catch (IOException e)
				{
					e.printStackTrace();
				}
			}
		}.start();
		return inpipe;
	}
}

Diese erledigt die Transformation entweder nach der Serialisierung oder vor der Deserialisierung transparent mit - man muss also statt der direkten Benutzung von XMLDecoder und XMLEncoder nur noch die entsprechenden Methoden dieser Klasse aufrufen und jeweils ein passendes XSL-Template mitgeben - schon kann man auch Daten austauschen, wenn sich die entsprechenden Klassen auf den beiden Seiten unterscheiden!

Und man kann damit natürlich nicht nur De/Serialisierung zwischen XMLDecoder und XMLEncoder flexibilisieren - das korrekte Stylesheetvorausgesetzt kann man nun mittels XMLEncoder Daten für beliebige Zielschemata serialisieren und entsprechend mittels XMLDecoder Daten auch aus beliebigen Quellschemata deserialisieren!

Artikel, die hierher verlinken

XSL-Transformation für JAXB (und Python)

14.09.2022

Wie bereits in meinem früheren Artikel zu diesem Thema beschrieben beschäftigte mich die Möglichkeit, verschiedene Versionen der gleichen Klasse mittels XML zu de/serialisieren - meine Idee war, XSLT zur Anpassung der Unterschiede einzusetzen.

Alle Artikel rss Wochenübersicht Monatsübersicht Github Repositories Gitlab Repositories Mastodon Über mich home xmpp


Vor 5 Jahren hier im Blog

  • Zugriff auf Maps ohne Cast in Java

    22.11.2017

    Collections im Zusammenspiel mit Generics erlauben es, ohne Cast auf Elemente gleichen Typs typsicher zuzugreifen - was aber wenn man typsicher auf Elemente unterschiedlicher Typen in einer Collection zugreifen möchte, ohne zu casten? Hier die Vorstellung einer möglichen Antwort

    Weiterlesen...

Neueste Artikel

  • Nerd-Dictation Tests

    Ich habe vor einiger Zeit schon einmal mit Spracherkennung experimentiert und war damals enttäuscht - vielleicht aber auch deshalb, weil ich nur mäßig motiviert war und mich deshalb bereits früh abschrecken ließ, als nicht alles sofort so funktioniert hat wie ich es wollte. Nun habe ich das Thema nochmals aufgegriffen...

    Weiterlesen...
  • Struktur von PKIs re: Archivzeitstempel

    Hier nochmal eine Beleuchtung der Organisation einer Public Key Infrastructure (PKI) von einem (von mir) bisher nicht betrachteten Blickwinkel

    Weiterlesen...
  • Security QA mit Kotlin-Bibliotheken und Java

    Über die Probleme und Herausforderungen beim Unit-Testen im Security-Umfeld mit Kotlin-Bibliotheken...

    Weiterlesen...

Manche nennen es Blog, manche Web-Seite - ich schreibe hier hin und wieder über meine Erlebnisse, Rückschläge und Erleuchtungen bei meinen Hobbies.

Wer daran teilhaben und eventuell sogar davon profitieren möchte, muß damit leben, daß ich hin und wieder kleine Ausflüge in Bereiche mache, die nichts mit IT, Administration oder Softwareentwicklung zu tun haben.

Ich wünsche allen Lesern viel Spaß und hin und wieder einen kleinen AHA!-Effekt...

PS: Meine öffentlichen GitHub-Repositories findet man hier.