Unity命名规范检查器

为美术团队在 Unity 中创建一个自动化的命名规范检查器是一个非常棒的主意，这能极大地提升工作流的规范性和效率。

我们将使用 Unity 的 **AssetPostprocessor** API 来实现这个功能。这是一个特殊的编辑器脚本，它可以在资源被导入或重新导入时自动执行代码。

以下是实现这个检查器的详细步骤和代码。

核心概念
#

**AssetPostprocessor**: 这是一个 Unity 编辑器类。任何继承自它的脚本都可以“监听”资源的导入过程。它提供了多种方法，如 OnPreprocessTexture (在纹理导入前), OnPreprocessModel (在模型导入前) 等，以及一个通用的 OnPostprocessAllAssets (在所有资源导入后)。
正则表达式 (Regex): 这是匹配字符串模式的强大工具。我们将用它来定义你的命名规则，并检查文件名是否符合这些规则。
编辑器脚本 (Editor Script): 这个检查器脚本必须放在项目中的任何一个名为 Editor 的文件夹下。例如：Assets/Editor/。只有这样，Unity 才会把它当作编辑器脚本来执行。

步骤一：创建基础检查器脚本
#

首先，我们来创建一个简单的脚本，先针对你提供的 模型 (FBX) 和 贴图 (PNG) 命名规范进行检查。

在你的 Unity 项目中，找到 Assets 文件夹。
在 Assets 内创建一个新文件夹，命名为 Editor (如果已存在则无需创建)。
在 Editor 文件夹内，创建一个新的 C# 脚本，命名为 AssetNamingChecker.cs。
双击打开该脚本，并用下面的代码替换其内容：

// 放置在 Assets/Editor/ 文件夹下
using UnityEngine;
using UnityEditor;
using System.IO;
using System.Text.RegularExpressions;

public class AssetNamingChecker : AssetPostprocessor
{
    // 定义模型命名的正则表达式规则
    // 示例: SM_Wall_01_Var01, SM_Floor_Buff00_Var01, SM_Prop_Bookshelf_Var01_LOD0
    private const string ModelNamePattern = @"^SM_(Wall|Floor|Prop)_.+";

    // 定义贴图命名的正则表达式规则
    // 示例: T_SM_Wall_01_Var01_diffuse.png, T_SM_Prop_Bookshelf_Var01_LOD0_roughness.png
    private const string TextureNamePattern = @"^T_SM_.+_(diffuse|normal|roughness)";

    // 定义材质命名的正则表达式规则
    // 示例: M_SM_Wall_01_Var01.mat
    private const string MaterialNamePattern = @"^M_SM_.+";

    // 当任何资源被导入、删除、移动后都会调用此方法
    // 我们用这个通用方法来检查所有关心的资源类型
    static void OnPostprocessAllAssets(string[] importedAssets, string[] deletedAssets, string[] movedAssets, string[] movedFromAssetPaths)
    {
        foreach (string path in importedAssets)
        {
            CheckAssetName(path);
        }

        // 如果需要，也可以对移动的资源进行检查
        // foreach (string path in movedAssets)
        // {
        //     CheckAssetName(path);
        // }
    }

    private static void CheckAssetName(string path)
    {
        // 获取不带扩展名的文件名
        string filename = Path.GetFileNameWithoutExtension(path);
        // 获取文件扩展名
        string extension = Path.GetExtension(path).ToLower();

        bool isNameValid = true;
        string expectedPattern = "N/A";

        // 根据文件类型选择不同的规则进行检查
        switch (extension)
        {
            // 模型文件
            case ".fbx":
                isNameValid = Regex.IsMatch(filename, ModelNamePattern);
                expectedPattern = "SM_[Type]_[Detail]...";
                break;

            // 贴图文件
            case ".png":
            case ".exr": // 根据你的文档，贴图也可能是 .exr
                // UI贴图和模型贴图规则不同，需要区分
                if (path.Contains("/Art/UI/")) // 假设UI资源在特定路径
                {
                    // 在这里添加UI资源的命名检查逻辑
                    // 比如: isNameValid = Regex.IsMatch(filename, UINamePattern);
                }
                else
                {
                    isNameValid = Regex.IsMatch(filename, TextureNamePattern);
                    expectedPattern = "T_SM_[ModelName]_[Channel]";
                }
                break;

            // 材质文件
            case ".mat":
                isNameValid = Regex.IsMatch(filename, MaterialNamePattern);
                expectedPattern = "M_SM_[ModelName]";
                break;

            // 如果有其他需要检查的类型，在这里添加 case
            // case ".prefab":
            //     // ...
            //     break;
        }

        // 如果命名不规范，就在Console中打印一条警告信息
        if (!isNameValid)
        {
            // 使用 Debug.LogWarning 而不是 Error，这样不会中断导入流程
            Debug.LogWarning($"<b>[命名规范检查]</b>: 资源命名不规范!\n" +
                             $"路径: {path}\n" +
                             $"请遵循命名约定: <b>{expectedPattern}</b>");
        }
    }
}

代码解释：
#

我们使用 OnPostprocessAllAssets 方法，因为它能捕获所有导入的资源。
我们遍历 importedAssets 数组，这是所有新导入或修改的资源的路径列表。
Path.GetFileNameWithoutExtension(path) 用来获取文件名，Path.GetExtension(path) 用来获取文件类型（如 .fbx）。
Regex.IsMatch(filename, Pattern) 是核心检查部分，它用我们定义的正则表达式 Pattern 去匹配 filename。
如果匹配失败 (!isNameValid)，Debug.LogWarning 会在 Unity 的 Console 窗口打印一条黄色的警告信息，清晰地告诉美术同学哪个文件错了，以及正确的格式应该是什么样的。

步骤二：扩展检查器以支持UI资源
#

现在，我们把上一份你确认的《UI资源工作流标准》中的命名规则也加进去。

我们将修改上面的脚本，使其更加完善和灵活。

// 放置在 Assets/Editor/ 文件夹下
using UnityEngine;
using UnityEditor;
using System.IO;
using System.Text.RegularExpressions;

public class AssetNamingChecker : AssetPostprocessor
{
    // === 模型资源规则 ===
    private const string ModelNamePattern = @"^SM_(Wall|Floor|Prop)_.+";
    private const string ModelTextureNamePattern = @"^T_SM_.+_(diffuse|normal|roughness)";
    private const string ModelMaterialNamePattern = @"^M_SM_.+";

    // === UI 资源规则 ===
    // 示例: UI_MainMenu_Btn_Start_Normal
    private const string UISpriteNamePattern = @"^UI_([A-Za-z0-9]+)_(Icon|Btn|Panel|Bg|Img|Bar)_.+";
    // 示例: Wall_01_Var01.prefab, Prop_Bookshelf_Var01_LOD0.prefab
    private const string PrefabNamePattern = @"^(Wall|Floor|Prop|Common|MainMenu|Shop|HUD)_.+";


    static void OnPostprocessAllAssets(string[] importedAssets, string[] deletedAssets, string[] movedAssets, string[] movedFromAssetPaths)
    {
        foreach (string path in importedAssets)
        {
            CheckAssetName(path);
        }
    }

    private static void CheckAssetName(string path)
    {
        // 忽略对文件夹和Unity内置资源的检查
        if (Directory.Exists(path) || path.StartsWith("Packages/"))
        {
            return;
        }

        string filename = Path.GetFileNameWithoutExtension(path);
        string extension = Path.GetExtension(path).ToLower();

        bool isNameValid = true;
        string expectedPattern = "N/A";
        bool shouldCheck = true;

        switch (extension)
        {
            case ".fbx":
                isNameValid = Regex.IsMatch(filename, ModelNamePattern);
                expectedPattern = "SM_[Type]_[Detail]...";
                break;

            case ".png":
            case ".jpg":
            case ".tga":
            case ".exr":
                // 根据路径区分是模型贴图还是UI贴图
                if (path.Contains("/Art/UI/"))
                {
                    isNameValid = Regex.IsMatch(filename, UISpriteNamePattern);
                    expectedPattern = "UI_[Module]_[Type]_[Description]_[State]";
                }
                else
                {
                    isNameValid = Regex.IsMatch(filename, ModelTextureNamePattern);
                    expectedPattern = "T_SM_[ModelName]_[Channel]";
                }
                break;

            case ".mat":
                isNameValid = Regex.IsMatch(filename, ModelMaterialNamePattern);
                expectedPattern = "M_SM_[ModelName]";
                break;

            case ".prefab":
                isNameValid = Regex.IsMatch(filename, PrefabNamePattern);
                expectedPattern = "[Module]_[Type]_[Description]";
                break;
            
            default:
                // 对于不关心的文件类型，不进行检查
                shouldCheck = false;
                break;
        }

        if (shouldCheck && !isNameValid)
        {
            Debug.LogWarning($"<b>[命名规范检查]</b>: 资源命名不规范!\n" +
                             $"<color=grey>路径: {path}</color>\n" +
                             $"<color=red>当前命名: {Path.GetFileName(path)}</color>\n" +
                             $"<color=green>期望格式: {expectedPattern}</color>");
        }
    }
}

如何使用
#

将上面最终版本的代码粘贴到你的 Assets/Editor/AssetNamingChecker.cs 脚本中。
保存脚本，返回 Unity，等待它编译完成。
现在，检查器已经开始工作了！
测试一下：
- 尝试拖入一个名为 MyModel.fbx 的文件到项目中。
- 或者拖入一个名为 background.png 的图片到 Art/UI/Sprites 文件夹下。
- 你会立刻在 Console 窗口看到黄色的警告信息，精确地指出哪个文件命名错误以及期望的格式。