[Vue源码解读] template编译成render function

入口源码路径:https://github.com/vuejs/vue/blob/dev/src/platforms/web/entry-runtime-with-compiler.js

在上面js的Vue.prototype.$mount函数中找到以下代码:

    const options = vm.$options
    const { render, staticRenderFns } = compileToFunctions(template, {
        outputSourceRange: process.env.NODE_ENV !== 'production',
        shouldDecodeNewlines,
        shouldDecodeNewlinesForHref,
        delimiters: options.delimiters,
        comments: options.comments
    }, this)
    options.render = render
    options.staticRenderFns = staticRenderFns

实际源码如下图,多次运行函数形成闭包,结构复杂,本文只保留核心函数,并对源码做了部分删简,文中有源码路径,如有需要,可自行查看全源码。

compileToFunctions

compileToFunctions

(src/compiler/to-function.js)

      const cache = Object.create(null)
      function compileToFunctions (
        template,
        options,
        vm
      ){
        options = extend({}, options)
    
        // check cache
        const key = options.delimiters
          ? String(options.delimiters) + template
          : template
        if (cache[key]) {
          return cache[key]
        }
    
        // compile
        const compiled = compile(template, options)

        // turn code into functions
        const res = {}
        const fnGenErrors = []
        res.render = createFunction(compiled.render, fnGenErrors)
        res.staticRenderFns = compiled.staticRenderFns.map(code => {
          return createFunction(code, fnGenErrors)
        })
    
        return (cache[key] = res)
      }

compileToFunctions主要做了两件事:

  • 一是调用compile(template)将template编译成render(字符串形式)
  • 二是调用createFunction(render)将字符串形式的render转化成render function

下面来看这两个函数:

compile

(src/compiler/reate-compiler.js)

    function compile (template, options){
      const finalOptions = Object.create(baseOptions)
        
      //不同平台baseOptions有区别,合并得到最终配置
      if (options) {
        // merge custom modules
        if (options.modules) {
          finalOptions.modules =
            (baseOptions.modules || []).concat(options.modules)
        }
        // merge custom directives
        if (options.directives) {
          finalOptions.directives = extend(
            Object.create(baseOptions.directives || null),
            options.directives
          )
        }
        // copy other options
        for (const key in options) {
          if (key !== 'modules' && key !== 'directives') {
            finalOptions[key] = options[key]
          }
        }
      }
      
      const compiled = baseCompile(template.trim(), finalOptions)
      return compiled
    }

compile主要是合并配置,然后调用baseCompile,下面看baseCompile

baseCompile

(src/compiler/index)

    function baseCompile (template, options){
      const ast = parse(template.trim(), options)
      if (options.optimize !== false) {
        optimize(ast, options)
      }
      const code = generate(ast, options)
      return {
        ast,
        render: code.render,
        staticRenderFns: code.staticRenderFns
      }
    }

baseCompile是编译过程的核心,下面进行分析。

parse

parse 函数解析 template,形成AST

optimize

optimize 的主要作用是标记静态节点。静态节点是和数据没有关系,不需要每次都更新的内容。标记静态节点是为了之后diff时,diff算法会直接跳过静态节点,从而减少了比较的过程,优化了patch的性能。

generate

generate 将 AST 转化成 render 字符串

举例分析说明:

    <div id="app" >
        <ul style="color: red;" class="list">
            <li v-for="(girl, index) in Goods" :key='id'>
                <span>{{ girl.name }}</span>
            </li>
        </ul>
    </div>
    
    <script src="https://cdn.bootcdn.net/ajax/libs/vue/2.6.9/vue.js"></script>
    <script type="text/javascript">
        const vm = new Vue({
            el: '#app',
            data: {
                Goods: [
                    { id: '1', name: '美女1', age: 18 },
                    { id: '2', name: '美女2', age: 19 },
                    { id: '3', name: '美女3', age: 20 },
                    { id: '4', name: '美女4', age: 21 }
                ]
            }
        });
    </script>

通过断点调试,在控制台查看编译过程及结果:

  • parse 得到的 ast
ast.png

如上图,AST是一个js对象,描述了标签名是什么,有哪些属性,有哪些子元素等等。想深入了解请点击:Vue模板 AST 详解

  • generate 将 AST 转化成 render字符串

递归遍历AST,最后拼接出render

将render字符串格式化后如下样式:

    render: "with(this) {
        return _c('div', {
            attrs: {
                "id": "app"
            }
        }, [_c('ul', {
            staticClass: "list",
            staticStyle: {
                "color": "red"
            }
        }, _l((Goods), function(girl, index) {
            return _c('li', {
                key: id
            }, [_c('span', [_v(_s(girl.name))])])
        }), 0)])
    }"

_c, _l等函数,是用来生成VNode,本文不再展开阐述。

有了render字符串,层层返回,compileToFunctions函数会调用createFunction函数,根据render字符串生成render function。

下面看createFunction函数:

createFunction:

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

函数很简单,调用new Function(code),将render字符串当参数传入。最终得到render function。

最后回顾下:

compileToFunctions

generate运行结束后得到render字符串,baseCompile将render字符串返回给compile,compile又返回给compileToFunctions,compileToFunctions调用createFunction(render)函数将render字符串转化为render函数,最后compileToFunctions将render函数返回。

Vue.prototype.$mount函数中,把render函数挂载到vm.$options.render上(源码在开头),我们可以直接在控制台打印查看。

render-function.png
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,457评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,837评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,696评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,183评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,057评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,105评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,520评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,211评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,482评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,574评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,353评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,213评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,576评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,897评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,174评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,489评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,683评论 2 335