HTML高亮关键字真麻烦

livem 发布于2019-08-02 11:47 / 328人阅读

摘要：有这么一个功能在网页中高亮关键字。如下当为时，会将名也错误的替换掉关键字父节点通过来进行背景染色处理，对原始有一定程度污染，可能对再次定位造成影响。

有这么一个功能：在网页中高亮关键字。

本以为一个 innerHTML replace 就能实现的简单操作，却遇到了许多的问题。本文就记录这些问题和最终的完美解决办法，
希望能对有同样遭遇的小伙伴有所帮助。只对结果感兴趣的，忽略过程，直接跳过看结果吧~

常用做法：正则替换

思路：要想高亮元素，那么需要将关键字提取出来用标签包裹，然后对标签进行样式调整。使用 innerHTML，或 outHTML, 而不能使用 innerText,outText。

const regex = new RegExp(keyword,"g")
element.innerHTML = element.innerHTML.replace(regex,""+keyword+"")
element.classList.add("highlight")

这样做存在的隐患有如下：

keyword 如果是 () 等正则对象的关键字将会构建正则对象失败。（可以通过转义解决）

keyword 如果是一些 HTML 标签如 div 将会对 innerHTML 进行错误的替换

keyword 如果和一些DOM属性名、值相同，也会导致异常替换。如下当 keyword 为 test 时，会将 class 名也错误的替换掉：

  
    test

关键字父节点 element 通过 class 来进行背景染色处理，对原始DOM有一定程度污染，可能对 element 再次定位造成影响。（作为插件希望尽可能少改变原始DOM）

正则优化一：仅处理位于标签内的元素

var formatKeyword = text.replace(/[-/^$*+?.()|[]{}]/g, "$&") // 转义处理keyword包含的特殊字符，如 /.
var finder = new RegExp(">.*?"++".*?<") // 提取位于标签内的文本，避免误操作 class、id 等

element.innerHTML = element.innerHTML.replace(finder,function(matched){
        return matched.replace(text,"
"+text+
)
})// 对提取的标签内文本进行关键字替换

以能解决大多数问题，但依旧存在的问题是,只要标签属性存在类似 < 符号，将会打破匹配规则导致正则提取内容错误, HTML5 dataset 可以自定义任意内容，故这些特殊字符是无法避免的。

  替换

正则优化二：清除可能影响的标签

  keyword
  =》将闭合标签用变量替换
  [replaced1]keyword[replaced2]//闭合标签内 id="keyword" 不会被处理
  =》
  [replaced1]keyword[replaced2]
  =》将暂存变量 replaced 替换为原先标签
  keyword

这种思路及源码从这里来，
但存在问题是：

如果 [replaced1] 包含 keyword, 那么替换时将发生异常

最重要的，当标签值中包含 <> 符号时，此方法也不能正确的提取标签

总之在经过了N多尝试之后，通过正则都没能有效的处理各种情况。然后换了个思路，不通过字符串的方式，通过节点处理。element.childNodes 可以最有效的清理标签内的干扰信息。

[完美解决方案]通过 DOM 节点处理

 
    keyword 1
  
    keyword 2

通过 parent.childNodes 得到所有子节点。child 节点可以通过 innerText.replce(keyword,result) 的方式替换得到想要的高亮效果,如下：
keyword 2
（递归处理：当child节点不含子节点时进行replace操作）。

但是 keyword 1 是属于文本节点，只能修改文本内容，无法增加 HTML，更无法多带带控制其样式。而文本节点也不能转换为普通节点，这也是最苦恼的事情。

最后~，本文的重点来了，因为这个功能，让我第一次认真接触到了文本节点这个东西。从这里发现了Text对象，使用切割文本节点并替换的方式实现高亮。

源码以及还原高亮见源码

const reg = new RegExp(keyword.replace(/[-/^$*+?.()|[]{}]/g, "$&"))
highlight = function (node,reg){
    if (node.nodeType == 3) {  //只处理文本节点
        const match = node.data.match(new RegExp(reg));
        if (match) {
          const highlightEl = document.createElement("b");
          highlightEl.dataset.highlight="y"
          const wordNode = node.splitText(match.index)
          wordNode.splitText(match[0].length); // 切割成前 关键词 后三个Text 节点
          const wordNew = document.createTextNode(wordNode.data);
          highlightEl.appendChild(wordNew);//highlight 节点构建成功
          wordNode.parentNode.replaceChild(highlightEl, wordNode);// 替换该文本节点
        }
    } else if (node.nodeType == 1 && node.dataset.highlight!="y"
    ) {
        for (var i = 0; i < node.childNodes.length; i++) {
            highlight(node.childNodes[i], reg);
            i++
        }
    }  
}

最后，留个彩蛋，以上方法也是存在一个小 bug 的，有兴趣可以去发现一下。

专线服务 idc机房托管关键词高亮 html黄色高亮标签 html页面高亮设置高亮html编辑器

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/53115.html

HTML高亮关键字真麻烦

摘要：有这么一个功能在网页中高亮关键字。如下当为时，会将名也错误的替换掉关键字父节点通过来进行背景染色处理，对原始有一定程度污染，可能对再次定位造成影响。有这么一个功能：在网页中高亮关键字。本以为一个 innerHTML replace 就能实现的简单操作，却遇到了许多的问题。本文就记录这些问题和最终的完美解决办法，希望能对有同样遭遇的小伙伴有所帮助。只对结果感兴趣的，忽略过程，直接跳过...

LiuZh 2019-08-23 12:26 评论0 收藏0
基于Vue实现关键词实时搜索高亮显示关键词

摘要：高亮显示通过实现对关键词的替换，通过添加实现关键词高亮显示匹配关键字正则高亮替换值在查询到结果后执行方法将查询出来的数据传递过来通过来将关键词替换成标签，同时用中的进行绑定。最近在做移动real-time-search于实时搜索和关键词高亮显示的功能，通过博客的方式总结一下，同时希望能够帮助到别人~~~ 如果不喜欢看文字的朋友我写了一个demo方便已经上传到了github上，可以cl...

NusterCache 2019-08-22 18:50 评论0 收藏0
基于Vue实现关键词实时搜索高亮显示关键词

摘要：高亮显示通过实现对关键词的替换，通过添加实现关键词高亮显示匹配关键字正则高亮替换值在查询到结果后执行方法将查询出来的数据传递过来通过来将关键词替换成标签，同时用中的进行绑定。最近在做移动real-time-search于实时搜索和关键词高亮显示的功能，通过博客的方式总结一下，同时希望能够帮助到别人~~~ 如果不喜欢看文字的朋友我写了一个demo方便已经上传到了github上，可以cl...

xushaojieaaa 2019-08-30 15:54 评论0 收藏0
记录微信小程序的坑

摘要：除官方外的参考文章微信小程序实例创建下发模板消息实例手把手教你开发微信小程序之模版消息开发教你突破小程序模板消息的推送限制获取用户信息接口的废弃问题接口是获取用户信息昵称，头像等的接口，在官方文档上写是即将废弃。 ----------------更新-------------- 2018年10月10日官网3个接口废弃的通知： 1、分享监听接口分享消息给好友时，开发者将无法从callba...

EastWoodYang 2019-08-23 12:02 评论0 收藏0