代码生成阶段 | 周陆军博客

1. 前言

经过前几篇文章，我们把用户所写的模板字符串先经过解析阶段解析生成对应的抽象语法树AST，接着再经过优化阶段将AST中的静态节点及静态根节点都打上标记，现在终于到了模板编译三大阶段的最后一个阶段了——代码生成阶段。所谓代码生成阶段，到底是要生成什么代码？答：要生成render函数字符串。

我们知道，Vue实例在挂载的时候会调用其自身的render函数来生成实例上的template选项所对应的VNode，简单的来说就是Vue只要调用了render函数，就可以把模板转换成对应的虚拟DOM。那么Vue要想调用render函数，那必须要先有这个render函数，那这个render函数又是从哪来的呢？是用户手写的还是Vue自己生成的？答案是都有可能。我们知道，我们在日常开发中是可以在Vue组件选项中手写一个render选项，其值对应一个函数，那这个函数就是render函数，当用户手写了render函数时，那么Vue在挂载该组件的时候就会调用用户手写的这个render函数。那如果用户没有写呢？那这个时候Vue就要自己根据模板内容生成一个render函数供组件挂载的时候调用。而Vue自己根据模板内容生成render函数的过程就是本篇文章所要介绍的代码生成阶段。

现在我们知道了，所谓代码生成其实就是根据模板对应的抽象语法树AST生成一个函数，通过调用这个函数就可以得到模板对应的虚拟DOM。

2. 如何根据AST生成render函数

通过上文我们知道了，代码生成阶段主要的工作就是根据已有的AST生成对应的render函数供组件挂载时调用，组件只要调用的这个render函数就可以得到AST对应的虚拟DOM的VNode。那么如何根据AST生成render函数呢？这其中是怎样一个过程呢？接下来我们就来细细剖析一下。

假设现有如下模板：

html

<div id="NLRX"><p>Hello {{name}}</p></div>

该模板经过解析并优化后对应的AST如下：

javascript

ast = {
    'type': 1,
    'tag': 'div',
    'attrsList': [
        {
            'name':'id',
            'value':'NLRX',
        }
    ],
    'attrsMap': {
      'id': 'NLRX',
    },
    'static':false,
    'parent': undefined,
    'plain': false,
    'children': [{
      'type': 1,
      'tag': 'p',
      'plain': false,
      'static':false,
      'children': [
        {
            'type': 2,
            'expression': '"Hello "+_s(name)',
            'text': 'Hello {{name}}',
            'static':false,
        }
      ]
    }]
  }

下面我们就来根据已有的这个AST来生成对应的render函数。生成render函数的过程其实就是一个递归的过程，从顶向下依次递归AST中的每一个节点，根据不同的AST节点类型创建不同的VNode类型。接下来我们就来对照已有的模板和AST实际演示一下生成render函数的过程。

首先，根节点div是一个元素型AST节点，那么我们就要创建一个元素型VNode，我们把创建元素型VNode的方法叫做_c(tagName,data,children)。我们暂且不管_c()是什么，只需知道调用_c()就可以创建一个元素型VNode。那么就可以生成如下代码：
javascript
```
_c('div',{attrs:{"id":"NLRX"}},[/*子节点列表*/])
```
根节点div有子节点，那么我们进入子节点列表children里遍历子节点，发现子节点p也是元素型的，那就继续创建元素型VNode并将其放入上述代码中根节点的子节点列表中，如下：
javascript
```
_c('div',{attrs:{"id":"NLRX"}},[_c('p',{attrs:{}},[/*子节点列表*/])])
```
同理，继续遍历p节点的子节点，发现是一个文本型节点，那就创建一个文本型VNode并将其插入到p节点的子节点列表中，同理，创建文本型VNode我们调用_v()方法，如下：
javascript
```
_c('div',{attrs:{"id":"NLRX"}},[_c('p',{attrs:{}},[_v("Hello "+_s(name))])])
```

到此，整个AST就遍历完毕了，我们将得到的代码再包装一下，如下：

javascript

`
 with(this){
   reurn _c(
     'div',
     {
       attrs:{"id":"NLRX"},
     },
     [
       _c(
         'p',
         {
           attrs:{}
         },
         [
           _v("Hello "+_s(name))
         ]
       )
     ]
   )
 }
 `

最后，我们将上面得到的这个函数字符串传递给createFunction 函数（关于这个函数在后面会介绍到），createFunction 函数会帮我们把得到的函数字符串转换成真正的函数，赋给组件中的render选项，从而就是render函数了。如下：
javascript
```
res.render = createFunction(compiled.render, fnGenErrors)

function createFunction (code, errors) {
  try {
    return new Function(code)
  } catch (err) {
    errors.push({ err, code })
    return noop
  }
}
```

以上就是根据一个简单的模板所对应的AST生成render函数的过程，理论过程我们已经了解了，那么在源码中实际是如何实现的呢？下面我们就回归源码分析其具体实现过程。

3. 回归源码

代码生成阶段的源码位于src/compiler/codegen/index.js 中，源码虽然很长，但是逻辑不复杂，核心逻辑如下：

javascript

export function generate (ast,option) {
  const state = new CodegenState(options)
  const code = ast ? genElement(ast, state) : '_c("div")'
  return {
    render: `with(this){return ${code}}`,
    staticRenderFns: state.staticRenderFns
  }
}

javascript

const code = generate(ast, options)

调用generate函数并传入优化后得到的ast，在generate函数内部先判断ast是否为空，不为空则调用genElement(ast, state)函数创建VNode，为空则创建一个空的元素型div的VNode。然后将得到的结果用with(this){return ${code}}包裹返回。可以看出，真正起作用的是genElement函数，下面我们继续来看一下genElement函数内部是怎样的。

genElement函数定义如下：

javascript

export function genElement (el: ASTElement, state: CodegenState): string {
  if (el.staticRoot && !el.staticProcessed) {
    return genStatic(el, state)
  } else if (el.once && !el.onceProcessed) {
    return genOnce(el, state)
  } else if (el.for && !el.forProcessed) {
    return genFor(el, state)
  } else if (el.if && !el.ifProcessed) {
    return genIf(el, state)
  } else if (el.tag === 'template' && !el.slotTarget) {
    return genChildren(el, state) || 'void 0'
  } else if (el.tag === 'slot') {
    return genSlot(el, state)
  } else {
    // component or element
    let code
    if (el.component) {
      code = genComponent(el.component, el, state)
    } else {
      const data = el.plain ? undefined : genData(el, state)

      const children = el.inlineTemplate ? null : genChildren(el, state, true)
      code = `_c('${el.tag}'${
        data ? `,${data}` : '' // data
      }${
        children ? `,${children}` : '' // children
      })`
    }
    // module transforms
    for (let i = 0; i < state.transforms.length; i++) {
      code = state.transforms[i](el, code)
    }
    return code
  }
}

genElement函数逻辑很清晰，就是根据当前 AST 元素节点属性的不同从而执行不同的代码生成函数。虽然元素节点属性的情况有很多种，但是最后真正创建出来的VNode无非就三种，分别是元素节点，文本节点，注释节点。接下来我们就着重分析一下如何生成这三种节点类型的render函数的。

3.1 元素节点

生成元素型节点的render函数代码如下：

javascript

const data = el.plain ? undefined : genData(el, state)

const children = el.inlineTemplate ? null : genChildren(el, state, true)
code = `_c('${el.tag}'${
data ? `,${data}` : '' // data
}${
children ? `,${children}` : '' // children
})`

生成元素节点的render函数就是生成一个_c()函数调用的字符串，上文提到了_c()函数接收三个参数，分别是节点的标签名tagName，节点属性data，节点的子节点列表children。那么我们只需将这三部分都填进去即可。

获取节点属性data

首先判断plain属性是否为true，若为true则表示节点没有属性，将data赋值为undefined；如果不为true则调用genData函数获取节点属性data数据。genData函数定义如下：

javascript

export function genData (el: ASTElement, state: CodegenState): string {
  let data = '{'
  const dirs = genDirectives(el, state)
  if (dirs) data += dirs + ','

    // key
    if (el.key) {
        data += `key:${el.key},`
    }
    // ref
    if (el.ref) {
        data += `ref:${el.ref},`
    }
    if (el.refInFor) {
        data += `refInFor:true,`
    }
    // pre
    if (el.pre) {
        data += `pre:true,`
    }
    // 篇幅所限，省略其他情况的判断
    data = data.replace(/,$/, '') + '}'
    return data
}

我们看到，源码中genData虽然很长，但是其逻辑非常简单，就是在拼接字符串，先给data赋值为一个{，然后判断存在哪些属性数据，就将这些数据拼接到data中，最后再加一个}，最终得到节点全部属性data。

获取子节点列表children

获取子节点列表children其实就是遍历AST的children属性中的元素，然后根据元素属性的不同生成不同的VNode创建函数调用字符串，如下：

javascript

export function genChildren (el):  {
    if (children.length) {
        return `[${children.map(c => genNode(c, state)).join(',')}]`
    }
}
function genNode (node: ASTNode, state: CodegenState): string {
  if (node.type === 1) {
    return genElement(node, state)
  } if (node.type === 3 && node.isComment) {
    return genComment(node)
  } else {
    return genText(node)
  }
}

上面两步完成之后，生成_c（）函数调用字符串，如下：

javascript

code = `_c('${el.tag}'${
        data ? `,${data}` : '' // data
      }${
        children ? `,${children}` : '' // children
      })`

3.2 文本节点

文本型的VNode可以调用_v(text)函数来创建，所以生成文本节点的render函数就是生成一个_v(text)函数调用的字符串。_v()函数接收文本内容作为参数，如果文本是动态文本，则使用动态文本AST节点的expression属性，如果是纯静态文本，则使用text属性。其生成代码如下：

javascript

export function genText (text: ASTText | ASTExpression): string {
  return `_v(${text.type === 2
    ? text.expression // no need for () because already wrapped in _s()
    : transformSpecialNewlines(JSON.stringify(text.text))
  })`
}

3.3 注释节点

注释型的VNode可以调用_e(text)函数来创建，所以生成注释节点的render函数就是生成一个_e(text)函数调用的字符串。_e()函数接收注释内容作为参数，其生成代码如下：

javascript

export function genComment (comment: ASTText): string {
  return `_e(${JSON.stringify(comment.text)})`
}

4. 总结

本篇文章介绍了模板编译三大阶段的最后一个阶段——代码生成阶段。

首先，介绍了为什么要有代码生成阶段以及代码生成阶段主要干什么。我们知道了，代码生成其实就是根据模板对应的抽象语法树AST生成一个函数供组件挂载时调用，通过调用这个函数就可以得到模板对应的虚拟DOM。

接着，我们通过一个简单的模板演示了把模板经过递归遍历最后生成render函数的过程。

最后，我们回归源码，通过分析源码了解了生成render函数的具体实现过程。

1. 前言 ​

2. 如何根据AST生成render函数 ​

3. 回归源码 ​

3.1 元素节点 ​

3.2 文本节点 ​

3.3 注释节点 ​

4. 总结 ​

1. 前言

2. 如何根据AST生成render函数

3. 回归源码

3.1 元素节点

3.2 文本节点

3.3 注释节点

4. 总结