Mere XML i Java. Denne artikel beskriver brug af XML i Java udover parsning (som er beskrevet i artiklen "XML parsning i Java").

Transkript

1 Denne guide er oprindeligt udgivet på Eksperten.dk Mere XML i Java Denne artikel beskriver brug af XML i Java udover parsning (som er beskrevet i artiklen "XML parsning i Java"). Den beskriver bl.a. udskrivning og ændring af XML. Den forudsætter kendskab til Java og XML samt lidt kendskab til XML parsning i Java. Skrevet den 15. Feb 2010 af arne_v I kategorien Programmering / Java [vigtigt: artikel er samme artikel som denne - der gik koks i det i forbindelse med 2 store nedbrud på Eksperten for mange år siden - først ville jeg ikke slette en af dem af hensyn til dem som havde "betalt" for artiklen og nu beholder jeg duplikaterne af hensyn til afgivne kommentarer] Historie: V1.0-03/04/ original V1.1-07/04/ understrege at teorien er beskrivet i den første artikel V1.2-25/07/ tilføje lidt flere forklaringer V1.3-12/12/ opdatere fra JDOM B8 til JDOM 1.0 (der er faktisk ændringer i JDOM interfacet) V1.4-20/08/ tilføje brug af XPath V1.5-26/12/ tilføje standard løsninger som har erstattet Xerces specifikke løsninger og tilføje links V1.6-14/02/ smårettelser Indledning For beskrivelse af W3C DOM og JDOM henvises til artiklen "XML parsning i Java". Der er hele teorien. Det forudsættes at teorien og parse teknikken er kendt. Her vil vi fokusere på brug af W3C DOM og JDOM til andet end parsning. SAX vil ikke blive omtalt da processingen af de indlæste data sker løbende i forbindelse med parsningen og er 100% applikations specifik. Eksemplerne vil bruge følgende fil: test.xml <?xml version='1.0' standalone='yes'?> <medlemmer> <medlem no="1"> <navn>niels Nielsen</navn> <adresse>nellikevej 19</adresse> </medlem>

2 <medlem no="2"> <navn>jens Jensen</navn> <adresse>jagtvej 17</adresse> </medlem> <medlem no="3"> <navn>ole Olsen</navn> <adresse>omfartsvejen 13</adresse> </medlem> <medlem no="4"/> </medlemmer> Udskrift W3C DOM træ Når man nu har lært at læse XML filer ind er det jo naturligt at ville kunne skrive dem ud igen. Der er forskellige måder at udskrive et W3C DOM træ på: - selv skrive noget kode - bruge noget Xerces specifik kode - bruge noget standard kode hvis ens JAXP version er tilstrækkelig ny - bruge XSLT Alle 3 metoder vil blive vist. Først gør det selv koden som består af en enkelt metode writexml som man kalder med en node. Metoden udskriver så start tag med attributter, kalder sig selv rekursivt for child elementer og udskriver slut tag. Når den kaldes med document root, så udskriver den hele DOM træet. WriteW3CDOMCustom.java import java.io.printstream; import javax.xml.parsers.documentbuilderfactory; import javax.xml.parsers.factoryconfigurationerror; import org.w3c.dom.document; import org.w3c.dom.namednodemap; import org.w3c.dom.node; import org.w3c.dom.nodelist; import org.xml.sax.saxexception; public class WriteW3CDOMCustom { public static void writexml(printstream ps, String ind, Node parent) { switch (parent.getnodetype()) { case Node.ELEMENT_NODE : ps.print(ind + "<" + parent.getnodename()); NamedNodeMap atts = parent.getattributes();

3 for (int i = 0; i < atts.getlength(); i++) { ps.print(" " + atts.item(i).getnodename() + "=\"" + atts.item(i).getnodevalue() + "\""); NodeList childs = parent.getchildnodes(); if (childs.getlength() == 0) { ps.println("/>"); else { ps.println(">"); for (int i = 0; i < childs.getlength(); i++) { writexml(ps, ind + " ", (Node) childs.item(i)); ps.println(ind + "<" + parent.getnodename() + "/>"); break; case Node.TEXT_NODE : if(!parent.getnodevalue().trim().equals("")) { ps.println(ind + parent.getnodevalue().trim()); break; default : // nothing return; DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance(); Document doc = db.parse("c:\\test.xml"); writexml(system.out, "", doc.getdocumentelement()); catch (FactoryConfigurationError e) { catch (ParserConfigurationException e) { catch (SAXException e) { catch (IOException e) { return; Den nok mest brugte XML Java parser nemlig Xerces kommer med en en klasse XMLSerializer til at udskrive DOM træer med. Vigtigt: brug en OutputFormat'er med indenting true - ellers ser output ikke godt ud. WriteW3CDOMXerces.java

4 import javax.xml.parsers.documentbuilderfactory; import javax.xml.parsers.factoryconfigurationerror; import org.w3c.dom.document; import org.xml.sax.saxexception; import org.apache.xml.serialize.outputformat; import org.apache.xml.serialize.xmlserializer; public class WriteW3CDOMXerces { DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance(); Document doc = db.parse("c:\\test.xml"); OutputFormat fmt = new OutputFormat(); fmt.setindenting(true); XMLSerializer ser = new XMLSerializer(System.out, fmt); ser.serialize(doc); catch (FactoryConfigurationError e) { catch (ParserConfigurationException e) { catch (SAXException e) { catch (IOException e) { return; Efter mange år uden en standard måde at udskrive DOM træer med kom der en metode. Bemærk: denne metode kræver en nyere JAXP (enten nyere Java eller en nyere Xerces), fordi den kræver DOM 3.0! WriteW3CDOMStandard.java import javax.xml.parsers.documentbuilderfactory; import javax.xml.parsers.factoryconfigurationerror;

5 import org.w3c.dom.document; import org.w3c.dom.domimplementation; import org.w3c.dom.bootstrap.domimplementationregistry; import org.w3c.dom.ls.domimplementationls; import org.w3c.dom.ls.lsoutput; import org.w3c.dom.ls.lsserializer; import org.xml.sax.saxexception; public class WriteW3CDOMStandard { DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance(); Document doc = db.parse("c:\\test.xml"); DOMImplementation impl = DOMImplementationRegistry.newInstance().getDOMImplementation("XML 3.0"); DOMImplementationLS feature = (DOMImplementationLS)impl.getFeature("LS","3.0"); LSSerializer ser = feature.createlsserializer(); LSOutput output = feature.createlsoutput(); output.setcharacterstream(system.console().writer()); ser.write(doc, output); catch (FactoryConfigurationError e) { catch (ParserConfigurationException e) { catch (SAXException e) { catch (IOException e) { catch (ClassNotFoundException e) { catch (InstantiationException e) { catch (IllegalAccessException e) { return; Mens man ventede på DOM 3.0 fandt snedige folk ud af at man kunne bruge XSLT med et tomt XSL til at udskrive med. WriteW3CDOMXSLT.java

6 import javax.xml.parsers.documentbuilderfactory; import javax.xml.parsers.factoryconfigurationerror; import javax.xml.transform.transformer; import javax.xml.transform.transformerconfigurationexception; import javax.xml.transform.transformerexception; import javax.xml.transform.transformerfactory; import javax.xml.transform.dom.domsource; import javax.xml.transform.stream.streamresult; import org.w3c.dom.document; import org.xml.sax.saxexception; public class WriteW3CDOMXSLT { DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance(); Document doc = db.parse("c:\\test.xml"); TransformerFactory tf = TransformerFactory.newInstance(); Transformer t = tf.newtransformer(); t.transform(new DOMSource(doc), new StreamResult(System.out)); catch (FactoryConfigurationError e) { catch (ParserConfigurationException e) { catch (SAXException e) { catch (IOException e) { catch (TransformerConfigurationException e) { catch (TransformerException e) { return; Udskrift JDOM træ JDOM har en indbygget måde at udskrive et træ på som iøvrigt ligner Xerces en del. WriteJDOM.java import java.io.fileinputstream; import java.io.filenotfoundexception;

7 import org.jdom.document; import org.jdom.jdomexception; import org.jdom.adapters.domadapter; import org.jdom.adapters.xercesdomadapter; import org.jdom.input.dombuilder; import org.jdom.output.format; import org.jdom.output.xmloutputter; public class WriteJDOM { DOMAdapter da = new XercesDOMAdapter(); org.w3c.dom.document w3cdoc = da.getdocument(new FileInputStream("C:\\test.xml"), false); DOMBuilder b = new DOMBuilder(); Document doc = b.build(w3cdoc); XMLOutputter fmt = new XMLOutputter(Format.getPrettyFormat()); System.out.println(fmt.outputString(doc)); catch (FileNotFoundException e) { catch (IOException e) { catch (JDOMException e) { catch (Exception e) { Ændring af og helt nyt W3C DOM træ En anden naturlig ting er at ville er at ændre et indlæst træ. Det er ret simpelt. Dokumentet har metoder til at oprette nye noder og alle noder har en metode til at tilføje de nyoprettede noder som børn. ChangeW3CDOM.java import javax.xml.parsers.documentbuilderfactory; import javax.xml.parsers.factoryconfigurationerror; import org.w3c.dom.document; import org.w3c.dom.element;

8 import org.w3c.dom.node; import org.w3c.dom.nodelist; import org.xml.sax.saxexception; import org.apache.xml.serialize.outputformat; import org.apache.xml.serialize.xmlserializer; public class ChangeW3CDOM { DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance(); Document doc = db.parse("c:\\test.xml"); // fjern tomme medlemmer NodeList elements = doc.getelementsbytagname("medlem"); for (int i = 0; i < elements.getlength(); i++) { Node element = (Element) elements.item(i); if(!element.haschildnodes()) { element.getparentnode().removechild(element); // tilføj nyt medlem Element navn = doc.createelement("navn"); navn.appendchild(doc.createtextnode("lars Larsen")); Element adresse = doc.createelement("adresse"); adresse.appendchild(doc.createtextnode("ledvej 14")); Element medlem = doc.createelement("medlem"); medlem.setattribute("no", "4"); medlem.appendchild(navn); medlem.appendchild(adresse); doc.getdocumentelement().appendchild(medlem); OutputFormat fmt = new OutputFormat(); fmt.setindenting(true); XMLSerializer ser = new XMLSerializer(System.out, fmt); ser.serialize(doc); catch (FactoryConfigurationError e) { catch (ParserConfigurationException e) { catch (SAXException e) { catch (IOException e) { return; Og at oprette et helt nyt træ er helt tilsvarende.

9 CreateW3CDOM.java import javax.xml.parsers.documentbuilderfactory; import javax.xml.parsers.factoryconfigurationerror; import org.w3c.dom.document; import org.w3c.dom.element; import org.apache.xml.serialize.outputformat; import org.apache.xml.serialize.xmlserializer; public class CreateW3CDOM { // lav nyt DOM træ DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance(); Document doc = db.newdocument(); // tilføj elementer til DOM træ Element one1 = doc.createelement("one"); one1.appendchild(doc.createtextnode("a")); Element one2 = doc.createelement("one"); one2.appendchild(doc.createtextnode("bb")); Element one3 = doc.createelement("one"); one3.appendchild(doc.createtextnode("ccc")); Element all = doc.createelement("all"); all.appendchild(one1); all.appendchild(one2); all.appendchild(one3); doc.appendchild(all); OutputFormat fmt = new OutputFormat(); fmt.setindenting(true); XMLSerializer ser = new XMLSerializer(System.out, fmt); ser.serialize(doc); catch (FactoryConfigurationError e) { catch (ParserConfigurationException e) { catch (IOException e) { return; Ændring af og helt nyt JDOM træ

10 Med hensyn til at ændre og oprette træer ligner JDOM faktisk meget W3C DOM. Man kan bare oprette node med en almindelig constructor og interfacet er en anelse mere naturligt. ChangeJDOM.java import java.io.fileinputstream; import java.io.filenotfoundexception; import java.util.list; import org.jdom.document; import org.jdom.element; import org.jdom.jdomexception; import org.jdom.adapters.domadapter; import org.jdom.adapters.xercesdomadapter; import org.jdom.input.dombuilder; import org.jdom.output.format; import org.jdom.output.xmloutputter; public class ChangeJDOM { DOMAdapter da = new XercesDOMAdapter(); org.w3c.dom.document w3cdoc = da.getdocument(new FileInputStream("C:\\test.xml"), false); DOMBuilder b = new DOMBuilder(); Document doc = b.build(w3cdoc); // fjern tomme medlemmer List list = doc.getrootelement().getchildren(); for (int i = 0; i < list.size(); i++) { Element elm = (Element) list.get(i); if(elm.getchildren().size() == 0) { elm.getparent().removecontent(elm); // tilføj nyt medlem Element navn = new Element("navn"); navn.settext("lars Larsen"); Element adresse = new Element("adresse"); adresse.settext("ledvej 14"); Element medlem = new Element("medlem"); medlem.addcontent(navn); medlem.addcontent(adresse); medlem.setattribute("no", "4"); doc.getrootelement().addcontent(medlem); XMLOutputter fmt = new XMLOutputter(Format.getPrettyFormat()); System.out.println(fmt.outputString(doc)); catch (FileNotFoundException e) { catch (IOException e) {

11 catch (JDOMException e) { catch (Exception e) { CreateJDOM.java import org.jdom.document; import org.jdom.element; import org.jdom.output.format; import org.jdom.output.xmloutputter; public class CreateJDOM { // lav nyt DOM træ Document doc = new Document(); // tilføj elementer til DOM træ Element one1 = new Element("one"); one1.settext("a"); Element one2 = new Element("one"); one2.settext("bb"); Element one3 = new Element("one"); one3.settext("ccc"); Element all = new Element("all"); all.addcontent(one1); all.addcontent(one2); all.addcontent(one3); doc.setrootelement(all); XMLOutputter fmt = new XMLOutputter(Format.getPrettyFormat()); System.out.println(fmt.outputString(doc)); Walker W3C DOM har en smart måde at søge et træ igennem efter en bestemt slags noder. Bemærk at denne feature er meget ny og ikke er understøttet i Java SDK 1.4 XML support. Man er nødt til at bruge 1.5 eller at hente f.eks. en nyere Xerces. ScanWitHWalker.java

12 import javax.xml.parsers.documentbuilderfactory; import javax.xml.parsers.factoryconfigurationerror; import org.w3c.dom.document; import org.w3c.dom.node; import org.w3c.dom.traversal.documenttraversal; import org.w3c.dom.traversal.nodefilter; import org.w3c.dom.traversal.treewalker; import org.xml.sax.saxexception; public class ScanWithWalker { DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance(); Document doc = db.parse("c:\\test.xml"); // walk alle elementer af typen navn TreeWalker walk = ((DocumentTraversal) doc).createtreewalker(doc.getdocumentelement(), NodeFilter.SHOW_ELEMENT, null, false); Node n; while ((n = walk.nextnode())!= null) { if (n.getnodename().equals("navn")) { System.out.println(n.getFirstChild().getNodeValue()); catch (FactoryConfigurationError e) { catch (ParserConfigurationException e) { catch (SAXException e) { catch (IOException e) { Vi laver en walker som: - starter i document root - finder alle elementer - ikke har et filter Og så tester vi bare om elementet er et name. Den funktionalitet kunne også være lagt ind i et filter. Men det synes jeg ikke var umagen værd her.

13 Man kan selvfølgelig nemt selv lave noget kode som løber alle elementer igennem (f.eks. rekursivt lige som i writexml metoden i første program). Men walkeren giver noget pænt og let læseligt kode. XPath Hvis man kun skal bruge nogle ganske bestemte noder kan man selecte dem med XPath som er et query sprog til XML. Jeg vil ikke gå i detaljer med hensyn til XPath syntax det kan man og det er der skrevet bøger om. Den ultra korte version er: xxxx - finder elementer med navn xxxx //xxxx/yyyy - finder elementer med navn yyyy under elementer med navn xxxx xxxx[yyyy='abc'] - finder elementer med navn xxxx som har et under element med navn yyyy og en tekstværdi 'abc' xxxx[@yyyy=123] - finder elementer med navn xxxx som har en attribut med navn yyyy og en talværdi 123 Man kan bruge XPath i både W3C DOM og JDOM. XPath er ikke understøttet i Java SDK 1.4 XML support. Man er nødt til at bruge 1.5 eller at hente f.eks. en nyere Xerces. For W3C DOM findes der både en Xerces specifik og en standard måde at gøre det på. SelectWithXPathW3CDOMXerces.java: import javax.xml.parsers.documentbuilderfactory; import javax.xml.transform.transformerexception; import org.w3c.dom.document; import org.w3c.dom.element; import org.w3c.dom.nodelist; import org.xml.sax.saxexception; import org.apache.xpath.xpathapi; public class SelectWithXPathW3CDOM { DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance(); Document doc = db.parse("c:\\test.xml"); // find element hvor no=2 Element res1 =

14 (Element)XPathAPI.selectSingleNode(doc.getDocumentElement(), Element name1 = (Element)res1.getElementsByTagName("navn").item(0); System.out.println(name1.getFirstChild().getNodeValue()); // find alle elementer hvor no >= 2 NodeList res2 = XPathAPI.selectNodeList(doc.getDocumentElement(), "/medlemmer/medlem[@no>=2]"); for(int i = 0; i < res2.getlength(); i++) { Element name2 = (Element)((Element)res2.item(i)).getElementsByTagName("navn").item(0); if(name2!= null) { System.out.println(name2.getFirstChild().getNodeValue()); catch (ParserConfigurationException e) { catch (SAXException e) { catch (IOException e) { catch (TransformerException e) { SelectWithXPathW3CDOMStandard.java: import javax.xml.parsers.documentbuilderfactory; import javax.xml.transform.transformerexception; import javax.xml.xpath.xpath; import javax.xml.xpath.xpathconstants; import javax.xml.xpath.xpathexpressionexception; import javax.xml.xpath.xpathfactory; import org.w3c.dom.document; import org.w3c.dom.element; import org.w3c.dom.nodelist; import org.xml.sax.saxexception; import org.apache.xpath.xpathapi; public class SelectWithXPathW3CDOMStandard {

15 DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance(); Document doc = db.parse("c:\\test.xml"); XPath xpath = XPathFactory.newInstance().newXPath(); // find element hvor no=2 Element res1 = (Element)xpath.evaluate("/medlemmer/medlem[@no=2]", doc.getdocumentelement(), XPathConstants.NODE); Element name1 = (Element)res1.getElementsByTagName("navn").item(0); System.out.println(name1.getFirstChild().getNodeValue()); // find alle elementer hvor no >= 2 NodeList res2 = (NodeList)xpath.evaluate("/medlemmer/medlem[@no>=2]", doc.getdocumentelement(), XPathConstants.NODESET); for(int i = 0; i < res2.getlength(); i++) { Element name2 = (Element)((Element)res2.item(i)).getElementsByTagName("navn").item(0); if(name2!= null) { System.out.println(name2.getFirstChild().getNodeValue()); catch (ParserConfigurationException e) { catch (SAXException e) { catch (IOException e) { catch (XPathExpressionException e) { SelectWithXPathJDOM.java: import java.io.fileinputstream; import java.io.filenotfoundexception; import java.util.list; import org.jdom.document; import org.jdom.element; import org.jdom.jdomexception; import org.jdom.adapters.domadapter; import org.jdom.adapters.xercesdomadapter; import org.jdom.input.dombuilder; import org.jdom.xpath.xpath; public class SelectWithXPathJDOM {

16 DOMAdapter da = new XercesDOMAdapter(); org.w3c.dom.document w3cdoc = da.getdocument(new FileInputStream("C:\\test.xml"), false); DOMBuilder b = new DOMBuilder(); Document doc = b.build(w3cdoc); // find element hvor no=2 Element res1 = (Element)XPath.selectSingleNode(doc, "/medlemmer/medlem[@no=2]"); System.out.println(res1.getChild("navn").getText()); // find alle elementer hvor no >= 2 List res2 = XPath.selectNodes(doc, "/medlemmer/medlem[@no>=2]"); for (int i = 0; i < res2.size(); i++) { Element name2 = ((Element)res2.get(i)).getChild("navn"); if(name2!= null) { System.out.println(name2.getText()); catch (FileNotFoundException e) { catch (IOException e) { catch (JDOMException e) { Videre Artiklen "Nye Java XML API'er" beskriver: - StAX - JAXB - XStream Kommentar af simonvalter d. 05. Apr Viser igen nogen gode eksempler som ikke er større end at man aligevel kan sætte sig ind i dem og ændre dem til eget formål. jeg har brugt både denne og artiklen "XML parsning i Java" flere gange, og har fundet det meget lærerigt med et korrekt eksempel. Kommentar af mr.handstand d. 07. Apr Jeg ønskede en artikel - ikke 5 stk. copy-paste koder. Jeg forventer mere dybde i en artikel, end blot en sætning med ordene, "her kommer chocket". Kommentar af avj d. 16. Jun Kommentar af blackadder d. 03. Apr

17 Det er mere en samling Java funktioner end en egentlig artikel. Der er meget kode, men ikke så meget forklaring. Kommentar af mikkelbm d. 15. Dec Alt i alt en god artikel. Og til kritikerne af artiklen vil jeg bare sige, at for mit vedkommende siger gode eksempler mange gange meget mere end en sides sludder for en sladder!!!