Unity非同期完全に理解するための第一歩～非同期処理とは何か～

# 最初に

どうも、[ろっさむ](https://twitter.com/Ev_rossam)です。
9月に、[「Unity 非同期完全に理解した勉強会」](https://connpass.com/event/95696/)にLT枠として参加してきました。

結論から申し上げますと、Unity非同期完全に理解していないことを完全に理解することができました。

ということで、これを機に非同期周りの完全理解を目指し、記事として執筆しようと思った次第です(遅い)。記事を読み始める時点での対象者に求めるスキルはUnity4系以降を触っている且つ、「コルーチンでしょ！知ってる知ってる！！」又は「async/awaitとかでしょ！わかるわかる！！」という雰囲気で非同期処理をやっている程度です（完全に私のことです）。

コルーチンから始まり、async/await周りについても触れていきたいと思っていますので、どうぞよろしくお願いいたします。

出来るだけ噛み砕きつつ細かく説明していくので、よければ眺めていってください。

Unity非同期完全に理解するための歩み：
- 【Part0】[タスクとスレッドとプロセスの違いを知って非同期完全理解に近付く](https://qiita.com/4_mio_11/items/3b83c11bb0fac4844604)
- 【Part1】Unity非同期完全に理解するための第一歩～非同期処理とは何か～ ←今ココ！
- 【Part2】[古来よりUnity非同期を実現していたコルーチンとは何者か？](https://qiita.com/4_mio_11/items/3030f9a39f59cd68f705)
- 【Part3】[非同期理解のためにasync/awaitとTaskの基礎を学んだ話](https://qiita.com/4_mio_11/items/f9b19c04509328b1e5c1)

# まず非同期の意味を本当に理解していますか？？

## 同期処理とは

本格的に非同期関連の処理について勉強する前に、一応「非同期」とは何なのかを確認しましょう。

**「同期」とは一連の処理が終わるまで待ち続けること。**

一般的なプログラムは上から順番に処理を実行していきますよね？
つまり処理Aが始まったら、処理Aが終わるまでその次の処理は実行されません。

これを**同期処理**と言います。

ゲームで例えると、アイテムリストに表示するアイテム全ての描画処理を終えるまでは他に何の処理も行えずUI周りを含め、画面全体がフリーズするということですね。このような事態になるのは当然ながら不推奨です。

![image.png](https://qiita-image-store.s3.amazonaws.com/0/36899/35c3489e-f048-9f7b-0fea-125968364e1f.png)


## 非同期処理とは

**「非同期」とは重い処理があった場合は終わるのを待たないこと。**

時間のかかる処理Aがあったとしたら、処理Aが終わるのを待たずに次の処理を実行します。処理Aには**コールバックメソッド**を登録して、**処理が終わり次第、そのメソッドが呼び出されるようにします**。

先の例で言うなら、アイテムの描画処理中に「Now Loading...」などのUIを表示させ、それを動かし続けることです。アイテム描画処理が終わり次第、アイテムリストを表示させます。ちなみに、こうすることで、ユーザーがアプリに持つストレスを減らす効果があります。

さて、もう少し深いところまで見てみましょう。

# 非同期処理と並列処理

よく非同期処理と並列処理は間違われがちなので、ここで一度違いをおさらいしておきましょう。

非同期処理は先ほど述べたように重い処理に対してはコールバックメソッドを登録しておき、処理が終わり次第そのメソッドを呼び出して結果を受け取り、その結果を使用してまた処理を行います。これは**重い処理だけでメインスレッドを占有させないため**です。逆に言うと、**メインスレッドが停止しているように見えず、別の処理を実行できているかのように見えていれば、それも非同期**と言って良いです（例：メインスレッドにてミリ秒単位で処理を切り替える(同期処理)、マルチスレッドで別スレッドに処理を託す(並列処理)、外部とのやり取り中にできる待ち時間に重い処理を行う(I/O待ち)）。

この機能を備えているのが**C#の「async/awaitとTaskクラス」**となります。
<br>
一方で並列処理とは、**計算処理系などの比較的短い処理をマルチスレッドで実行する**事で複数コアを持つハードウェアの**パフォーマンスを最大まで引き出す**ための手法となります。

この機能を備えているのが**Unityであれば「C# Job System」**となります。

# 非同期設計

(サンプルコードはC++です)

非同期設計をする場合には、同期設計と異なり**処理結果が要求して即座に結果が返ってくるとは限らない**事を頭に置いて置かなければなりません。例えば、レイキャストを使用して、プレイヤーが敵キャラクターに視線を向けているかの判定を行うとします。同期設計の場合、即座にレイキャストが行われた後リターンされます。

```C++
while(true)
{
    // プレイヤーの視線上に敵がいるかレイをキャストする。
    RayCastResult r = castRay(playerPosition + (playerForwardVec*100.0f), enemyPosition)

    if(r.hitSomething() && isEnemy(r.getHitObject()))
    { // プレイヤーが敵を確認できる。 }
}
```
<br>
非同期設計ではレイキャストを行う処理をセットしておき、リクエストキューに入れる関数を呼んだ後、すぐにリターンします。メインのスレッドは占有されないため、他の処理を行うことができます。この間にレイキャストの処理は他のCPUまたはコアによって処理されています。処理が完了すると、メインのスレッドがレイキャストの結果を受け取って処理することができます。

```C++
RayCastResult r;
bool rayJobPending = false;
while(true)
{
    // 前フレームのレイキャストジョブの結果を待つ。
    if (rayJobPending)
    {
        waitForRayCastResults(&r);

        if(r.hitSomething() && isEnemy(r.getHitObject()))
        { // プレイヤーが敵を確認できる。 }
    }

    // 新しいレイを次のフレームへキャストする
    rayJobPending = true;
    requestRayCast(playerForwardVec*100.0f), enemyPosition, &r);

    // 他の作業を行う
}
```

## 非同期処理のリクエストタイミングと、いつまで待つか

### このリクエストをどの程度早く送り出すことができるか

当たり前ですが、非同期処理のリクエストを送るタイミングが早ければ早いほど、処理の結果が必要となる時点までに処理が終わっている可能性が高くなります。このタイミングによっては、メインスレッドが非同期リクエストの完了待ちで待機状態になってしまう可能性もあるため、**できるだけ早い段階でリクエストを送る**必要があります。

### このリクエストの結果が必要となるまでにどのくらい待てるか

リクエスト結果が必要となるタイミングはいつになるでしょうか。アップデートループの後半の処理でしょうか。それとも１フレームまたはそれ以上の遅延を許容し、少し前の状態の結果を使用しても問題ないでしょうか。**タイムラグを許容できる処理なのか**どうか考える必要があります。


# 参考

- ゲームエンジンアーキテクチャ(文献)
- [Unityのマルチスレッド界隈のはなし](http://orange-lily27.hatenablog.com/entry/2018/04/26/224319)
- [イケてるエンジニアになろうシリーズ 〜メモリとプロセスとスレッド編〜](https://moro-archive.hatenablog.com/entry/2014/09/11/013520)
- [「Unity2018.xで知っておきたいC# Job System機能の概要」](https://qiita.com/4_mio_11/items/39354a18425da7490b59)
- [async/await のしくみ](https://www.slideshare.net/ufcpp/asyncawait-114647813)