コンストラクタでの非同期メソッドの実行

Question

C# Xamarinでアプリの開発をしています。

「PCL Storage」というプラグインを使用しているのですが、その中のメソッドのGetFilesAsyncとReadAllTextAsyncをコンストラクタで使用したいと思っています。ですが、このメソッドは非同期のもので、コンストラクタで使用することができなくて困っています。

	public class TaskListView : ListView
	{
		public TaskListView()
		{
			var data = makeTaskListData();
			ItemsSource = data.Result;

			var cell = new DataTemplate(typeof(TextCell));
			cell.SetBinding(TextCell.TextProperty, "Title");

			ItemTemplate = cell;
		}

		// 非同期メソッドで実装するしかなかった。ListViewのデータクラス
		private async Task<List<TaskData>> makeTaskListData()
		{
			IFolder rootFolder = FileSystem.Current.LocalStorage;
			IList<IFile> fileList = await rootFolder.GetFilesAsync();
			var fileTitleList = new List<TaskData>();

			foreach (var file in fileList)
			{
				string fileTitle = await file.ReadAllTextAsync();
				// とりあえずタイトルを取得
				fileTitleList.Add(new TaskData { Title = fileTitle });
			}
			return fileTitleList;
		}
	}

このようにprivateのメソッドを作り、そこに非同期処理を纏めてから、コンストラクタで使用するという方法もやってみたのですが、このListViewを表示しようとするとフリーズしてしまいました。

根本的にやり方が間違っているような気がします。質問の内容以外でもおかしな所があれば、指摘していただけると嬉しいです。

Answer 1

コンストラクタ内のdata.Resultは結果が返ってくるまでUIスレッドを止めてしまいます。
makeTaskListData内でawait rootFolder.GetFilesAsync();が非同期に処理され、それがUIスレッドのコンテキストに戻されるけれど、すでにUIスレッドは結果待ちで止まっているのでそこできれいにデッドロックしてるかと。
kekyo2さんがasync-awaitダークサイドis何にまとめられていますのでご参考にされてみてはいかがでしょうか。

そちらにあるようにConfigureAwaitなどを使えばフリーズしないのではないかと思いますが、TaskをResultなどで待つことはそのスレッドを止めてしまうため基本的にはしない方がいいと思います。

ちなみにそのような場合はコンストラクタは最低限のクラスの初期化だけすまして別にasyncのInitializeメソッドを設けそれを使って非同期の処理を呼び出すなども手かと思います。

Comments

[shiita]

awaitとasyncを付けていれば非同期で動いてくれるんだな、程度の理解しかなかったため、非常に参考になりました。ありがとうございます。

ConfigureAwait(false)にすることで、ワーカースレッドにmakeTaskListData()を最後まで実行させることで、Resultで結果を待ってもデッドロックしなくなりました。

Answer 2

C#に詳しいわけではないですが，調べてみると「やっぱりそうか」と思える手法は見つかりました．staticなファクトリメソッドからprivateなコンストラクタを叩くようにすると良さそうです．

c# - Can constructors be async? - Stack Overflow

追記

JavaScriptのノリで適当に書いてみました，あやふやな知識で書いた上にデバッグも全くしてないので，おかしいところがあれば指摘お願いします．

public class TaskListView : ListView
{
    public static async Task<TaskListView> BuildTaskListViewAsync()
    {
        var rootFolder = FileSystem.Current.LocalStorage;
        var files = await rootFolder.GetFilesAsync();
        var taskDataList = await Task.WhenAll(files.Select(async file => {
            var title = await file.ReadAllTextAsync();
            return new TaskData { Title = title };
        }));
        return new TaskListView(taskDataList);
    }

    private TaskListView(List<TaskData> taskDataList)
    {
        ItemsSource = taskDataList;
        var cell = new DataTemplate(typeof(TextCell));
        cell.SetBinding(TextCell.TextProperty, "Title");
        ItemTemplate = cell;
    }
}

Comments

[mpyw]

ところで元のコード，ファイルの読み取りを1個ずつawaitしてるの無駄じゃないでしょうか？「ファイル内容を読み取ってreturnするタスク」をリストtasksにあらかじめ全部突っ込んでおいて，Task.WhenAll(tasks) をawaitすればいいと思います．

(C#には詳しくないので正確なコードを書く自信はないです…

[shiita]

わざわざコードまでありがとうございます。Task.WhenAll知りませんでした、無駄を省けました。Task.WhenAllの戻り値が配列のタスクだったため、リストにキャストしたら動くようになりました。

TaskListViewのコンストラクタをタスクで返せたのはいいのですが、TaskListViewを使う場所も別のクラスのコンストラクタなので、フリーズは回避できませんでした。

Answer 3

単なるクラスなら以下のやり方とかあると思います。
1.コンストラクタで何もせずInitializeAsyncメソッドで取り込む
2.staticなCreateInstanceAsyncメソッドでクラスを作って返す

が、これはListView(GUI部品)なのでomanukeさんの言うように根本的な作り方としてまずいです。
MVVM的に分離して作られてはいかがでしょうか？

Comments

[shiita]

回答ありがとうございます。GUIプログラミングとC#を勉強し始めて日が浅いため、MVVM(特にデータバインディング)がよくわかっていないです。omanukeさんの回答から動くものは完成したので、後々勉強をしながら改良していきたいと思います。