基于AST的HTML代码重构实战

夜芳酱_9576

夜芳酱_9576

2026-07-03

826人浏览

原创

直接用正则替换html会出事,因为正则无法可靠识别嵌套标签、引号配对、注释或cdata等边界,易导致错改、错删甚至xss漏洞;ast能准确建模节点关系与结构,是安全重构的前提。

基于ast的html代码重构实战

为什么直接用正则替换 HTML 会出事

因为 HTML 是嵌套结构,而正则无法可靠识别标签边界、属性引号配对、注释或 CDATA 区域。<div><p>hello</p></div> 看似简单,但一旦混入 <script>console.log('<div>');</script> 或 <!-- <div> -->,正则就大概率错删、错改甚至注入漏洞。AST 能准确建模节点类型、父子关系和属性结构,这是重构安全的前提。

用 parse5 构建可操作的 HTML AST

parse5 是目前 Node.js 生态中兼容性好、错误容忍强的 HTML 解析器,输出符合 WHATWG DOM 标准的 AST(Document / Element / Text 等节点)。它不依赖浏览器环境,适合 CLI 工具或构建流程集成。

关键点:

  • parse5.parse() 返回完整文档树,适合全量重构;parse5.parseFragment() 更轻量,适合处理片段(如组件模板)
  • 节点上的 nodeName、childNodes、attrs 可直接读写,但注意:修改 attrs 数组需深拷贝后操作,原数组是只读引用
  • 避免直接拼接字符串生成新 HTML —— 用 parse5.serialize(node) 输出,它会自动处理转义、自闭合标签、命名空间等细节

批量重命名 class 属性值的实操逻辑

这是最常见的重构需求:把旧 CSS 类名 btn-primary 替换为 c-button--primary,但必须避开 class 出现在 JS 字符串或注释里的场景。

正确做法是遍历所有 Element 节点,只处理其 attrs 中键为 class 的项:

anything-to-html
anything-to-html

将调研报告、方案对比、数据分析、需求梳理、会议纪要、设计说明、代码评审、学习笔记等任务产物输出为可在浏览器直接打开的单文件 HTML,替代 Markdown 作为最终交付物。Markdown 在信息密度、视觉清晰度和可分享性上已跟不上 AI 产物的丰富度,HTML 能同时承载排版、表格、SVG 等。

下载
function rewriteClassAttrs(ast) {
  const walk = (node) => {
    if (node.nodeType === parse5.treeAdapters.defaultTreeAdapter.ELEMENT_NODE) {
      const classAttr = node.attrs.find(a => a.name === 'class');
      if (classAttr && classAttr.value) {
        classAttr.value = classAttr.value
          .split(/\s+/)
          .map(cls => cls === 'btn-primary' ? 'c-button--primary' : cls)
          .join(' ');
      }
    }
    node.childNodes?.forEach(walk);
  };
  walk(ast);
}

注意:

  • 不要用 node.getAttribute('class') —— 这是 DOM API,在 parse5 AST 上不存在
  • 空格分割要防多空格、首尾空格,split(/\s+/) 比 split(' ') 更鲁棒
  • 如果类名有动态拼接(如 class="btn-{{type}}"),AST 本身不执行模板逻辑,这类需配合模板引擎解析器协同处理

保留原始格式与 sourcemap 的现实约束

AST 解析 + 序列化默认会“规范化”HTML:缩进重排、属性顺序重排、引号统一为双引号。这对 diff 和协作很不友好。

目前没有通用方案完美保留原始空白和注释位置,但可缓解:

  • 用 parse5.parse() 的 treeAdapter 选项启用 sourceCodeLocationInfo: true,获取每个节点的起始/结束偏移
  • 序列化时不用 parse5.serialize(),改用 parse5.TreeSerializer 自定义输出逻辑(例如跳过文本节点的空白压缩)
  • 若需精确映射修改位置,建议在重构前用 source-map 库记录原始字符偏移,而非依赖 AST 内置位置信息 —— 它在 fragment 模式下可能缺失

真正难的不是解析或替换,而是当一个 <div class="x y"> 被拆成两行、中间插了注释、又嵌了 <code><svg></svg> 时,如何让输出既语义正确,又不激怒团队里那个坚持 prettier 配置的人。

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

相关文章

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

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

下载

相关标签:

html解析器 html

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

相关专题

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

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

2023.06.14

6415

7

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

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

2023.06.21

3592

4

html网页制作
html网页制作

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

2023.07.31

3250

5

html空格
html空格

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

2023.08.01

3279

5

html是什么
html是什么

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

2023.08.11

4979

6

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

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

2023.08.11

3221

3

html转txt
html转txt

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

2023.08.31

3029

3

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

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

2023.09.01

2668

6

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

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

2023.09.20

2748

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Libclang tutorial
Libclang tutorial

共0课时 | 0人学习