org.dom4j.Element的常用方法举例

Bertha 。 2024-03-17 11:34 37阅读 0赞

#### org.dom4j.Element的常用方法举例 ####

*  一、以xml进行举例说明
 *   *  1、读取xml
     *   *  （1）、从文件中读取
         *  （2）、从字符串中读取
     *  2、Element的常用方法
     *   *  （1）、获取节点名称
         *  （2）、获取节点的值
         *  （3）、设置节点值
         *  （4）、增加或修改节点属性
         *  （5）、获取节点属性的个数
         *  （6）、获取节点的子节点
         *  （7）、根据子节点的名字获取子节点
         *  （8）、添加子节点
         *  （9）、删除某个子节点

## 一、以xml进行举例说明 ##

### 1、读取xml ###

这里读取文件用“org.dom4j.io.SAXReader”这个类，使用“org.dom4j.Document”接收文档数据。  
![在这里插入图片描述][1965db564df2403b85812a2834b951f1.png]

这是测试使用的xml文件“testXml.xml”：

#### （1）、从文件中读取 ####

读取文件使用“SAXReader”的“read(File file)”方法。  
![在这里插入图片描述][3ab21426f3b14d7a8eadeeaa4e4db3ef.png]

测试：

public static void main(String[] args) {
        
        SAXReader reader = new SAXReader();
        Document doc = null;
        String xmlFile = "D:\\opt\\jeecg-boot\\upload\\cib\\testXml.xml";
    
        try {
        
            doc = reader.read(new File(xmlFile));
        } catch (Exception e) {
        
            e.printStackTrace();
        }
    
        System.out.println(doc.getRootElement().asXML());
    }

> asXML()方法以xml的形式输出

运行结果如下：  
![在这里插入图片描述][c5bee79a312540749e8d96bb489b07cd.png]  
成功读取xml文件中的数据。

#### （2）、从字符串中读取 ####

使用“read(InputStream in)”方法从字符串中读取

public static void main(String[] args) {
        
        String xmlStr = "<FOX version=\"1.0\"><SIGNONMSGSRSV1><SONRS><STATUS><CODE>0</CODE><SEVERITY>INFO</SEVERITY></STATUS><DTSERVER>2023-05-2515:43:53</DTSERVER></SONRS></SIGNONMSGSRSV1><SECURITIES_MSGSRSV1><QUERYACCEPTTRNRS><TRNUID>202305251543515222</TRNUID><STATUS><CODE>0</CODE><SEVERITY>INFO</SEVERITY><MESSAGE>处理成功！</MESSAGE></STATUS><RSBODY><CLIENTREF>202305241745245833</CLIENTREF><RESULTCODE>2</RESULTCODE></RSBODY></QUERYACCEPTTRNRS></SECURITIES_MSGSRSV1></FOX>";
    
        SAXReader reader = new SAXReader();
        Document doc = null;
        try {
        
            doc = reader.read(new ByteArrayInputStream(xmlStr.getBytes("UTF-8")));
        } catch (Exception e) {
        
            e.printStackTrace();
        }
    
        printXML(rootElement);
    }

这是格式化xml字符输出的方法：

/**
     * 以xml的形式输出节点
     * @param element
     */
    private static String printXML(Element element) {
        
        OutputFormat outputFormat = OutputFormat.createPrettyPrint();  //格式化打印xml文件
        outputFormat.setEncoding("UTF-8");
    
        StringWriter stringWriter = new StringWriter();
        XMLWriter xmlWriter = new XMLWriter(stringWriter, outputFormat);
        String xmlPrint = null;
        try {
        
            xmlWriter.write(element);
    
            xmlPrint = stringWriter.toString();
            System.out.println(xmlPrint);
    
            xmlWriter.close();
        } catch (IOException e) {
        
            e.printStackTrace();
        }
    
        return xmlPrint;
    }

运行结果如下：  
![在这里插入图片描述][20d6ef8e562a48eda9e415e14b79bc10.png]  
我一般就使用这两种方式读取xml文件。

### 2、Element的常用方法 ###

下面演示“org.dom4j.Element”的常用方法。

#### （1）、获取节点名称 ####

使用“getName()”方法获取节点名称，节点名称就是标签名称。

代码如下：

运行结果如下：  
![在这里插入图片描述][0e376839e2dc4f3099901be8015420e7.png]

#### （2）、获取节点的值 ####

代码如下：

运行结果如下：  
![在这里插入图片描述][b4461d0ad399424a8274e018ef106e01.png]  
节点的值是xml标签中的文本值，子节点（子标签）不属于节点的值。

要想看到效果，可以在字符串中加上：  
![在这里插入图片描述][77ec0702ebbe43f7b2642b905bad3db0.png]  
再次运行：  
![在这里插入图片描述][4c7674c4b927430d9126b45398a85376.png]  
这里会换行是因为有换行符“\\n”。

还有一个“getTextTrim()”方法，顾名思义就是获取节点值的同事去掉前后两边的空格、换行符等。

#### （3）、设置节点值 ####

上面是直接在字符串中增加的节点值，还可以通过Element的方法设置，代码如下：

运行结果如下：

![在这里插入图片描述][9fec5bea1b744d37a6333cec71425cab.png]

#### （4）、增加或修改节点属性 ####

字符串串中的version="1.0"就是“FOX”的属性，现在我要使用“(String name, String value)”方法加上page=“1”的属性，代码如下：

运行结果如下：

![在这里插入图片描述][18fa5649f4fa413f8ff27b30fa139b1d.png]

此外，“addAttribute”方法也可以修改已经存在的标签属性，比如我要报“version”的值设置为“2.0”，代码如下：

![在这里插入图片描述][7021aa2b057840c9930ee9d2ab8d83f6.png]

运行结果如下：

![在这里插入图片描述][64ec859d7de94c09950f6fcc5c0cf155.png]

#### （5）、获取节点属性的个数 ####

通过“attributeCount()”方法获取节点属性的个数，代码如下：

运行结果如下：  
![在这里插入图片描述][bab354f985794343ab1359b55ea28f95.png]  
“FOX”节点的属性就是只有“version”一个。

#### （6）、获取节点的子节点 ####

使用“elements()”获取节点所有的子节点，代码如下：

运行结果如下：

![在这里插入图片描述][e9b5c38b506c4a9c88062d721779c05d.png]  
可以看到已经返回所有的子节点。

“elements”还有其他重载方法，比如：“elements(String name)”方法，传入子节点的名称时，会返回子节点中所有该名称的的节点，为了演示效果，在xml字符串新增了一个“SECURITIES\_MSGSRSV1”节点（标签），如下图：  
![在这里插入图片描述][b7c1908757054c68befc74e1fd92b201.png]

代码如下：

//这里补全的代码没有Element类型，自己手动加上
    List<Element> SECURITIES_MSGSRSV1List = rootElement.elements("SECURITIES_MSGSRSV1");
    for (Element SECURITIES_MSGSRSV1 : SECURITIES_MSGSRSV1List) {
        
        System.out.println("SECURITIES_MSGSRSV1_name：" + SECURITIES_MSGSRSV1.getName() + "，SECURITIES_MSGSRSV1_text：" + SECURITIES_MSGSRSV1.getText());
    }

运行结果如下：

![在这里插入图片描述][2b9ac9c525154232ad477a1d72967343.png]

也可以使用“elementIterator()”方法，它是Element的一个迭代方法，也可以枚举子节点，举例如下：

Iterator foxIterator = rootElement.elementIterator();
    Element currentFoxChildElement = null;
    while (foxIterator.hasNext()) {
        
        currentFoxChildElement = (Element) foxIterator.next();
        System.out.println("currentFoxChildName：" + currentFoxChildElement.getName() + "，currentFoxChildValue：" + currentFoxChildElement.getText());
    }

运行结果如下：

![在这里插入图片描述][5c338311d5a645948db70fb54faabdeb.png]  
“elementIterator”也有其他重载方法，比如：“elementIterator(String name)”方法，传入子节点名称就会返回所有该名称的子节点，还是以新增的第二个“SECURITIES\_MSGSRSV1”做演示，代码如下：

Iterator SECURITIES_MSGSRSV1Iterator = rootElement.elementIterator("SECURITIES_MSGSRSV1");
    Element currentSECURITIES_MSGSRSV1 = null;
    while (SECURITIES_MSGSRSV1Iterator.hasNext()) {
        
        currentSECURITIES_MSGSRSV1 = (Element) SECURITIES_MSGSRSV1Iterator.next();
        System.out.println("SECURITIES_MSGSRSV1_name：" + currentSECURITIES_MSGSRSV1.getName() + "，SECURITIES_MSGSRSV1_text：" + currentSECURITIES_MSGSRSV1.getText());
    }

运行结果如下：

![在这里插入图片描述][46638b516a144d3ba3e79e289901c651.png]

#### （7）、根据子节点的名字获取子节点 ####

使用“element(String name)”方法获取子节点，注意没有后面没有“s”，代码如下：

运行结果如下：

![在这里插入图片描述][1fd644e135ee43cbbcdab0321f4fa0bc.png]  
利用这个方法可以获取很深的子节点，比如我要获取“SEVERITY”节点，代码如下：

![在这里插入图片描述][65c1f5d45a4c4b78bcf9e9ff9808e1b4.png]  
运行结果如下：

![在这里插入图片描述][4203a3e94798468b86b9fd5f4e75b799.png]  
可以看到已经获取到了对应的子节点。这种方式可以解决“com.alibaba.fastjson.JSONObject”通过“getJSONObject”方法获取多层数据下，某一层存在一个以上key报转换类型异常的问题。

不过使用的时候也要小心，一定要保证对应的子节点存在，不然很容易导致空指针异常。

假如对应的子节点存在一个以上，则返回第一个子节点，比如我在xml字符串中加入了一个和“SEVERITY”的子节点：

![在这里插入图片描述][5209e84994044cf5b0fa15b6d4807cf9.png]

增加打印节点的值，再次运行，结果如下：

![在这里插入图片描述][df533a7cbf6a417ab0b2d9052d2ddafc.png]  
可以看到当有多个相同节点名称的时候，返回第一个对应的子节点。

那要是我要找到第二个相同子节点怎么办？可以使用“elements”带节点名称的方法，获得相同名称的所有子节点集合，再根据索引获得指定子节点，获得第二个子节点代码如下：

List<Element> SEVERITYElementList = rootElement.element("SIGNONMSGSRSV1").element("SONRS").element("STATUS").elements("SEVERITY");
    
    Element currentSEVERITYElement = null;
    for (int i = 0; i < SEVERITYElementList.size(); i++) {
        
        currentSEVERITYElement = SEVERITYElementList.get(i);
    
        if ("SEVERITY".equals(currentSEVERITYElement.getName()) && 1 == i) {
        
            System.out.println("currentSEVERITYName：" + currentSEVERITYElement.getName() + "，currentSEVERITYValue：" + currentSEVERITYElement.getText());
        }
    }

运行结果如下：

![在这里插入图片描述][8b16ddd656554c38b7d3a98920245ef4.png]  
成功获得对应的第二个子节点。

#### （8）、添加子节点 ####

“Element”使用“addElement(String name)”方法添加子节点，我这里传的是子节点的名称，代码如下：

public static void main(String[] args) {
        
        String xmlStr = "<FOX version=\"1.0\"><SIGNONMSGSRSV1><SONRS><STATUS><CODE>0</CODE><SEVERITY>INFO</SEVERITY><SEVERITY>ERROR</SEVERITY></STATUS><DTSERVER>2023-05-2515:43:53</DTSERVER></SONRS></SIGNONMSGSRSV1><SECURITIES_MSGSRSV1><QUERYACCEPTTRNRS><TRNUID>202305251543515222</TRNUID><STATUS><CODE>0</CODE><SEVERITY>INFO</SEVERITY><MESSAGE>处理成功！</MESSAGE></STATUS><RSBODY><CLIENTREF>202305241745245833</CLIENTREF><RESULTCODE>2</RESULTCODE></RSBODY></QUERYACCEPTTRNRS></SECURITIES_MSGSRSV1></FOX>";
    
        SAXReader reader = new SAXReader();
        Document doc = null;
        try {
        
            doc = reader.read(new ByteArrayInputStream(xmlStr.getBytes("UTF-8")));
        } catch (Exception e) {
        
            e.printStackTrace();
        }
    
        Element rootElement = doc.getRootElement();
    
        Element addChildElement = rootElement.addElement("ADD");
        printXML(rootElement);
    }

运行结果如下：

![在这里插入图片描述][34331a2a88ad4968a8bbc884e16ac523.png]

可以看到已经增加了子节点（子标签），但这样的标签在xml中是不合法的，可以显示地设置一下文本值，代码如下：

![在这里插入图片描述][b87a8bd573884e71be9e18da31c46406.png]

再次运行：

![在这里插入图片描述][32795af8dd9e4153971573b9fa22c577.png]  
可以看到新增的子节点（子标签）正常了。

#### （9）、删除某个子节点 ####

需要先使用“element”方法获取到对应的节点，再使用“remove(Element element)”方法删除节点，比如我要删除字符串中的“SECURITIES\_MSGSRSV1”节点，代码如下：

public static void main(String[] args) {
        
        String xmlStr = "<FOX version=\"1.0\"><SIGNONMSGSRSV1><SONRS><STATUS><CODE>0</CODE><SEVERITY>INFO</SEVERITY><SEVERITY>ERROR</SEVERITY></STATUS><DTSERVER>2023-05-2515:43:53</DTSERVER></SONRS></SIGNONMSGSRSV1><SECURITIES_MSGSRSV1><QUERYACCEPTTRNRS><TRNUID>202305251543515222</TRNUID><STATUS><CODE>0</CODE><SEVERITY>INFO</SEVERITY><MESSAGE>处理成功！</MESSAGE></STATUS><RSBODY><CLIENTREF>202305241745245833</CLIENTREF><RESULTCODE>2</RESULTCODE></RSBODY></QUERYACCEPTTRNRS></SECURITIES_MSGSRSV1></FOX>";
    
        SAXReader reader = new SAXReader();
        Document doc = null;
        try {
        
            doc = reader.read(new ByteArrayInputStream(xmlStr.getBytes("UTF-8")));
        } catch (Exception e) {
        
            e.printStackTrace();
        }
    
        Element rootElement = doc.getRootElement();
    
        printXML(rootElement);
    
        Element SECURITIES_MSGSRSV1 = rootElement.element("SECURITIES_MSGSRSV1");
        rootElement.remove(SECURITIES_MSGSRSV1);
    
        printXML(rootElement);
    
    }

运行结果如下：

![在这里插入图片描述][866edcced1b04e0b81de6cdefd970bab.png]  
可以看到已经删除“SECURITIES\_MSGSRSV1”。

当尝试使用“remove(Namespace namespace)”方法删除节点时，发现是删除失败的。代码如下：

public static void main(String[] args) {
        
        String xmlStr = "<FOX version=\"1.0\"><SIGNONMSGSRSV1><SONRS><STATUS><CODE>0</CODE><SEVERITY>INFO</SEVERITY><SEVERITY>ERROR</SEVERITY></STATUS><DTSERVER>2023-05-2515:43:53</DTSERVER></SONRS></SIGNONMSGSRSV1><SECURITIES_MSGSRSV1><QUERYACCEPTTRNRS><TRNUID>202305251543515222</TRNUID><STATUS><CODE>0</CODE><SEVERITY>INFO</SEVERITY><MESSAGE>处理成功！</MESSAGE></STATUS><RSBODY><CLIENTREF>202305241745245833</CLIENTREF><RESULTCODE>2</RESULTCODE></RSBODY></QUERYACCEPTTRNRS></SECURITIES_MSGSRSV1></FOX>";
    
        SAXReader reader = new SAXReader();
        Document doc = null;
        try {
        
            doc = reader.read(new ByteArrayInputStream(xmlStr.getBytes("UTF-8")));
        } catch (Exception e) {
        
            e.printStackTrace();
        }
    
        Element rootElement = doc.getRootElement();
    
        printXML(rootElement);
    
        Element SECURITIES_MSGSRSV1 = rootElement.element("SECURITIES_MSGSRSV1");
    //        rootElement.remove(SECURITIES_MSGSRSV1);
    
        rootElement.remove(SECURITIES_MSGSRSV1.getNamespace());
    
        printXML(rootElement);
    
    }

运行结果如下：

![在这里插入图片描述][c8f7000d93e34bc99d0f062479e41494.png]

debug发现所有的删除方法最后都会走这个方法：

![在这里插入图片描述][f01bf4cde3fb4096b447bc616eff497d.png]

而“contentShadow”是一个集合，发现是“Element”集合  
![在这里插入图片描述][221f1897f15f4c99822d3dee296cf054.png]  
只有传的是“Element”，“answer”才会返回“true”，才会走删除节点“childRemoved(Node node)方法”。

[1965db564df2403b85812a2834b951f1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/ab88fb46c9264cc7bb8e807ec3e4e39f.png
[3ab21426f3b14d7a8eadeeaa4e4db3ef.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/90888d43b9454c7cb556af66b1ed8c25.png
[c5bee79a312540749e8d96bb489b07cd.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/3223b6468ec64ff682c3c3f2a4b58789.png
[20d6ef8e562a48eda9e415e14b79bc10.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/803cb1fb81404d29900493c3c781cd90.png
[0e376839e2dc4f3099901be8015420e7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/c82db7b2d1534c6fb3f26e97f8bf8585.png
[b4461d0ad399424a8274e018ef106e01.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/847c7df40cc544678fccd4772ce63fc1.png
[77ec0702ebbe43f7b2642b905bad3db0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/9f56cffa0f0a4a318b2dc9d243025e6b.png
[4c7674c4b927430d9126b45398a85376.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/f7f23e4d6522454f8d2bc60a0a35b430.png
[9fec5bea1b744d37a6333cec71425cab.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/bee0b1edd35d44dc85459c0186a03052.png
[18fa5649f4fa413f8ff27b30fa139b1d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/262f80bca3974dc087ef9d4926c21399.png
[7021aa2b057840c9930ee9d2ab8d83f6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/e7324c6a04614eddb4f0bd7d3e563a2c.png
[64ec859d7de94c09950f6fcc5c0cf155.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/261e0ac423924816911bdf84db462827.png
[bab354f985794343ab1359b55ea28f95.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/17540886a41e4e22a3dcf21913d4bcf3.png
[e9b5c38b506c4a9c88062d721779c05d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/8e32546b30c2454d850697baa63ec81f.png
[b7c1908757054c68befc74e1fd92b201.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/8a0cc65324654fe6b1b5872d180fc959.png
[2b9ac9c525154232ad477a1d72967343.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/bb805e065695421c92cb0ce271ffeb43.png
[5c338311d5a645948db70fb54faabdeb.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/171936b2ccd34bd8ab5a0103302cd039.png
[46638b516a144d3ba3e79e289901c651.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/8b29a003b30840b1a1aebbd6e7520fce.png
[1fd644e135ee43cbbcdab0321f4fa0bc.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/0dea09dc6feb4f28b1c8a093e82a5566.png
[65c1f5d45a4c4b78bcf9e9ff9808e1b4.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/ed967110aa8f4a95921d55f64248036b.png
[4203a3e94798468b86b9fd5f4e75b799.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/6980140d731d49b1b2c0e6d2f4304d26.png
[5209e84994044cf5b0fa15b6d4807cf9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/dc35b6feb71f475c99d745a9977e69c2.png
[df533a7cbf6a417ab0b2d9052d2ddafc.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/c2cfed58827b4a05838815aedbc3d08e.png
[8b16ddd656554c38b7d3a98920245ef4.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/3265a7d70b004dfca1d82547240cc4a8.png
[34331a2a88ad4968a8bbc884e16ac523.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/7a2fd47f776f432eb0c1ab445b170437.png
[b87a8bd573884e71be9e18da31c46406.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/a7318a539cc841268274f446e1847429.png
[32795af8dd9e4153971573b9fa22c577.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/73bb56da17b440b984ba570428c39fb8.png
[866edcced1b04e0b81de6cdefd970bab.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/ae8f8cff17ec4ded94bdd909c87b2b4e.png
[c8f7000d93e34bc99d0f062479e41494.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/5491d4efffa64821b28dac2063b718e1.png
[f01bf4cde3fb4096b447bc616eff497d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/90b8ea0fd32d449b8886238034e94841.png
[221f1897f15f4c99822d3dee296cf054.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/17/bf502e5e930647b88de8fc42ae6a5b68.png