本文我们一起通过学习Vue模板编译原理(一)-Template生成AST来分析Vue源码。预计接下来会围绕Vue源码来整理一些文章，如下。

这些文章统一放在我的git仓库：https://github.com/yzsunlei/javascript-series-code-analyzing。觉得有用记得star收藏。

模板编译是Vue中比较核心的一部分。关于Vue编译原理这块的整体逻辑主要分三个部分，也可以说是分三步，前后关系如下：

第一步：将模板字符串转换成element ASTs（解析器）

第二步：对 AST 进行静态节点标记，主要用来做虚拟DOM的渲染优化（优化器）

第三步：使用element ASTs生成render函数代码字符串（代码生成器）

对应的Vue源码如下，源码位置在src/compiler/index.js

  1. export const createCompiler = createCompilerCreator(function baseCompile (
  2.   template: string,
  3.   options: CompilerOptions
  4. ): CompiledResult {
  5.   // 1.parse，模板字符串 转换成 抽象语法树(AST)
  6.   const ast = parse(template.trim(), options)
  7.   // 2.optimize，对 AST 进行静态节点标记
  8.   if (options.optimize !== false) {
  9.     optimize(ast, options)
  10.   }
  11.   // 3.generate，抽象语法树(AST) 生成 render函数代码字符串
  12.   const code = generate(ast, options)
  13.   return {
  14.     ast,
  15.     render: code.render,
  16.     staticRenderFns: code.staticRenderFns
  17.   }
  18. })

这篇文档主要讲第一步将模板字符串转换成对象语法树(element ASTs)，对应的源码实现我们通常称之为解析器。

在分析解析器的原理前，我们先举例看下解析器的具体作用。

来一个最简单的实例：

  1. <div>
  2.   <p>{{name}}</p>
  3. </div>

上面的代码是一个比较简单的模板，它转换成AST后的样子如下：

  1. {
  2.   tag: "div"
  3.   type: 1,
  4.   staticRoot: false,
  5.   static: false,
  6.   plain: true,
  7.   parent: undefined,
  8.   attrsList: [],
  9.   attrsMap: {},
  10.   children: [
  11.     {
  12.       tag: "p"
  13.       type: 1,
  14.       staticRoot: false,
  15.       static: false,
  16.       plain: true,
  17.       parent: {tag: "div", ...},
  18.       attrsList: [],
  19.       attrsMap: {},
  20.       children: [{
  21.         type: 2,
  22.         text: "{{name}}",
  23.         static: false,
  24.         expression: "_s(name)"
  25.       }]
  26.     }
  27.   ]
  28. }

其实AST并不是什么很神奇的东西，不要被它的名字吓倒。它只是用JS中的对象来描述一个节点，一个对象代表一个节点，对象中的属性用来保存节点所需的各种数据。

事实上，解析器内部也分了好几个子解析器，比如HTML解析器、文本解析器以及过滤器解析器，其中最主要的是HTML解析器。顾名思义，HTML解析器的作用是解析HTML，它在解析HTML的过程中会不断触发各种钩子函数。这些钩子函数包括开始标签钩子函数、结束标签钩子函数、文本钩子函数以及注释钩子函数。

我们先看下解析器整体的代码结构，源码位置src/compiler/parser/index.js

  1. parseHTML(template, {
  2.   warn,
  3.   expectHTML: options.expectHTML,
  4.   isUnaryTag: options.isUnaryTag,
  5.   canBeLeftOpenTag: options.canBeLeftOpenTag,
  6.   shouldDecodeNewlines: options.shouldDecodeNewlines,
  7.   shouldDecodeNewlinesForHref: options.shouldDecodeNewlinesForHref,
  8.   shouldKeepComment: options.comments,
  9.   outputSourceRange: options.outputSourceRange,
  10.   // 每当解析到标签的开始位置时，触发该函数
  11.   start (tag, attrs, unary, start, end) {
  12.     //...
  13.   },
  14.   // 每当解析到标签的结束位置时，触发该函数
  15.   end (tag, start, end) {
  16.     //...
  17.   },
  18.   // 每当解析到文本时，触发该函数
  19.   chars (text: string, start: number, end: number) {
  20.     //...
  21.   },
  22.   // 每当解析到注释时，触发该函数
  23.   comment (text: string, start, end) {
  24.     //...
  25.   }
  26. })

实际上，模板解析的过程就是不断调用钩子函数的处理过程。整个过程，读取template字符串，使用不同的正则表达式，匹配到不同的内容，然后触发对应不同的钩子函数处理匹配到的截取片段，比如开始标签正则匹配到开始标签，触发start钩子函数，钩子函数处理匹配到的开始标签片段，生成一个标签节点添加到抽象语法树上。

还举上面那个例子来说：

  1. <div>
  2.   <p>{{name}}</p>
  3. </div>

整个解析运行过程就是：解析到

时，会触发一个标签开始的钩子函数start，处理匹配片段，生成一个标签节点添加到AST上；然后解析到

时，又触发一次钩子函数start，处理匹配片段，又生成一个标签节点并作为上一个节点的子节点添加到AST上；接着解析到{{name}}这行文本，此时触发了文本钩子函数chars，处理匹配片段，生成一个带变量文本(变量文本下面会讲到)标签节点并作为上一个节点的子节点添加到AST上；然后解析到

，触发了标签结束的钩子函数end；接着继续解析到

，此时又触发一次标签结束的钩子函数end，解析结束。

模板解析过程会涉及到许许多多的正则匹配，知道每个正则有什么用途，会更加方便之后的分析。

那我们先来看看这些正则表达式，源码位置在src/compiler/parser/index.js

  1. export const onRE = /^@|^v-on:/
  2. export const dirRE = process.env.VBIND_PROP_SHORTHAND
  3.   ? /^v-|^@|^:|^\.|^#/
  4.   : /^v-|^@|^:|^#/
  5. export const forAliasRE = /([\s\S]*?)\s+(?:in|of)\s+([\s\S]*)/
  6. export const forIteratorRE = /,([^,\}\]]*)(?:,([^,\}\]]*))?$/
  7. const stripParensRE = /^\(|\)$/g
  8. const dynamicArgRE = /^\[.*\]$/
  10. const argRE = /:(.*)$/
  11. export const bindRE = /^:|^\.|^v-bind:/
  12. const propBindRE = /^\./
  13. const modifierRE = /\.[^.\]]+(?=[^\]]*$)/g
  15. const slotRE = /^v-slot(:|$)|^#/
  17. const lineBreakRE = /[\r\n]/
  18. const whitespaceRE = /\s+/g
  20. const invalidAttributeRE = /[\s"'<>\/=]/

上面这些正则相对来说比较简单，基本上都是用来匹配Vue中自定义的一些语法格式，如onRE匹配 @ 或 v-on 开头的属性，forAliasRE匹配v-for中的属性值，比如item in items、(item, index) of items。

下面这些就是专门针对html的一些正则匹配，源码位置在src/compiler/parser/html-parser.js

  1. const attribute = /^\s*([^\s"'<>\/=]+)(?:\s*(=)\s*(?:"([^"]*)"+|'([^']*)'+|([^\s"'=<>`]+)))?/
  2. const dynamicArgAttribute = /^\s*((?:v-[\w-]+:|@|:|#)\[[^=]+\][^\s"'<>\/=]*)(?:\s*(=)\s*(?:"([^"]*)"+|'([^']*)'+|([^\s"'=<>`]+)))?/
  3. const ncname = `[a-zA-Z_][\\-\\.0-9_a-zA-Z${unicodeRegExp.source}]*`
  4. const qnameCapture = `((?:${ncname}\\:)?${ncname})`
  5. const startTagOpen = new RegExp(`^<${qnameCapture}`)
  6. const startTagClose = /^\s*(\/?)>/
  7. const endTag = new RegExp(`^<\\/${qnameCapture}[^>]*>`)
  8. const doctype = /^<!DOCTYPE [^>]+>/i
  9. const comment = /^<!\--/
  10. const conditionalComment = /^<!\[/

这些正则表达式相对来说就复杂一些，如attribute用来匹配标签的属性，startTagOpen、startTagClose用于匹配标签的开始、结束部分等。这些正则表达式的写法就不多说了，有兴趣的朋友可以针对这些正则一个一个的去测试一下。

这里我们来看看HTMl解析器。

事实上，解析HTML模板的过程就是循环的过程，简单来说就是用HTML模板字符串来循环，每轮循环都从HTML模板中截取一小段字符串，然后重复以上过程，直到HTML模板被截成一个空字符串时结束循环，解析完毕。

我们通过源码，就可以看到整个函数逻辑就是被一个while循环包裹着。源码位置在：src/compiler/parser/html-parser.js

  1. export function parseHTML (html, options) {
  2.   const stack = []
  3.   const expectHTML = options.expectHTML
  4.   const isUnaryTag = options.isUnaryTag || no
  5.   const canBeLeftOpenTag = options.canBeLeftOpenTag || no
  6.   let index = 0
  7.   let last, lastTag
  8.   while (html) {
  9.     //...
  10.   }
  11.   
  12.   parseEndTag()
  13.   
  14.   //...
  15. }

下面我用一个简单的模板，模拟一下HTML解析的过程，以便于更好的理解。

  1. <div>
  2.   <p>{{text}}</p>
  3. </div>

最初的HTML模板：

  1. <div>
  2.   <p>{{text}}</p>
  3. </div>

第一轮循环时，截取出一段字符串

，解析出是div开始标签并且触发钩子函数start，截取后的结果为：

  2.   <p>{{text}}</p>
  3. </div>

第二轮循环时，截取出一段换行空字符串，会触发钩子函数chars，截取后的结果为：

  1.   <p>{{text}}</p>
  2. </div>

第三轮循环时，截取出一段字符串

，解析出是p开始标签并且触发钩子函数start，截取后的结果为：

  1.   {{text}}</p>
  2. </div>

第四轮循环时，截取出一段字符串{{name}}，解析出是变量字符串并且触发钩子函数chars，截取后的结果为：

  1.   </p>
  2. </div>

第五轮循环时，截取出一段字符串

，解析出是p闭合标签并且触发钩子函数end，截取后的结果为：

  2. </div>

第六轮循环时，截取出一段换行空字符串，会触发钩子函数chars，截取后的结果为：

  1. </div>

第七轮循环时，截取出一段字符串

，解析出是div闭合标签并且触发钩子函数end，截取后的结果为：

  1.  

第八轮循环时，发现只有一个空字符串，解析完毕，循环结束。

现在，是不是就对HTML解析过程很清楚了。其实循环过程对每次匹配到的片段进行分析记录还是很复杂的，因为被截取的片段分很多种类型，比如：

开始标签，例如<div>

结束标签，例如</div>

HTML注释，例如<!-- 注释 -->

DOCTYPE，例如<!DOCTYPE html>

条件注释，例如<!--[if !IE]>-->注释<!--<![endif]-->

文本，例如’字符串’

对每个片段的具体处理这里就不说了，有兴趣的直接看源码去。

文本解析器是对HTML解析器解析出来的文本进行二次加工。文本其实分两种类型，一种是纯文本，另一种是带变量的文本。如下：

这种就是纯文本：

  1. 这里有段文本

这种就是带变量的文本：

  1. 文本内容：{{text}}

上面HTML解析器在解析文本时，并不会区分文本是否是带变量的文本。如果是纯文本，不需要进行任何处理；但如果是带变量的文本，那么需要使用文本解析器进一步解析。因为带变量的文本在使用虚拟DOM进行渲染时，需要将变量替换成变量中的值。

我们知道，HTML解析器在碰到文本时，会触发chars钩子函数，我们先来看看钩子函数里面是怎么区分普通文本和变量文本的。

源码位置在：src/compiler/parser/html-parser.js

  1. chars (text: string, start: number, end: number) {
  2.   //...
  3.   let child: ?ASTNode
  4.   if (!inVPre && text !== ' ' && (res = parseText(text, delimiters))) {
  5.     child = {
  6.       type: 2,
  7.       expression: res.expression,
  8.       tokens: res.tokens,
  9.       text
  10.     }
  11.   } else if (text !== ' ' || !children.length || children[children.length - 1].text !== ' ') {
  12.     child = {
  13.       type: 3,
  14.       text
  15.     }
  16.   }
  17.   //...
  18.   children.push(child)
  19. }

我们重点看res = parseText(text,delimiters)这一行，通过条件判断设置不同的类型。事实上type=2表示表达式类型，type=3表示普通文本类型。

我们再来看看parseText函数具体做了什么

  1. export function parseText (
  2.   text: string,
  3.   delimiters?: [string, string]
  4. ): TextParseResult | void {
  5.   const tagRE = delimiters ? buildRegex(delimiters) : defaultTagRE
  6.   // 匹配不到带变量时直接返回了
  7.   if (!tagRE.test(text)) {
  8.     return
  9.   }
  10.   const tokens = []
  11.   const rawTokens = []
  12.   let lastIndex = tagRE.lastIndex = 0
  13.   let match, index, tokenValue
  14.   // 对匹配到的变量循环处理成表达式
  15.   while ((match = tagRE.exec(text))) {
  16.     index = match.index
  17.     // push text token
  18.     // 先把 { { 前边的文本添加到tokens中
  19.     if (index > lastIndex) {
  20.       rawTokens.push(tokenValue = text.slice(lastIndex, index))
  21.       tokens.push(JSON.stringify(tokenValue))
  22.     }
  23.     // tag token
  24.     const exp = parseFilters(match[1].trim())
  25.     // 使用_s对变量进行包装
  26.     // 把变量改成`_s(x)`这样的形式也添加到数组中
  27.     tokens.push(`_s(${exp})`)
  28.     rawTokens.push({ '@binding': exp })
  29.     // 设置lastIndex来保证下一轮循环时，正则表达式不再重复匹配已经解析过的文本
  30.     lastIndex = index + match[0].length
  31.   }
  32.   // 当所有变量都处理完毕后，如果最后一个变量右边还有文本，就将文本添加到数组中
  33.   if (lastIndex < text.length) {
  34.     rawTokens.push(tokenValue = text.slice(lastIndex))
  35.     tokens.push(JSON.stringify(tokenValue))
  36.   }
  37.   return {
  38.     expression: tokens.join('+'),
  39.     tokens: rawTokens
  40.   }
  41. }

实际上这个函数就是处理带变量的文本，首先如果是纯文本，直接return。如果是带变量的文本，使用正则表达式匹配出文本中的变量，先把变量左边的文本添加到数组中，然后把变量改成_s(x)这样的形式也添加到数组中。如果变量后面还有变量，则重复以上动作，直到所有变量都添加到数组中。如果最后一个变量的后面有文本，就将它添加到数组中。

那么对于上面示例处理结果如下：

  1. parseText('这里有段文本')
  2. // undefined
  4. parseText('文本内容：{{text}}')
  5. // '"文本内容：" + _s(text)'

好了，对于文本解析器就这么多内容。

模板解析是Vue模板编译的第一步，即通过模板得到AST（抽象语法树）。

生成AST的过程核心就是借助HTML解析器，当HTML解析器通过正则匹配到不同的片段时会触发对应不同的钩子函数，通过钩子函数对匹配片段进行解析我们可以构建出不同的节点。

文本解析器是对HTML解析器解析出来的文本进行二次加工，主要是为了处理带变量的文本。

版权声明：本文为yzsunlei原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://www.cnblogs.com/yzsunlei/p/12118330.html