【Unity】Addressableアセットシステムで同期ロードが公式サポート、Resources.Loadを置き換え可能に

UnityのAddressableアセットシステムで同期ロードが公式にサポートされたので、その使い方とResources.Loadを置き換える方法についてまとめました。

Addressablesと同期ロード
- 今までは非同期なロード方法しかなかった
- 同期ロードが公式サポートされた
同期ロードの仕方
Resources.Loadと置き換えるには
同期ロード使用時の注意点
関連
参考

Unity2019.4.0
Addressbles 1.17.4

Addressablesと同期ロード

今までは非同期なロード方法しかなかった

Addressableアセットシステムにはこれまで同期ロードのサポートがありませんでした。
そのため以下のように非同期メソッドやコルーチンなどでロードの完了を待機する必要がありました。

// 非同期メソッド
var handle = Addressables.LoadAssetAsync<GameObject>("FooPrefab");
await handle.Task; // 待機
var prefab = handle.Result;

// コルーチン
var handle = Addressables.LoadAssetAsync<GameObject>("FooPrefab");
yield return handle; // 待機
var prefab = handle.Result;

// コールバック
var handle = Addressables.LoadAssetAsync<GameObject>("FooPrefab").Completed += x =>
{
    var prefab = handle.Result;
};

もし同期的にリソースを取得したい場合には、以下の記事のようにプリロードをしたり、専用のProviderを書いたりする必要がありました。

light11.hatenadiary.com

同期ロードが公式サポートされた

しかしやはり公式としてのサポートには強い要望があり、以下のスレッドで長らく議論されていました。

forum.unity.com

そして今回、Addressbles1.17.4でついに公式なサポートが追加されました。

https://t.co/909DcIqa4a

Addressablesの1.17で同期ロードのAPIが追加されたっぽいぞ！
— su10@ハイパーカジュアルゲーム開発 (@su10_dev) 2021年4月7日

Addressablesの1.17系が現時点ではプレビュー版なので同期ロードもプレビュー版とはなりますが、
本記事ではこの機能の使い方についてまとめます。

同期ロードの仕方

従来の非同期ロードでは、AsyncOperationHandleをawaitやコルーチンで待機する必要がありました。
今回実装された同期ロードではその代わりに、以下のようにWaitForCompletion()を呼ぶことで同期的な待機ができます。

using UnityEngine;
using UnityEngine.AddressableAssets;

public class Example : MonoBehaviour
{
    private void Start()
    {
        // 今まで通りロードメソッドを呼ぶ
        var op = Addressables.LoadAssetAsync<GameObject>("FooPrefab");
        
        // WaitForCompletionで同期的にロード完了を待機
        var prefab = op.WaitForCompletion();
        
        // 使い終わったらリリース（今まで通り）
        Addressables.Release(op);
    }
}

Resources.Loadと置き換えるには

さて前節の実装ではリソースの解放をする必要がある関係でソースコードが複数行になってしまっています。
が、すでに書かれているResources.Loadを置き換えることを考えるともう少し簡潔に書けると嬉しいところです。

// Resources.Loadで読み込む例
var prefab = Resources.Load<GameObject>("FooPrefab");

// Addressablesでもこんな感じで書きたい（理想）
var prefab = Addressables.Load<GameObject>("FooPrefab");

Addlerを使って一行で書く

Addressablesは明示的に解放処理をする必要があるため、上記のように複数行にまたがる記述になってしまいます。
そこでこの解放処理を簡潔に書くため、Addlerというライブラリ（僕が公開してるライブラリです）を使います。

light11.hatenadiary.com

これを使うとリソースの寿命を指定したGameObjectと紐づけ、そのGameObjectが破棄されるときに一緒に解放することができます。
記述は以下のように一行で行えるようになり、また解放をし忘れてメモリリークする心配もなくなります。

using Addler.Runtime.Core;
using UnityEngine;
using UnityEngine.AddressableAssets;

public class Example : MonoBehaviour
{
    private void Start()
    {
        // gameObjectが破棄されたら自動的にこのアセットも解放される
        var prefab = Addressables.LoadAssetAsync<GameObject>("FooPrefab").BindTo(gameObject).WaitForCompletion();
    }
}

なおAddlerの機能はこれだけではなく、オブジェクトプールやプリロードなどの機能を包括したライブラリになっています。

さらにシンプルに書く

実際に使うときにはこれをラップしてもっと簡潔に書けるクラスを作っておくのが良いかと思います。

using Addler.Runtime.Core;
using UnityEngine;
using UnityEngine.AddressableAssets;

public class ResourceLoader
{
    private readonly GameObject _defaultBindTarget;

    public ResourceLoader(GameObject defaultBindTarget)
    {
        _defaultBindTarget = defaultBindTarget;
    }
    
    public T Load<T>(string address, GameObject bindTarget = null)
    {
        if (bindTarget == null)
        {
            bindTarget = _defaultBindTarget;
        }
        return Addressables.LoadAssetAsync<T>(address).BindTo(bindTarget).WaitForCompletion();
    }
}

こんな感じで作っておけば以下のようにとてもシンプルにロードできます。

using Addler.Runtime.Core;
using UnityEngine;
using UnityEngine.AddressableAssets;

public class Example : MonoBehaviour
{
    private ResourceLoader _resourceLoader;
    
    private void Start()
    {
        _resourceLoader = new ResourceLoader(gameObject);

        // 同期ロード
        _resourceLoader.Load<GameObject>("FooPrefab");
    }
}