UniTask を利用した GSS のシートをスクリプタブル・オブジェクトに取り込む方法

　UniTask を利用した非同期処理の実装例を学習します。

　Google の SpreadSheet(スプレッドシート。以下、GSS とします)のシートの情報を１シートにつき、１つのスクリプタブル・オブジェクトに取り込む方法について、
コルーチンにより実装していた非同期処理の部分を UniTask (async/await) を利用した処理に置き換えて実装します。

　事前にこちらの記事より、元となる処理の作成を行ってから学習をします。

＜新しい学習内容＞

　・async キーワードと await キーワードを利用した非同期処理
　・UniTask とは？
　・CancellationToken（キャンセレーショントークン）

＜async キーワードと await キーワードを利用した非同期処理＞

　このキーワード群は C# の Task クラス、および UniTask クラスに紐づいた構文です。
よって Task クラスか UniTask クラスと一緒に宣言を行う必要があります。

　async(エイシンク) は Asynchoronous(エイシンクロナス) という単語の略語で「非同期」という意味です。
これは await を利用するメソッドを記述するために、メソッドの宣言時につける必要があるキーワードです。
その際、戻り値には UniTask を利用します。

＜async キーワード＞

private async UniTask Hoge() {

}

　await(アウェイト) キーワードは「待ち受ける」という意味です。
このキーワードは、非同期処理として実行するメソッドの先頭に記述します。

＜await キーワード＞

private async UniTask Hoge() {
    await HogeHoge();
}

　この２つのキーワードを利用し、戻り値の型を UniTask にすることにより、コルーチン処理と同じように非同期処理を実行し、その処理の解決を待ち受ける機能(メインスレッドに処理が戻ってくるのを待つ)を実装することが出来ます。
またコルーチンメソッド内で記述が可能であった yield return null や WaitUntil なども処理も UniTask には static メソッドとして用意されていますので、async / await キーワードを使うことで、コルーチンメソッドを置き換えることが出来ます。

　またコルーチンでは直接指定できなかった戻り値も UniTask<T> として記述できるようになっています。
タプル型を利用することで複数の戻り値を持たせることも可能です。

　なお UniTask には void に相当する UniTaskVoid 型があります。こちらの型にすることで処理を待ち受けない(await できない)メソッドとして機能させることも出来ます。
処理の完了を通知する必要がないメソッドで利用するため、この機能は UniTask を使った非同期処理の最後に利用されることになります。(非同期処理を最初に処理し始める場所、とも言えます)

＜参考サイト＞

MicroSoft
https://docs.microsoft.com/ja-jp/dotnet/csharp/pro...

Qiita @4_mio_11 様
非同期理解のためにasync/awaitとTaskの基礎を学んだ話
https://qiita.com/4_mio_11/items/f9b19c04509328b1e...

＜UniTask をインポートする＞

　以下の Github サイトから UniTask 用の Unitypackage をダウンロードしてインポートを行うか、PackageManager 経由でインポートを行います。

１．Github サイトから Unitypackage をダウンロードしてインポートする場合

https://github.com/Cysharp/UniTask/releases

＜Unitypackage を選択する＞

　Unity を起動し、ダウンロードした Unitypackage を Unity 内の Assets フォルダにドラッグアンドドロップしてください。
インポート用のポップアップウインドウが開きますので、Import を押してください。自動的にインポートが始まります。

２．PackageManager 経由でインポートする場合

　Unity 内で PackageManager ウインドウを開き、左上の＋アイコンを押して、Add package from git URL... を選択します。

　Github の URL を入力するポップアップが出ますので、そちらに、下記の URL をコピーして貼り付け、Add ボタンを押します。

＜UniTask の GitURL＞

 https://github.com/Cysharp/UniTask.git?path=src/UniTask/Assets/Plugins/UniTask

＜上記の URL をコピーして貼り付けてから Add ボタンを押す＞

　以上の手順を行うと、自動的に UniTask のインポートが始まります。

＜UniTask とは？＞

　C# において提供されている Task 機能を、より Unity に最適化し、より扱いやすくしたものが、UniTask になります。
UniTask は非同期処理に優れており、コルーチンによる処理の多くを async / await キーワードを使って非同期処理として記述できるようになります。

Chsharp 様
https://github.com/Cysharp/UniTask

　スクリプト内で UniTask の機能を利用する場合には、using Cysharp.Threading.Tasks; の宣言が必要になります。

　大きな違いとして、コルーチンや Invoke メソッドは MonoBehavior クラス内のメンバであるため、MonoBehavior を継承しないと実装が出来ませんが、UniTask と async / await にはその制約はありません。つまり、MonoBehavior を継承していない static クラスなどでも利用可能です。
　
　また、コルーチンの処理はゲームオブジェクトが破棄された段階で自動的に処理が破棄(キャンセル)されますが、
async / await で実装した非同期処理は自動的には停止しませんので、キャンセル処理を考えて実装する必要があります。

＜参考サイト＞

Qiita @toRisouP 様
UniTask機能紹介
https://qiita.com/toRisouP/items/4445b6b9bf00e49eb...

ソフトメディア研究会すいま様
UniTaskでレッツ非同期！
http://softmedia.sakura.ne.jp/advent-calendar/2019...

スプレッドシートを読み込んでスクリプタブル・オブジェクトに取り込むための処理を修正する

　GSSReader クラスと GSSReciver の２つのクラスのリファクタリングを行い、
非同期処理の部分をコルーチンメソッドから UniTask の機能と async / await の機能を利用した処理に修正します。

　リファクタリングになりますので、修正後は同じように動作することが求められます。

GSSReader スクリプトを修正する

　スプレッドシートにアクセスし、シート内の情報をシートごとに取得しておくためにクラスです。

GSSReader.cs

　<=　クリックすると開きます

using System.IO;
using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using UnityEngine.Networking;
using UnityEngine.Events;
using Cysharp.Threading.Tasks;　　　//　<=　☆　宣言を追加します

/// <summary>
/// シート名の登録用
/// </summary>
public enum SheetName {
    None,        // 自分の作成したスプレッドシート内のシートの名前を登録します
    SkillData,
    ItemData,
    EventData

}

/// <summary>
/// 読み込むシートのデータ群。シートの情報を管理します
/// </summary>
[System.Serializable]
public class SheetData {
    public SheetName SheetName;
    public List<string[]> DatasList = new List<string[]>();
}

/// <summary>
/// スプレッドシートのデータを取得してシート別に解析します
/// 解析が終了したら、OnLoadEnd に登録したメソッドを呼び出します
/// 解析結果は SheetData クラスの DatasList 変数からシートごとに取得
/// </summary>
public class GSSReader : MonoBehaviour {

    public string SheetID = "読み込むスプレッドシートのアドレス";

    public UnityEvent OnLoadEnd;　　　// この変数にインスペクターからメソッドを登録しておくと、スプレッドシートを読み込み後にコールバックする

    [Header("読み込みたいシート名を選択")]
    public SheetData[] sheetDatas;


////*　処理を変更　*////


    //public void Reload() => StartCoroutine(GetFromWeb());   //  処理を書き換えますのでコメントアウトします

    public async UniTask Reload() => await GetFromWebAsync();


////*　処理を変更　*////


////*　☆①～②の処理を変更・追加　*////


    public async UniTask GetFromWebAsync() {　　　//　<=　☆①　メソッドの戻り値、キーワードの追加、メソッド名を非同期処理のメソッドであることがわかる名称に変更します。


　　　　// CancellationToken の作成
        var token = this.GetCancellationTokenOnDestroy();　　//　<=　☆②　処理を追加します　


////*　ここまで　*////


        // 複数のシートの読み込み
        for (int i = 0; i < sheetDatas.Length; i++) {

            // シート名だけ毎回読み込み先を変更する
            string url = "https://docs.google.com/spreadsheets/d/" + SheetID + "/gviz/tq?tqx=out:csv&sheet=" + sheetDatas[i].SheetName.ToString();

            // Web の GoogleSpreadSheet を取得
            UnityWebRequest request = UnityWebRequest.Get(url);


////*　☆③～④の処理を変更します　*////


            // 取得できるまで待機
            //yield return request.SendWebRequest();　　　//　<=　☆③　処理を書き換えますのでコメントします


　　　　　　// 非同期処理の処理に加えて CancellationToken の設定を行い、非同期処理をキャンセルした場合には処理が停止するようにセットする
            await request.SendWebRequest().WithCancellation(token);　　//　<=　☆③　処理を書き換えます

            Debug.Log(request.downloadHandler.text);

            // エラーが発生しているか確認
            bool protocol_error = request.result == UnityWebRequest.Result.ProtocolError ? true : false;
            bool connection_error = request.result == UnityWebRequest.Result.ConnectionError ? true : false;

            // エラーがある場合
            if (protocol_error || connection_error) {

　　　　　　　　// エラー表示を行い、処理を終了する
                Debug.LogError(request.error);
                //yield break;　　　　//　<=　☆④  処理を書き換えますのでコメントします

　　　　　　　　return;               //　<=　☆④  処理を書き換えます
            }


////*　ここまで　*////


            // GSS の各シートごとのデータを List<string[]> の形で取得
            sheetDatas[i].DatasList = ConvertToArrayListFromCSV(request.downloadHandler.text);
        }

        // GSSLoader のメソッドを登録しておいて実行する
        OnLoadEnd.Invoke();
    }

    /// <summary>
    /// 取得した GoogleSpreadSheet(GSS) の CSV ファイルの情報を ArrayList 形式に変換
    /// </summary>
    /// <param name="text"></param>
    /// <returns></returns>
    private List<string[]> ConvertToArrayListFromCSV(string text) {
        StringReader reader = new StringReader(text);
        reader.ReadLine();  // 1行目はヘッダー情報なので、読み込んで何もしないで読み飛ばす

        List<string[]> rows = new List<string[]>();

        while (reader.Peek() >= 0) {  // Peek メソッドを使うと戻り値の値によりファイルの末尾まで達しているか確認できる。末尾になると -1 が戻るので、そうなるまで繰り返す
            string line = reader.ReadLine();        // 一行ずつ読み込み
            string[] elements = line.Split(',');    // 行のセルは,で区切られているので、それを分割して１文字ずつの情報が入った配列にする

            for (int i = 0; i < elements.Length; i++) {　　// 1文字ずつ取り出す
                if (elements[i] == "\"\"") {
                    continue;                       // 取り出した文字が空白である場合は除去
                }
                elements[i] = elements[i].TrimStart('"').TrimEnd('"');  // 文字の最初と最後にある "" を削除する
                //Debug.Log(elements[i]);
            }
            rows.Add(elements);
        }
        return rows;
    }
}

＜CancellationToken（キャンセレーショントークン）＞

　非同期処理の途中で処理が停止するような事態が発生した場合についての制御の処理です。

　コルーチンメソッドの処理については、ゲームオブジェクトの生存状態とコルーチンメソッドの処理が紐づいて動いていますので、
ゲームオブジェクトが破壊されると、その時点でコルーチンメソッドの処理も自動的に終了します。

　UniTask で利用する async / await による非同期処理はゲームオブジェクトに処理が紐づいていないため、
処理を実行したスクリプトがアタッチされているゲームオブジェクトが破壊されても、処理自体は動き続けてしまうことになり、
メモリリークを引き起こす原因となります。

　そのため、事前に処理を停止するための制御を用意しておいて、処理の停止を行えるようにしておく必要があります。

　C# には CancellationToken という機能が用意されておりますが、UniTask でも同様の機能が用意されています。
これを利用することで非同期処理を停止させることが出来るようになります。

　C# の CancellationToken は System.Threading の namespace に用意されていますが、
UniTask の宣言内にも用意されていますので、重複して宣言する必要はありません。

　using Cysharp.Threading.Tasks;

　// CancellationToken の作成
　var token = this.GetCancellationTokenOnDestroy();

　// 非同期処理に CancellationToken の設定を行い、非同期処理をキャンセルした場合には処理が停止するようにセットする
  await request.SendWebRequest().WithCancellation(token);

GSSReceiver スクリプトを修正する

　スプレッドシートから取得したデータが GSSReacer クラスの SheetData 配列変数内に格納されているので、
それをシート単位で任意のスクリプタブル・オブジェクトに値として取り込むためのクラスです。

GSSReceiver.cs

　<=　クリックすると開きます

using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using System.Linq;
using Cysharp.Threading.Tasks;　　　//　<=　宣言を追加します

/// <summary>
/// スプレッドシートから取得したデータをシート単位で任意のスクリプタブル・オブジェクトに値として取り込む
/// </summary>
[RequireComponent(typeof(GSSReader))]
public class GSSReceiver : MonoBehaviour
{
    public bool IsLoading { get; set; }


////*　☆①の処理を修正します　*////


    private void Awake() {

        // GSS のデータ取得準備
        //StartCoroutine(PrepareGSSLoadStart());　　//　<=　☆①　処理を書き換えるのでコメントアウトします


        PrepareGSSLoadStartAsync().Forget();　　　　　 //　<=　☆①　処理を書き換えます
    }


////*　ここまで　*////


////*　☆②～③の処理の修正をします　*////


    /// <summary>
    /// GSS のデータ取得準備
    /// </summary>
    /// <returns></returns>
    private async UniTask PrepareGSSLoadStartAsync() {   //　<=　☆②　メソッド名、メソッドの戻り値の変更とキーワードを追加します

        IsLoading = true;

        // 読み込んでない場合には、GSS を取得して SO に取得する
        //yield return StartCoroutine(GetComponent<GSSReader>().GetFromWeb());　//　<=　☆③　処理を書き換えるのでコメントアウトします


        await GetComponent<GSSReader>().GetFromWebAsync();　　　　 //　<=　☆③　処理を書き換えます


////*　ここまで　*////


        IsLoading = false;

        Debug.Log("GSS データを SO に取得");
    }

    /// <summary>
    /// インスペクターから GSSReader の OnLoadEnd にこのメソッドを追加することで GSS の読み込み完了時にコールバックされる
    /// </summary>
    public void OnGSSLoadEnd() {

        GSSReader reader = GetComponent<GSSReader>();

　　　　// スプレッドシートから取得した各シートの配列を List に変換
        List<SheetData> sheetDataslist = reader.sheetDatas.ToList();

　　　　// 情報が取得できた場合
        if (sheetDataslist != null) {

            // スクリプタブル・オブジェクトに代入
            DataBaseManager.instance.skillDataSO.skillDatasList = 
                new List<SkillData>(sheetDataslist.Find(x => x.SheetName == SheetName.SkillData).DatasList.Select(x => new SkillData(x)).ToList());

            // TODO 他の SO を追加する

        }
    }
}

ゲームを実行して動作を確認する

　非同期処理をコルーチンメソッドから UniTask を利用した処理にリファクタリングしただけですので、
ゲームを実行した際の処理はいままでと同じように動作することを確認します。

　ゲームを実行すると、自動的にスプレッドシートの読み込みと、読み込んだ情報をスクリプタブル・オブジェクトに取り込む処理が実行されます。

　SkillDataSO スクリプタブル・オブジェクトを確認し、Size が 0 ではなく、スプレッドシートの行の数分になっており、値が代入されているかを確認してください。

　また複数のスクリプタブル・オブジェクトを用意している場合も同様に確認してください。

　以上になります。

このページを編集するこのページを元に新規ページを作成

印刷する

コメント（0）

UniTask を利用した GSS のシートをスクリプタブル・オブジェクトに取り込む方法 - i-school 先頭へ

コメントをかく

名前	ユーザIDを使用しないで書き込む	ユーザーIDを使う	ログインする
画像コード	画像に記載されている文字を下のフォームに入力してください。
備考	「http://」を含む投稿は禁止されています。
本文
利用規約をご確認のうえご記入下さい

i-school