基于HTML的组件化架构:减少代码冗余的最佳实践

小枫同学_9050

小枫同学_9050

2026-05-03

891人浏览

原创

原生html无法复用组件,因其是声明式标记语言,无作用域、变量、条件渲染或文件引入机制;常见错误包括误用iframe、document.write或未激活template;web components或构建时预处理是可行解法。

基于html的组件化架构:减少代码冗余的最佳实践

纯 HTML 本身不支持 import、include 或组件复用,硬写 10 个页面的 header 和 footer 就是给自己埋雷——改一处,漏九处,连测试都容易漏。

为什么原生 HTML 无法直接复用组件

HTML 是声明式标记语言,不是编程语言。它没有作用域、变量、条件渲染或文件引入机制。像 <include src="header.html"></include> 这种写法在浏览器里根本不会解析,也不会生效。开发者常误以为加个自定义标签(如 <my-header></my-header>)就能复用,但没 JS 驱动、没构建流程介入,它只是个空壳,DOM 里啥都不会出现。

常见错误现象包括:

  • 把 header.html 直接扔进主页面用 <iframe src="header.html"></iframe> 加载——导致样式隔离、SEO 失效、滚动错位、JS 上下文断裂
  • 用 document.write() 拼接 HTML 字符串——破坏 DOM 构建流,触发重排,且 XSS 风险高
  • 依赖浏览器原生 <template></template> 标签却忘了用 JS 克隆并 append —— 页面始终空白

Web Components 是唯一真正“原生”的解法

如果你必须坚持纯前端、零构建工具、不依赖后端模板,Custom Elements + Shadow DOM 是目前唯一被所有现代浏览器稳定支持的方案。它不靠打包、不靠服务端,运行时即可注册并复用。

实操关键点:

  • 用 customElements.define() 注册组件,名称必须含短横线(如 "nav-bar"),否则浏览器拒绝识别
  • <template></template> 内部不能有 <script></script> 或 <style></style>,它们需通过 JS 动态注入或用 adoptedStyleSheets 关联
  • Shadow DOM 默认 mode="closed" 会屏蔽外部 CSS,若要继承全局样式,得显式设为 mode="open"
  • 组件内响应用户操作(如点击菜单)必须用 this.shadowRoot.addEventListener(),而非 document.addEventListener()

示例片段(可直接粘贴到 HTML 文件底部运行):

Wechat HTML Publisher
Wechat HTML Publisher

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

下载
<template id="tmpl-header"><header style="background:#333;color:white;padding:1rem;"><h1><slot name="title">My App</slot></h1>
  </header></template><script>
  class NavBar extends HTMLElement {
    constructor() {
      super();
      const tmpl = document.getElementById('tmpl-header');
      this.attachShadow({ mode: 'open' }).appendChild(tmpl.content.cloneNode(true));
    }
  }
  customElements.define('nav-bar', NavBar);
</script><nav-bar><span slot="title">Dashboard</span></nav-bar>

构建阶段预处理是最务实的选择

对毕业设计、内部管理系统这类无需 SSR、但追求开发体验的项目,硬啃 Web Components 成本偏高。更现实的做法是:用构建工具在编译时把模块拼好,输出标准 HTML。

推荐组合:Webpack + html-webpack-plugin + posthtml-include(轻量、无 JS 运行时依赖)。

使用前提与注意事项:

  • 每个组件存为独立文件,如 src/includes/header.html,内容仅包含片段(不要带 或 )
  • 主 HTML 中用 <include src="./includes/header.html"></include>(注意路径是相对于当前 HTML 文件)
  • posthtml-include 不解析 JS,也不支持循环/变量;想动态生成列表?得换 html-loader + webpack 的 require 语法,或切到模板引擎
  • 最终产物是静态 HTML,部署即用,无运行时性能损耗,也兼容老旧 CDN 缓存策略

别为了“组件化”而牺牲可维护性

很多团队过早引入 Web Components 或强行套 Vue SFC,结果组件粒度太细、props 接口混乱、CSS 作用域打架,反而比复制粘贴更难 debug。真正值得提取的组件只有三类:

  • 结构固定、样式强约束的 UI 块(如带图标+文字+状态色的 status-badge)
  • 跨页面一致的导航/表单布局(如含搜索框+筛选项+导出按钮的 list-toolbar)
  • 需统一行为控制的交互单元(如带加载态、防重复提交的 submit-button)

其它场景,比如两个页面的表格列数不同、排序逻辑各异,硬抽成一个 data-table 组件,最后往往变成一堆 v-if 和 props 配置项,阅读成本远超直接写两份 HTML。

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

相关文章

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

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

下载

相关标签:

html

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

相关专题

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

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

2023.06.14

5735

7

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

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

2023.06.21

3252

4

html网页制作
html网页制作

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

2023.07.31

2930

5

html空格
html空格

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

2023.08.01

2939

5

html是什么
html是什么

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

2023.08.11

4759

6

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

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

2023.08.11

2901

3

html转txt
html转txt

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

2023.08.31

2689

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

2428

5

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

共1课时 | 220人学习