寫在前面

經過一段時間的改進, 後來用 QuickJS 代替了 duktape 另外實作了一個 unity-jsb, 此項目修正了若幹 unity-duktape 實作上的問題和BUG, 且運作效率更高.

本文介紹的插件 duktape-unity 可以使你在 Unity3D 中使用 javascript/typescript 來寫腳本. 這裡說的腳本是指可以在包括iOS上動态執行的腳本. 目前主流的選擇是 lua 和 ILRuntime(C#), 都是很成熟的方案. typescript 或許可以是介于兩者之間的一種選擇, 即有動态腳本語言的特性, 又有強類型的輔助.

概況

duktape-unity 的使用方法與 slua/ulua 等是類似的, 通過生成綁定代碼并對部分值類型進行特定優化來提高互動效率. 并針對 js 的使用習慣, 做了一些 js 風格的封裝, 例如事件/委托的封裝, 有兩種方式在 js 中将 js 函數注冊到 C# 事件/委托上 (這裡均以 ts 為例):

// 方法一, 直接注冊 js 函數
UnityEngine.Application.lowMemory.on(() => {
    console.log("low memory");
});

// 方法二, 構造一個 Delegate 對象進行注冊, 這種方式 Delegate 對象本身就是一個 Dispatcher, 可以自己再 on/off 多個響應者
let delegate = new DuktapeJS.Delegate0();
delegate.on(this, () => {
    console.log("low memory")
});
delegate.on(this, () => {
    // ...
});
UnityEngine.Application.lowMemory.on(delegate);

而且, 得益于自動生成的 d.ts 聲明的幫助, 寫腳本時是有類型驗證的.

內建

Assets/Duktape 是插件主要代碼, 直接放到工程目錄（可以是子目錄）中即可. Assets/DuktapeExtra 是插件輔助代碼, 可選, 目前主要作用是将 js stacktrack 轉換到 typescript stacktrack, 在調試過程中有較大幫助.

接着, 在項目根目錄編輯生成綁定代碼的配置檔案 ./duktape.json：

{
    "outDir": "Assets/Generated",  // 生成csharp綁定代碼的目錄
    "typescriptDir": "Assets/Generated",  // 生成 d.ts 聲明的目錄
    // rootpath of ts/js project
    "workspace": "",
    "logPath": "Temp/duktape.log", // 生成csharp綁定代碼過程中産生的日志檔案
    // auto, cr, lf, crlf
    "newLineStyle": "auto", // 生成代碼的換行符
    // 隐式生成 （在下列子產品中定義的類型中未明确禁止生成的類都将生成綁定）
    "implicitAssemblies": [
        "UnityEngine",
        "UnityEngine.CoreModule", 
        "UnityEngine.UI", 
        "UnityEngine.UIModule", 
        "UnityEngine.TextRenderingModule",
        "UnityEngine.AnimationModule"
    ], 
    // 顯式生成 （在下列子產品中定義的類型必須明确指定需要生成綁定的類型）
    "explicitAssemblies": [
        "Assembly-CSharp"
    ],
    // 禁止生成綁定的類型全名字首
    "typePrefixBlacklist": [
        "JetBrains.",
        "Unity.Collections.",
        "Unity.Jobs.",
        "Unity.Profiling.",
        "UnityEditor.",
        "UnityEditorInternal.",
        "UnityEngineInternal.",
        "UnityEditor.Experimental.",
        "UnityEngine.Experimental.",
        "Unity.IO.LowLevel.",
        "Unity.Burst.",
        // more types ...
        "UnityEngine.Assertions."
    ], 
    // 生成綁定代碼所在的命名空間
    "ns": "DuktapeJS",
    // 生成的綁定代碼中使用的縮進符
    "tab": "    "
}

然後執行菜單 Duktape/Generate Bindings 生成綁定代碼.