Addressableのアドレス一覧からモデルクラスを生成するEditor拡張

はじめに

この記事はUnity Advent Calendar 2022の14日目の記事です。
今年も変わらず大きな盛り上がりを見せているAdventCalendar、是非他の記事も覗いてみてください！!

概要

Addressableを導入したプロジェクトでコーディングをしていると、以下のような不満がありました。

• アセットのアドレスを確認するのめんどくさい
• EditorとUnityを切り替えるのがめんどくさい
• アドレスのtypoによってランタイムエラーを起こしてしまう

そこで、AddressableのアドレスがまとまっているモデルクラスがあったらEditorのコード補完でアドレスを確認できると思い、実際に実装してみました。

本記事で利用したコードはGitHubGistにまとまっています。

Addressableとは？

Unityのアセットを管理するための仕組み
アセットに一意の名前（アドレス）を付与してマップすることで、アセットを簡単に取得することができる

実装方針

どんな形でモデルクラスが生成されるといいかを考えた時に、以下のような理想を持っていました。

• Editorの入力補完によって、現在のプロジェクトでAddressable管理されているアセットをGroupごとに探すことができる
• そのアドレスを取得することができる

その為生成されるモデルクラスは以下のような形式になります。

namespace hoge
{
    /// <summary>
    /// サマリーコメント
    /// </summary>
    public static class piyo
    {
        public static class AddressableGroupName
        {
            public static readonly string AddressableLabel = "AddressableLabel";
        }
    }
}

モデルクラスを生成するためのモデルを定義

上記のモデルクラスを生成する為のモデルを以下のように定義しました。

public class AddressableAddress
{
    public string Group { get; private set; }
    public Dictionary<string, string> AddressDictionary { get; private set; }

    public AddressableAddress(string group, Dictionary<string, string> addressDictionary)
    {
        Group = group;
        AddressDictionary = addressDictionary;
    }
}

C#のコードからクラスファイルを生成する

記事量が多くなってしまう為外部の参考記事を貼らせていただきますmm

@Kan_Kikuchi さんのブログを参考に以下のような実装をしました。

Addressable管理されているアドレス一覧を取得

プロジェクトでAddressable管理されているアドレス一覧をコードから取得して、モデルクラスを生成する為に以下のような実装を行いました。

static void AddressBookGenerate()
{
    var list = new List<AddressableAddress>();
    var addressableSetting = AddressableAssetSettingsDefaultObject.Settings;
    var assets = new List<AddressableAssetEntry>();
    var GroupList = new List<string>();

    addressableSetting.GetAllAssets(assets, true);
    foreach (var a in assets)
    {
        // NOTE: BuiltInDataやデフォルトグループは除外している
        if (a.parentGroup.Name.Contains("Built In Data")) continue;
        if (a.parentGroup.Name.Contains("Default Local Group")) continue;

        if (!GroupList.Contains(a.parentGroup.Name))
        {
            GroupList.Add(a.parentGroup.Name);
            list.Add(new AddressableAddress(
               a.parentGroup.Name,
               new Dictionary<string, string>()
            ));
        }

        list.Find(x => x.Group == a.parentGroup.Name).AddressDictionary.Add(a.address, a.address);
    }

    ModelClassGenerator.Create(
        className: "AddressBook",
        classInfo: "Addressableのアドレスリスト",
        namespaceName: "Hoge.ModelClass",
        saveDirectory: "Assets/Script/Model",
        valueList: list
    );
}

実装解説

var addressableSetting = AddressableAssetSettingsDefaultObject.Settings;
Addressableの設定を拾ってくる(Addressableに関するEditor拡張を書くとき大体こいつをどうにかする)

var assets = new List<AddressableAssetEntry>();
AddressableAssetEntry型は

addressableSetting.GetAllAssets(assets, true);
第一引数に指定したListに対して、すべてのアセットエントリを取得

※ドキュメントを見ると特定のGroupやエントリでフィルタすることもできそう

list.Add(new AddressableAddress(a.parentGroup.Name,new Dictionary<string, string>()));
あとは、listにGroup名とAddressを突っ込んで上にあったModelClassを生成するクラスに突っ込むだけ

実際に生成したクラス

Unity公式サンプルのLoadyDungeonsを使ってモデルクラスを生成してみました。

namespace Model.Addressables
{
    /// <summary>
    /// Addressableのアドレスリスト
    /// </summary>
    public static class AddressBook
    {
        public static class HatsGroup
        {
            public static readonly string Hat00 = "Hat00";
            public static readonly string Hat01 = "Hat01";
            public static readonly string Hat02 = "Hat02";
            public static readonly string Hat03 = "Hat03";
        }
        public static class Level_00Group
        {
            public static readonly string Level_00 = "Level_00";
        }
        public static class Level_01Group
        {
            public static readonly string Level_01 = "Level_01";
        }
        public static class Level_02Group
        {
            public static readonly string Level_02 = "Level_02";
        }
        public static class Level_03Group
        {
            public static readonly string Level_03 = "Level_03";
        }
    }
}

まとめ

ちゃんとAddressableをプロジェクトに導入して運用するには、アドレスを自動付与するEditor拡張が必須になるかと思います。
また、そのEditor拡張はCI環境で実行されることも多いと思うのでついでにモデルクラスも生成しておくと、実装時にちょっとだけ幸せになれます。

※バグ等ありましたらコメントにてご教授ください🙏🙏🙏

ドキュメント