WPFで極力闇を見せないDispatcherを作ってみた

# はじめに

https://espresso3389.hatenablog.com/entry/2016/08/09/022724

上記の記事で他スレッドにDispatcherを設けるとき、いくつかの闇があると書かれていた。
それを自分なりに見せないように設計し、実装してみたので公開する。

# 解決したい課題

C#で非同期で作業をする場合、Taskという非常に便利な機能がある。
これを使えば、簡単に非同期の処理を記述できる。

[前回](https://qiita.com/mickie895/items/a867be5758a5c123aa73)の本を、非同期で100冊追加する処理を試しに書いてみるとこうなる。

<details><summary>変更点のみ抜粋</summary><div>

```cs
        public MainWindowViewModel()
        {
            Dispatcher uiThread = Dispatcher.CurrentDispatcher;
            BookList = new List<BookInfo>();
            AddItemToShelf();
            uiThread.BeginInvoke(() => {
                BookList = books;
                Title = $"本の総数：{BookList.Count}冊";
            });
        }

        public async void AddItemToShelf()
        {
            books = new List<BookInfo>();
            ConcurrentQueue<BookInfo> createdBookQueue = new ConcurrentQueue<BookInfo>();
            List<Task> tasks = new List<Task>();
            for (int i = 0; i < 100; i++)
            {
                string bookName = $"TaskName{i}";
                tasks.Add(Task.Run(() => createdBookQueue.Enqueue(new BookInfo(bookName))));
            }

            await Task.WhenAll(tasks);

            while(createdBookQueue.TryDequeue(out BookInfo book))
            {
                books.Add(book);
            }

        }
```
</div></details>

全ソースコードはGitHubにアップロードしておいた。[タグも一応つけておいた。](https://github.com/mickie895/dispatchersample/tree/create_with_task/)

このソースは100個のタスクを雑に詰め込んでいるので、実際に実行してみるとこのように
タスクの生成順と実際の並び順が一致することは稀になっている。

![スレッドセーフ.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/395414/3fda6ac3-ae2a-a66d-e1d8-52377782700e.png)

もし、これを順番を保ったまま生成したいとなると、冒頭で示したページのコードを使えば良い。
だけどそこに書かれているコードは著者が言っているように闇がいくつか存在するし、
大規模なソフトとかだとログの機能などですでにawaitを挟んでいて事故が起きる可能性も高そうだ。

というわけで、今回はできるだけ闇を隠すようなDispatcherを作ってみた。

# ソースコード

https://github.com/mickie895/dispatchersample/blob/main/BookShelfSample/Threading/DispatcherBase.cs

名前空間は各自で使用状況に合わせて修正してほしい。

今回変更しているのは次の二点。

+ Task.Resultを使わない
+ 抽象クラス化してカプセル化

## Task.Resultの使用回避

Task.Resultでデッドロックを起こす可能性があるのだったら使わなければいいじゃない、ということでUIスレッドのDispatcherに```baseDispatcher.BeginInvoke((Action)OnInitiallized);```を投げるようにして回避する。
ただ、baseDispatcherがUIスレッドではなかった場合に不具合が起こるから、
初期化時にUIスレッドのDispatchetrを渡せるようにコンストラクタのオーバーロードをしておいた。

## 抽象クラス化してカプセル化

今回提示したソースコードは抽象クラス化して、外部から使えるメソッドは次の3つに絞った。

+ OnInitiallized
    + 初期化が完了されたときにベースのスレッドで実行されるメソッド
+ PostOnIsolatedThread
    + 作成したスレッドのメッセージキューに新しい処理を追加するメソッド
+ PostOnBaseThread
    + ベースのスレッドのメッセージキューに新しい処理を追加するメソッド

https://github.com/mickie895/dispatchersample/blob/main/BookShelfSample/ViewModels/BookListDispatcher.cs

そうして絞ってしまえば、上のリンクのようなシンプルな記述方法で100個のインスタンスの作成を特定のスレッドで行い、
結果を返すことができる。
ちなみにOnInitiallizedの最後の処理でBookListCreateComplete→OnBookListCreateCompletedと一つメソッドを挟んでいるのは、
外部のスレッドのすべてのメッセージキューが終了されたことを確定させてからUIスレッドに作業が完了したと通知したいから。
PostOn～～の関数は作業の予約をしただけなため、いきなりPostOnBaseThreadを使ってしまうと、
100個のインスタンスの作成作業と更新完了通知を同時に走らせてしまうため、最終的な出力は不定のものになってしまう。

なお、今回は雑に作っているので初期化が終わったらすぐにインスタンスの作成をしているけど、
初期化に手間取り過ぎたりOnInitiallizedの処理が少なすぎたらBookListChangedを購読する前に
OnBookListCreateCompletedが呼ばれてしまう可能性が出てくるので注意してください。
（コンストラクタに作業完了時のActionを指定できるようにしてもいいかもしれない）

# 実行結果

上のコードを実際に動かしてみたらこのように順番が正しく出るようになった。
![ディスパッチャの採用.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/395414/a0b783bf-2d38-dbe6-14cd-80696c083746.png)