Unity Editor从模板创建脚本

我们使用 Visual Studio + Unity 开发游戏的时候 Unity为我们提供了MonoBehaviour 脚本的模板，在 Project 下的 Assets 面板下点击右键，在弹出的菜单中点 Create -> C# Script就可以创建MonoBehaviour 脚本。

但是创建出来的脚本文件不是 utf-8 格式的，导致我们写的注释经常乱码，而且代码也没有格式化，需要我们手动格式化，非常麻烦。所以我们可以编写 Editor 脚本来实现从我们自定义的模板中创建代码。除了有以上两点好处，还可以添加命名空间，或者你想自定义的任何内容，非常方便，可以大大减少一些重复而枯燥的工作。

首先创建模板脚本放在指定的目录下然后创脚本 CreateClass.cs 放在Editor 目录下。

CreateClass.cs 脚本内容如下:

//---------------------------------------------------------------------
// XRLGame
// Copyright © 2019-2022 XRLGame Co., Ltd. All rights reserved.
// Author: JerryYang
// Time: 2022-10-21 14:28:41
// Feedback: yang2686022430@163.com
//---------------------------------------------------------------------

using UnityEngine;
using UnityEditor;
using UnityEditor.ProjectWindowCallback;
using System.IO;
using System.Text;

namespace XRL
{
  /// <summary>
  /// 从模板创建文件，有如下好处：
  /// 1. 编码格式统一为UTF-8带签名
  /// 2. 代码统一格式化
  /// 3. 添加命名空间
  /// </summary>
  public class CreateClass : MonoBehaviour
  {
    [MenuItem("Assets/CreateClass/MonoBehaviour")]
    public static void CreateMonoBehaviour()
    {
      string templatePath = "Assets/XRLGame/Editor/Templates/csharp/MonoBehaviour.txt";
      Create(templatePath);
    }

    [MenuItem("Assets/CreateClass/XRLMonoBehaviour")]
    public static void CreateXRLMonoBehaviour()
    {
      string templatePath = "Assets/XRLGame/Editor/Templates/csharp/XRLMonoBehaviour.txt";
      Create(templatePath);
    }

    private static void Create(string path) 
    {
      if (IsSelectedFolder())
      {
        string folderPath = AssetDatabase.GUIDToAssetPath(Selection.assetGUIDs[0]);

        // 创建代码文件的过程中，在重命名时调用该方法
        Texture2D icon = EditorGUIUtility.IconContent("d_cs Script Icon").image as Texture2D;
        ProjectWindowUtil.StartNameEditingIfProjectWindowExists(0,
          ScriptableObject.CreateInstance<CreateScriptAsset>(),
          folderPath + "/CreateScript.cs",
          icon,
          path);
      }
    }

    private static bool IsSelectedFolder()
    {
      return Path.GetExtension(AssetDatabase.GUIDToAssetPath(Selection.assetGUIDs[0])) == string.Empty;
    }
  }

  public class CreateScriptAsset : EndNameEditAction
  {
    // 重命名新创建的Script时，调用它
    public override void Action(int instanceId, string pathName, string resourceFile)
    {
      // 基于模板文件生成具体文件时，需替换文件中的部分内容：如类名替换为文件名
      UnityEngine.Object obj = CreateTemplateScriptAsset(pathName, resourceFile);
      ProjectWindowUtil.ShowCreatedAsset(obj);
    }

    private static UnityEngine.Object CreateTemplateScriptAsset(string newScriptPath, string templatePath)
    {
      // 读入模板内容
      StreamReader sr = new StreamReader(templatePath);
      string content = sr.ReadToEnd();
      sr.Close();

      // 修改内容中的部分内容
      content = content.Replace("#ScriptName#", Path.GetFileNameWithoutExtension(newScriptPath));
      content = content.Replace("#Author#", "JerryYang");
      content = content.Replace("#CreateTime#", System.DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss"));
      content = content.Replace("#Copyright#", "Copyright © 2019-2022 XRLGame Co., Ltd. All rights reserved.");
      content = content.Replace("#Feedback#", "yang2686022430@163.com.");

      // 将修改后的内容写入新创建的文件
      StreamWriter sw = new StreamWriter(Path.GetFullPath(newScriptPath), false, new UTF8Encoding(true, false));
      sw.Write(content);
      sw.Close();

      // 导入资源
      AssetDatabase.ImportAsset(newScriptPath);
      return AssetDatabase.LoadAssetAtPath(newScriptPath, typeof(UnityEngine.Object));
    }
  }
}