《前端实战总结》之使用解释器模式实现获取元素Xpath路径的算法

前端领域里基于javascript的设计模式和算法有不少,在不少复杂应用中也扮演着很重要的角色,接下来就介绍一下javascript设计模式中的解释器模式,并用它来实现一个获取元素Xpath路径的算法。javascript

上期回顾

正文

1.解释器模式

对于一种语言,咱们给出其文法表示形式(一种语言中的语法描述工具,用来定义语言的规则),并定义一种解释器,经过这种解释器来解释语言中定义的句子。css

定义听起来可能比较抽象,举个例子好比咱们常见的网站多语言,要实现多语言咱们首先要预约语言的类型,提早设计不一样语言的语料库,而后咱们会根据配置和统一的变量规则来映射到不一样语言。html

2.元素的Xpath路径

XPath 用于在 XML 文档中经过元素和属性进行导航。虽然XPath 是用来查找XML节点,但一样能够用来查找HTML文档中的节点,由于HTML和XML结构相似。这里咱们只考虑html,即元素在html页面中所处的路径。前端

那么如何快速获取元素的Xpath路径呢?其实也很简单,咱们打开谷歌调试工具:vue

选中某个元素,以下,单机鼠标右键:

选中Copy XPath便可复制元素的Xpath路径。格式可能长这样:

//*[@id="juejin"]/div[2]/main/div/div[1]/article/div[1]
复制代码

获取元素Xpath路径的应用场景不少,好比咱们常常使用的python爬虫,利用爬虫框架能够经过Xpath路径很方便额控制页面中的某个dom节点,进而获取想要的数据和元素;又好比咱们经过发送元素的Xpath路径给后端,后端能够统计某一功能的使用状况和交互数据;又好比分析用户在网站中浏览的热力分布图,路径画像等等。java

3.js实现获取元素的Xpath路径

在实现以前,首先咱们分析一下Xpath路径的结构,好比咱们有一个页面,元素span的结构以下:node

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta http-equiv="X-UA-Compatible" content="ie=edge">
    <title>Document</title>
</head>
<body>
    <div>
       <span>我是徐小夕</span>
    </div>
</body>
</html>
复制代码

那么咱们的Xpath路径可能长这样:python

HTML/BODY|HEAD/DIV/SPAN
复制代码

从上面能够看出,咱们的最右边一个元素都是目标元素,而最左边第一个元素都是最外层容器。要完成这个过程首先咱们要经过元素的parentNode来获取当前元素的父元素,直到找到最顶层位置。但咱们还须要注意的一点是,每找到上一层咱们还要遍历该元素前面的兄弟元素previousSibling,若是这个兄弟元素名字和它后面的元素名字相同,则在元素名上+1.webpack

第一步咱们先实现一个遍历同级兄弟元素的方法getSameLevelName:css3

// 获取兄弟元素名称
function getSameLevelName(node){
    // 若是存在兄弟元素
    if(node.previousSibling) {
        let name = '',   // 返回的兄弟元素名称字符串
           count = 1,    // 紧邻兄弟元素中相同名称元素个数
           nodeName = node.nodeName,
           sibling = node.previousSibling;
        while(sibling){
            if(sibling.nodeType == 1 && sibling.nodeType === node.nodeType && sibling.nodeName){
                if(nodeName == sibling.nodeName){
                    name += ++count;
                }else {
                    // 重制相同紧邻节点名称节点个数
                    count = 1;
                    // 追加新的节点名称
                    name += '|' + sibling.nodeName.toUpperCase()
                }
            }
            sibling = sibling.previousSibling;
        }
        return name
    }else {
        // 不存在兄弟元素返回''
        return ''
    }
}
复制代码

第二步,遍历文档树。

// XPath解释器
let Interpreter = (function(){
    return function(node, wrap){
        // 路径数组
        let path = [],
        // 若是不存在容器节点,默认为document
        wrap = wrap || document;
        // 若是当前节点等于容器节点
        if(node === wrap) {
            if(wrap.nodeType == 1) {
                path.push(wrap.nodeName.toUpperCase())
            }
            return path
        }
        // 若是当前节点的父节点不等于容器节点
        if(node.parentNode !== wrap){
            // 对当前节点的父节点执行遍历操做
            path = arguments.callee(node.parentNode, wrap)
        }
        // 若是当前节点的父元素节点与容器节点相同
        else {
            wrap.nodeType == 1 && path.push(wrap.nodeName.toUpperCase())
        }
        // 获取元素的兄弟元素的名称统计
        let siblingsNames = getSameLevelName(node)
        if(node.nodeType == 1){
            path.push(node.nodeName.toUpperCase() + sublingsNames)
        }
        // 返回最终的路径数组结果
        return path
    }
})()
复制代码

有了这两个方法,咱们就能够轻松获取元素的XPath路径啦,好比:

let path = Interpreter(document.querySelector('span'))
console.log(path.join('/'))
复制代码

这样会返回开篇的同样的数据结构了.如:HTML/BODY|HEAD/DIV/SPAN

最后

若是想了解更多webpack,node,gulp,css3,javascript,nodeJS,canvas等前端知识和实战,欢迎在公众号《趣谈前端》加入咱们一块儿学习讨论,共同探索前端的边界。

更多推荐

相关文章
相关标签/搜索