Yucchiy's Note

Unityでファイルパスを扱う上での注意点

December 26, 2019

TL;DR

Unityでファイルパスを扱う場合は、そのファイルパスがAssetDatabaseのファイルパスなのか、OS依存なファイルパスなのか意識するとよい。

Unityでのアセットのファイルパスについて

Unityでは、エディタ拡張などでアセットを操作する場合、データをバイナリやテキストで直接読み込んだり、加工することは少なく、 AssetDatabaseを用いてデータを処理することが多いです。

ちなみにAssetDatabaseのファイルパスはOSに依存しない設計になっていて、 Assetsファルダを起点とした相対パスで表現されます(ex: Assets/Scene/SampleScene.unity)。

ただし、例えば独自フォーマットのファイルを読み込みたい場合などは、System.IO系のメソッドを利用する必要がありますが、こちらのファイルパスは、OSに依存しています

具体的には、Macではディレクトリセパレータは/で表されますし(ex: ~/Document/hoge.dat)、Windowsでは同じフォルダはディレクトリセパレータは\で表されます。

なので、AssetDatabaseで取得できるファイルパスは、Windowsではそのまま利用できず、以下の処理を用いてファイルパスをOS依存のものに変換してやる必要があります。

// これは本来やらないほうがいい(後述)

// AssetDatabaseのディレクトリセパレータ
const string kAssetDatabaseDirectorySeparatorChar = '/';

// .datとつくファイルをAssets/Settingsから取得する
string[] guids = UnityEditor.AssetDatabase.FindAssets(".dat", new string[] { "Assets/Settings" });
foreach (string guid in guids)
{
    // ここで取得できるfilepathは、AssetDatabaseでのファイルパス
    string filepath = UnityEditor.AssetDatabase.GUIDToAssetPath(guid);

    // OS依存なファイルパスに変換する
    filepath = filepath.Replace(
        kAssetDatabaseDirectorySeparatorChar,
        // https://docs.unity3d.com/ScriptReference/Path.DirectorySeparatorChar.html
        // OSのディレクトリセパレータを返してくれる
        System.IO.Path.DirectorySeparatorChar
    );

    // .dat拡張子ファイル以外は無視する
    if (System.IO.Path.GetExtension(filepath) != ".dat")
    {
        continue;
    }

    using (var stream = new System.IO.FileStream(
            filepath,
            System.IO.FileMode.Create
    ))
    {
        // ここで読み込んだファイルの処理をする
    }
}

ただし、個人的には上記に示したコードサンプルはあまり良い実装ではなく、AssetDatabaseで取得したパスはAssetDatabaseのAPIのみで利用し、 System.IOで取得できるパスはSystem.IOのみで利用するのが望ましいです。つまり、2つのファイルパスが混ざるような実装はできればしない方が良いです

例えば、上記の実装は下記の実装に置き換えてもいいかもしれません。

// .datとつくファイルをAssets/Settingsから取得するが、
// System.IO.Directory.GetFilesメソッドでそもそも取得する。
string[] filepaths = System.IO.Directory.GetFiles("Assets/Settings", "*.dat");
foreach (string filepathin filepaths)
{
    // .dat拡張子ファイル以外は無視する
    if (System.IO.Path.GetExtension(filepath) != ".dat")
    {
        continue;
    }

    using (var stream = new System.IO.FileStream(
            filepath,
            System.IO.FileMode.Create
    ))
    {
        // ここで読み込んだファイルの処理をする
    }
}

うまく行かないケース

例えば、エディタ拡張でプロジェクトビューで選択したファイルに対して、右クリックでファイルフォーマットチェックをする機能を実装したい場合などです。

選択中のファイルを取得するには、UnityEditor.Selection.assetGUIDsを用いますが、 取得できる値がGUIDなため、ファイルパスを取得するにはやはりUnityEditor.AssetDatabase.GUIDToAssetPathメソッドを用いてAssetDatabaseのファイルパスを取得し、 そこからOS依存なファイルパスに変換が必要になります。

なのでUnityでファイルパスを扱う場合は、常にAssetDatabaseのファイルパスなのか、OS依存なファイルパスなのかを意識できると、ミスが少なくなるのかなと思います。


Yuichiro MUKAI
Yuichiro MUKAIGame & Web Programmer

シブヤで働くゲームプログラマー. C#(For Unity)をメインに, 趣味でPHPなどを書きます.

Twitter / Facebook