xLua的配置分析

xLua用白名單來指明生成哪些代碼，而白名單通過attribute來配置，比如你想從lua調用c#的某個類，希望生成適配代碼，你可以為這個類型打一個LuaCallCSharp標簽：

[LuaCallCSharp]??

public?class?A??

{??

} ?

有時我們無法直接給一個類型打標簽，比如系統api，沒源碼的庫，或者實例化的泛化類型，這時你可以在一個靜態類里聲明一個靜態field或者靜態property，該字段的類型除BlackList和AdditionalProperties之外只要實現了IEnumerable就可以了（這兩個例外后面具體會說），然后為這字段加上標簽：

[LuaCallCSharp] ?

public?static?Listmymodule_lua_call_cs_list?=?new?List()??

{??

typeof(GameObject),??

typeof(Dictionary),??

}; ?

XLua.LuaCallCSharp

一個C#類型加了這個配置，xLua會生成這個類型的適配代碼（包括構造該類型實例，訪問其成員屬性、方法，靜態屬性、方法），否則將會嘗試用性能較低的反射方式來訪問。

一個類型的擴展方法（Extension Methods）加了這配置，也會生成適配代碼并追加到被擴展類型的成員方法上。

xLua只會生成加了該配置的類型，不會自動生成其父類的適配代碼，當訪問子類對象的父類方法，如果該父類加了LuaCallCSharp配置，則執行父類的適配代碼，否則會嘗試用反射來訪問。

反射訪問除了性能不佳之外，在il2cpp下還有可能因為代碼剪裁而導致無法訪問，后者可以通過下面介紹的ReflectionUse標簽來避免。

XLua.ReflectionUse

一個C#類型類型加了這個配置，xLua會生成link.xml阻止il2cpp的代碼剪裁。

對于擴展方法，必須加上LuaCallCSharp或者ReflectionUse才可以被訪問到。

建議所有要在Lua訪問的類型，要么加LuaCallCSharp，要么加上ReflectionUse，這才能夠保證在各平臺都能正常運行。

XLua.CSharpCallLua

如果希望把一個lua函數適配到一個C#delegate（一類是C#側各種回調：UI事件，delegate參數，比如List:ForEach；另外一類場景是通過LuaTable的Get函數指明一個lua函數綁定到一個delegate）?；蛘甙岩粋€lua table適配到一個C# interface，該delegate或者interface需要加上該配置。

XLua.GCOptimize

一個C#純值類型（注：指的是一個只包含值類型的struct，可以嵌套其它只包含值類型的struct）或者C#枚舉值加上了這個配置。xLua會為該類型生成gc優化代碼，效果是該值類型在lua和c#間傳遞不產生（C#）gc alloc，該類型的數組訪問也不產生gc。各種無GC的場景，可以參考05_NoGc例子。

除枚舉之外，包含無參構造函數的復雜類型，都會生成lua table到該類型，以及改類型的一維數組的轉換代碼，這將會優化這個轉換的性能，包括更少的gc alloc。

XLua.AdditionalProperties

這個是GCOptimize的擴展配置，有的時候，一些struct喜歡把field做成是私有的，通過property來訪問field，這時就需要用到該配置（默認情況下GCOptimize只對public的field打解包）。

標簽方式比較簡單，配置方式復雜一點，要求是Dictionary>類型，Dictionary的Key是要生效的類型，Value是屬性名列表?？梢詤⒖糥Lua對幾個UnityEngine下值類型的配置，SysGCOptimize類。

XLua.BlackList

如果你不要生成一個類型的一些成員的適配代碼，你可以通過這個配置來實現。

標簽方式比較簡單，對應的成員上加就可以了。

由于考慮到有可能需要把重載函數的其中一個重載列入黑名單，配置方式比較復雜，類型是List

例如下面是對GameObject的一個屬性以及FileInfo的一個方法列入黑名單：

[BlackList] ?

public?static?List>?BlackList?=?new?List>()??{??

new?List(){"UnityEngine.GameObject",?"networkView"},??

new?List(){"System.IO.FileInfo",?"GetAccessControl",?"System.Security.AccessControl.AccessControlSections"},??

}; ?

下面是生成期配置，必須放到Editor目錄下 CSObjectWrapEditor.GenPath

配置生成代碼的放置路徑，類型是string。默認放在“Assets/XLua/Gen/”下。

CSObjectWrapEditor.GenCodeMenu

該配置用于生成引擎的二次開發，一個無參數函數加了這個標簽，在執行“XLua/Generate Code”菜單時會觸發這個函數的調用。