- React Nativeの仮想ドキュメントオブジェクトモデル(DOM)内にある、デタッチされたDOMのようなオブジェクト。
- JavaScriptオブジェクト内の循環参照。
- ガベージコレクションの妨げとなる、保持されたままのコンポーネントやイベントリスナー。
- 意図的にメモリリークを起こすサンプルのVega向けReact Nativeアプリを作成する。
- アプリの実行中のさまざまな段階でヒープスナップショットをキャプチャする。
- MemLabを使用してこれらのスナップショットを分析し、メモリリークを特定する。
- MemLabの出力を解釈して、リークの性質と原因を理解する。
前提条件
- Node.jsをセットアップする。 Node.jsをインストールする。
-
MemLabをインストールする。
-
ANRクラッシュを防ぐには、デバッグ用のvpkgビルドを使用して環境を設定するか、
react-native.config.jsに次の内容を追加します。
手順1: サンプルアプリを作成する
次のコマンドを使用して、テスト目的で意図的にサンプルリークを起こすサンプルアプリを作成します。app.jsファイルの例
次のファイルには、メモリリークのシナリオを実行するサンプルアプリのコードスニペットと、メモリリークを作成、クリア、分析するツールが含まれています。手順2: アプリをビルドする
以下のコマンドを実行します。手順3: アプリを実行する
-
Vega仮想デバイスを実行します。
Vega仮想デバイスが起動し、アプリを実行する準備が整いました。
-
Vega仮想デバイス上でアプリを実行します。
アプリはVega仮想デバイスで起動します。
手順4: ヒープスナップショットをキャプチャしてコピーする
-
各スナップショットを取得する前に、ガベージコレクションをトリガーします。
- アプリの実行中に [Take Snapshot] ボタンをクリックして、デバイス上のヒープスナップショットをキャプチャします。 システムは、ステップ6で説明したように、スナップショットファイルをアプリのデータディレクトリに保存します。
-
[Create Detached DOM Leak] ボタンをクリックして、メモリリークを起こす要素を10,000個生成します。
コンソールは
Detached DOM leak created with 10,000 elementsをログします。 - [Take Snapshot] ボタンをもう一度選択して、スナップショットを再取得します。 システムによって、別のスナップショットファイルがアプリのデータディレクトリに保存されます。
-
[Clear Leaks] ボタンをクリックして、メモリリークをシミュレートする要素を削除します。
コンソールは
All leaks clearedをログします。 -
Take Snapshotボタンを選択して、最後のスナップショットを取得します。
[Take Snapshot] ボタンをクリックするたびに、スナップショットファイルが保存されているシステム上の場所がログに記録されます。
- スナップショットファイルをローカルコンピューターにコピーします。 これで、スナップショットファイルがローカルマシンの宛先パスに存在するようになりました。取得したヒープスナップショットを使用して、潜在的なメモリリークを分析して特定できます。
手順5: MemLabを実行する
スナップショットに対してMemLabを実行するには、以下のコマンド形式を使用します。- すべてのスナップショットをメモリに読み込みます。
- ベースラインとターゲットのスナップショットを比較して、新しいオブジェクトを特定します。
- 特定した新しいオブジェクトを分析して、最終スナップショットまで存続しているかどうかを確認します。
- 保持パターンを理解するためにオブジェクト参照をトレースします。
MemLabコマンド構造の説明
memlab find-leaksコマンドは、メモリリークを特定するMemLabのコア機能です。次のパラメータは、実行する比較を定義します。
- - 潜在的なリークを発生させる前に撮影された、初期のヒープスナップショットを指定します。基準点として使用されます。
- - 潜在的なリークが発生した後に撮影されたスナップショットを指定します。MemLabはこのスナップショットをベースラインと比較して、新たに発生した、リークの疑いがあるオブジェクトを特定します。
- - リークのクリアを試みた後に撮影されたスナップショットを指定します。MemLabはこの情報を使用して、オブジェクトが本当にリークしているか、それとも正常なアプリ状態の一部であるかを判断します。
--trace-all-objects- すべてのオブジェクトをトレースするようMemLabに指示します。より包括的な分析が可能になりますが、処理時間が長くなる場合があります。
MemLabの出力例
MemLabの出力の解釈
MemLabの出力で重要な要素は以下のとおりです。Alive objects allocated in target page
このセクションには、アプリの操作後または変更後にまだメモリに存在しているオブジェクトが表示されます。この一覧は潜在的なメモリ保持の問題を示し、各オブジェクトについて次の詳細を含んでいます。name- オブジェクト名またはその構造型。type- オブジェクトが「object」(JSObjectやJSArrayなど)なのか、「closure」(メモリーを保持する関数)なのか。count- 各オブジェクト型のインスタンスの数。retainedSize- これらのオブジェクトによって保持されているメモリの合計。
JSArray (Object Type)- 305個のインスタンス、1.1MBのメモリを保持します。JSObject(id, name)- 10,000個のインスタンス。1.1MBのメモリも保持されます。
多数のトレースによるサンプリングトレース
このセクションでは、10,100個のトレースがあるため、MemLabは49.5%のサンプリングを使用して効率的な処理を行ったことを確認できます。MemLab found X leaks
この例では、MemLabは5件のリークを発見しました。出力される一覧には、各メモリリークについて次の情報が含まれます。- 類似リークの数 - ツールが同様のリークパターンを検出した回数。
- リークオブジェクトの保持サイズ - リークのあったオブジェクトによって保持されているメモリの合計。
- リークのトレース - オブジェクトがどのように相互接続されているかと、ガベージコレクターがそれらを回収できない理由。
ガベージコレクション(GC)ルート
これらは、メモリに残っていて、ほかのオブジェクトのガベージコレクションを妨げているオブジェクトのエントリポイントです。このトレースは、GCルートが参照を通じてどのようにオブジェクトを存続させているかを、JSObjects、JSArray、クロージャー参照へと戻るパスと共に示します。 例1 リークパターン:同様のリークが4,956件あり、1.1MBのメモリを保持しています。JSObject(current) → JSArray → JSObject(id, name).
このトレースから、JSArrayが10,000個のJSObject(id, name)オブジェクトへの参照を保持しているため、それらのオブジェクトがガベージコレクションされないことがわかります。
例2
リークパターン:同様のリークが22件あり、2.9KBのメモリを保持しています。
トレースには、React Nativeのビューシステムの一部であるDetached FiberNode RCTViewオブジェクトが関係しています。onBlurなどのイベントハンドラーは、コードによって削除された後もオブジェクトを保持するため、リークの原因となる可能性があります。
MemLabによるスナップショットの分析
- Alive objects allocated in target pageセクションを調べて、保持されているオブジェクトを確認します。
-
「MemLab found [X] leak(s)」という行で、MemLabによって明確に特定されたリークの数を確認します。
各リークについて以下を確認します。
- 同様のリークの数と合計保持サイズを確認します。
- オブジェクトのトレースを調べて、システムがどのようにオブジェクトを保持しているかを把握します。
- デタッチされたDOM要素や大きい配列など、想定外の保持に注意します。
リークへの対処
アプリ内のリークに対処するには、次の操作を実行します。- リークのあるオブジェクトのパターン(デタッチされたDOM要素、クリアされないイベントリスナーなど)を特定します。
- アプリ内で対応するコードを特定します。
- 修正を実装します。たとえば、コンポーネントを適切にマウント解除し、配列をクリアし、イベントリスナーを削除します。
修正の確認
修正されたことを確認するには、次の操作を実行します。- 修正を実装したアプリを再ビルドし、再実行します。
- スナップショットの取得と分析のプロセスを繰り返します。
- 以前に特定されたリークがMemLabの出力に表示されなくなったことを確認します。
関連トピック
- 💬 コミュニティ: アプリがメモリ不足になっていないかを確認するには、どうすればよいですか?
- アプリのKPIを測定
- UIレンダリングの問題の特定
- オーバードローの検出
- Vega向けReact Nativeアプリでのコンポーネントの再レンダリングに関する問題の調査

