5.2 选择（Selection）

Range 是用于管理选择范围的通用对象。

文档选择是由 Selection 对象表示的，可通过 window.getSelection() 或 document.getSelection() 来获取。

根据 Selection API 规范：一个选择可以包括零个或多个范围（不过实际上，只有 Firefox 允许使用 Ctrl+click (Mac 上用 Cmd+click) 在文档中选择多个范围）。

这是在 Firefox 中做的一个具有 3 个范围的选择的截图：

正如我们将看到的，某些 Selection 方法暗示可能有多个范围，但同样，在除 Firefox 之外的所有浏览器中，范围最多是 1。

与范围相似，选择的起点称为“锚点（anchor）”，终点称为“焦点（focus）”。

主要的选择属性有：

• 1）anchorNode：选择的起始节点；
• 2）anchorOffset：选择开始的 anchorNode 中的偏移量；
• 3）focusNode：选择的结束节点；
• 4）focusOffset：选择开始处 focusNode 的偏移量；
• 5）isCollapsed：如果未选择任何内容（空范围）或不存在，则为 true ；
• 6）rangeCount：选择中的范围数，除 Firefox 外，其他浏览器最多为 1。

看完上面，不知道了解了没？没关系，我们继续往下。

综上所述：一般我们只有一个 Range，当我们的光标在 contenteditable 的 div 上闪动的时候，其实就有了一个 Range，这个 Range 的开始和结束位置都是一样的。

另外：我们还可以直接通过 Selection.focusNode获取到对应的节点，通过 Selection.focusOffset 获取到对应的偏移量。

就像下图：

这样，我们就获取到了光标的位置以及对应的TextNode对象。

6、代码实现第2步：获取需要@的用户

在上一节我们获得了光标在对应Node节点的偏移量，以及对应的Node节点。那么就可以通过textContent方法获取整个文本。

一般来说，通过一个简单的正则就可以获取@的内容了：

// 获取光标位置

const getCursorIndex = () => {

  const selection = window.getSelection();

  return selection?.focusOffset;

};

 // 获取节点

const getRangeNode = () => {

  const selection = window.getSelection();

  return selection?.focusNode;

};

 // 获取 @ 用户

const getAtUser = () => {

  const content = getRangeNode()?.textContent || "";

  const regx = /@([^@\s]*)$/;

  const match = regx.exec(content.slice(0, getCursorIndex()));

  if(match && match.length === 2) {

    return match[1];

  }

  return undefined;

};

因为@的插入可能是末尾，可能是中间，所以我们在判断前，还需要截取光标前的文本。

所以简单地slice一下就好了：

content.slice(0, getCursorIndex())

7、代码实现第3步：弹窗展示以及按键拦截

弹窗是否展示的逻辑，跟判断@用户类似，都是同一个正则。

// 是否展示 @

const showAt = () => {

  const node = getRangeNode();

  if(!node || node.nodeType !== Node.TEXT_NODE) returnfalse;

  const content = node.textContent || "";

  const regx = /@([^@\s]*)$/;

  const match = regx.exec(content.slice(0, getCursorIndex()));

  return match && match.length === 2;

};

弹窗需要出现在正确的位置，幸好现代浏览器有不少好用的API。

const getRangeRect = () => {

  const selection = window.getSelection();

  const range = selection?.getRangeAt(0)!;

  const rect = range.getClientRects()[0];

  const LINE_HEIGHT = 30;

  return {

    x: rect.x,

    y: rect.y + LINE_HEIGHT

  };

};

当出现弹窗之后，我们还需要拦截掉输入框的『上』、『下』、『回车』的操作，否则在输入框响应这些按键会让光标位置偏移到其他地方。

const handleKeyDown = (e: any) => {

    if(showDialog) {

      if(

        e.code === "ArrowUp"||

        e.code === "ArrowDown"||

        e.code === "Enter"

      ) {

        e.preventDefault();

      }

    }

  };

然后在弹窗里面监听这些按键，实现上下选择、回车确定、关闭弹窗的功能。

const keyDownHandler = (e: any) => {

  if(visibleRef.current) {

    if(e.code === "Escape") {

      props.onHide();

      return;

    }

    if(e.code === "ArrowDown") {

      setIndex((oldIndex) => {

        return Math.min(oldIndex + 1, (usersRef.current?.length || 0) - 1);

      });

      return;

    }

    if(e.code === "ArrowUp") {

      setIndex((oldIndex) => Math.max(0, oldIndex - 1));

      return;

    }

    if(e.code === "Enter") {

      if(

        indexRef.current !== undefined &&

        usersRef.current?.[indexRef.current]

      ) {

        props.onPickUser(usersRef.current?.[indexRef.current]);

        setIndex(-1);

      }

      return;

    }

  }

};

8、代码实现第3步：替换@文本为定制标签

大致的原理图：

8.1 把原来的 TextNode 进行切块

假如文本是：“请帮我泡一杯咖啡@ABC，这是后面的内容”。

那么我们需要根据光标的位置，替换掉@ABC文本，然后分成前后两块：『请帮我泡一杯咖啡』、『这是后面的内容』。

8.2 创建 At 标签

为了能实现删除键能把删除全部删除，需要把 at 标签的内容包裹起来。

这是第一版写的一个标签，但是如果直接用会有点小问题，留着后续再讨论：

const createAtButton = (user: User) => {

  const btn = document.createElement("span");

  btn.style.display = "inline-block";

  btn.dataset.user = JSON.stringify(user);

  btn.className = "at-button";

  btn.contentEditable = "false";

  btn.textContent = `@${user.name}`;

  return btn;

};

8.3 把标签插进去

首先：我们可以获取 focusNode 节点，然后就可以获取它的父节点以及兄弟节点。

现在需要做的是：把旧的文本节点删除，然后在原来的位置上依次插入『请帮我泡一杯咖啡』、【@ABC】、『这是后面的内容』。

具体来看看代码：

parentNode.removeChild(oldTextNode);

// 插在文本框中

if(nextNode) {

  parentNode.insertBefore(previousTextNode, nextNode);

  parentNode.insertBefore(atButton, nextNode);

  parentNode.insertBefore(nextTextNode, nextNode);

} else{

  parentNode.appendChild(previousTextNode);

  parentNode.appendChild(atButton);

  parentNode.appendChild(nextTextNode);

8.4 重置光标的位置

我们这一顿操作之前，因为原来的文本节点丢失，所以我们的光标也失去了。这时候就需要重新把光标定位到 at 标签之后。

简单来说就是把光标定位到 nextTextNode 节点之前即可：

// 创建一个 Range，并调整光标

const range = newRange();

range.setStart(nextTextNode, 0);

range.setEnd(nextTextNode, 0);

const selection = window.getSelection();

selection?.removeAllRanges();

selection?.addRange(range);

8.5 优化 at 标签

第2步中，我们创建了 at 标签，但是会有点小问题。

这时候光标就定位到了『按钮边框内』，但光标的位置实际上是正确的。

为了优化这个问题，首先想到的是在nextTextNode中添加一个『0宽字符』——\u200b。

// 添加 0 宽字符

const nextTextNode = newText("\u200b"+ restSlice);

// 定位光标时，移动一位

const range = newRange();

range.setStart(nextTextNode, 1);

range.setEnd(nextTextNode, 1);

但是，事情没那么简单。因为我发现如果往前可能也会这样……

最后一想：把内容区弄宽一点不就行了？比如左右加个空格？然后就把标签包裹了一层……

const createAtButton = (user: User) => {

  const btn = document.createElement("span");

  btn.style.display = "inline-block";

  btn.dataset.user = JSON.stringify(user);

  btn.className = "at-button";

  btn.contentEditable = "false";

  btn.textContent = `@${user.name}`;

  const wrapper = document.createElement("span");

  wrapper.style.display = "inline-block";

  wrapper.contentEditable = "false";

  const spaceElem = document.createElement("span");

  spaceElem.style.whiteSpace = "pre";

  spaceElem.textContent = "\u200b";

  spaceElem.contentEditable = "false";

  const clonedSpaceElem = spaceElem.cloneNode(true);

  wrapper.appendChild(spaceElem);

  wrapper.appendChild(btn);

  wrapper.appendChild(clonedSpaceElem);

  return wrapper;

};

穷人粗糙版 at 人，最终完结~

9、小结一下

Web前端富文本的坑确实比较多，之前没怎么了解过这部分的知识。虽然整个过程看起来很粗糙，但是技术原理就是这样。

不完善的地方很多，有更好的方式可以共同讨论下。

如果有兴趣，也可以到 Playground 玩一玩（点此进入）。

上面链接打开后是这样的，可以在线试试本文代码的运行效果：

10、参考资料

[1] Selection的W3C官方API手册

[2] 现代JavaScript 教程

[3] Range的MDN在线API手册

[4] Android端IM应用中的@人功能实现：仿微博、QQ、微信，零入侵、高可扩展

附录：更多IM入门实践文章

《跟着源码学IM(一)：手把手教你用Netty实现心跳机制、断线重连机制》

《跟着源码学IM(二)：自已开发IM很难？手把手教你撸一个Andriod版IM》

《跟着源码学IM(三)：基于Netty，从零开发一个IM服务端》

《跟着源码学IM(四)：拿起键盘就是干，教你徒手开发一套分布式IM系统》

《跟着源码学IM(五)：正确理解IM长连接、心跳及重连机制，并动手实现》

《跟着源码学IM(六)：手把手教你用Go快速搭建高性能、可扩展的IM系统》

《跟着源码学IM(七)：手把手教你用WebSocket打造Web端IM聊天》

《跟着源码学IM(八)：万字长文，手把手教你用Netty打造IM聊天》

本文已同步发布于“即时通讯技术圈”公众号。

同步发布链接是：http://www.52im.net/thread-3767-1-1.html