如何利用HTML自定义元素实现实时通讯组件

秋丽君_4448

秋丽君_4448

2026-06-30

958人浏览

原创

自定义元素中应缓存 websocket 实例以避免重复连接:在 constructor 初始化私有属性,在 connectedcallback 中检查并创建连接,onclose 时置空;通过 shadow dom 安全渲染消息;监听 attribute 变化时重建连接;dispatchevent 需设置 bubbles: true 和 composed: true 才能跨 shadow boundary 传播。

如何利用html自定义元素实现实时通讯组件

自定义元素里怎么创建 WebSocket 连接

不能在 connectedCallback 里直接 new WebSocket,否则每次元素被移出再插入 DOM(比如切换 Tab、v-if 切换)都会新建连接,导致重复连接、内存泄漏、服务端连接数暴增。

正确做法是用私有属性缓存连接实例,并在首次连接时初始化:

  • 在 constructor 中初始化 this._socket = null 和 this._url(从 attribute 或默认值读取)
  • 在 connectedCallback 中检查 this._socket 是否为 null 或已关闭(readyState !== WebSocket.OPEN),仅在此时创建新连接
  • 监听 onclose 时设 this._socket = null,避免残留引用

示例关键逻辑:

class ChatWidget extends HTMLElement {
  constructor() {
    super();
    this._socket = null;
    this._url = this.getAttribute('endpoint') || 'ws://localhost:8080';
  }
  connectedCallback() {
    if (!this._socket || this._socket.readyState === WebSocket.CLOSED) {
      this._socket = new WebSocket(this._url);
      this._socket.onmessage = (e) => this._handleMessage(e);
      this._socket.onclose = () => { this._socket = null; };
    }
  }
  _handleMessage(event) {
    const msg = JSON.parse(event.data);
    this.dispatchEvent(new CustomEvent('message', { detail: msg }));
  }
}

如何让自定义元素响应消息并更新 UI

自定义元素本身不自动渲染内容,必须手动操作 shadow DOM 或 light DOM。常见错误是直接修改 innerHTML 导致 XSS 漏洞或丢失事件绑定。

推荐方式是用 document.createElement 构建安全节点,再 append 到 shadow root:

Wechat HTML Publisher
Wechat HTML Publisher

直接上传HTML富文本到微信公众号草稿箱。支持完整的HTML格式,无需Markdown转换。

下载
  • 在 constructor 中调用 this.attachShadow({ mode: 'open' })
  • 在 _handleMessage 中创建 <div class="msg">,用 <code>textContent 设置消息体(不拼接 HTML 字符串)
  • 对用户昵称等可信任字段,若需富文本支持,应严格白名单过滤,而非直接 innerHTML
  • 避免每条消息都重绘整个消息区——用 appendChild 追加,而不是替换全部内容
  • attribute 变化时如何动态更新 WebSocket 地址

    observedAttributes 是必须的,否则 attributeChangedCallback 不会触发。只声明它还不够,你还得显式处理地址变更:

    • 在 static get observedAttributes() 中返回 ['endpoint']
    • 在 attributeChangedCallback 中判断是否是 'endpoint' 变更,且新旧值不同
    • 若已存在连接,先 close() 再重建;注意加防抖,防止快速连续 setAttribute 导致频繁重连
    • 不要在 attributeChangedCallback 里直接调用 connect() —— 应复用 connectedCallback 的连接逻辑,保持单一入口

    为什么 dispatchEvent 后监听不到 custom event

    常见原因是事件冒泡被 shadow DOM 阻断,或者监听位置错了。自定义元素发出的事件默认不冒泡出 shadow boundary,除非显式设置 bubbles: true。

    正确写法:

    • 发送时: this.dispatchEvent(new CustomEvent('message', { detail: msg, bubbles: true, composed: true }))
    • 接收时:监听必须挂在 document 或父容器上,不能只监听 chat-widget 元素自身(除非用 addEventListener('message', ...) 在该元素实例上)
    • 如果父组件是 Vue/React,注意框架可能封装了原生事件,需用 @message.native 或 onMessage 绑定方式

    shadow DOM 的 composed: true 是关键,漏掉它,外部 JS 就收不到事件。

前端入门到VUE实战笔记:立即使用
在学习笔记中,你将探索 前端 的入门与实战技巧!

相关文章

HTML速学教程(入门课程)
HTML速学教程(入门课程)

HTML怎么学习?HTML怎么入门?HTML在哪学?HTML怎么学才快?不用担心,这里为大家提供了HTML速学教程(入门课程),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

websocket html

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
html版权符号
html版权符号

html版权符号是“©”,可以在html源文件中直接输入或者从word中复制粘贴过来,php中文网还为大家带来html的相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.14

5755

7

html在线编辑器
html在线编辑器

html在线编辑器是用于在线编辑的工具,编辑的内容是基于HTML的文档。它经常被应用于留言板留言、论坛发贴、Blog编写日志或等需要用户输入普通HTML的地方,是Web应用的常用模块之一。php中文网为大家带来了html在线编辑器的相关教程、以及相关文章等内容,供大家免费下载使用。

2023.06.21

3272

4

html网页制作
html网页制作

html网页制作是指使用超文本标记语言来设计和创建网页的过程,html是一种标记语言,它使用标记来描述文档结构和语义,并定义了网页中的各种元素和内容的呈现方式。本专题为大家提供html网页制作的相关的文章、下载、课程内容,供大家免费下载体验。

2023.07.31

2930

5

html空格
html空格

html空格是一种用于在网页中添加间隔和对齐文本的特殊字符,被用于在网页中插入额外的空间,以改变元素之间的排列和对齐方式。本专题为大家提供html空格的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.01

2959

5

html是什么
html是什么

HTML是一种标准标记语言,用于创建和呈现网页的结构和内容,是互联网发展的基石,为网页开发提供了丰富的功能和灵活性。本专题为大家提供html相关的各种文章、以及下载和课程。

2023.08.11

4779

6

html字体大小怎么设置
html字体大小怎么设置

在网页设计中,字体大小的选择是至关重要的。合理的字体大小不仅可以提升网页的可读性,还能够影响用户对网页整体布局的感知。php中文网将介绍一些常用的方法和技巧,帮助您在HTML中设置合适的字体大小。

2023.08.11

2901

3

html转txt
html转txt

html转txt的方法有使用文本编辑器、使用在线转换工具和使用Python编程。本专题为大家提供html转txt相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.31

2709

3

html文本框代码怎么写
html文本框代码怎么写

html文本框代码:1、单行文本框【<input type="text" style="height:..;width:..;" />】;2、多行文本框【textarea style=";height:;"></textare】。

2023.09.01

2408

6

HTML嵌入CSS样式的方法
HTML嵌入CSS样式的方法

HTML嵌入CSS样式的方法有内联样式、内部样式表和外部样式表。本专题为大家提供CSS样式相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.20

2448

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WebSocket手册
WebSocket手册

共0课时 | 0人学习

Webman中文手册
Webman中文手册

共0课时 | 0人学习