Download as PDF, PPTX
![UniTaskTracker
• await中のUniTaskを可視化するEditor拡張
• Unity Editorの [Window] -> [UniRx] -> [UniTask Tracker]
• UniTaskがリークしていないか確認できる](https://image.slidesharecdn.com/unitask-190923053224/85/UniTask-68-320.jpg)
Uploaded bytorisoup
UniTask入門
Unity++ 〜ショートセッション勉強会 presented by Unity部〜 https://meetup.unity3d.jp/jp/events/1112
UniTask入門
- 1.
- 2. ⾃⼰紹介 • とりすーぷ • @toRisouP •バーチャルキャスト社 • Unityエンジニア • 最近はサーバ開発 • MagicOnion, k8s • Microsoft MVP 2018〜 • Developer Technology
- 3. 今回の内容「UniTask」 • UniTaskの概要 • UniTaskの使い⽅ •機能紹介 • キャンセル管理について
- 4.
- 5. UniTaskとは •Unity向けasync/await拡張ライブラリ • Unityの標準機能ではない、⾃分で導⼊が必要な外部ライブラリ • 株式会社Cysharpさんが提供 •主開発はneuecc⽒（UniRxの作者） • 前はUniRxの⼀部だったが、後に分離したライブラリ化された • その名残で名前空間が「UniRx.Async」のまま
- 6. UniTaskでできること • 「async/awaitでなんでもできるようになる」 • コルーチンをasync/awaitに置き換え •Unityイベント関数のawait • UnityEditor上でawait状況の可視化
- 7.
- 8.
- 9.
- 10.
- 11.
- 12. UniTaskを使うメリット • コルーチンを使う必要がなくなる • より使いやすいasync/awaitですべてを記述できる •既存のTaskよりもハイパフォーマンス • Unityに最適化されたTask-likeな機構が使える • UniRxよりはわかりやすい • ⼿続き処理で書ける、は⼗分メリット
- 13.
- 14. UniTaskが使える条件 • C# 7以降が使えるUnityであること •Unity 2018.3 以降 • Unity 2018.2 以前はIncremental Compilerを導⼊していると使える
- 15.
- 16. UniTaskが提供する機能 • UniTask型、UniTask<T>型 • UniTaskに付随するstaticメソッド群 •Unity機能のAwaiter • UniTaskTracker
- 17. UniTaskが提供する機能 • UniTask型、UniTask<T>型 • UniTaskに付随するstaticメソッド群 •Unity機能のAwaiter • UniTaskTracker
- 18.
- 19.
- 20. Task型 vs UniTask型 TaskUniTask 機能 Unityでは不要な機能が多い Unityで活⽤できる機能のみ オブジェクトサイズ ムダに⼤きい ⼩さい 実⾏コンテキスト管理 TaskScheduler & SynchronizationContext PlayerLoop 必要なC# version C# 5.0以上 C# 7.0以上 Task Tracker 無 Unity Editor上で利⽤可能
- 21.
- 22.
- 23. 例: async/awaitから作る • async/awaitの戻り値をUniTaskに書き換えるだけでOK •これだけでTask型からUniTask型に変換される
- 24. 例: async/awaitから作る • ジェネリック版のときも同様 •Task<T> を UniTask<T> に置き換えるだけ
- 25. (補⾜) UniTaskVoid型 • UniTaskの機構に乗った”async void” • 投げっぱなし（Fire-and-forget）の⾮同期処理として使う
- 26.
- 27.
- 28.
- 29.
- 30.
- 31. 注意点1 • Observableが必ず完了する状態にすること • useFirstValue=trueでTake(1)と同等になる
- 32. 注意点2 • UniTask ->Observable 時、 実⾏コンテキストは必ずメインスレッドになる
- 33. UniTask/UniTask<T>型 まとめ • 使い勝⼿は標準Taskとほとんど同じ •既存のasyncメソッドを機械的に置換して問題ない • Observableが絡む時だけちょっと注意が必要
- 34. UniTaskが提供する機能 • UniTask型、UniTask<T>型 • UniTaskに付随するstaticメソッド群 •Unity機能のAwaiter • UniTaskTracker
- 35.
- 36.
- 37. UniTask.Run • デリゲートをThreadPool上で実⾏する • Task.Runと挙動はおなじ •await後はUnityメインスレッドに戻る(configureAwait = true の時)
- 38. UniTask.Delay • 指定秒数後に完了するUniTaskを⽣成する • awaitすることで「⼀定時間待つ」ができる •どのタイミングで時間計測するか選べる • デフォルトはUpdate()タイミングで計測
- 39. UniTask.DelayFrame • 指定フレーム後に完了するUniTaskを⽣成する • awaitすることで「⼀定フレーム待つ」ができる •どのタイミングで計測するか選べる • デフォルトはUpdate()タイミング
- 40. UniTask.Yield() • 指定のタイミングで1フレーム待機する • 処理をメインスレッドに戻すことにも使える •引数なしの場合はUpdateタイミングで1フレーム待機になる
- 41.
- 42. UniTask.SwitchToThreadPool • 実⾏コンテキストをThreadPoolに切り替える • awaitするとそれ以降がThreadPool上での処理になる •似たものでSwitchToTaskPoolがあるが、こっちは⾮推奨
- 43.
- 44. UniTask.SwitchToMainThread • 実⾏コンテキストをメインスレッドに切り替える • awaitするとそれ以降がメインスレッド上での処理になる •UniTask.Yield(PlayerLoopTiming.Update)と微妙に挙動が異なる
- 45. UniTask.WaitUntil / UniTask.WaitWhile •条件を満たすまで/満たさなくなるまで待機する • コルーチンのWaitUntil/WaitWhileと同等 • どのPlayerLoopタイミングでチェックするかも指定できる
- 46.
- 47. UniTask.WaitUntilValueChanged • 指定のオブジェクトのパラメータが変動するまで待機する • UniRxのObserveEveryValueChangedと同じ •対象は弱参照で保持され、GCされるとawaitはキャンセルされる
- 48.
- 49.
- 50.
- 51. Staticメソッド群 まとめ • Unity向けに調整された機能が多くて便利 •標準Taskとくらべて使いやすくなってたりもする • まだまだあるけど量が多いので省略
- 52. UniTaskが提供する機能 • UniTask型、UniTask<T>型 • UniTaskに付随するstaticメソッド群 •Unity機能のAwaiter • UniTaskTracker
- 53.
- 54.
- 55. 補⾜：GetAwaiter() • Awaiterを取得するためのメソッド • クラスメソッドだけでなく、拡張メソッドでもOK •⾃前で実装すればなんでもawaitできるようになる awaitにカーソルを合わせて定義元を参照するとどのGetAwaiter()が呼ばれるかわかる
- 56.
- 57. UniTaskが提供するAwaiter • コルーチン • AsyncOperation •uGUI Event • Unityコールバック • JobHandle • UnityEvent
- 58.
- 59.
- 60.
- 61.
- 62.
- 63.
- 64.
- 65. Awaiter まとめ • Unityのあらゆる要素がawait可能になる •コルーチンの上位互換としてasync/awaitが利⽤可能になる
- 66. UniTaskが提供する機能 • UniTask型、UniTask<T>型 • UniTaskに付随するstaticメソッド群 •Unity機能のAwaiter • UniTaskTracker
- 67.
- 68. UniTaskTracker • await中のUniTaskを可視化するEditor拡張 • UnityEditorの [Window] -> [UniRx] -> [UniTask Tracker] • UniTaskがリークしていないか確認できる
- 69.
- 70.
- 71.
- 72.
- 73.
- 74.
- 75.
- 76.
- 77. CancellationToken if⽂で判定 if( IsCancellationRequested )throw new OperationCanceledException(); の省略記法
- 78.
- 79. UniTaskとCancellationToken • UniTaskはCancellationTokenを使ってキャンセル判定を⾏う • キャンセル要求がくるとUniTaskはキャンセル状態になる •await中の場合はそこで処理が終了しawait以降は実⾏されない
- 80.
- 81. Tokenが渡せない処理の場合のキャンセル • CancellationTokenの状態を⼿動で確認する • どのタイミングで処理を⽌めるのか、は⾃分で考える •キャンセル時はOperationCanceledExceptionを発⾏すればOK
- 82.
- 83.
- 84.
- 85. Throwするタイミング • キャンセル要求が外部からされた時にthrowする • 外から「処理を⽌めてね」って⾔われた時に投げる例外 •⾃⼰判断で勝⼿に投げてよい例外ではない
- 86.
- 87.
- 88.
- 89. 悪⽤しない • キャンセル⽤途以外では利⽤しないこと • 本来の⽤途とは別の使い⽅をすると、そこから負債になる •「処理に失敗したときにエラーログに出したくないから、 OperationCanceledException使っちゃおう」みたいなのはNG
- 91. UniTaskとキャンセル まとめ • CancellationTokenは可能な限り指定する •OperationCanceledExceptionは特殊なので扱いに注意
- 92.
- 93. UniTask、結局何に使えばいいの？ • 深く考えず使えそうなところでどんどん使おう • コルーチンの代替として使える •他のコンポーネントが処理を終えるのを待つ、とかにも使える • むしろUniTaskが使えないことがストレスになるくらいには便利
- 94. 他の⾮同期処理との使い分けは？ • async/awaitを使うなら、UniTaskをまず使う • 理由が無い限り標準Taskは使わない •UniRx(Observable)は⽤途に応じて使う • Observableはイベント処理や、結果が複数になる⾮同期処理向け • Observableもawait可能だし、UniTaskとの相互変換もできる
- 95. まとめ • UniTaskめっちゃ便利だから使おう！！！！ • あと今回の話の補⾜的なのをUniBook11に書きました •さらにUniRx＋UniTask本、マダカイテルカラマッテネ…