ナビゲーション遷移時の参照保持によるメモリ リーク

[jaizawa758]

バージョン：Kamishibai.Hosting 3.0.1

ViewModelで大きなオブジェクトを扱う場面があり、画面遷移後には使用されたメモリはGCに回収してもらいたい。
現状は画面遷移時にNavigationStackクラスに参照を保持しているためにメモリーリークがおこるようです。

再現手順
https://zenn.dev/nuits_jp/books/introduction-to-kamishibai/viewer/02-getting-started
上記のページまで作成、FirstViewModelを次のように改修する

using Kamishibai;
using System.Collections.ObjectModel;

namespace GettingStarted;

[Navigate]
public class FirstViewModel : IPausingAware
{
    public FirstViewModel(string message)
    {
        Message = message;
        Items.Add(new ChonkyClass()); // 大きなオブジェクトの例
    }

    public string Message { get; }

    public ObservableCollection<ChonkyClass> Items { get; private set; } = new();　

    public void OnPausing(PreForwardEventArgs args)
    {
        Items.Clear();
    }
}

public class ChonkyClass
{
    public int[] Array;

    public ChonkyClass()
    {
        Array = new int[100000000];
    }

    public int Id => GetHashCode();
}

プログラムを実行しNavigateボタンを何度も押下する
タスクマネージャーでメモリ使用量を観察する

起動直後

Navigateボタンを何度か押下後

[nuitsjp]

@jaizawa758
情報提供ありがとうございます！

いただいたコードに修正して、メモリープロファイラーに掛けてみました。

1. Snapshot ＃1: Navigateなし
2. Snapshot ＃2: Navigate 1回
3. Snapshot ＃3: Navigate n回
4. Snapshot ＃4: Navigate m回

1回目でドバっと増えたあと、２回目以降は大きく増えている形跡はなくメモリーはリークしていないものと思います。
上記はプロファイラー側で分析のタイミングでGCをかけています。

恐らく、実行環境でGCが「まだ走っていない」ため不要なメモリーがヒープから改修されていないのではないでしょうか？
OnPausingにつぎのように明示的にGCを入れてみてください。

    public void OnPausing(PreForwardEventArgs args)
    {
        Items.Clear();
        GC.Collect();
    }

入れた結果がこちらです。

ピコっと一瞬上がっていますが、GCにすぐ回収されており、リークしている形跡はありません。

GC自体が重たい処理で画面遷移の都度、フレームワーク側から呼び出すことは、他のアプリとの都合を考えると好ましくないため、上記で解消できるようであれば、アプリケーション側でGCを明示的に呼び出すようにしてください。

よろしくお願いします。

[jaizawa758]

@nuitsjp

回答ありがとうございます。
明示的にGCで対応していきます。

---

メモひとりごと
省メモリで動作させるにはNET 6.0環境のがよい（サポート切れ
dotMemoryの試用版をダウンロード
NET 8.0 と NET 6.0での比較

NET 6.0

NET 8.0

[nuitsjp]

@jaizawa758
解決したようなら良かったです。
一つ、.NET6のサポートは今日までで終了になるのでお気を付けください。

[jaizawa758]

@nuitsjp

もう少し調べてみました。
dotMemoryでview, viewmodelのインスタンス数を見てみましたが、これはメモリーリークになるのではないでしょうか？
ナビゲーション実行した数だけインスタンスが作成されGCでは解放されません

これらの対応してみました

1. こちらをコメントアウトして試した結果がこちらです。viewはインスタンスが１つまで抑えられました
   ※FrameworkElemenrtクラスではなく、stringクラスかなにかで保持するのよいか？（PrismライブラリーではUrlクラスを使用していた
   

   KAMISHIBAI/Source/Kamishibai.View/NavigationFrame.cs

   Line 137 in a5247c4

   _pages.Push(view);

   
   
2. NET dependency injectionについて
   こちらや
   こちらの記事
   最上位のコンテナーから解決された場合、メモリ リークが発生する可能性があります。
   NavigationFrameクラスなどのGetServiceメソッドを使用している箇所はすべてスコープが必要かと思いますがどうでしょうか？viewmodelの複数インスタンスが作成されるのは変わらなかったが、別のページに移動するとインスタンスはすべて解放されるようです。

追加：PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions"

    private static FrameworkElement GetPresentation(IServiceProvider serviceProvider, Type viewModelType)
    {
        Type viewType = ViewTypeCache.GetViewType(viewModelType);
+      using var scope = serviceProvider.CreateScope();
        var frameworkElement = (FrameworkElement)scope.ServiceProvider.GetService(viewType)!;

        return frameworkElement;
    }

• 現状困っていることはありません。
• Prismライブラリの動作見てみましたが、インスタンスは1つ（RegionMemberLifetime(KeepAlive = falseで新しいインスタンス作成指示）　インスタンスは１つのみ作成され２つ３つなど作成されません、ページ遷移後はインスタンスは解放されます。個人的には同じ動作が好ましい思っています。