<< Java Architecture for XML Binding >>

Transkript

1 JAXB << Java Architecture for XML Binding >> 1

2 Lernziele JAXB Übersicht JAXB Prinzip von Data Binding verstehen Java Klassen aus XSD erzeugen Java Objekte aus XML marschallen bzw. unmarschallen Customized Binding 2

3 Was ist JAXB? JAXB JAXB = Java Architecture for XML Binding JAXB ist ein Standard von SUN bezüglich Java Objekte und XML. ( java.sun.com/xml/jaxb) 3 JAXB enstand aus dem Java Community Process JSR 31 (ca. 2001) MacroMedia BEA HP BreezeFactor Fujitsu webmethods IBM Intalio Oracle Software AG TIBCO Extensibility

4 Eigenschaften von JAXB JAXB Bei JAXB werden die Klassen nicht mehr in Java geschrieben. Sie werden entweder mittels XML Schema oder einer DTD beschrieben. Ein Binding Compiler generiert den Java Source Code anhand von XML Schema oder DTD. JAXB bietet ein Framework um Instanzen dieser generierten Klassen in XML zu marschallen und wieder zurück. 4

5 Prinzip Data Binding bei JAXB JAXB - Prinzip Data Data Structures Structures <xsd> <xsd> <! <! DTD DTD > > Customized Customized Binding Binding <xml> <xml> Binding Compiler Java Java Source Source Code Code Java Compiler Java Java Byte Byte Code Code <xml> <xml> Binding Framework Objekte 5 JAXB erzeugt anhand XSD Java Source Code. Diese Klassen haben die Binding Funktionen schon eingebettet.

6 Prinzip Data Binding bei JAXB JAXB - Prinzip 6

7 JAXB - Prinzip Zusammenspiel von Schema und Objekten b. JAXB 7

8 JAXB - Prinzip Warum Klassen durch XSD oder DTD generieren? Mittels XSD lässt sich fast jede beliebige Datenstruktur beschreiben Das Prinzip lässt sich auch auf andere Technologien anwenden und mit Java kombinieren. z.b. Generierung des Datenmodel einer Datenbank DB Binding Framework Objekte 8 Data Data Model Model [SQL] [SQL] Data Data Structures Structures <xsd> <xsd> Java Java ByteCode ByteCode [class] [class]

9 JAXB beziehen und installieren: JAXB kann bei SUN bezogen werden. Es wird nur zusammen mit dem Java Webservice Development Pack JWSDP ausgeliefert. java.sun.com/webservices/jwsdp/index.jsp JAXB Konfiguration: JAXB - Installation Zurzeit ist das JWSDP ein Package mit eigenem Installer Um das JWSDP bzw. JAXB zu nutzen müssen die Home Environment Variablen angelegt werden. 9 set JAVA_HOME=<your J2SE installation directory> set JWSDP_HOME=<your JWSDP 1.4 installation directory>

10 JAXB - Binding Beispiel einfache Klassen CD Catalog : public class Catalog { Collection cds; } public class Cd { String title; Sting artist; double price; String country; } cds Catalog 0..* Cd title artist price country Set() und Get() Methoden für wurden wegen die wegen der Übersichtlichkeit weggelassen 10

11 JAXB Binding Beispiel einfache Klassen CD Catalog in DTD: <!ELEMENT catalaog (cd*) > <!ELEMENT cd (title, artist, price) > <!ATTLIST cd country CDATA #REQUIRED> <!ELEMENT title (#PCDATA) > <!ELEMENT artist (#PCDATA) > <!ELEMENT price (#PCDATA) > Die DTD lässt eine sehr kompakte Schreibweise zu Mittels der DTD können wir Relationen (0..*) oder (1..*) genauer ausdrücken als in Java. 11 Datentype der Klassenattribute sind aber beschränkt, alles wird zu String

12 JAXB Binding Beispiel einfache Klassen CD Catalog in XSD: 12 <?xml version="1.0" encoding="utf-8"?> <xsd:schema xmlns:xsd=" <xsd:element name="catalog"> <xsd:complextype> <xsd:sequence> <xsd:element name="cd" type="cd" maxoccurs="unbounded" minoccurs="0"/> </xsd:sequence> </xsd:complextype> </xsd:element> <xsd:complextype name="cd"> <xsd:sequence> <xsd:element name="title" type="xsd:string"/> <xsd:element name="artist" type="xsd:string"/> <xsd:element name="price" type="xsd:double"/> </xsd:sequence> <xsd:attribute name="country" type="xsd:string"/> </xsd:complextype> </xsd:schema>

13 Vorteile Beschreibung mittels XSD: JAXB - Binding Bei XSD ist der Syntax nicht so kompakt Mittels XSD können genauere Relationen definiert werden als mit DTD oder Java XSD lässt genauere Datentypen zu als DTD 13

14 Verwendung des Bindings Compilers: Der Binding Compiler kann entweder mittels ANT oder über das mitgelieferte xjc.bat aufgerufen werden Beispiel Aufruf xjc.bat : JAXB Binding Compiler %JWSDP_HOME%\jaxb\bin\xjc.bat -p my.music d gen-src cdcatalog.xsd Parameter Beschreibung -p pack.subpack package für die generierten Klassen -d dir Destinations-Verzeichnis, muss existieren xxxx.xsd Pfad zur XML Schema Datei 14

15 JAXB Binding Compiler 15 Verwendung des Bindings Compilers: Beispiel Ausgabe: %JWSDP_HOME%\jaxb\bin\xjc.bat -d gen-src -p my.music cdcatalog.xsd parsing a schema... compiling a schema... my\music\impl\catalogimpl.java my\music\impl\catalogtypeimpl.java my\music\impl\cdimpl.java my\music\impl\jaxbversion.java my\music\catalog.java my\music\catalogtype.java my\music\cd.java my\music\objectfactory.java my\music\bgm.ser my\music\jaxb.properties ca. 40 Dateien werden generiert!

16 Ausgabe des Binding Compilers: JAXB - Binding JAXB generiert für unsere Objekte jeweils Interfaces, Implementation und Hilfsklassen Wir werden nie direkt die Implementation selber verwenden, sondern nur die Interfaces und Hilfsklassen Catalog Cd ObjectFactory CatalogImpl CdImpl 16

17 JAXB Framework Marshalling mit JAXB 17 // create Factory ObjectFactory factory = new ObjectFactory(); // Build Cd Catalog Catalog cat = factory.createcatalog(); Cd cd = factory.createcd(); cd.setcountry("usa"); cd.setprice(10.90);... cat.getcd().add(cd); // initialise JAXB JAXBContext jc = JAXBContext.newInstance("my.music"); // create a Marshaller Marshaller m = jc.createmarshaller(); // marshal catalog OutputStream os = new FileOutputStream("cdcatalog.xml"); m.marshal( cat, os );

18 Unmarshalling mit JAXB JAXB Framework 18 // initialise JAXB JAXBContext jc = JAXBContext.newInstance("my.music"); // create an Unmarshaller Unmarshaller u = jc.createunmarshaller(); // unmarshal catalog Catalog cat = (Catalog) u.unmarshal( new FileInputStream("cdcatalog.xml")); // Iterate through CD's Iterator it = cat.getcd().iterator(); while(it.hasnext()) { Cd cd = (Cd) it.next(); System.out.println(cd.getTitle()); }

19 Validierung bei Marshalling (1/2): Beispiel im XSD: Der Marshaller von JAXB unternimmt keine Validierung beim marshallen der Objekte. Dies kann zu einer Verletzung des Schemas führen <xsd:element name="cd" type="cd" maxoccurs="unbounded" minoccurs="2"/> Beispiel im Java Code: // Build Cd Catalog with only one CD Catalog cat = factory.createcatalog(); cat.getcd().add(cd); m.marshal( cat, os ); JAXB Framework 19 Auswirkungen wären ungültige XML

20 Validierung bei Marshalling (2/2): JAXB bietet einen Validator um die Objektstruktur gemäss dem Schema zu überprüfen Beispiel im Java Code: JAXB Framework // Build Cd Catalog with only one CD Catalog cat = factory.createcatalog(); cat.getcd().add(cd); // Create Validator Validator validator = jc.createvalidator(); validator.validate(cat); m.marshal( cat, os ); Ausgabe ist eine Exception da mehr CD s erwartet wurden: 20 DefaultValidationEventHandler: [ERROR]: uncompleted content model. expecting: <cd>

21 JAXB Customized Binding JAXB bietet die Möglichkeit das Binding nach eigenen Wünschen anzupassen. Abbildung von XML Elementen Java Bean Package Vererbung Methodennamen Datentypen für Java Bean Attribute Das Customized Binding wird mittels definierten XML Anweisungen beschrieben. Diese Anweisungen können inline im XSD oder als externe Datei realisiert werden. 21

22 JAXB Customized Binding Beispiel einer externen Binding Definition (1/2): <jaxb:bindings xmlns:jaxb=" xmlns:xs=" version="1.0"> <jaxb:bindings schemalocation="cdcatalog.xsd"> <jaxb:bindings <jaxb:class name="compactdisc"/> <jaxb:bindings <jaxb:property name="albumname"/> </jaxb:bindings> </jaxb:bindings> </jaxb:bindings> </jaxb:bindings> 22 Hier wird ein XML Element auf eine anderen Klassennamen gemappt

23 JAXB Customized Binding Beispiel einer externen Binding Definition (2/2): Generiertes Interfaces nach Aufruf des Binding Compilers interface CompactDisc { public void setalbumname(string value); public String getalbumname(); public void setprice(double value); public double getprice(); } public void setartist(string value); public String getartist(); 23

24 JAXB Customized Binding Die wichtigsten Customizing Binding Instruktionen sind: <jaxb:bindings> Root Element oder Beginn einer Definition <jaxb:class> Mapping von einem XSD ComplexType auf Klasse <jaxp:property> Mapping von einem Element oder Attribut auf ein Bean Property <jaxb:javatype> Angaben um spezielle Datentypen von/nach String zu konvertieren 24

25 Deklaration JAXB Customized Binding Aufbau eines externen Bindings (1/3): Root schemalocation bindings node class property javatype bindings node <jaxb:bindings... > <jaxb:bindings schemalocation... > <jaxb:bindings node="[xpath]"> <jaxb:xxxx> </jaxb:bindings> <jaxb:bindings node="[xpath]"/> 25 schemalocation </jaxb:bindings> <jaxb:bindings schemalocation... /> </jaxb:bindings>

26 JAXB Customized Binding Aufbau eines externen Bindings (2/3): Externe Binding Defintionen beginnen mit dem Root <jaxb:bindings>. Der Namespace und die Version ist dabei zwingend <jaxb:bindings xmlns:jaxb=" xmlns:xsd=" version="1.0"> Danach wird auf das jeweilige Schema mit einem <jaxb:bindings schemalocation> verwiesen 26 <jaxb:bindings xmlns:jaxb=... > <jaxb:bindings schemalocation="path.to.schema.xsd">... </jaxb:bindings> </jaxb:bindings>

27 JAXB Customized Binding Aufbau eines externen Bindings (3/3): Die Binding Definition besteht aus verschiedenen Mapping Instruktionen. Die Beziehung zwischen diesen Instruktionen und dem XSD wird mittels XPath festgelegt. <jaxb:bindings xmlns:jaxb=... > <jaxb:bindings schemalocation="..."> 27 <jaxb:bindings <jaxb:class name="compactdisc"/> <jaxb:bindings <jaxb:property name="albumname"/> </jaxb:bindings> </jaxb:bindings>... </jaxb:bindings>

28 JAXB Customized Binding Aufruf des Binding Compilers bei externem Binding: Die externe Binding Definition wird beim Aufruf des Binding Compilers mit einem separaten Parameter -b angegeben: %JWSDP_HOME%\jaxb\bin\xjc.bat -b cdcatalog.jbx cdcatalog.xsd 28

29 JAXB Customized Binding Beispiel einer inline Binding Definition (1/2): <xsd:complextype name="cd"> <xsd:attribute name="country" type="xs:string"> <xsd:annotation> <xsd:appinfo> <jaxb:property name="isocountry"/> </xsd:appinfo> </xsd:annotation> </xsd:attribute> </xsd:complextype> Die Binding Instruktionen werden mittels <xsd:annotation> in das Schema eingebettet 29 Sie werden jeweils für jedes Element separat angegeben

30 JAXB Customized Binding Beispiel einer inline Binding Definition (2/2): <xs:complextype name="cd"> <xs:attribute name="country" type="xs:string"> <xs:annotation> <xs:appinfo> <jaxb:property name="isocountry"/> </xs:appinfo> </xs:annotation> </xs:attribute> public interface Cd </xs:complextype> { public void setisocountry(string c); public String getisocountry(); } 30 Hier wird ein XML Attribut auf ein bestimmtes Java Bean Property gemappt

31 JAXB - Links Sun: JAXB Sun: Java Web Service Tutorial xml.com: The JAXB API On Java: Understanding JAXB IBM: Data Binding with JAXB 31