dom4j基本使用与XPath不生效处理

dom4j的XPath不生效问题

dom4j使用XPath的时候，发现不能获取到节点

最可能是命名空间的问题，因为如果节点上有Namespace，那么XPath中就应该使用namespace的前缀。

例如：

<definitions xmlns="http://www.omg.org/spec/BPMN/20100524/MODEL">
  <process isExecutable="true">process>
definitions>
1
2
3

@Test
public void base() throws DocumentException {
    SAXReader reader = new SAXReader();
    Document document = reader.read(new File("F:\\tmp\\camunda.xml"));
    Node versionNode = document.selectSingleNode("/definitions/process");
    System.out.println(versionNode);
}
1
2
3
4
5
6
7

上面的代码读到的就是空节点

怎么处理呢？3中方式

1. XPath表达式中加上对应的前缀
2. 去除xml字符串中的namespace
3. 通过dom4j的VisitorSupport去除Namespace节点

使用XPath表达式前缀

@Test
public void prefixNamespace() throws DocumentException {
    SAXReader reader = new SAXReader();
    Map<String, String> map = new HashMap<>();
    reader.getDocumentFactory().setXPathNamespaceURIs(map);
    File file = new File("F:\\tmp\\camunda.xml");
    Document document = reader.read(file);
    String namespaceURI = document.getRootElement().getNamespaceURI();
    map.put("ns", namespaceURI);
    XPath xPath = document.createXPath("/ns:definitions/ns:process");
    System.out.println(xPath.selectSingleNode(document));
}
1
2
3
4
5
6
7
8
9
10
11
12

XPath表达式"/ns:definitions/ns:process"中的ns就是前缀，其中ns是自定义的，可以随便改和map中设置的一致即可。

改方式的问题是：

1. 不同节点可能有不同的Namespace，就要每个节点都要处理
2. ns前缀是所有节点都要加，而不是整个表达式前面就可以

去除xml字符串中的namespace

@Test
public void removeStringNamespace() throws DocumentException, IOException {
    SAXReader reader = new SAXReader();
    Path path = Paths.get("F:\\tmp\\camunda.xml");
    String xml = Files.readString(path);
    xml = xml .replaceAll("xmlns=\"[^\"]*\"","");
    System.out.println(xml);
    StringReader stringReader = new StringReader(xml);
    Document document = reader.read(stringReader);
    Node node = document.selectSingleNode("/definitions/process");
    System.out.println(node);
}
1
2
3
4
5
6
7
8
9
10
11
12

这种方式比较简单粗暴，但是去除xml中的命名空间的表达式需要兼容性好。

通过VisitorSupport去除Namespace节点

import org.dom4j.Attribute;
import org.dom4j.Document;
import org.dom4j.Element;
import org.dom4j.Namespace;
import org.dom4j.VisitorSupport;
import org.dom4j.tree.DefaultElement;

/**
 * dom4j xpath 清理namespace
 */
public final class Dom4jNameSpaceCleaner extends VisitorSupport {
    public void visit(Document document) {
        ((DefaultElement) document.getRootElement())
                .setNamespace(Namespace.NO_NAMESPACE);
        document.getRootElement().additionalNamespaces().clear();
    }

    public void visit(Namespace namespace) {
        namespace.detach();
    }

    public void visit(Attribute node) {
        String content = node.toString();
        if (content.contains("xmlns")
                || content.contains("xsi:")) {
            node.detach();
        }
    }

    public void visit(Element node) {
        if (node instanceof DefaultElement) {
            ((DefaultElement) node).setNamespace(Namespace.NO_NAMESPACE);
        }
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

@Test
public void dom4jNameSpaceCleaner() throws DocumentException {
    SAXReader reader = new SAXReader();
    Document document = reader.read(new File("F:\\tmp\\camunda.xml"));
    document.accept(new Dom4jNameSpaceCleaner());
    Node node = document.selectSingleNode("/definitions/process");
    System.out.println(node);
}
1
2
3
4
5
6
7
8

XPath表达式

基本表达式

@Test
public void xpath() throws DocumentException, IOException {
    String xmlFileStr = "F:\\tmp\\camunda.xml";
    Document document = Dom4jXmlHelper.getDocument(xmlFileStr);
    Node process = document.selectSingleNode("/definitions/process");
    // 获取process下的所有userTask节点
    List<Node> nodes = process.selectNodes("userTask");
    for(Node node : nodes){
        System.out.println(node.getName());
    }

    // 获取process下的所有userTask节点下的incoming节点
    nodes = process.selectNodes("userTask/incoming");
    for(Node node : nodes){
        System.out.println(node.getName());
    }

    // 获取process下的所有userTask节点下的camunda:前缀节点,不考虑位置
    nodes = process.selectNodes("userTask//camunda:*");
    System.out.println("camunda:" + nodes.size());
    for(Node node : nodes){
        System.out.println(node.getName());
    }

    // 获取process下的所有id属性
    nodes = process.selectNodes("//@id");
    for(Node node : nodes){
        System.out.println(node.getStringValue());
    }
    
    // 获取process下的userTask节点下所有属性
    nodes = process.selectNodes("userTask//@*");
    for(Node node : nodes){
        System.out.println(node.getStringValue());
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

位置表达式

@Test
public void xpathPosition() throws DocumentException, IOException {
    String xmlFileStr = "F:\\tmp\\camunda.xml";
    Document document = Dom4jXmlHelper.getDocument(xmlFileStr);
    Element root = document.getRootElement();
    List<Node> nodes = root.selectNodes("process/userTask[1]/@id");
    for (Node node : nodes) {
        System.out.println(node.getStringValue());
    }

    nodes = root.selectNodes("process/userTask[last()]/@id");
    for (Node node : nodes) {
        System.out.println(node.getStringValue());
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

关系表达式

 @Test
public void xpathRelation() throws DocumentException, IOException {
    String xmlFileStr = "F:\\tmp\\camunda.xml";
    Document document = Dom4jXmlHelper.getDocument(xmlFileStr);
    Element root = document.getRootElement();
    List<Node> nodes = root.selectNodes("process/attribute::*");
    for (Node node : nodes) {
        System.out.println(node.getStringValue());
    }
}
1
2
3
4
5
6
7
8
9
10

Element常用方法与说明

使用非XPath方式，就得手动通过API去一层一层的查找。

 @Test
public void base() throws DocumentException {
    SAXReader reader = new SAXReader();
    Document document = reader.read(new File("F:\\tmp\\camunda.xml"));
    Element rootElement = document.getRootElement();
    Element process = rootElement.element("process");
    List<Element> elementList = process.elements("userTask");
    System.out.println(elementList.size());
    for(Element element : elementList){
        System.out.println(element.attribute("id").getValue());
    }
}
1
2
3
4
5
6
7
8
9
10
11
12