CreateAssetで作成するファイルのパスに含めてはいけない文字

CreateAsset関数に渡すファイルパスのファイル名部分に、空白や一部記号など特定の文字が含まれていると例外が発生する件についてまとめました。

導入

AnimationClipを自動作成するEditor拡張を作成する過程で、空白や一部記号など特定の文字が含まれているファイルパスを指定した際に例外が発生する現象に遭遇しました。原因、回避方法が見つかったので共有します。

環境

• Windows 10
• Unity 2019.4.31f1
• Microsoft Visual Studio Community 2019 Version 16.11.16

事象

CreateAssetを用いると、第一引数に作成するオブジェクトを、第二引数にファイルパスを指定することで、アセットを作成することができます。

以下は、Buttonが押下されたら、ファイル名をファイルパスに合成してCreateAssetメソッドに渡し、アニメーションクリップを作成するエディタ拡張のコードになります。

サンプルコード

EditorExample

using UnityEngine;
#if UNITY_EDITOR
using UnityEditor;
#endif

public class EditorExample : EditorWindow
{
    [MenuItem("EditorExample/FileExportTest")]
    private static void Create()
    {
        // 生成
        EditorExample window = GetWindow<EditorExample>("EditorExample");
    }

    // ファイルの名前部分を格納する変数
    string fileName = "";

    private void OnGUI()
    {
        /* エディターレイアウトここから */
        Color defaultColor = GUI.backgroundColor;
        using (new GUILayout.VerticalScope(EditorStyles.helpBox))
        {
            GUI.backgroundColor = Color.gray;
            using (new GUILayout.HorizontalScope(EditorStyles.toolbar))
            {
                GUILayout.Label("ファイル作成");
            }
            GUI.backgroundColor = defaultColor;
            /* エディターレイアウトここまで */

            // ファイル名入力テキストボックス
            fileName = EditorGUILayout.TextField("FileName:", fileName);

            if (GUILayout.Button("作成"))
            {
                if (fileName != null)
                {
                    ExportFile(fileName);
                }
            }
        }
    }

    public static void ExportFile(string fileName)
    {
        // オブジェクトを作成
        var animation = new AnimationClip();
        if (animation == null) return;

        // ファイル名をファイルパスに変換
        string exportPath = "Assets/EditorExample/Resources/" + fileName + ".anim";

        // アニメーションクリップを作成
        AssetDatabase.CreateAsset(animation, exportPath);
    }
}

このようなエディタが生成できます。

注目するのがExportFileメソッドです。CreateAssetを使用しています。
exportPathに引数として与えられた文字列（ファイル名）をパス・拡張子と結合した合成文字列を格納した後、CreateAssetに指定します。

    public static void ExportFile(string fileName)
    {
        // オブジェクトを作成
        var animation = new AnimationClip();
        if (animation == null) return;

        // ファイル名をファイルパスに変換
        string exportPath = "Assets/EditorExample/Resources/" + fileName + ".anim";

        // アニメーションクリップを作成
        AssetDatabase.CreateAsset(animation, exportPath);
    }

このとき、特定のファイル名を使って完成したファイルパスをCreateAssetに渡すとエラーが発生します。

ケース１：ファイル名に一部の記号が入っている場合

ファイル名に、/（スラッシュ）、\（バックスラッシュ）、?（クエスチョン）、*（アスタリスク）など、一部の文字を指定するとエラーが発生する。

ケース２：ファイル名行頭が空白文字(全半角空白)の場合

ファイル名の行頭に空白が入っている場合、エラーが発生する。

原因

使用してはいけない文字が使用されている

「ファイル名やパス名に使用してはいけない文字」というものが存在しています。その文字を使ってファイルを作成しようとすると、例外が発生してしまうのです。
例えば、ファイル名とパスについて、" < > | をファイル名とパス名に含めることはできない。
また、パスについては: ? * / \をパスに含めることができるが、ファイル名には使用できない。

今回のコードの場合、ファイル名の部分(.anim直前)を変更できるようにしているため、" < > | : ? * / \これらを含めるとエラーになってしまいます。

次の点を除き、拡張文字セット (128 ~ 255) の Unicode 文字と文字など、現在のコード ページの任意の文字を名前に使用します。

次の予約文字:

• < (より小さい)
• (より大きい)
• : (コロン)
• " (二重引用符)
• / (スラッシュ)
• \ (円記号)
• |(垂直バーまたはパイプ)
• ? (疑問符)
• * (アスタリスク)
• 整数値 0。ASCII NUL 文字と呼ばれることもあります。

• 整数表現が 1 ~ 31 の範囲にある文字 (これらの文字が許可されている代替データ ストリームを除く)。 ファイル ストリームの詳細については、「ファイルのストリーム」を参照してください。

• ターゲット ファイル システムで許可されていないその他の文字。

誤った空白の使い方がされている

空白をファイルパスに含めてしまうと、そこでパスが分割されてしまうため、例外が出力されたものと思われます。¹

ファイル名またはディレクトリ名をスペースまたはピリオドで終了することも禁止されています。
が、 今回のコードでは末尾に空白が入っていても作成できてしまいました。（末尾の空白は無視される？）

ファイル名またはディレクトリ名をスペースまたはピリオドで終了しないでください。 基になるファイル システムではこのような名前がサポートされる場合がありますが、Windows シェルとユーザー インターフェイスではサポートされません。 ただし、名前の最初の文字としてピリオドを指定することもできます。 たとえば、".temp" です。

解決方法

使用不可文字・空白のどちらが含まれていても、正規表現と、IsMatch関数またはReplace関数を用いて解決することができました。

• 使用不可文字・空白パターンを検知したらログを出力し、終了する
• 使用不可文字・空白パターンをnullに置き換えて除去する
  の２パターンを紹介します。

使用不可文字・空白パターンを検知したらログを出力し、終了する

ExportFileメソッドに追記します。

EditorExample

    public static void ExportFile(string fileName)
    {
        var animation = new AnimationClip();
        if (animation == null) return;
        
        /* 追記ここから */
        // 使えない文字(" < > | : ? * / \)を含んでいないかチェック
        if (System.Text.RegularExpressions.Regex.IsMatch(fileName,
                                @"(^[\s]+|[\s]+$)|(""|<|>|\||:|\?|\*|/|\\)"))
        {
            // 使えないファイル名がある
            Debug.Log("Failed to create asset.");
            return;
        }
        /* 追記ここまで */

        string exportPath = "Assets/EditorExample/Resources/" + fileName + ".anim";

        AssetDatabase.CreateAsset(animation, exportPath);
        Debug.Log("Created an Asset in "+ exportPath +" .");
    }

Regex.IsMatch関数は、正規表現と一致する対象が入力文字列内で見つかったかどうかをチェックしてくれるメソッドです。正規表現とマッチした場合trueを、それ以外の場合はfalseを返します。

        // 使えない文字(" < > | : ? * / \)を含んでいないかチェック
        if (System.Text.RegularExpressions.Regex.IsMatch(fileName,
                                @"(^[\s]+|[\s]+$)|(""|<|>|\||:|\?|\*|/|\\)"))
        {
            ...

ファイル名（filename）に、使えない文字(" < > | : ? * / )を含んでいないか、前後に空白が入っていないかをチェックしたいので、正規表現を組み立てると、

@"(""|<|>|\||:|\?|\*|/|\\)|(^[\s]+|[\s]+$)"

となります。
後半の[\s]は、文字列では空白(0x20)を意味しますが、正規表現においてはタブなどを含む空白文字全般にマッチするメタ文字列になるそうです。²。

• メタキャラクタを必ず「 \ 」でエスケープすること
• ダブルクォーテーションはエスケープできないため「""」と記述すること
  に注意してください。

（初めてしっかりと正規表現を分析したので苦労しました）
メソッドの修正により、使用不可文字・空白パターンがファイル名に含まれていた場合、失敗した旨をログに出力し処理を終了させることができました。

使用不可文字・空白パターンをnullに置き換えて除去する

ExportFileメソッドに追記します。

ExportFile

    public static void ExportFile(string fileName)
    {
        var animation = new AnimationClip();
        if (animation == null) return;
        
        fileName = System.Text.RegularExpressions.Regex.Replace(fileName
                               , @"(^[\s]+|[\s]+$)|(<|>|\||:|\?|\*|/|\\|"")"
                               , "");

        string exportPath = "Assets/EditorExample/Resources/" + fileName + ".anim";

        AssetDatabase.CreateAsset(animation, exportPath);
        Debug.Log("Created an Asset in "+ exportPath +" .");
    }

Regex.Replace関数は、指定した入力文字列内で正規表現パターンに一致する文字列を、指定した置換文字列に置き換えます。第一引数に文字列を、第二引数に正規表現パターンを、第三引数に置き換える文字列を指定します。

第二引数の正規表現は前述のIsMatch関数による検知に使用したものと同じです。（使用不可文字と、文字列前後の空白がマッチ対象となります。）
メソッドの修正により、使用不可文字・空白パターンをファイル名に含んでいても、対象文字を削除してファイルを作成することができました。

おわりに

初めて記事を書き上げることができました。誰かの役に立てばうれしいです。

某VRSNSでUnityやEditor拡張に初めて触れ、面倒な処理作業の自動化をできることの魅力にとりつかれました。独学ではありますが将来的になにか便利ツールとしてリリースできればいいなと考えながら学習をしています。これらのアウトプットが将来に役立つかは正直わからないのですが、継続してプログラムを書き続けて探求していき、なにか得るものがあればよいなと考えています。

参考記事

1. https://atmarkit.itmedia.co.jp/bbs/phpBB/viewtopic.php?topic=18081&forum=7 ↩

2. https://docs.ruby-lang.org/ja/latest/doc/spec=2fregexp.html#:~:text=%E3%80%8C%5Cs%E3%80%8D%E3%81%AF%E6%96%87%E5%AD%97%E5%88%97,%E3%81%99%E3%82%8B%E3%83%A1%E3%82%BF%E6%96%87%E5%AD%97%E5%88%97%E3%81%A7%E3%81%99%E3%80%82 ↩