vue3关键字高亮指令的制作

前言

因为业务需要，要在当前项目上做一个将搜索结果所存在的关键字进行高亮显示的需求，然后在网上找了一下类似解决方案，最后在这篇文章中找到了一个解决方案，所以这次指令的制作其实就是将这篇文章进行一个指令的制作而已。（经过作者了同意）

简单间讲下上面文章的思路

总结一下这篇文章的两种方案：

1. 插入替换标签方式。就是通过正则匹配，匹配出对应的关键字然后通过将关键字包裹在一层span标签中替换关键字，重新渲染视图。
2. 渲染层贴标签方式。就是找到关键字渲染的DOM，在这个DOM之上创建一个贴图的渲染层，通过提供的DOM2范围API（可以参考红宝书第16章的范围，有很详细的讲解 ）确定贴图的位置，创建对应的span贴图标签放到渲染层上。

我将上面两种方案都实现了，核心代码就是这篇文章提供的，大家可以去参考，我就不多赘述了。

实现

代码里面有注释就不一行一行解释了

/**
 *  关键字高亮
 *  使用方式：v-highlight="{
          keyWord: '要高亮的文本',
          textDomSelectors: ['p'], // 要高亮的文本所在的标签选择器 如：<p>123123213要高亮的文本13123</p>
          renderWay: RenderWay.ALTERNATE // 类型
        }"
 */

import { debounced, escString } from '@/utils/utils'

export enum RenderWay {
  ALTERNATE, // 替换文本为span标签模式
  LABELLING, // 贴标签模式
  SVG//  SVG模式，这个方式有渲染问题，暂不做（动态插入的的标签无法渲染，估计是DOM改变后，但是没有更新视图）
}

export type HighlightParamsType = {
  keyWord: string // 关键字
  textDomSelectors: string[] // DOM选择器（于需要高亮的文本所在的节点）
  renderWay?: RenderWay // 渲染方式
}

export type CDomRectType = (DOMRect & {
  tLeft?: number,
  tTop?: number
})

/**
 * 创建高亮贴标签区域
 * @param targetEl
 */
function createHighlightArea(targetEl: HTMLElement, renderWay: RenderWay = RenderWay.LABELLING) {
  return new Promise<HTMLElement | null>((res, rej) => {
    let tagName = renderWay !== RenderWay.SVG ? 'div' : 'svg'
    if (!targetEl) rej()
    targetEl.style.setProperty('position', 'relative')
    const {
      offsetWidth: width,
      offsetHeight: height
    } = targetEl
    let area: any = targetEl.querySelector('#highlight-area')
    // 查看目标元素节点下是否存在ID为highlight-area的元素
    if (area) area.innerHTML = ''
    else if (width && height) {
      area = document.createElement(tagName)
      area.setAttribute('id', 'highlight-area')
      area.style.setProperty('position', 'absolute')
      area.style.setProperty('top', '0')
      area.style.setProperty('left', '0')
      area.style.setProperty('right', '0')
      area.style.setProperty('bottom', '0')
      area.style.setProperty('pointer-events', 'none')
      area.style.setProperty('z-index', '10')
      if (renderWay === RenderWay.SVG) {
        area.setAttribute('width', String(width))
        area.setAttribute('height', String(height))
        area.setAttribute('xmlns', 'http://www.w3.org/2000/svg')
        // area.setAttribute('viewBox', `0 0 ${width} ${height}`)
      }
      console.log('创建渲染层：', area)
      targetEl.appendChild(area)
    }
    res(area)
  })
}

/**
 * 匹配DOM节点中所有关键字
 * @param word
 * @param el
 */
function matchingAllKeyWord(value: HighlightParamsType): CDomRectType[] | HTMLElement[] {
  let result: any = []
  value.textDomSelectors.forEach((selector: string) => {
    const doms = document.querySelectorAll(selector)
    Array.from(doms).forEach((dom: any) => {
      if (!dom) return
      dom.style.setProperty('position', 'relative')
      dom.style.setProperty('z-index', '100')
      if (value.renderWay === RenderWay.ALTERNATE) {
        result.push(dom)
      } else {
        const rectItemArr = createRangeRectItem(value.keyWord, dom)
        if (rectItemArr.length) result = [...result, ...rectItemArr]
      }
    })
  })
  return result
}

function insertLabel(keyWord: string, dom: HTMLElement) {
  const regExp = new RegExp(keyWord, 'gi')
  dom.innerHTML = dom.innerHTML.replace(regExp, `<span style="background: yellow">${keyWord}</span>`)
}

/**
 * 使用贴标签方式，创建一个range的rect信息
 * @param keyWord 需要匹配的关键字
 * @param reg 正则
 * @param dom
 */
function createRangeRectItem(keyWord: string, dom: HTMLElement): CDomRectType[] {
  const textDom: any = dom.firstChild
  let matchResult: any = null
  const reg: RegExp = new RegExp(escString(keyWord), 'gi')
  let result: CDomRectType[] = []
  const range = document.createRange()
  while (matchResult = reg.exec(dom.innerText)) {
    const { index } = matchResult
    if (textDom.length < index + keyWord.length) continue
    // 确定范围边界（注意：下面两个方法的第一个参数需要传入的确切的值，比如某个标签里面的文本，只要文本，不能有其他内容）
    range.setStart(textDom, index)
    range.setEnd(textDom, index + keyWord.length)
    // 获取这个范围的Rect信息
    const recItem = range.getBoundingClientRect()
    if (recItem)
      result = handleMultiLineRectItem(recItem, dom, keyWord.length, matchResult)

  }
  range.detach()
  return result
}

/**
 * 处理跨行高亮数据
 * @param rectItem
 * @param lineHeight
 * @returns CDomRectType | CDomRectType[]
 */
function handleMultiLineRectItem(rectItem: CDomRectType, dom: HTMLElement, len: number, result: RegExpExecArray): CDomRectType[] {
  const textDom: any = dom.firstChild
  const standardRange = document.createRange()
  standardRange.setStart(textDom, 0)
  standardRange.setEnd(textDom, 0)
  const standardRangeReact = standardRange.getBoundingClientRect()
  const lineHeight = standardRangeReact.height
  if (lineHeight === rectItem.height) return [rectItem]
  else {
    /**
     * 文本：我要显示高亮的文本
     * 关键字：keyWord=显示高亮的
     * 解释：高字在第一行，亮字在第二行，所以这里涉及到了换行
     * 定义两个指针i和j，i指向keyWord的0坐标（显）,j指向1坐标（示）
     * 在循环中不断创建范围，校验第i到第j个字符所创建的范围中的高度是否是一行内容的高度
     * 如果是，则将这个范围加入到结果数组中，然后i++，j++，继续循环
     * 注意：因为只需要一个贴图来渲染不换行的文案，比如（显示高）只修要一个span标签显示，但是之前的循环中灰创建（显，显示，显示高）三个范围
     * 实际上只需要（显示高）这个范围的数据而已，所以要在j!==1的时候删除掉前面的内容，只保留最后一个
     * 如果找到了换行的那个字符（亮），这个时候i就会重新赋值为i=j-1（此时的j为坐标为4，对应'的'字符）在重复上诉过程就能拆分出来两行内容所需的数据了
     * 
     * 推荐一个优化方案：
     * 可以结合二分查找进行优化，比较忙，就不魔改了
     * */
    let resultArr: CDomRectType[] = []
    //   处理多行
    let i = 0
    let j = 1
    while (j <= len) {
      const subRange = document.createRange()
      subRange.setStart(textDom, result.index + i)
      subRange.setEnd(textDom, result.index + j)
      const subRangeReact = subRange.getBoundingClientRect()
      if (subRangeReact.height === lineHeight) {
        if (j !== 1) resultArr.pop() // 只保留单行内容的最后一个
        j++
      } else {
        i = j - 1
      }
      resultArr.push(subRangeReact)
      subRange.detach()
    }
    return resultArr
  }
}

/**
 * 计算要生成高亮区域的范围的真实渲染位置
 * 注意：因为getBoundingClientRect拿到的是当前节点和视口之间的关系
 * 所以需要计算出当前节点rect数据和当前节点父级元素rect数据之间的相对位置
 * 推荐的文章中有解释
 * @param rectArr
 */
function calcHighlightRealPosition(rectArr: CDomRectType[], parent: HTMLElement): CDomRectType[] {
  const parentRect = parent.getBoundingClientRect()
  if (!parentRect) return rectArr
  rectArr.forEach((rect: CDomRectType) => {
    rect['tLeft'] = rect.left - parentRect.left
    rect['tTop'] = rect.top - parentRect.top
  })
  return rectArr
}

/**
 * 创建span标签，用于高亮背景显示
 * @param rect
 */
function createdSpanBgDom(rect: CDomRectType): HTMLSpanElement {
  const span = document.createElement('span')
  span.style.setProperty('position', 'absolute')
  span.style.setProperty('left', `${rect.tLeft}px`)
  span.style.setProperty('top', `${rect.tTop}px`)
  span.style.setProperty('width', `${rect.width}px`)
  span.style.setProperty('height', `${rect.height}px`)
  span.style.setProperty('z-index', `-1`)
  span.style.setProperty('background-color', 'rgba(255, 255, 0,.4)')
  return span
}


/**
 * todo 测试代码，因为有无法渲染的问题，先不做
 * @param rect
 */
function createSvgPath(rect: CDomRectType[]) {
  const path = document.createElementNS('http://www.w3.org/2000/svg', 'path')
  const d = 'M 10 10 L 50 40 L 100 10'
  path.setAttribute('d', d)
  path.setAttribute('stroke', 'red')
  path.setAttribute('fill', 'red')
  return path
}


export default debounced(
  async function(el: HTMLElement, binding: any, vnode: any, prevVnode: any) {
    const params = binding.value as HighlightParamsType
    const arr = matchingAllKeyWord(params)
    if (params.renderWay !== RenderWay.ALTERNATE) {
      if (!params.renderWay) params['renderWay'] = RenderWay.LABELLING
      const areaDom = await createHighlightArea(el, params.renderWay)
      await nextTick()
      if (!areaDom) return
      const rangeDomRectInfoArr = calcHighlightRealPosition(
        arr as CDomRectType[],
        areaDom
      )
      if (params.renderWay === RenderWay.LABELLING) {
        rangeDomRectInfoArr.forEach((rect: DOMRect) => {
          const span = createdSpanBgDom(rect)
          areaDom.appendChild(span)
        })
      } else if (params.renderWay === RenderWay.SVG) {
        console.log('创建path', areaDom)
        // todo：SVG方式有渲染问题，待解决
        // const path = createSvgPath(rangeDomRectInfoArr)
        // areaDom.appendChild(path)
      }
    } else {
      arr.forEach((dom) => {
        insertLabel(params.keyWord, dom as HTMLElement)
      })
    }
  },
  500
)

工具函数

/**
 * 
 * 添加转义字符
 * @param value
 */
export function escString(value:string) {
  let arr = ['(', '[', '{', '/', '^', '$', '¦', '}', ']', ')', '?', '*', '+', '.', "'", '"']
  for (let i = 0; i < arr.length; i++) {
    if (value) {
      if (value.indexOf(arr[i]) > -1) {
        const reg = (str:string) => str.replace(/[[]/{}()*'"\¦+?.\^$|]/g, "\$&")
        value = reg(value)
      }
    }

  }
  return value;
}

/**
 * @des 防抖 ，多次只执行最后一次
 * @param func 需要包装的函数
 * @param delay 延迟时间，单位ms
 * @param immediate 是否默认执行一次(第一次不延迟)
 * 返回值为any不为Function主要是为了解决使用window对象上的某些监听返回的错误： Type 'Function' provides no match for the signature '(this: GlobalEventHandlers, ev: UIEvent): any'
 */
export const debounced = (
  func: Function,
  delay: number = 500,
  immediate: boolean = false
): any => {
  let timer: any
  return (...args: any) => {
    if (immediate) {
      func.apply(this, args)
      immediate = false
      return
    }
    clearTimeout(timer)
    timer = setTimeout(() => {
      func.apply(this, args)
    }, delay)
  }
}

效果展示

插入替换标签方式

渲染层贴标签方式

结语

这个指令只能算是简单的指令，基本满足了我当前的业务需求，通用性不是很大，大家可以参考 ，还有很多优化的方面没做，比如可以在方案2中，重新搜索时，要移除之前渲染过的节点 ，或者对之前的节点进行重复利用 ，在校验换行的方法中进行二分查找优化等，这两种方案都是对DOM进行操作，感觉都不是最优，原来是想使用svg做，但是在动态插入path等标签的时候会有无法正常渲染的问题，估计是vue没有通知视图更新的原因，也可以使用canvas（搜结果索数据量很大的时候可以这么做），主要还是看业务需求，所以看大伙选择。