如何使用HTML自定义元素封装原生Web存储接口

酷晨吖_3720

酷晨吖_3720

2026-06-30

950人浏览

原创

customelements.define() 必须在 dom 解析完成前执行,否则未注册的自定义标签无法升级;constructor 中仅可 attachshadow,属性读取和 localstorage 操作必须延迟至 connectedcallback,并显式声明 observedattributes 才能响应属性变更。

如何使用html自定义元素封装原生web存储接口

customElements.define() 必须在 localStorage 操作前注册

浏览器解析 HTML 时,遇到未注册的自定义标签(如 <local-storage></local-storage>)会直接跳过生命周期,后续调用 customElements.define() 也无法“升级”已存在的节点。这意味着:如果页面里先写了 <local-storage key="theme"></local-storage>,再执行注册,这个元素永远不会触发 constructor 或 connectedCallback。

实操建议:

  • 把注册逻辑放在 <script defer></script> 中,确保它在 DOM 解析完成前执行但又不阻塞渲染
  • 避免在模块内部单独注册——多个组件文件各自调用 customElements.define('local-storage', ...) 会导致重复定义错误:Failed to execute 'define': the name "local-storage" has already been used
  • 统一在项目入口(如 main.js)中集中注册所有自定义元素

constructor 中只能 attachShadow,不能读写 localStorage

自定义元素的 constructor 执行时机早于 DOM 挂载,此时元素尚未插入文档,this.textContent、this.getAttribute('key') 都不可靠,更不能调用 localStorage.getItem() —— 因为属性值可能还没被解析出来,且该方法在部分隐私模式下会直接抛出 SecurityError。

正确做法是把存储读取延迟到 connectedCallback:

  • connectedCallback 是首个能安全读取属性、访问 this.getAttribute()、并执行同步存储操作的钩子
  • 若需支持 SSR 或服务端直出,注意 localStorage 在 Node.js 环境不存在,应加 if (typeof localStorage !== 'undefined') 判断
  • 不要在 constructor 里写 this.attachShadow({ mode: 'open' }) 以外的任何 DOM 操作——浏览器只允许此处首次创建 shadowRoot,否则报错:Shadow root cannot be created on a host which already has children

attributeChangedCallback 不会自动触发,必须显式声明 observedAttributes

想让 <local-storage key="user-preferences" value="dark"></local-storage> 的 value 属性变更同步到 localStorage,光写 attributeChangedCallback 方法没用。浏览器根本不会监听,除非你明确告诉它:“我要盯住这几个属性”。

Html To Pdf
Html To Pdf

使用 Puppeteer + Chrome 将 HTML 渲染为中文 PDF,自动处理图表等待、Tab 展开、动画、测高、白边消除、防分页,适用于看板、报表、网页和交互图表转 PDF。

下载

声明方式只有两种(任选其一):

  • static get observedAttributes() { return ['key', 'value']; }
  • static observedAttributes = ['key', 'value'];

常见陷阱:

  • 拼写必须完全一致:'Key' ≠ 'key',大小写敏感
  • attributeChangedCallback 的 oldValue 和 newValue 永远是字符串,哪怕你传的是 value="true",拿到的也是 "true",不是布尔值
  • 首次渲染时已有属性(比如 HTML 里直接写了 value="init"),该回调不会触发——得在 connectedCallback 里手动读一次 localStorage.getItem(this.getAttribute('key')) 做初始化

Shadow DOM 内无法用外部 CSS 控制,样式必须内联或注入

一旦调用 this.attachShadow({ mode: 'open' }),内部结构就与主文档样式隔离。localStorage 组件本身通常不渲染视觉内容,但如果你封装了带 UI 的存储控制面板(如开关、输入框),就必须把样式打进 shadowRoot。

推荐做法:

  • 用 const style = document.createElement('style') 创建样式节点,style.textContent = 'div { color: #333; }',再 shadowRoot.appendChild(style)
  • 避免依赖全局类名或 ID:document.querySelector('.storage-toggle') 在 shadow 内无效,必须用 this.shadowRoot.querySelector('.storage-toggle')
  • 如果组件需要响应式更新 UI(比如显示当前存储值),别用 this.innerHTML = ... —— 它污染 light DOM,破坏封装;改用 this.shadowRoot.innerHTML = ... 或更稳妥的 template.content.cloneNode(true)

真正难处理的不是读写 localStorage,而是如何让属性变更、DOM 插入、异步存储失败这三者节奏对齐——connectedCallback 可能被多次调用,attributeChangedCallback 可能批量触发,而 localStorage.setItem() 是同步但可能抛异常。这些边界情况不兜住,组件就会静默失效。

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

相关文章

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

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

下载

相关标签:

html

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

相关专题

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

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

2023.06.14

5095

7

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

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

2023.06.21

2972

4

html网页制作
html网页制作

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

2023.07.31

2630

5

html空格
html空格

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

2023.08.01

2659

5

html是什么
html是什么

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

2023.08.11

4599

6

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

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

2023.08.11

2601

3

html转txt
html转txt

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

2023.08.31

2389

3

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

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

2023.09.01

2188

6

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

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

2023.09.20

2168

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
GDB 17.2 官方文档集合
GDB 17.2 官方文档集合

共0课时 | 0人学习

Bootstrap 入门安装配置
Bootstrap 入门安装配置

共0课时 | 0人学习

38+ PhpStorm 提示和技巧
38+ PhpStorm 提示和技巧

共1课时 | 209人学习