DOM 4 J紹介とコード例

28254 ワード

dom 4 j

DOM 4 Jはdom 4 j.orgのオープンソースXML解析パッケージです.Dom 4 jは簡単でオープンソースのライブラリであり、XML、XXPTh、XSLTに使用されます.それはJavaプラットフォームに適用され、Java集合の枠組みを採用し、DOM、SAX、JAXPを完全にサポートしています.
DOM 4 Jダウンロードjarパッケージ:http://downloads.sourceforge.net/dom4j/dom4j-1.6.1.jar
JAXEN(XXXathへのサポート):http://dist.codehaus.org/jaxen/distributions/jaxen-1.1.1.zip
1.DOM 4 J主要インターフェース
DOM 4 J主要インターフェースは全部org.dom 4 jというカバンの中で定義されています.
DOM4J介绍与代码示例

−Nodeは、全てのdom 4 jのXMLノードのために多状態挙動を定義している.
-Branchは、XML要素(Element)やドキュメント(Docement)などのサブノードを含むことができる共通の動作を定義しています.
_;-ElementはXML要素を定義します.
|-DcumentはXML文書を定義しています.
-DcumentType XML DOCTYPE宣言を定義する;
-Entity定義XML entity;
-AttributeはXMLの属性を定義しています.
-Processing Instruction定義XML処理命令;
-CharcterDataは、文字ベースのノードを識別するための識別口実である.CDATA、Comments、Textのようです.
_;-CDATAはXML CDATA領域を定義している.
_;-TextはXMLテキストノードを定義する.
|-CompmentはXMLコメントの行為を定義しています.
2.XMLドキュメントの作成
例xml:students.xml

<?xml version="1.0" encoding="UTF-8"?>

<?xml-stylesheet type="text/xsl" href="students.xsl"?>

<students>

    <!--A Student Catalog -->

    <student sn="01">

        <name>sam</name>

        <age>18</age>

    </student>

    <student sn="02">

        <name>lin</name>

        <age>20</age>

    </student>

</students>

以下は上記の文書をdom 4 jで作成し、2つの方法で作成し、一つはdom 4 jで提供される方法であり、一つは文字列で変換する方法である.

import java.io.File;

import java.io.FileWriter;

import java.io.IOException;

import java.util.HashMap;

import java.util.Map;

import org.dom4j.Document;

import org.dom4j.DocumentException;

import org.dom4j.DocumentHelper;

import org.dom4j.Element;

import org.dom4j.io.XMLWriter;



public class XmlGen {

    public Document generateDocumentByMethod() {

        Document document = DocumentHelper.createDocument();

        // ProcessingInstruction

        Map<String, String> inMap = new HashMap<String, String>();

        inMap.put("type", "text/xsl");

        inMap.put("href", "students.xsl");

        document.addProcessingInstruction("xml-stylesheet", inMap);

        // root element

        Element studentsElement = document.addElement("students");

        studentsElement.addComment("An Student Catalog");

        // son element

        Element stuElement = studentsElement.addElement("student");

        stuElement.addAttribute("sn", "01");

        Element nameElement = stuElement.addElement("name");

        nameElement.setText("sam");

        Element ageElement = stuElement.addElement("age");

        ageElement.setText("18");

        // son element

        Element anotherStuElement = studentsElement.addElement("student");

        anotherStuElement.addAttribute("sn", "02");

        Element anotherNameElement = anotherStuElement.addElement("name");

        anotherNameElement.setText("lin");

        Element anotherAgeElement = anotherStuElement.addElement("age");

        anotherAgeElement.setText("20");

        return document;

    }



    public Document generateDocumentByString() {

        String text = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>"

                + "<?xml-stylesheet type=\"text/xsl\" href=\"students.xsl\"?>"

                + "<students><!--An Student Catalog--> <student sn=\"01\">"

                + "<name>sam</name><age>18</age></student><student sn=\"02\">"

                + "<name>lin</name><age>20</age></student></students>";

        Document document = null;

        try {

            document = DocumentHelper.parseText(text);

        } catch (DocumentException e) {

            e.printStackTrace();

        }

        return document;

    }



    public void saveDocument(Document document, File outputXml) {

        try {

            //     

            OutputFormat format = OutputFormat.createPrettyPrint();

            /*

             * //     

             * 

             * OutputFormat format = OutputFormat.createCompactFormat();

             */

            /*

             * //   XML  

             * 

             * format.setEncoding("GBK");

             */

            XMLWriter output = new XMLWriter(new FileWriter(outputXml), format);

            output.write(document);

            output.close();

        } catch (IOException e) {

            System.out.println(e.getMessage());

        }

    }



    public static void main(String[] argv) {

        XmlGen dom4j = new XmlGen();

        Document document = null;

        // document=dom4j.generateDocumentByMethod();

        document = dom4j.generateDocumentByString();

        dom4j.saveDocument(document, new File("output.xml"));

    }

}

Xml Gen.java
メソッドgenerate DockmentByMethod()を呼び出してxmlドキュメントを構築します.
1.DcumentHelperを使ってDcumentの例を得る
Dcument document=Dcument Helper.create Dcument()
2.Processing Instructionを作成する
document.addProcessing Instruction(「xml-styless heet」、inMap);
3.要素Elementの作成
Element students Element=document.addElement(「students」)
4.元素にコメントを付けるComment
students Element.addComment(An Student Catalog);
5.元素に属性を追加する
students Element.addComment(An Student Catalog);
6.元素にテキスト値Textを追加する
element.set Text(「18」);
方法generate DockmentByString()は文字列変換によって直接的にxml文書を構築し、DockmentHelper.parseText()を使用して実現する.
document=Dcument Helper.parseText(text)
メソッドsaveDocument(Docment document、File outputXml)はドキュメントをファイルに保存し、文字コードを指定してフォーマット出力を指定できます.
3.XMLドキュメントの変更
ここでxpathを使用して、修正すべき要素と属性を特定します.jaxenのサポートが必要です.
例では、students-gen.xmlの最初のstudent要素のsn属性を001に変更し、サブ要素nameコンテンツをjeffに変更します.
Xml Mod.java

import java.io.File;

import java.io.FileWriter;

import java.io.IOException;

import java.util.Iterator;

import java.util.List;

import org.dom4j.Attribute;

import org.dom4j.Document;

import org.dom4j.DocumentException;

import org.dom4j.Element;

import org.dom4j.io.SAXReader;

import org.dom4j.io.XMLWriter;



public class XmlMod {

    public void modifyDocument(File inputXml) {

        try {

            SAXReader saxReader = new SAXReader();

            Document document = saxReader.read(inputXml);

            List list = document.selectNodes("//students/student/@sn");

            Iterator iter = list.iterator();

            while (iter.hasNext()) {

                Attribute attribute = (Attribute) iter.next();

                if (attribute.getValue().equals("01"))

                    attribute.setValue("001");

            }

            list = document.selectNodes("//students/student");

            iter = list.iterator();

            while (iter.hasNext()) {

                Element element = (Element) iter.next();

                Iterator iterator = element.elementIterator("name");

                while (iterator.hasNext()) {

                    Element nameElement = (Element) iterator.next();

                    if (nameElement.getText().equals("sam"))

                        nameElement.setText("jeff");

                }

            }

            XMLWriter output = new XMLWriter(new FileWriter(new File(

                    "students-modified.xml")));

            output.write(document);

            output.close();

        } catch (DocumentException e) {

            System.out.println(e.getMessage());

        } catch (IOException e) {

            System.out.println(e.getMessage());

        }

    }



    public static void main(String[] argv) {

        XmlMod dom4jParser = new XmlMod();

        dom4jParser.modifyDocument(new File("students-gen.xml"));

    }

}

1.ファイルのリソースをFileで特定し、これに基づいてDcumentのインスタンスを取得する
SAXREAder saxReader=new SAXREAder()
Dockment document=saxReader.read(inputXml)
2.Dockmentの例のselectNodes方法は、xpathに導入され、Listのインスタンスを返し、これに基づいて、サブジェネレータを使用して、特定のアプリケーションを完了することができる.
List list=document.selectNodes('/students/student/@sn);
4.XMLドキュメントを巡回
ここでは2つのエルゴード法が提供されており、1つは反復に基づくエルゴードであり、1つはVisitorモードに基づくエルゴードである.
Xml Tra.java

import java.io.File;

import java.util.Iterator;

import org.dom4j.Attribute;

import org.dom4j.Document;

import org.dom4j.DocumentException;

import org.dom4j.Element;

import org.dom4j.ProcessingInstruction;

import org.dom4j.VisitorSupport;

import org.dom4j.io.SAXReader;

public class XmlTra {

    private File inputXml;

    public XmlTra(File inputXml) {

        this.inputXml = inputXml;

    }

    public Document getDocument() {

        SAXReader saxReader = new SAXReader();

        Document document = null;

        try {

            document = saxReader.read(inputXml);

        } catch (DocumentException e) {

            e.printStackTrace();

        }

        return document;

    }

    public Element getRootElement() {

        return getDocument().getRootElement();

    }

    public void traversalDocumentByIterator() {

        Element root = getRootElement();

        //            

        for (Iterator ie = root.elementIterator(); ie.hasNext();) {

            System.out.println("======");

            Element element = (Element) ie.next();

            System.out.println(element.getName());

            //     

            for (Iterator ia = element.attributeIterator(); ia.hasNext();) {

                Attribute attribute = (Attribute) ia.next();

                System.out.println(attribute.getName() + ":"

                + attribute.getData());

            }

            //             

            for (Iterator ieson = element.elementIterator(); ieson.hasNext();) {

                Element elementSon = (Element) ieson.next();

                System.out.println(elementSon.getName() + ":"

                + elementSon.getText());

            }

        }

    }

    public void traversalDocumentByVisitor() {

        getDocument().accept(new MyVisitor());

    }

    /**

     * 

     *          

     */

    private static class MyVisitor extends VisitorSupport {

        /**

         * 

         *       ，         

         */

        public void visit(Attribute node) {

            System.out.println("attribute : " + node.getName() + " = "

            + node.getValue());

        }

        /**

         * 

         *         ，           

         */

        public void visit(ProcessingInstruction node) {

            System.out.println("PI : " + node.getTarget() + " "

            + node.getText());

        }

        /**

         * 

         *       ，           ，  ，               。    ，         

         */

        public void visit(Element node) {

            if (node.isTextOnly())

                System.out.println("element : " + node.getName() + " = "

                + node.getText());

            else

                System.out.println("--------" + node.getName() + "--------");

        }

    }

    public static void main(String[] argv) {

        XmlTra dom4jParser = new XmlTra(new File("students-gen.xml"));

        // dom4jParser.traversalDocumentByIterator();

        dom4jParser.traversalDocumentByVisitor();

    }

}

方法trversal DockmentByIterator()は、各Elementは、element Iterator()とatributeIterator()を介して、そのサブ要素と属性の代わりに、そのサブエージェントを提供する.
VisitorはGOFデザインモードの一つです.その主な原理は二つの種類がお互いに相手の引用を保有しています.そして一つはVisitorとして多くのVisityableを訪問します.DOM 4 JのVisitorモードは一つのクラスを決めてVisitorインターフェースを実現すればいいです.

public class MyVisitor extends VisitorSupport {

    public void visit(Element element) {

        System.out.println(element.getName());

    }

    public void visit(Attribute attr) {

        System.out.println(attr.getName());

    }

}

呼び出し:root.accept(new MyVisitor()
Visitorインターフェースは多様なVisit()の重荷重を提供しています.XMLによって異なるオブジェクトは異なる方式でアクセスします.上記はElementとAttributeの簡単な実現です.一般的によく使われているのはこの二つです.VisitoSupportはDOM 4 Jが提供するデフォルトのアダプターであり、VisitorインターフェースのDefault Adapterモードであり、このモードはコードを簡略化するために様々なvisit(*)の空き実装を提供しています.
このVisitorは全サブノードを自動的に巡回するものです.root.accept(MyVisitor)なら、サブノードを巡回します.初めて使う時は、自分で遍歴する必要があると思い、再帰中にVisitorを呼び出しました.
5.Element Handlerを使用する
Xml Handler.java

import java.io.File;

import org.dom4j.DocumentException;

import org.dom4j.Element;

import org.dom4j.ElementHandler;

import org.dom4j.ElementPath;

import org.dom4j.io.SAXReader;

public class XmlHandler {

    public static void main(String[] args) {

       SAXReader saxReader = new SAXReader();

       File file = new File("students.xml");

       try {

           //     ElementHandler  。

           saxReader.addHandler("/students/student", new StudentHandler());

           saxReader.read(file);

       } catch (DocumentException e) {

           System.out.println(e.getMessage());

       }

    }

    /**

     *   StudentHandler    ， <student>      。

     */

    private static class StudentHandler implements ElementHandler {

       public void .Start(ElementPath path) {

           Element elt = path.getCurrent();

           System.out.println("Found student: " + elt.attribut.ue("sn"));

           //       <name>    。

           path.addHandler("name", new NameHandler());

       }

       public void .End(ElementPath path) {

           //       <name>    。

           path.removeHandler("name");

       }

    }

    /**

     *   NameHandler    ， <student> <name>       。

     */

    private static class NameHandler implements ElementHandler {

       public void .Start(ElementPath path) {

           System.out.println("path : " + path.getPath());

       }

       public void .End(ElementPath path) {

           Element elt = path.getCurrent();

           //   <name>            。

           System.out.println(elt.getName() + " : " + elt.getText());

       }

    }

}

6.XSLT変換XMLを使用する
ここではJAXPのサポートを使わなければなりません.

import javax.xml.transform.Transformer;

import javax.xml.transform.TransformerFactory;

import org.dom4j.Document;

import org.dom4j.io.DocumentResult;

import org.dom4j.io.DocumentSource;

    ……

    public Document styleDocument(Document document, String stylesheet)

           throws Exception {

       // load the transformer using JAXP

       TransformerFactory factory = TransformerFactory.newInstance();

       Transformer transformer = factory.newTransformer(new StreamSource(stylesheet));

       // now lets style the given document

       DocumentSource source = new DocumentSource(document);

       DocumentResult result = new DocumentResult();

       transformer.transform(source, result);

       // return the transformed document

       Document transformedDoc = result.getDocument();

       return transformedDoc;

    }

……

本記事は「子ぼうず」のブログから出ていますので、ぜひこの出典を保持してください.

Promise解決多層非同期呼び出し