# webComponent:像搭积木一样构建web应用

30 秒速记

  • 组件化十个字:对内高内聚,对外低耦合
  • 好组件 = 状态藏在内部 + 只通过约定好的接口和外界打交道
  • JS 本身就能做到:函数作用域、块级作用域、闭包、class 私有字段 #x
  • 前端的难点在 HTML 和 CSS:DOM 和样式默认全局,光封装 JS 不够
  • Web Components 要补的就是结构 + 样式 + 行为一起封装

组件化说白了就是:里面的东西紧密配合,外面只留几个简单的接口。 这样多人协作时,每个人管好自己的组件,改内部实现不会影响别人。JS 封装状态没问题,闭包、模块作用域、class 的私有字段都能把数据藏起来。麻烦在前端组件不只有逻辑,还有结构和样式,而 DOM 和 CSS 天生是全局共享的:你的 .title 可能被别人的样式覆盖,你的节点也可能被别人的脚本改掉。Web Components 就是浏览器原生给出的整套封装方案。

什么是组件化呢?

其实组件化并没有一个明确的定义,不过这里我们可以使用 10 个字来形容什么是组件化,那就是:对内高内聚,对外低耦合。对内各个元素彼此紧密结合、相互依赖,对外和其他组件的联系最少且接口简单。

可以说,程序员对组件化开发有着天生的需求,因为一个稍微复杂点的项目,就涉及到多人协作开发的问题,每个人负责的组件需要尽可能独立完成自己的功能,其组件的内部状态不能影响到别人的组件,在需要和其他组件交互的地方得提前协商好接口。通过组件化可以降低整个系统的耦合度,同时也降低程序员之间沟通复杂度,让系统变得更加易于维护。

使用组件化能带来很多优势,所以很多语言天生就对组件化提供了很好的支持,比如 C/C++ 就可以很好地将功能封装成模块,无论是业务逻辑,还是基础功能,抑或是 UI,都能很好地将其组合在一起,实现组件内部的高度内聚、组件之间的低耦合。

大部分语言都能实现组件化,归根结底在于编程语言特性,大多数语言都有自己的函数级作用域、块级作用域和类,可以将内部的状态数据隐藏在作用域之下或者对象的内部,这样外部就无法访问了,然后通过约定好的接口和外部进行通信。

JavaScript 虽然有不少缺点,但是作为一门编程语言,它也能很好地实现组件化,毕竟有自己的函数级作用域和块级作用域,所以封装内部状态数据并提供接口给外部都是没有问题的。

既然 JavaScript 可以很好地实现组件化,那么我们所谈论的 WebComponent 到底又是什么呢?

面试官追问

追问 1把用户卡片的几个函数放进一个对象,算完成组件化了吗?
参考回答

只封装了逻辑。卡片的样式还是全局的,别人一句 .card p { color: red } 就能改掉它的外观,外部脚本也能直接改它的节点。结构和样式也有了边界,才算完整的组件。

追问 2页面拆成十几个文件,改筛选区还是把表格弄坏了,怎么检查拆分质量?
参考回答

看两个模块之间是不是共享了可变状态,比如都读写同一个全局对象,或者筛选区直接 document.querySelector 去改表格的节点。文件拆开只是物理上分开,通信只走 props、事件或明确的方法调用才是真解耦。

追问 3JS 里怎么写一个真正私有的状态?
参考回答

老写法用闭包也行,返回的对象里只暴露方法,变量留在函数作用域里。

追问 4React 组件已经够用了,Web Components 适合什么场景?
参考回答

跨框架复用最合适,比如设计系统要同时给 React、Vue 和老的 jQuery 页面用;或者往别人的页面里嵌第三方挂件,靠 Shadow DOM 隔开样式。纯 React 项目内部一般没必要。

追问 5组件对外暴露哪些东西比较合适?
参考回答

属性传数据进来,事件把变化通知出去,必要时暴露少量方法,比如 open()、reset()。内部节点结构和类名不承诺,调用方一旦依赖内部层级,组件就没法重构了。

# 阻碍前端组件化的因素

30 秒速记

  • 两个拦路虎:CSS 全局生效、DOM 全局可改
  • 所有样式进同一份 CSSOM,两个人都写 p { },合到一个页面就按优先级和先后顺序互相覆盖
  • 页面只有一棵 DOM 树,任何脚本都能 querySelector 到别人的节点
  • 单独测都没问题,一集成就出事,这类问题最难查
  • 社区方案:BEM 命名、CSS Modules、CSS-in-JS、iframe;原生方案就是 Shadow DOM

前端组件化难,难的不是 JS,而是 CSS 和 DOM 默认都是全局的。 浏览器把页面里所有样式解析进同一份 CSSOM,两个模块都写 p { color: ... },单独测都正常,合到一个页面后就按优先级和先后顺序互相覆盖。DOM 也一样,整个页面只有一棵树,任何脚本都能查到、改掉别人的节点。以前大家靠命名约定(BEM)或构建工具(CSS Modules)给类名加前缀来躲冲突,但这是约定不是机制,第三方代码不守规矩就没辙。

在前端虽然 HTML、CSS 和 JavaScript 是强大的开发语言,但是在大型项目中维护起来会比较困难,如果在页面中嵌入第三方内容时,还需要确保第三方的内容样式不会影响到当前内容,同样也要确保当前的 DOM 不会影响到第三方的内容。

所以要聊 WebComponent,得先看看 HTML 和 CSS 是如何阻碍前端组件化的,这里我们就通过下面这样一个简单的例子来分析下:

<style>
p {
      background-color: brown;
      color: cornsilk
   }
</style>
<p>time.geekbang.org</p>
@前端进阶之旅: 代码已经复制到剪贴板
<style>
p {
      background-color: red;
      color: blue
   }
<p>time.geekbang</p>
@前端进阶之旅: 代码已经复制到剪贴板

上面这两段代码分别实现了自己 p 标签的属性,如果两个人分别负责开发这两段代码的话,那么在测试阶段可能没有什么问题,不过当最终项目整合的时候,其中内部的 CSS 属性会影响到其他外部的 p 标签的,之所以会这样,是因为 CSS 是影响全局的。

我们在《23 | 渲染流水线:CSS 如何影响首次加载时的白屏时间?》这篇文章中分析过,渲染引擎会将所有的 CSS 内容解析为 CSSOM,在生成布局树的时候,会在 CSSOM 中为布局树中的元素查找样式,所以有两个相同标签最终所显示出来的效果是一样的,渲染引擎是不能为它们分别单独设置样式的。

除了 CSS 的全局属性会阻碍组件化,DOM 也是阻碍组件化的一个因素,因为在页面中只有一个 DOM,任何地方都可以直接读取和修改 DOM。所以使用 JavaScript 来实现组件化是没有问题的,但是 JavaScript 一旦遇上 CSS 和 DOM,那么就相当难办了

面试官追问

追问 1两个团队的模块各自测都正常,合到首页后段落样式全乱了,为什么?
参考回答

典型的全局样式冲突。两边都写了 p { } 这样的标签选择器,进到同一份 CSSOM 后按权重和先后顺序叠加,后加载的覆盖先加载的。在 DevTools 的 Styles 面板看被划掉的规则来自哪个文件,一眼就清楚。

追问 2文章区颜色被改了,怎么区分是样式冲突还是被脚本改了?
参考回答

选中节点看 Styles 面板:命中的是某个外部样式表的规则,就是 CSS 冲突;是元素的 style 属性或类名变了,就是脚本动的手。不确定就在 Elements 面板右键节点,选 Break on → attribute modifications,谁改的直接断到那行代码。

追问 3CSS Modules 不就解决样式冲突了吗,还要 Shadow DOM 干嘛?
参考回答

CSS Modules 只是把类名编译成 title_x7f3a 这种唯一名字,管不住全局标签选择器往里渗,也拦不住别人的脚本。自己团队的代码用它够了;要嵌第三方内容,或者给不受控的页面提供组件,才需要 Shadow DOM 这种机制级的隔离。

追问 4第三方活动页要嵌进主站,双方都满是 div、p 标签选择器,怎么接?
参考回答

最省心的是 iframe,样式、脚本、DOM 全隔开,代价是通信要走 postMessage、高度要自己同步。想融合得自然一点,就让对方以 Shadow DOM 组件的形式交付,外面的选择器选不中里面,里面的样式也漏不出来。

追问 5靠选择器前缀约定能防住样式污染吗?
参考回答

能防住大部分,前提是所有人都守规矩、有代码审查。它挡不住标签选择器、* 通配符和继承属性,第三方代码更不会照你的约定写。

# WebComponent 组件化开发

30 秒速记

  • 三件套:Custom Elements(自定义标签)+ Shadow DOM(隔离)+ <template>(可复用的惰性结构)
  • <template> 里的内容不渲染、脚本不执行,要 content.cloneNode(true) 克隆后挂上去才生效
  • 组件类继承 HTMLElement,构造函数里 attachShadow({ mode: 'open' }),再把模板副本塞进影子根
  • customElements.define('geek-bang', GeekBang) 注册,标签名必须带连字符
  • 隔离的是 DOM 和 CSS,JS 没有隔离:影子树里的脚本照样跑在全局作用域

Web Components 就是三样东西配合:<template> 写结构和样式,Shadow DOM 把它们关进一个独立的小房间,customElements.define 把整套东西注册成一个新标签。