[Unity] 対象のフォルダ以下にあるファイルの名前一覧をもつクラスを生成する拡張

記事の内容のプロジェクト（Unlicense）

はじめに

この記事ではEditor拡張を使って、対象のフォルダ以下にあるファイルのリストを出力するクラスを作成するものを作っています
ファイルのリストを作成する理由としては、AssetBundle化した場合などにファイルの名前でアクセスすることが多いのですが
その指定が文字列を直接指定していた場合、ファイルの移動やリネームをしただけで動かなくなってしまうことがあります

そこで変数に入れて参照することで、そういったエラーを防げますし、ファイルの読み込みテストも容易にできます。

今回作ったものは全てGithubにUnlicenseで上げておりますので、ご自由にお使いください

22/08/31 Dictionaryでの出力に対応しました！

Dictionaryでやるか、変数で出力するかを選べるようになりました
また、細かいですが生成タイプ、ファイル名、namespace名、クラス名は生成後保存されるようになりました

動作

作成した拡張の動画です。このような形でファイルが出力されます

コードは全て上げていますが、どのようにしてファイルのリストを作っているのか。のポイントを書いていきます

ファイルのリストの取得

まず、特定フォルダ以下にあるファイルの取得です。これは実はすごく簡単で、
AssetDatabase.GetAssetOrScenePath
を使い、Editor拡張でアタッチしたフォルダのパスを取得しています

その後
DirectoryInfo.GetFiles
を使い、サブフォルダを含めるかどうかでファイルのリストを取得しています

ただ、このファイルのリストを全て使うと、metaファイルなどのリスト化したくないものまでリストに入ってしまいます

ファイルのリストから特定の拡張子を除外

今回はとりあえず4つの拡張子をリストから除外するようにしました
_ignoreExtensionListに持たせています。
対象としたのは".meta", ".txt", ".DS_Store", ".cs"の4つです
目的がアセットのリストなのですが、必要に応じて増やしていくと思います
ファイルのリストを作成する際に、拡張子をチェックしてこれらに該当していたら除外しています

ファイルの名前から相対パスを取得

実は今回一番苦労したのがここになります。
AssetDatabase.GetAssetOrScenePathで取得したパスはAssets/から始まるプロジェクトからのパスなのですが、DirectoryInfo.GetFilesで取得したファイルのパスは絶対パスになっていました
今回は設定したフォルダからの相対パスを出したいので、変換する必要があります
リファレンスを探しましたが、なかなかに見つからず、力わざでやることにしました（コメントお待ちしています）

対象となるのはこの部分です
プロジェクトのルートパス以外を削除
まずApplication.dataPathでプロジェクトのパスを取得します。
そのパスにはプロジェクトのルートである　Assets/が入ってしまっているので、'/'でsplitをし、最後のパスであるAssets/を外したパスを作成します

その後、ファイルの絶対パスから作成したパスを除外し、さらにその後に探索するフォルダの相対パスを除外することで、探索するフォルダからの相対パスが取得できました

csファイルの出力方法

これは単純にcsファイルのテンプレートを用意し、必要な部分をReplaceしていきます
NameListsTemplate.txt
を用意し、そこでnamespace名、クラス名、それとファイルのリストに使うテンプレート行を用意します

今回は #で囲われている部分をReplace対象にしましたが、ここはなんでもいいです
ファイルのリストに関しては一括での置き換えが難しいので、対象の行となる部分を変数としてあらかじめ持っておきます
FileListTemplate
このテンプレート一個一個に対してファイル名をもとにリストをつくっていき、最後にそのリストをFileListTemplateでReplaceすることで一括でのリストを作成しています

（変数名に使えないファイル名だとエラーが出ますが、現在は空白のみ対応しています）

禁則文字や別フォルダにある名前被りなどは出てくるとは思いますが、それらは発生したら対応する。というアプローチでいいかと思います

出力するテキストファイルが完成したら、最後に指定したファイル名で出力して完成です
出力処理

拡張の使い方の説明

最後に拡張のGUI部分の解説をします。そのままではありますが、念の為。ちなみに全部の項目が設定必須です

1. 検索フォルダ
   検索の対象となるフォルダです。この配下のファイルをリスト化します
2. ファイル名
   アウトプットするcsファイルのファイル名です。拡張子は不要です
3. namespace名
   使用するnamaspaceを指定します
4. クラス名
   使用するクラス名を指定します
5. 成績先フォルダ
   クラスファイルを生成する親フォルダを指定します
6. サブフォルダを含める
   階層になっているフォルダがあった場合、その中身も含めてリスト化します

最後に

こういったファイルのリストを作る拡張は一度作っておくと使いまわせますし、ファイルの消失などの事故も防ぎやすいです
また、重複しているファイルのチェックなどもしやすくなるので、機械的にこういった処理を行えると大変便利ですので
最初に一手間をかけて今後の開発を快適にしていくことを心がけると、いい開発ができるのでは。と思っています

今回記事で紹介した内容は全てGithubに上がっており、Unlicenseになっていますので、ぜひ使っていただけると幸いです

ありがとうございました