专栏名称: 前端之巅
InfoQ前端垂直社群:紧跟前端发展,共享一线技术,万名淀粉互助,共登前端之巅!
目录
相关文章推荐
前端早读课  ·  【第3450期】JavaScript ... ·  昨天  
前端之巅  ·  纯血鸿蒙微信 App 正式上线!依然使用了 ... ·  2 天前  
前端大全  ·  前端实现画中画超简单,让网页飞出浏览器 ·  4 天前  
前端早读课  ·  【早阅】Chrome 133+ 全新 ... ·  3 天前  
云南省商务厅  ·  云南省2025年消费品以旧换新政策发布 ·  3 天前  
云南省商务厅  ·  云南省2025年消费品以旧换新政策发布 ·  3 天前  
51好读  ›  专栏  ›  前端之巅

Vue直出内存泄露问题的追查实践

前端之巅  · 公众号  · 前端  · 2017-07-06 23:27

正文

作者 |  张云路 (Qzone 前端)
前言

近期,我们遇到了 Vue 直出内存泄露问题,并进行了追查。其项目背景是,我们在一次规模较大的运营活动中正好碰到了内存泄漏的问题,技术背景和业务背景分别如下:

  • 技术背景:node直出项目,直出用到了 Vue 的直出方案。

  • 业务背景:一次 PV 最高达到 1400W 的运营活动 qps 的压力下,后期使得服务出现一定错误率。

本文将回顾整个追查的实践过程。

1. 发现内存泄漏

项目上线之后,前端收到了报错,伴随着就是 CPU 占有增加,内存增加。

报错伴随着内存泄漏,那么立即根据报错信息,修复问题。


报错的原因是me.masterInfo.fans_num不存在,后端的一定不可用性导致该字段出现问题。

  1. c computed: {

  2.     fansNum: function () {

  3.          var me = this;

  4.          var fansNum = [];

  5.          if (me.masterInfo.fans_num && me.masterInfo.fans_num.toString()) {

  6.               fansNum = Array.from(('0000000' + me.masterInfo.fans_num).slice(-8));

  7.          }

  8.          return fansNum;

  9.        }

  10.    },


修复解决完毕,内存泄漏修复完成。

这里大概猜测一下,熟悉Vue的基本知道,computed里面的function是需要return的,如果没有会导致报错,报错是正常的,内存泄漏缺是不正常的,两者是不是似乎有关系呢?

2. 内存泄漏追查 - > 抽离其他代码

这里抽离了基本代码,印证是否是computed引起。

  1. define(function (require, exports, module) {

  2.    module.exports = function (data, tmpl) {

  3.        return {

  4.            template: tmpl.main(),

  5.            computed: {

  6.                'Test': function (argument) {

  7.                    throw 'error happened';

  8.                    return 1;

  9.                }

  10.            }

  11.        };

  12.    };

  13. });

直出端正常的报错。

我们这里尝试部署到开发机上。

AB 压测:

  1. ab -c 2000 -n 50000

  2. -H 'Accept-Encoding: gzip, deflate, sdch'

  3. -H 'Accept-Language: zh-CN,zh;q=0.8,en;q=0.6,zh-TW;q=0.4'

  4. -H 'User-Agent: Mozilla/5.0 (iPhone; CPU iPhone OS 9_1 like Mac OS X)'

  5. -H 'Accept: text/html,p,*/*;q=0.8' -H 'Cache-Control: max-age=0'

  6. -H 'Cookie: 'p_skey=*******'

  7. -H 'Proxy-Connection: keep-alive'

  8. -X ip地址xx.xx.xx.xx

  9. -k

  10. 'http://活动地址'

2000 的并发,50000 的请求量,这里其实不大,但是对于排查错误已经足够了。

这里我们这边的node服务框架提供了堆转储的快照功能,于是我们去下载快照如下:

上面这个是压测无报错的正常页面情况,其实这里搜索 Vue $ 2 的对象是没有的。

下面这个是压测有报错的异常页面情况,这里搜索 Vue $ 2 发现创建了 4368 个对象。

3. 确认内存泄露是由于 Vue

现在基本能确定是中 Vue 引发的情况,虽然内部的node框架很好的帮助了我们的排查但是脱离本身的node框架是必要的。

app.js

  1. 'use strict';

  2. const path = require('path');

  3. const Vue = require('vue/dist/vue.runtime.common.js');

  4. const VueRender = require('vue-server-renderer').createRenderer();

  5. var timer = setInterval(function(argument) {

  6.    const App = {

  7.        template: '

    {{test}}
    ',

  8.        computed: {

  9.            "test": function() {

  10.                throw 'erro happened';

  11.                return 1;

  12.            }

  13.        }

  14.    }

  15.    const vm = new Vue(App);

  16.    VueRender.renderToString(vm, function(error, html) {

  17.        if (error) {

  18.            console.log('error happened', error)

  19.        } else {

  20.            console.log(html);

  21.        }

  22.    })

  23. }, 10);

无限循环下:

25221 user_00 20 0 973m 123m 14m S 3.0 3.0 0:10.72 node

25221 user_00 20 0 1003m 141m 14m S 3.3 3.7 0:13.07 node

25221 user_00 20 0 1200m 332m 14m S 13.0 8.7 0:34.88 node

通过上面,我们发现内存确实不断增长。

  1. var timers = setInterval( function (argument) {

  2.    heapdump.writeSnapshot('./' + Date.now() + '.heapsnapshot');

  3. }, 30000);


紧接着安装heapdump(查看 V8 内存消耗,并生产快照的实用工具)

红框的是有error发生的,无报错的heapdump的快照其实很小:

4. 问题的分析和解决

已经解决了 https://github.com/Vuejs/Vue/issues/5975 // 提供 issure 给 Vue。

PS:虽然 Vue 已经更改 bug,但我仍然事后诸葛亮去追寻这个问题 ;

(1)Vue $ 2 对象是哪里来的,自然而然是 Vue export的一个对象。既然computed里面的报错导致了内存泄漏,那么我们就去看我们创建的vue对象的computed在哪里被init的。


  1. // src/core/instance/index.js

  2. function Vue (options) {

  3.  if (process.env.NODE_ENV !== 'production' &&

  4.    !(this instanceof Vue)) {

  5.    warn('Vue is a constructor and should be called with the `new` keyword')

  6.  }

  7.  this._init(options)

  8. }


(2)init作为Vue调用的第一个方法,将我们所有的参数options传递进去,那么这个入口没问题。

computed作为Vue的非静态属性,那么一定会在Vue的声明周期中去执行,那么初步猜测,initState不论从命名还是时机都符合。


  1. // src/core/instance/init.js

  2. vm._self = vm

  3.    initLifecycle(vm)

  4.    initEvents(vm)

  5.    initRender(vm)

  6.    callHook(vm, 'beforeCreate')

  7.    initInjections(vm) // resolve injections before data/props

  8.    initState(vm)

  9.    initProvide(vm) // resolve provide after data/props

  10.    callHook(vm, 'created')

  1. export function initState (vm: Component) {

  2.  vm._watchers = []

  3.  const opts = vm.$options

  4.  if (opts.props) initProps(vm, opts.props)

  5.  if (opts.methods) initMethods(vm, opts.methods)

  6.  if (opts.data) {

  7.    initData(vm)

  8.  } else {

  9.    observe(vm._data = {}, true /* asRootData */)

  10.  }

  11.  if (opts.computed) initComputed(vm, opts.computed)

  12.  if (opts.watch) initWatch(vm, opts.watch)

  13. }

于是我们去看initComputed的代码:


  1. function initComputed (vm, computed) {

  2.  var watchers = vm._computedWatchers = Object.create(null);

  3.  for (var key in computed) {

  4.    var userDef = computed[key];

  5.    var getter = typeof userDef === 'function' ? userDef : userDef.get;

  6.    // create internal watcher for the computed property.

  7.    // 这句话是重点啊 传入了我们报错的getter,并且开启了dirty为true。

  8.    watchers[key] = new Watcher(vm, getter, noop, computedWatcherOptions);

  9.    // component-defined computed properties are already defined on the

  10.    // component prototype. We only need to define computed properties defined

  11.    // at instantiation here.

  12.    if (!(key in vm)) {

  13.      defineComputed(vm, key, userDef);

  14.    }

  15.  }

  16. }

这里注意,在initComputed方法的时候我们会有一个vm._computedWatchers,并对里面每个key(我们这里是test里面新建一个watcher,这里先不讲这个watcher是为了什么)

因为我们创建的test是不在Vue里面的值,故而,defineComputed;


  1. function defineComputed (target, key, userDef) {

  2.  if (typeof userDef === 'function') {

  3.    sharedPropertyDefinition.get = createComputedGetter(key);

  4.    sharedPropertyDefinition.set = noop;

  5.  } else {

  6.    sharedPropertyDefinition.get = userDef.get

  7.      ? userDef.cache !== false

  8.        ? createComputedGetter(key)

  9.        : userDef.get

  10.      : noop;

  11.    sharedPropertyDefinition.set = userDef.set

  12.      ? userDef.set

  13.      : noop;

  14.  }

  15.  Object.defineProperty(target, key, sharedPropertyDefinition);

  16. }



Vue数据监听的本质是 defineProperty,万变不离其宗,最后执行了defineProperty,并且createComputedGetter则作为get的赋值方法。


现在,我们的computed已经被注入代码之中了,那么下一次解析我们测试demo里面的{{test}}的时候,那么get方法将被触发,createComputedGetter()调用开始:


  1. function createComputedGetter (key) {

  2.  return function computedGetter () {

  3.    var watcher = this._computedWatchers && this._computedWatchers[key];

  4.    if (watcher) {

  5.      if (watcher.dirty) {

  6.        watcher.evaluate();

  7.      }

  8.      if (Dep.target) {

  9.        watcher.depend();

  10.      }

  11.      return watcher.value

  12.    }

  13.  }

  14. }


现在用到我们在initComputed里面新建的watcher了,对于新建的computedWatcher,lazy为true,那么dirty也是true.(这里是这么考虑的,新建的computed里面,假设里面用到了vue的一些其他被监听的data,那么势必要进行一次重新的get计算)。


  1. Watcher.prototype.evaluate = function evaluate () {

  2.  this.value = this.get();

  3.  this.dirty = false;

  4. };



ps: 其实watcher在vue里面就是负责对表达式求值,触发defineProperty里面的get函数。


现在是最关键代码了:


  1. Watcher.prototype.get = function get () {

  2.  pushTarget(this);

  3.  var value;

  4.  var vm = this.vm;

  5.  if (this.user) {

  6.    try {

  7.      value = this.getter.call(vm, vm);

  8.    } catch (e) {

  9.      handleError(e, vm, ("getter for watcher \"" + (this.expression) + "\""));

  10.    }

  11.  } else {

  12.    value = this.getter.call(vm, vm);

  13.  }

  14.  // "touch" every property so they are all tracked as

  15.  // dependencies for deep watching

  16.  if (this.deep) {

  17.    traverse(value);

  18.  }

  19.  popTarget();

  20.  this.cleanupDeps();

  21.  return value

  22. };


一步一步分析如下:


  • pushTarge 和 poptarget


这里引入一个 Dep 的概念,在 vue 中如何在每次数据发生改变的时候通知有哪些属性依赖了这个变化的对象呢,Deps 就是作为依赖收集器负责将所有依赖被改变对象的对象收集起来(在 defineProperty 的 get 里面),并且触发他们(在 definePropery 的 set 里面)。

所以在每次 defineProperty 里面会有 new 一个 Dep 对象,

这样就可以理解,凡是 Vue 中有一个 watcher 执行到了,那么势必会执行 Dep.target 的添加,和被监听属性 get 里面的 Dep 的新建,而被监听属性 set 触发,那么这个 Dep 就会按照 target 全部 notify。


  1. Dep.target = null;

  2. var targetStack = [];

  3. function pushTarget (_target) {

  4.  if (Dep.target) { targetStack.push(Dep.target); }

  5.  Dep.target = _target;

  6. }

  7. function popTarget () {

  8.  Dep.target = targetStack.pop();

  9. }


但是我们watch方法,以及computed方法而言,每次收集和执行时相当于独立于其他data的监听的,所以我们这边用了targetStack的堆栈临时存放Dep.target进行依赖收集,这点其实算是用了一个比较讨巧的方法吧。执行完,得到value,然后在pop回去,Dep的target原来是什么就是什么好了。

  • this.user

对于用户自定义而言的callback,Vue这里做了处理,防止报错。

  • 其他诸如watch里面的deep,暂不论述了。

然而,计算的方法是在代码里是属于 user!= true 里面的。

于是:

  1. value = this.getter.call(vm, vm);


——这句话华丽丽的挂掉了。(this.getter 里面是我们写的报错的代码.....)

那么问题来了

targetStack作为一个全局定义的堆栈,我们每次请求向里面pop了一个watcher对象(这个读者可以打出看看,其实还不小的对象的),然后呢,错误,异常。其实targetStack一直没有被销毁。

长期以往,当每次请求都过来,都向targetStack里面pop一个watcher,好吧,内存泄漏了。

好吧,剩下我们看看他们的解决方案吧:

简单粗暴,不再以this.user作为判断了,这个只给$watch用。


当然value = this.getter.call(vm, vm)被try catch了,防止报错。


最后,finally就是决定了最后报错情况下依旧会进行处理,这里主要是 popTarget的执行,使得之前发生的内存泄漏得以消亡。


以上,这个问题总结完毕,不过不得不承认Vue的开发效率还是尤为高效的。

作者推荐


最后分享一下分析 Vue源码文章《Vue 2.1.7源码学习》,个人认为适合在一开始阅读:


http://hcysun.me/2017/03/03/Vue%E6%BA%90%E7%A0%81%E5%AD%A6%E4%B9%A0/


最后再附上一个仿这次内存泄漏的例子:

eg.js

'use strict';const path = require('path');const Zue = require('./test.js');const heapdump = require('heapdump');var timer = setInterval(function(argument) {    const App = {}    const vm = new Zue(App);
}, 10);var timers = setInterval( function (argument) {
    heapdump.writeSnapshot('./' + Date.now() + '.heapsnapshot');
}, 10000);

test.js

function Zue (options) {
    pushTarget(this);
}var targetStack = [];function pushTarget (_target) {
    targetStack.push(_target);
}module.exports = Zue;

然后node eg.js

然后 ok,本文完。

今日荐文

点击下方图片即可阅读

百度 Web 生态构建:发布基于 Vue 的 PWA 解决方案 LAVAS;将全面支持 Web AR


视野拓展

推荐一个不可错过的会议:ArchSummit 全球架构师峰会,邀请了上百位国内外顶尖技术专家前来分享各业务的核心架构设计,从 Web 协议底层优化到超级 App 的系列魔改,这里只谈最优秀的架构实践。

7 月 7 日,ArchSummit 全球架构师峰会即将开幕!如需报名,可直接识别下方二维码联系大会售票天使豆包,欢迎骚扰~!

前端之巅

「前端之巅」是 InfoQ 旗下关注前端技术的垂直社群,加入前端之巅学习群请关注「前端之巅」公众号后回复“加群”。投稿请发邮件到 [email protected],注明“前端之巅投稿”。