コンソールアプリでprivate async Taskでリフレクションを使用して帰り値を返せない

コンソールアプリでFormを継承させた時、何故か返り値が戻りません。
デバッガで見ると、LedSwitchTask内でreturn値の受け渡しが失敗するようです。

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Threading;
using System.Windows.Forms;
using System.Reflection;
namespace PrivateAccess {
    class Program {
        static void Main(string[] args) {
            
            PrivateAccess pr = new PrivateAccess();
            Task<string> res;

            Task.WhenAll(
                res = Task.Run(() =>
                {
                    Task<string> rt = pr.privateasynctest();
                    return rt;  
                })
            ).Wait();
            Console.WriteLine("status:" + res.Result);
        }
    }
    public class PrivateAccess :Form { //Formを継承させると、無限LOOPになる
  //  public class PrivateAccess { //Formを継承させなければ、正常にresが返る

        /// <summary>
        public PrivateAccess() {
        }

        public async Task<string> privateasynctest() {
            try {
                PrivateAccess theObject = new PrivateAccess();
                Type t = theObject.GetType();

                MethodInfo dynMethod = t.GetMethod("LedSwitchTask", BindingFlags.NonPublic | BindingFlags.Instance);

                var task = await (Task<string>)dynMethod.Invoke(theObject, new string[] { "1 0" });
             //   res = await task.ConfigureAwait(false);
                return task;
            }
            catch (Exception ex) {
                string s;
                s = ex.Message;
                return "NG";
            }
        }
        private async Task<string> LedSwitchTask(string allArg) {
            string res;
            res = await Task.Run(new Func<string>(() => {
                string chan;
                chan = allArg.Substring(0, 1);
                Thread.Sleep(800);
                return "OK";
            }));
            return res;
        }
    }
}コード

回答1件

ベストアンサー

なるほど！！！！！
これは面白いですね。原因が分かりました。

実は、async/awaitがデッドロックを引き起こす条件の一つに、「コンソールアプリケーションではないこと」というのがあります。
厳密に言うと、「SynchronizationContextという、プログラムの実行コンテキストを同期するためのstaticなプロパティに中身が存在する場合にデッドロックが発生する可能性がある」のですが、コンソールアプリケーションだとこれがデフォルトではnullになっています。そうすると、awaitした後に特定のコンテキストに復帰する動作が行われなくなるため、根本的にデッドロックが発生する原因が失われます。つまり、コンソールアプリケーションである限り、たとえWaitメソッドを使ってもスレッド同期によるデッドロックが発生しないということです。

しかし！！System.Windows.Forms.Formのインスタンスを生成するとき、どうやらコンストラクタがSynchronizationContextを生成するようです。つまり、質問のPrivateAccessクラスがFormを継承しているかどうかで、SynchronizationContextの有無が異なっていることになります。
すると、Mainメソッド内で呼び出しているWaitとprivateasynctestメソッドのawaitがぶつかってデッドロックを引き起こすようになるわけです。

これは……ちょっと想定外のクソ挙動で戸惑っていますが、、とりあえず、awaitを呼び出している式に対してそれぞれConfigureAwait(false)を付けることでSynchronizationContextの伝播を断ち切ることができるので、async/awaitを使う際はこのコーディングを徹底することでデッドロックを完全に回避することができます。

以下に、最低限の書き換えで動作するようにしたコードを掲載します。こちらをコピペで試してみてください。

csharp
1public class PrivateAccess :Form { //Formを継承させてもちゃんと動作するはず！
2
3    /// <summary>
4    public PrivateAccess() {
5    }
6
7    public async Task<string> privateasynctest() {
8        try {
9            PrivateAccess theObject = new PrivateAccess();
10            Type t = theObject.GetType();
11
12            MethodInfo dynMethod = t.GetMethod("LedSwitchTask", BindingFlags.NonPublic | BindingFlags.Instance);
13
14            var task = (Task<string>)dynMethod.Invoke(theObject, new string[] { "1 0" }); // <- awaitを外す
15            var res = await task.ConfigureAwait(false); // !
16            return res;
17        }
18        catch (Exception ex) {
19            string s;
20            s = ex.Message;
21            return "NG";
22        }
23    }
24    private async Task<string> LedSwitchTask(string allArg) {
25        string res;
26        res = await Task.Run(new Func<string>(() => {
27            string chan;
28            chan = allArg.Substring(0, 1);
29            Thread.Sleep(800);
30            return "OK";
31        })).ConfigureAwait(false); // !
32        return res;
33    }
34}

そして、元々の質問にあった、「IntelliTestから実行したときデッドロックする」については、こちらは推測ですが、おそらく内部でWaitかそれに類する動作を行っていると考えられます。
こちらも同期コンテキストの破棄を徹底することで問題は発生しなくなると予想できますが……(もしかして、UI関係とかのコンテキストが重要な非同期メソッドはIntelliTestでは評価できないってことかしら……？)
ここを掘り下げるにはさらなる調査が必要ですが、なんだか根の深い問題な気がします。

以下はお節介ですが。
自分でコードを書く場面では、決してWaitメソッドやResultプロパティを使わないようにしてくださいね。非同期に値を取得するメソッドをどこかしらで同期するというのは、実行戦略が異なる二つのコンテキストを無理矢理同期することになるため、デッドロックが発生する可能性が非常に高いのです。今回の話については結果的には回避不可能なハマりどころであったと言えますが、同じ種類のハマりどころを自分で作ることになるのだと言い換えると、どれだけヤバイかは理解できると思います。

投稿2017/06/23 15:25

編集2017/06/23 15:37