【Unity编辑器】Unity基于模板生成代码的原理与应用

unity中我们可以在Project面板右键或通过Assets菜单创建脚本或是shader，unity为我们提供了C#，javascript脚本以及四个shader代码的模板，当创建这些脚本时实际上是复制这些模板并改变其类名或是shader名，我们可以在Unity的安装目录下找到这些代码模板文件：D:\Program Files\Unity\Editor\Data\Resources\ScriptTemplates。

通过反编译UnityEditor.dll，可以在ProjectWindowUtil这个类中找到如下私有方法：

注意它先判断了模板文件是否包含test字符串，这一步是创建Editor Test C# script用的，因为这个脚本只能创建在Editor文件夹内，之后通过创建的代码类型获取图标，最后是ProjectWindowUtil.StartNameEditingIfProjectWindowExists。

继续跟踪，先看ScriptableObject.CreateInstance<DoCreateScriptAsset>()。

用反编译工具查看DoCreateScriptAsset这个类，

这是继承自EndNameEditAction的类，在ScriptableObject.CreateInstance创建实例后作为ProjectWindowUtil.StartNameEditingIfProjectWindowExists的结束命名的回调，

ProjectWindowUtil.StartNameEditingIfProjectWindowExists是一个公有方法，其作用是将设置焦点到某文件并进入重命名，因为我们知道当我们右键创建代码的时候除了会选中该代码文件，同时还是处于重命名代码的状态的，此时代码尚未编译，当我们结束重命名后才真正进入到DoCreateScriptAsset的Action方法，而这个方法中最重要的内容就是ProjectWindowUtil.CreateScriptAssetFromTemplete方法，继续进入该方法，看到这是一个内部方法：

至此基本就是Unity创建模板代码的核心内容了，其实就是通过将关键字替换的方法实现的。

知道这些内容后，我们就可以自己写一些代码模板，用反射的方式来让Unity帮我们处理这些模板并创建代码，或是直接照着unity的方式自己写一套模板创建的方式，如Lua模板，Shader模板，xml模板等。

可以将模板代码放到任何位置，或者放到unity自己放置模板的位置，unity代码模板路径的访问方式：

EditorApplication.applicationContentsPath+"/Resources/ScriptTemplates"

using UnityEditor;
using System.Reflection;

public class ProjectWindowUtilEx
{
    public static void CreateScriptUtil(string path, string templete)
    {
        MethodInfo method = typeof (ProjectWindowUtil).GetMethod("CreateScriptAsset",
            BindingFlags.Static | BindingFlags.NonPublic);
        if (method != null)
            method.Invoke(null, new object[] {templete, path});
    }
}

以Lua模板为例：

[MenuItem("Assets/Create/Lua/MyLua.lua")]
static void CreateMyLua()
{
   ProjectWindowUtilEx.CreateScriptUtil(@"Templates\Lua\MyLua.lua.txt", "New MyLua.lua");
}

【Unity编辑器】Unity基于模板生成代码的原理与应用

猜你喜欢