亲宝软件园·资讯

展开

一文带你吃透Vue3编译原理

mick 人气:0

一直对编译原理的东西都有一种恐惧感，感觉太难了，看不懂，打开vue3源码看到编译相关的代码，直接吓退。直到我学习了大崔哥的mini-vue,so ga ~

主要流程

现在我们就来一起分析一个简易的vue3的编译原理。一句话概括一下我们想要实现的功能，那就是将template模板生成我们想要的render函数即可。简单的一句话却蕴含着大量的知识。

<div>hi, {{message}}</div>

最后生成

import { toDisplayString as _toDisplayString, openBlock as _openBlock, createElementBlock as _createElementBlock } from "vue"

export function render(_ctx, _cache, $props, $setup, $data, $options) {
  return (_openBlock(), _createElementBlock("div", null, "hi, " + _toDisplayString(_ctx.message), 1 /* TEXT */))
}

首先template会通过词法分析、语法分析解析成AST(抽象语法树)，然后利用transform对AST进行优化，最后通过generate模块生成我们想要的render函数。

在vue3的源码中主要分成了3个部分（以下是简化后的源码）

export function baseCompile(template){
  const ast = baseParse(template)
  transform(ast)
  return generate(ast)
}

由于这3个部分牵扯的东西比较多，我们这篇文章主要来讲解一下parse的实现(友情提示：为了让大家刚好的理解，本文的代码全部都是精简过得哦)

parse的实现

我们就拿一个简单的例子入手

<div><p>hi</p>{{message}}</div>

看似一个简单的例子，其实3种类型：element、text、插值。我们将这三种类型用枚举定义一下。

const enum NodeTypes {
  ROOT,
  INTERPOLATION,
  SIMPLE_EXPRESSION,
  ELEMENT,
  TEXT
}

ROOT类型表示根节点，SIMPLE_EXPRESSION类型表示插值的内容。最后我们想要通过parse生成一个ast。

{
    type: NodeTypes.ROOT
    children: [
        {
          type: NodeTypes.ELEMENT,
          tag: "div",
          children: [
            {
              type: NodeTypes.ELEMENT,
              tag: "p",
              children: [
                {
                  type: NodeTypes.TEXT,
                  content: "hi"
                }
              ]
            },
            {
              type: NodeTypes.INTERPOLATION,
              content: {
                type: NodeTypes.SIMPLE_EXPRESSION,
                content: "message"
              }
            }
          ]
        }
    ]
}

基于源码我们可以知道ast是由函数baseParse生成。那我们就从这个函数入手。

baseParse

export function baseParse(content: string) {
  const context = createParseContext(content)
  return createRoot(parserChildren(context, []))
}

function createParseContext(content: string) {
  return {
    source: content
  }
}

function createRoot(children) {
  return {
    children,
    type: NodeTypes.ROOT
  }
}

首先创建一个全局的上下文对象context,并且存储了source。source就是我们传入的模板内容。接着创建根节点，包含了type和children。而children是由parseChildren创建。

parseChildren

function parseChildren(context, ancestors) {
  const nodes: any = []

  while (!isEnd(context, ancestors)) {
    const s = context.source
    let node
    if (s.startsWith("{{")) {
      node = parseInterpolation(context)
    } else if (s[0] === "<") {
      if (/[a-z]/i.test(s[1])) {
        node = parseElement(context, ancestors)
      }
    } else {
      node = parseText(context)
    }
    nodes.push(node)
  }
  return nodes
}

parseChildren是负责解析子节点并创建ast节点数组。parseChildren是自顶向下分析各个子节点的，对于模板内容要从左到右依次解析。每当碰到一个element节点都要递归的调用parseChildren去解析它的子节点。当碰到{{则认为需要处理的是插值节点，当碰到<则认为需要处理的是element节点，其余的则统一认为处理的是text节点。每处理完一个节点都会生成node并push到nodes中，最后返回nodes当做是父ast节点的children属性。

当然从左到右依次循环解析就一定要有一个退出循环的条件isEnd

function isEnd(context, ancestors) {
  const s = context.source

  if (s.startsWith("</")) {
    for (let i = 0; i < ancestors.length; i++) {
      const tag = ancestors[i]
      if (startsWithEndTagOpen(s, tag)) {
        return true
      }
    }
  }

  return !s
}
function startsWithEndTagOpen(source, tag) {
  return (
    source.startsWith("</") &&
    source.slice(2, 2 + tag.length).toLowerCase() === tag.toLowerCase()
  )
}

ancestors表示element标签的集合，大致的意思就是当碰到了结束标识符</,并且结束标签（source.slice(2, 2 + tag.length)）和element标签的集合中的标签匹配则说明当前的element节点处理完毕，则退出循环

下面我们就来看一下插值节点parseInterpolation、element节点parseElement和文本节点parseText分别是怎么处理的

parseInterpolation

function parseInterpolation(context) {
  const openDelimiter = "{{"
  const closeDelimiter = "}}"

  const closeIndex = context.source.indexOf(
    closeDelimiter,
    openDelimiter.length
  )

  advanceBy(context, openDelimiter.length)

  const rawContentLength = closeIndex - openDelimiter.length

  const rawContent = parseTextData(context, rawContentLength)

  const content = rawContent.trim()
  advanceBy(context, closeDelimiter.length)

  return {
    type: NodeTypes.INTERPOLATION,
    content: {
      type: NodeTypes.SIMPLE_EXPRESSION,
      content
    }
  }
}

function advanceBy(context: any, length: number) {
  context.source = context.source.slice(length)
}

function parseTextData(context: any, length) {
  const content = context.source.slice(0, length)

  advanceBy(context, content.length)
  return content
}

我们主要是为了获取插值的内容然后返回一个插值对象即可。closeIndex表示“}}”所在的位置。advanceBy函数的功能是推进。比如"{{"是不需要处理的，那么就直接把它截取掉。rawContentLength代表“{{”和“}}”中间内容的长度，通过parseTextData获取“{{”和“}}”中间的内容，并返回。然后把中间内容的部分做推进。由于我们写代码习惯可能会给内容的前后做留白，所以需要用trim做处理。然后把最后的“}}”推进，返回一个插值类型的对象即可。

parseElement

function parseElement(context, ancestors) {
  const element: any = parseTag(context, TagType.Start)
  ancestors.push(element)
  element.children = parseChildren(context, ancestors)
  ancestors.pop()

  if (startsWithEndTagOpen(context.source, element.tag)) {
    parseTag(context, TagType.End)
  } else {
    throw new Error(`缺少结束标签: ${element.tag}`)
  }

  return element
}

function parseTag(context: any, type: TagType) {
  const match: any = /^<\/?([a-z]*)/i.exec(context.source)
  const tag = match[1]
  advanceBy(context, match[0].length)
  advanceBy(context, 1)

  if (type === TagType.End) return

  return {
    type: NodeTypes.ELEMENT,
    tag
  }
}

function startsWithEndTagOpen(source, tag) {
  return (
    source.startsWith("</") &&
    source.slice(2, 2 + tag.length).toLowerCase() === tag.toLowerCase()
  )
}

parseElement第二个参数ancestors是一个数组来收集标签的（作用在上面的isEnd已经提到了）。通过parseTag获取标签名，parseTag通过正则拿到标签名然后返回一个标签对象，处理过的内容继续做推进。如果是结束标签则什么都不做。然后通过parseChildren递归的处理element的子节点。然后对结束标签进行处理，startsWithEndTagOpen判断是够存在结束标签，如果不存在则报错。

parseText

function parseText(context: any): any {
  let endIndex = context.source.length
  let endToken = ["<", "{{"]

  for (let i = 0; i < endToken.length; i++) {
    const index = context.source.indexOf(endToken[i])
    if (index !== -1 && endIndex > index) {
      endIndex = index
    }
  }

  const content = parseTextData(context, endIndex)

  return {
    type: NodeTypes.TEXT,
    content
  }
}

endIndex表示内容长度（此时内容的长度是已经推进过的字符到最后一个字符的长度）。比如

<div>hi,{{message}}</div>

能够进入到parseText函数中说明开始标签已经处理过了，所以context.source应该是

hi,{{message}}</div>

所以endIndex的长度应该是上面代码的长度。当碰到”<“或者”{{“的时候，则我们需要改变endIndex的值，比如上面的代码，我们想要拿到的文本内容应该是hi,,所以当碰到”{{“时，改变endIndex然后通过parseTextData拿到文本内容，返回一个文本对象。

总结

parse的作用就是将template生成ast对象。则需要对template从左到右依次处理，处理过了则进行推进，碰到element标签还需要递归处理，并把添加到element.children上，最终返回一个ast抽象语法树。

加载全部内容
相关教程
猜你喜欢
用户评论