0

0

如何用Web Components封装跨框架的业务组件?

狼影

狼影

发布时间:2025-10-05 18:48:02

|

213人浏览过

|

来源于php中文网

原创

web components通过custom elements、shadow dom和html templates实现跨框架复用。1. 使用customelements.define定义自定义标签,如user-info-card;2. shadow dom隔离样式与逻辑,避免全局污染;3. 通过observedattributes监听属性变化,dispatchevent抛出事件实现通信;4. 可打包为npm包,供react、vue等项目直接引入使用,实现一次封装、多处运行。

如何用web components封装跨框架的业务组件?

Web Components 是一套浏览器原生支持的技术,能让你创建可复用、封装良好且不依赖框架的 UI 组件。用它封装跨框架的业务组件,核心在于利用其三大特性:自定义元素(Custom Elements)、影子 DOM(Shadow DOM)和 HTML 模板(HTML Templates)。这样封装的组件可以在 React、Vue、Angular 甚至纯 HTML 项目中直接使用。

1. 使用 Custom Elements 定义组件标签

通过 customElements.define() 注册一个自定义 HTML 标签,这是跨框架使用的入口。

例如,封装一个用户信息卡片:
class UserInfoCard extends HTMLElement {
  constructor() {
    super();
    this.attachShadow({ mode: 'open' });
  }
<p>connectedCallback() {
const name = this.getAttribute('name') || '未知';
const avatar = this.getAttribute('avatar');</p><pre class='brush:php;toolbar:false;'>this.shadowRoot.innerHTML = `
  <div class="card">
    <img src="${avatar}" alt="头像" />
    <span>${name}</span>
  </div>
`;

} }

customElements.define('user-info-card', UserInfoCard);

之后在任意框架中都可以直接写:

<user-info-card name="张三" avatar="/avatar.png"></user-info-card>

2. 利用 Shadow DOM 实现样式与逻辑隔离

影子 DOM 能防止外部 CSS 干扰组件内部结构,也能避免组件样式“泄漏”到全局,这对跨项目复用非常关键。

在上面的例子中,this.attachShadow({ mode: 'open' }) 创建了独立的作用域,组件内的样式不会影响页面其他部分。

JTBC网站内容管理系统5.0.3.1
JTBC网站内容管理系统5.0.3.1

JTBC CMS(5.0) 是一款基于PHP和MySQL的内容管理系统原生全栈开发框架,开源协议为AGPLv3,没有任何附加条款。系统可以通过命令行一键安装,源码方面不基于任何第三方框架,不使用任何脚手架,仅依赖一些常见的第三方类库如图表组件等,您只需要了解最基本的前端知识就能很敏捷的进行二次开发,同时我们对于常见的前端功能做了Web Component方式的封装,即便是您仅了解HTML/CSS也

下载
你可以在 shadowRoot 中注入样式:
this.shadowRoot.innerHTML = `
  <style>
    .card {
      display: flex;
      align-items: center;
      padding: 8px;
      border: 1px solid #ddd;
      border-radius: 4px;
    }
    img {
      width: 32px;
      height: 32px;
      border-radius: 50%;
      margin-right: 8px;
    }
  </style>
  <div class="card">
    @@##@@
    <span>${name}</span>
  </div>
`;

3. 支持属性传值与事件通信

为了让组件更灵活,需支持从外部传入数据并对外抛出事件,这能让它在 React 或 Vue 中像普通组件一样绑定 props 和 listeners。

  • 通过 observedAttributes 监听属性变化
  • 使用 attributeChangedCallback 响应变更
  • 通过 this.dispatchEvent() 派发自定义事件
示例:点击用户卡片触发事件
static get observedAttributes() {
  return ['name', 'avatar'];
}
<p>attributeChangedCallback(name, oldValue, newValue) {
if (oldValue !== newValue) {
this.render();
}
}</p><p>render() {
const name = this.getAttribute('name') || '未知';
const avatar = this.getAttribute('avatar') || 'default.png';</p><p>this.shadowRoot.innerHTML = <code><!-- 同上 --></code>;</p><p>// 绑定事件
this.shadowRoot.querySelector('.card').onclick = () => {
this.dispatchEvent(new CustomEvent('view-profile', {
detail: { name }
}));
};
}

在 Vue 或 React 中监听:

<user-info-card name="李四" @view-profile="handleClick" />

4. 构建与发布为 npm 包(可选)

如果你希望多个项目共用这个组件,可以将其打包成 npm 包。

  • 使用 Vite、Rollup 等工具将组件构建成标准 ES Module
  • 导出类或调用 define 方法的函数
  • 在目标项目中 import 并注册即可使用
main.js 中注册:
import { UserInfoCard } from 'my-components';
customElements.define('user-info-card', UserInfoCard);

基本上就这些。Web Components 的优势在于“一次封装,到处使用”,只要浏览器支持,就能在任何技术中嵌入。关键是做好属性通信、样式隔离和事件机制,让组件行为清晰可控。

头像

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
typedef和define区别
typedef和define区别

typedef和define区别在类型检查、作用范围、可读性、错误处理和内存占用等。本专题为大家提供typedef和define相关的文章、下载、课程内容,供大家免费下载体验。

119

2023.09.26

define的用法
define的用法

define用法:1、定义常量;2、定义函数宏:3、定义条件编译;4、定义多行宏。更多关于define的用法的内容,大家可以阅读本专题下的文章。

388

2023.10.11

堆和栈的区别
堆和栈的区别

堆和栈的区别:1、内存分配方式不同;2、大小不同;3、数据访问方式不同;4、数据的生命周期。本专题为大家提供堆和栈的区别的相关的文章、下载、课程内容,供大家免费下载体验。

443

2023.07.18

堆和栈区别
堆和栈区别

堆(Heap)和栈(Stack)是计算机中两种常见的内存分配机制。它们在内存管理的方式、分配方式以及使用场景上有很大的区别。本文将详细介绍堆和栈的特点、区别以及各自的使用场景。php中文网给大家带来了相关的教程以及文章欢迎大家前来学习阅读。

605

2023.08.10

js正则表达式
js正则表达式

php中文网为大家提供各种js正则表达式语法大全以及各种js正则表达式使用的方法,还有更多js正则表达式的相关文章、相关下载、相关课程,供大家免费下载体验。

530

2023.06.20

js获取当前时间
js获取当前时间

JS全称JavaScript,是一种具有函数优先的轻量级,解释型或即时编译型的编程语言;它是一种属于网络的高级脚本语言,主要用于Web,常用来为网页添加各式各样的动态功能。js怎么获取当前时间呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

576

2023.07.28

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

760

2023.08.03

js是什么意思
js是什么意思

JS是JavaScript的缩写,它是一种广泛应用于网页开发的脚本语言。JavaScript是一种解释性的、基于对象和事件驱动的编程语言,通常用于为网页增加交互性和动态性。它可以在网页上实现复杂的功能和效果,如表单验证、页面元素操作、动画效果、数据交互等。

6207

2023.08.17

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

76

2026.03.11

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Django 教程
Django 教程

共28课时 | 4.9万人学习

React 教程
React 教程

共58课时 | 6万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 3.6万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号