FinalizationRegistry

FinalizationRegistry オブジェクトにより、オブジェクトがガベージコレクションで回収されるときにコールバックを要求することができます。

解説

FinalizationRegistry は、レジストリに登録されているオブジェクトが回収される (ガベージコレクションされる) 時にクリーンアップコールバックを要求する方法を提供します。(クリーンアップコールバックはファイナライザーと呼ばれることもあります。)

注: Cleanup callbacks should not be used for essential program logic. 詳しくは Notes on cleanup callbacks を見てください。

コールバックで渡すレジストリを作成します。

const registry = new FinalizationRegistry(heldValue => {
  // ....
});

次に、 register メソッドを呼び出して、クリーンアップコールバックを行いたいオブジェクトを登録し、そのオブジェクトと保持値を渡します。

registry.register(theObject, "some value");

レジストリがオブジェクトへの強い参照を保持すると、目的に反してしまうので、 (レジストリが強い参照を保持していれば、そのオブジェクトは決して回収されない)、強い参照は保持はしません。

theObject が回収された場合、クリーンアップコールバックは、指定した保持値 (上では "some value") で呼び出される可能性があります。保持値は、プリミティブでもオブジェクトでも、 undefined であっても構いません。保持値がオブジェクトの場合、レジストリはその値への強い参照を保持します (これにより、後でクリーンアップコールバックに渡すことができます)。

オブジェクトの登録を解除したい場合は、三番目の値を渡します。 これは、後でレジストリのレジストリの unregister 関数をコールしてオブジェクトの登録を解除する際に使用する登録解除トークンです。レジストリは、登録解除トークンへの弱い参照のみを保持します。

よくオブジェクト自身が登録解除トークンとして使われ、これは良い結果になります。

registry.register(theObject, "some value", theObject);
// ...some time later, if you don't care about `theObject` anymore...
registry.unregister(theObject);

ただし、同じオブジェクトである必要はありません。異なるものでも構いません。

registry.register(theObject, "some value", tokenObject);
// ...some time later, if you don't care about `theObject` anymore...
registry.unregister(tokenObject);

コンストラクター

FinalizationRegistry()
新しい FinalizationRegistry オブジェクト生成します。

インスタンスメソッド

FinalizationRegistry.prototype.register()
Registers an object with the registry in order to get a cleanup callback when/if the object is garbage-collected.
FinalizationRegistry.prototype.unregister()
Unregisters an object from the registry.
FinalizationRegistry.prototype.cleanupSome()
(Optional method.) Proactively requests cleanup callbacks for reclaimed objects.

Avoid where possible

Correct use of FinalizationRegistry takes careful thought, and it's best avoided if possible. It's also important to avoid relying on any specific behaviors not guaranteed by the specification. When, how, and whether garbage collection occurs is down to the implementation of any given JavaScript engine. Any behavior you observe in one engine may be different in another engine, in another version of the same engine, or even in a slightly different situation with the same version of the same engine. Garbage collection is a hard problem that JavaScript engine implementers are constantly refining and improving their solutions to.

Here are some specific points that the authors of the WeakRef proposal that FinalizationRegistry is part of included in its explainer document:

Garbage collectors are complicated. If an application or library depends on GC cleaning up a FinalizationRegistry or calling a finalizer [cleanup callback] in a timely, predictable manner, it's likely to be disappointed: the cleanup may happen much later than expected, or not at all. Sources of variability include:

  • One object might be garbage-collected much sooner than another object, even if they become unreachable at the same time, e.g., due to generational collection.
  • Garbage collection work can be split up over time using incremental and concurrent techniques.
  • Various runtime heuristics can be used to balance memory usage, responsiveness.
  • The JavaScript engine may hold references to things which look like they are unreachable (e.g., in closures, or inline caches).
  • Different JavaScript engines may do these things differently, or the same engine may change its algorithms across versions.
  • Complex factors may lead to objects being held alive for unexpected amounts of time, such as use with certain APIs.

Notes on cleanup callbacks

Some notes on cleanup callbacks:

  • Developers shouldn't rely on cleanup callbacks for essential program logic. Cleanup callbacks may be useful for reducing memory usage across the course of a program, but are unlikely to be useful otherwise.
  • A conforming JavaScript implementation, even one that does garbage collection, is not required to call cleanup callbacks. When and whether it does so is entirely down to the implementation of the JavaScript engine. When a registered object is reclaimed, any cleanup callbacks for it may be called then, or some time later, or not at all.
  • It's likely that major implementations will call cleanup callbacks at some point during execution, but those calls may be substantially after the related object was reclaimed.
  • There are also situations where even implementations that normally call cleanup callbacks are unlikely to call them:
    • When the JavaScript program shuts down entirely (for instance, closing a tab in a browser).
    • When the FinalizationRegistry instance itself is no longer reachable by JavaScript code.

Creating a new registry

You create the registry passing in the callback:

const registry = new FinalizationRegistry(heldValue => {
  // ....
});

Registering objects for cleanup

Then you register any objects you want a cleanup callback for by calling the `register` method, passing in the object and a *held value* for it:

registry.register(theObject, "some value");

仕様書

仕様書
WeakRefs
FinalizationRegistry の定義

ブラウザーの互換性

Update compatibility data on GitHub
デスクトップモバイルサーバー
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewAndroid 版 ChromeAndroid 版 FirefoxAndroid 版 OperaiOSのSafariSamsung InternetNode.js
FinalizationRegistryChrome 完全対応 84Edge 完全対応 84Firefox 完全対応 79IE 未対応 なしOpera 未対応 なしSafari 未対応 なしWebView Android 完全対応 84Chrome Android 完全対応 84Firefox Android 未対応 なしOpera Android 未対応 なしSafari iOS 未対応 なしSamsung Internet Android 未対応 なしnodejs 完全対応 13.0.0
無効
完全対応 13.0.0
無効
無効 From version 13.0.0: this feature is behind the --harmony-weak-refs runtime flag.
FinalizationRegistry() constructorChrome 完全対応 84Edge 完全対応 84Firefox 完全対応 79IE 未対応 なしOpera 未対応 なしSafari 未対応 なしWebView Android 完全対応 84Chrome Android 完全対応 84Firefox Android 未対応 なしOpera Android 未対応 なしSafari iOS 未対応 なしSamsung Internet Android 未対応 なしnodejs 完全対応 13.0.0
無効
完全対応 13.0.0
無効
無効 From version 13.0.0: this feature is behind the --harmony-weak-refs runtime flag.
registerChrome 完全対応 84Edge 完全対応 84Firefox 完全対応 79IE 未対応 なしOpera 未対応 なしSafari 未対応 なしWebView Android 完全対応 84Chrome Android 完全対応 84Firefox Android 未対応 なしOpera Android 未対応 なしSafari iOS 未対応 なしSamsung Internet Android 未対応 なしnodejs 完全対応 13.0.0
無効
完全対応 13.0.0
無効
無効 From version 13.0.0: this feature is behind the --harmony-weak-refs runtime flag.
unregisterChrome 完全対応 84Edge 完全対応 84Firefox 完全対応 79IE 未対応 なしOpera 未対応 なしSafari 未対応 なしWebView Android 完全対応 84Chrome Android 完全対応 84Firefox Android 未対応 なしOpera Android 未対応 なしSafari iOS 未対応 なしSamsung Internet Android 未対応 なしnodejs 完全対応 13.0.0
無効
完全対応 13.0.0
無効
無効 From version 13.0.0: this feature is behind the --harmony-weak-refs runtime flag.

凡例

完全対応  
完全対応
未対応  
未対応
ユーザーが明示的にこの機能を有効にしなければなりません。
ユーザーが明示的にこの機能を有効にしなければなりません。

関連情報