xLua的配置

xLua所有的配置都支持三种方式：打标签；静态列表；动态列表。

打标签

xLua用白名单来指明生成哪些代码，而白名单通过attribute来配置，比如你想从lua调用c#的某个类，希望生成适配代码，你可以为这个类型打一个LuaCallCSharp标签：

  1.     [LuaCallCSharp]
  2.     public class A
  3.     {
  4.     }

该方式方便，但在il2cpp下会增加不少的代码量，不建议使用。

静态列表

有时我们无法直接给一个类型打标签，比如系统api，没源码的库，或者实例化的泛化类型，这时你可以在一个静态类里声明一个静态字段，该字段的类型除BlackList和AdditionalProperties之外只要实现了IEnumerable<Type>就可以了（这两个例外后面具体会说），然后为这字段加上标签：

  1.     [LuaCallCSharp]
  2.     public static List<Type> mymodule_lua_call_cs_list = new List<Type>()
  3.     {
  4.         typeof(GameObject),
  5.         typeof(Dictionary<string, int>),
  6.     };

这个字段需要放到一个静态类里头，建议放到Editor目录。

动态列表

声明一个静态属性，打上相应的标签即可。

  1.     [Hotfix]
  2.     public static List<Type> by_property
  3.     {
  4.         get
  5.         {
  6.             return (from type in Assembly.GetExecutingAssembly().GetTypes()
  7.                     where type.Namespace == "XXXX"
  8.                     select type).ToList();
  9.         }
  10.     }

Getter是代码，你可以实现很多效果，比如按名字空间配置，按程序集配置等等。

这个属性需要放到一个静态类里头，建议放到Editor目录。

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<T>: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<Type, List<string>>类型，Dictionary的Key是要生效的类型，Value是属性名列表。可以参考XLua对几个UnityEngine下值类型的配置，SysGCOptimize类。

XLua.BlackList

如果你不要生成一个类型的一些成员的适配代码，你可以通过这个配置来实现。

标签方式比较简单，对应的成员上加就可以了。

由于考虑到有可能需要把重载函数的其中一个重载列入黑名单，配置方式比较复杂，类型是List<List<string>>，对于每个成员，在第一层List有一个条目，第二层List是个string的列表，第一个string是类型的全路径名，第二个string是成员名，如果成员是一个方法，还需要从第三个string开始，把其参数的类型全路径全列出来。例如下面是对GameObject的一个属性以及FileInfo的一个方法列入黑名单：

  1.     [BlackList]
  2.     public static List<List<string>> BlackList = new List<List<string>>()  {
  3.         new List<string>(){"UnityEngine.GameObject", "networkView"},
  4.         new List<string>(){"System.IO.FileInfo", "GetAccessControl", "System.Security.AccessControl.AccessControlSections"},
  5.     };

下面是生成期配置，必须放到Editor目录下

CSObjectWrapEditor.GenPath

配置生成代码的放置路径，类型是string。默认放在“Assets/XLua/Gen/”下。

CSObjectWrapEditor.GenCodeMenu

该配置用于生成引擎的二次开发，一个无参数函数加了这个标签，在执行“XLua/Generate Code”菜单时会触发这个函数的调用。

ExampleGenConfig.cs

  1.     using System.Collections.Generic;
  2.     using System;
  3.     using UnityEngine;
  4.     using XLua;
  6.     //配置的详细介绍请看Doc下《XLua的配置.doc》
  7.     public static class ExampleGenConfig
  8.     {
  9.         //lua中要使用到C#库的配置，比如C#标准库，或者Unity API，第三方库等。
  10.         [LuaCallCSharp]
  11.         public static List<Type> LuaCallCSharp = new List<Type>() {
  12.                     typeof(System.Object),
  13.                     typeof(UnityEngine.Object),
  14.                     typeof(Vector2),
  15.                     typeof(Vector3),
  16.                     typeof(Vector4),
  17.                     typeof(Quaternion),
  18.                     typeof(Color),
  19.                     typeof(Ray),
  20.                     typeof(Bounds),
  21.                     typeof(Ray2D),
  22.                     typeof(Time),
  23.                     typeof(GameObject),
  24.                     typeof(Component),
  25.                     typeof(Behaviour),
  26.                     typeof(Transform),
  27.                     typeof(Resources),
  28.                     typeof(TextAsset),
  29.                     typeof(Keyframe),
  30.                     typeof(AnimationCurve),
  31.                     typeof(AnimationClip),
  32.                     typeof(MonoBehaviour),
  33.                     typeof(ParticleSystem),
  34.                     typeof(SkinnedMeshRenderer),
  35.                     typeof(Renderer),
  36.                     typeof(WWW),
  37.                     typeof(System.Collections.Generic.List<int>),
  38.                     typeof(Action<string>),
  39.                     typeof(UnityEngine.Debug)
  40.                 };
  42.         //C#静态调用Lua的配置（包括事件的原型），仅可以配delegate，interface
  43.         [CSharpCallLua]
  44.         public static List<Type> CSharpCallLua = new List<Type>() {
  45.                     typeof(Action),
  46.                     typeof(Func<double, double, double>),
  47.                     typeof(Action<string>),
  48.                     typeof(Action<double>),
  49.                     typeof(UnityEngine.Events.UnityAction),
  50.                     typeof(System.Collections.IEnumerator)
  51.                 };
  53.         //黑名单
  54.         [BlackList]
  55.         public static List<List<string>> BlackList = new List<List<string>>()  {
  56.                     new List<string>(){"UnityEngine.WWW", "movie"},
  57.         #if UNITY_WEBGL
  58.                     new List<string>(){"UnityEngine.WWW", "threadPriority"},
  59.         #endif
  60.                     new List<string>(){"UnityEngine.Texture2D", "alphaIsTransparency"},
  61.                     new List<string>(){"UnityEngine.Security", "GetChainOfTrustValue"},
  62.                     new List<string>(){"UnityEngine.CanvasRenderer", "onRequestRebuild"},
  63.                     new List<string>(){"UnityEngine.Light", "areaSize"},
  64.                     new List<string>(){"UnityEngine.AnimatorOverrideController", "PerformOverrideClipListCleanup"},
  65.         #if !UNITY_WEBPLAYER
  66.                     new List<string>(){"UnityEngine.Application", "ExternalEval"},
  67.         #endif
  68.                     new List<string>(){"UnityEngine.GameObject", "networkView"}, //4.6.2 not support
  69.                     new List<string>(){"UnityEngine.Component", "networkView"},  //4.6.2 not support
  70.                     new List<string>(){"System.IO.FileInfo", "GetAccessControl", "System.Security.AccessControl.AccessControlSections"},
  71.                     new List<string>(){"System.IO.FileInfo", "SetAccessControl", "System.Security.AccessControl.FileSecurity"},
  72.                     new List<string>(){"System.IO.DirectoryInfo", "GetAccessControl", "System.Security.AccessControl.AccessControlSections"},
  73.                     new List<string>(){"System.IO.DirectoryInfo", "SetAccessControl", "System.Security.AccessControl.DirectorySecurity"},
  74.                     new List<string>(){"System.IO.DirectoryInfo", "CreateSubdirectory", "System.String", "System.Security.AccessControl.DirectorySecurity"},
  75.                     new List<string>(){"System.IO.DirectoryInfo", "Create", "System.Security.AccessControl.DirectorySecurity"},
  76.                     new List<string>(){"UnityEngine.MonoBehaviour", "runInEditMode"},
  77.                 };
  78.     }

?