如何追蹤 JS 對象是否被 GC
在自帶垃圾回收的語言中，開發(fā)者往往不需要過多地關注內(nèi)存管理。但是不代表我們可以完全忽略它。因為語言引擎的垃圾回收是有一定的判斷規(guī)則的，如果我們的變量所引用的內(nèi)存沒有符合這個規(guī)則，那么引擎無無法對這些內(nèi)存進行自動回收。所以如何追蹤變量的內(nèi)存是否被回收也變得非常重要，尤其在 Node.js 中。
因為 Node.js 通常以服務器的角色長期提供服務，一旦服務發(fā)生內(nèi)存泄露，就意味著我們的服務遲早會掛掉，盡管服務可以被自動重啟，但是這并不能從根本上解決問題。所以如何檢測內(nèi)存泄露，就變得非常重要。
我們通常會使用 V8 自帶的堆快照來判斷某些變量的內(nèi)存是否沒有得到正確的回收，這是一種非常有效的手段，因為我們在堆快照中可以實時看到當前所有 JS 對象的存活情況。但是快照是一種非常重的操作，因為它不僅會阻塞線程的執(zhí)行，而且會導致內(nèi)存的暴漲，前者導致我們的服務出現(xiàn)短暫的不可用，具體時間取決于進程的堆大小，堆內(nèi)存過大時，采集堆快照所引起的內(nèi)存暴漲可能會導致進程直接掛掉。下面介紹一種輕量級的內(nèi)存泄露檢測方式，雖然它不像堆快照那么強大，但是在某些場景下是有用的。
當我們想知道一個對象有沒有被回收時，有幾種方式，第一種就是通過引擎提供的快照能力，直接查看對象的存活情況，第二種則是注冊對象被 GC 時的回調(diào)，下面是介紹的第二種能力。引擎沒有直接提供當對象被 GC 時回調(diào)的能力，但是我們可以通過引擎提供的弱引用技術來實現(xiàn)這個功能（可參考 Node.js 的源碼）。
const { createHook, AsyncResource } = require('async_hooks');
const weakMap = new WeakMap();
let gcCallbackContext = {};
let hooks;
function trackGC(obj, gcCallback) {
if (!hooks) {
hooks = createHook({
destroy(id) {
if (gcCallbackContext[id]) {
gcCallbackContext[id]();
delete gcCallbackContext[id];
}
}
}).enable();
}
const gcTracker = new AsyncResource('none');
gcCallbackContext[gcTracker.asyncId()] = gcCallback;
weakMap.set(obj, gcTracker);
}
接著分析下代碼的實現(xiàn)，主要是利用了 WeakMap 和 async_hooks 實現(xiàn)了這個功能。當我們需要追蹤一個對象是否被 GC 時，我們只需要傳入這個對象和一個回調(diào)，然后調(diào)用 trackGC。trackGC 首先會針對一個被追蹤的對象生成一個關聯(lián)的 AsyncResource 對象。并且記錄 AsyncResource id 和 回調(diào)的對應關系，然后把再通過 WeakMap 把被追蹤的對象和 AsyncResource 對象關聯(lián)起來。那么當被追蹤的對象失去所有引用時，它關聯(lián)的 AsyncResource 對象就會被回收，從而 async_hooks 的 destroy 鉤子被回調(diào)，這時候執(zhí)行開發(fā)者注冊的回調(diào)通知開發(fā)者該對象已經(jīng)被 GC。接下來看看 如何使用。
const { trackGC } = require('../index');
function memory() {
return ~~(process.memoryUsage().heapUsed / 1024 / 1024);
}
console.log(`before new Array: ${memory()} MB`);
let key = {
a: new Array(1024 * 1024 * 10)
};
let key2 = {
a: new Array(1024 * 1024 * 10)
};
console.log(`after new Array: ${memory()} MB`);
trackGC(key, () => {
console.log("key gc");
});
trackGC(key2, () => {
console.log("key2 gc");
});
global.gc();
key = null;
key2 = null;
global.gc();
console.log(`after gc: ${memory()} MB`);
在上面的例子中，首先打印出初始化的進程內(nèi)存，接著分配一塊大的內(nèi)存，注冊對象的 GC 回調(diào)，把變量賦值為 null 使得它的關聯(lián)的對象失去唯一的強引用，從而被 GC，最后進行顯式 GC 并輸出這時候的內(nèi)存。下面是我電腦上的輸出。
before new Array: 3 MB
after new Array: 163 MB
after gc: 2 MB
key gc
key2 gc
可以看到注冊的 GC 回調(diào)被執(zhí)行了，并且內(nèi)存的確被回收了。
最后分析一下這個實現(xiàn)。這里主要是利用了 async_hooks 模塊的能力，因為 WeakMap 是沒有提供回調(diào)機制的。來看一下 AsyncResource 的實現(xiàn)，只列出核心代碼。
constructor(type, opts = kEmptyObject) {
const asyncId = newAsyncId();
this[async_id_symbol] = asyncId;
this[trigger_async_id_symbol] = triggerAsyncId;
registerDestroyHook(this, asyncId, ...);
}
當創(chuàng)建一個 AsyncResource 對象時，會調(diào)用 registerDestroyHook。
class DestroyParam {
public:
double asyncId;
Environment* env;
Global<Object> target;
Global<Object> propBag;};static void RegisterDestroyHook(const FunctionCallbackInfo<Value>& args) {
Isolate* isolate = args.GetIsolate();
DestroyParam* p = new DestroyParam();
p->asyncId = args[1].As<Number>()->Value();
p->env = Environment::GetCurrent(args);
p->target.Reset(isolate, args[0].As<Object>());
p->target.SetWeak(p, AsyncWrap::WeakCallback, WeakCallbackType::kParameter);
p->env->AddCleanupHook(DestroyParamCleanupHook, p);
}
RegisterDestroyHook 首先創(chuàng)建了一個 DestroyParam 對象保存一些上下文，然后利用 V8 的弱引入對象可以注冊回調(diào)的機制設置需要追蹤的對象的 GC 回調(diào)。那么當對象失去所有強引用被 GC 時，回調(diào)就會被執(zhí)行。
void AsyncWrap::WeakCallback(const WeakCallbackInfo<DestroyParam>& info) {
HandleScope scope(info.GetIsolate());
std::unique_ptr<DestroyParam> p{info.GetParameter()};
Local<Object> prop_bag = PersistentToLocal::Default(info.GetIsolate(),
p->propBag);
Local<Value> val;
p->env->RemoveCleanupHook(DestroyParamCleanupHook, p.get());
if (!prop_bag.IsEmpty() &&
!prop_bag->Get(p->env->context(), p->env->destroyed_string())
.ToLocal(&val)) {
return;
}
if (val.IsEmpty() || val->IsFalse()) {
AsyncWrap::EmitDestroy(p->env, p->asyncId);
}
}
最終通過 EmitDestroy 回調(diào) JS 層執(zhí)行 destroy 鉤子。這樣就實現(xiàn)了追蹤 JS 對象是否被 GC 的能力。具體可以參考 https://github.com/theanarkh/gc-tracker。
