用好lua+unity，让性能飞起来——lua与c#交互篇

前言

在看了uwa以前发布的《Unity项目常见Lua解决方案性能比较》，决定动手写一篇关于lua+unity方案的性能优化文。

整合lua是目前最强大的unity热更新方案，毕竟这是惟一能够支持ios热更新的办法。然而做为一个重度ulua用户，咱们踩过了不少的坑才将ulua上升到一个能够在项目中大规模使用的状态。事实上即便到如今lua+unity的方案仍不能轻易的说能够肆意使用，要用好，你须要知道不少。

所以，这篇文章是从一堆简单的优化建议里头，逐步挖掘出背后的缘由。只有理解了缘由，才能很清楚本身作的优化，究竟是为了什么，有多大的效果。

 

从最先的lua纯反射调用c#，以及云风团队尝试的纯c#实现的lua虚拟机，一直发展到如今的各类luajit+c#静态lua导出方案，lua+unity才算达到了性能上实用的级别。

但即便这样，实际使用中咱们会发现，比起cocos2dx时代luajit的发扬光大，如今lua+unity的性能依然存在着至关的瓶颈。仅从《性能比较》的test1就能够看到，iphone4s下二十万次position赋值就已经须要3000ms，若是是coc这样类型的游戏，不处理其余逻辑，一帧仅仅上千次位置赋值（好比数百的单位、特效和血条）就须要15ms，这显然有些偏高。

是什么致使lua+unity的性能并未达到极致，要如何才能更好的使用？咱们会一些例子开始，逐步挖掘背后的细节。

 

因为咱们项目主要使用的是ulua（集成了topameng的cstolua，可是因为持续的性能改进，后面已经作过大量的修改），本文的大部分结论都是基于ulua+cstolua的测试得出来的，slua都是基于其源码来分析（根据咱们分析的状况来看，二者原理上基本一致，仅在实现细节上有一些区别），但没有作过深刻测试，若有问题的话欢迎交流。

 

 

既然是lua+unity，那性能好很差，基本上要看两大点：

lua跟c#交互时的性能如何

纯lua代码自己的性能如何

由于这两部分都各有本身须要深刻探讨的地方，因此咱们会分为多篇去探讨整个lua+unity到底如何进行优化。

 

 

lua与c#交互篇

 

1.从致命的gameobj.transform.position = pos开始提及

像gameobj.transform.position = pos这样的写法，在unity中是再常见不过的事情

可是在ulua中，大量使用这种写法是很是糟糕的。为何呢？

 

由于短短一行代码，却发生了很是很是多的事情，为了更直观一点，咱们把这行代码调用过的关键luaapi以及ulua相关的关键步骤列出来（以ulua+cstolua导出为准，gameobj是GameObject类型，pos是Vector3）：

第一步：

GameObjectWrap.get_transform    lua想从gameobj拿到transform，对应gameobj.transform

  LuaDLL.luanet_rawnetobj            把lua中的gameobj变成c#能够辨认的id

  ObjectTranslator.TryGetValue      用这个id，从ObjectTranslator中获取c#的gameobject对象

  gameobject.transform                 准备这么多，这里终于真正执行c#获取gameobject.transform了

   ObjectTranslator.AddObject         给transform分配一个id，这个id会在lua中用来表明这个transform，transform要保存到ObjectTranslator供将来查找

  LuaDLL.luanet_newudata            在lua分配一个userdata，把id存进去，用来表示即将返回给lua的transform

  LuaDLL.lua_setmetatable            给这个userdata附上metatable，让你能够transform.position这样使用它

  LuaDLL.lua_pushvalue                返回transform，后面作些收尾

  LuaDLL.lua_rawseti

  LuaDLL.lua_remove

第二步：

TransformWrap.set_position                     lua想把pos设置到transform.position

   LuaDLL.luanet_rawnetobj                       把lua中的transform变成c#能够辨认的id

  ObjectTranslator.TryGetValue                 用这个id，从ObjectTranslator中获取c#的transform对象

  LuaDLL.tolua_getfloat3                          从lua中拿到Vector3的3个float值返回给c#

     lua_getfield + lua_tonumber 3次         拿xyz的值，退栈

     lua_pop

  transform.position = new Vector3(x,y,z) 准备了这么多，终于执行transform.position = pos赋值了

就这么一行代码，居然作了这么一大堆的事情！若是是c++，a.b.c = x这样通过优化后无非就是拿地址而后内存赋值的事。可是在这里，频繁的取值、入栈、c#到lua的类型转换，每一步都是满满的cpu时间，还不考虑中间产生了各类内存分配和后面的GC！

下面咱们会逐步说明，其中有一些东西实际上是没必要要的，能够省略的。咱们能够最终把他优化成：

lua_isnumber + lua_tonumber 4次，所有完成

 

2.在lua中引用c#的object，代价昂贵

从上面的例子能够看到，仅仅想从gameobj拿到一个transform，就已经有很昂贵的代价

c#的object，不能做为指针直接供c操做（其实能够经过GCHandle进行pinning来作到，不过性能如何未测试，并且被pinning的对象没法用gc管理），所以主流的lua+unity都是用一个id表示c#的对象，在c#中经过dictionary来对应id和object。同时由于有了这个dictionary的引用，也保证了c#的object在lua有引用的状况下不会被垃圾回收掉。

所以，每次参数中带有object，要从lua中的id表示转换回c#的object，就要作一次dictionary查找；每次调用一个object的成员方法，也要先找到这个object，也就要作dictionary查找。

若是以前这个对象在lua中有用过并且没被gc，那还就是查下dictionary的事情。但若是发现是一个新的在lua中没用过的对象，那就是上面例子中那一大串的准备工做了。

若是你返回的对象只是临时在lua中用一下，状况更糟糕！刚分配的userdata和dictionary索引可能会由于lua的引用被gc而删除掉，而后下次你用到这个对象又得再次作各类准备工做，致使反复的分配和gc，性能不好。

例子中的gameobj.transform就是一个巨大的陷阱，由于.transform只是临时返回一下，可是你后面根本没引用，又会很快被lua释放掉，致使你后面每次.transform一次，均可能意味着一次分配和gc。

 

 

3.在lua和c#间传递unity独有的值类型（Vector3/Quaternion等）更加昂贵

既然前面说了lua调用c#对象缓慢，若是每次vector3.x都要通过c#，那性能基本上就处于崩溃了，因此主流的方案都将Vector3等类型实现为纯lua代码，Vector3就是一个{x,y,z}的table，这样在lua中使用就快了。

可是这样作以后，c#和lua中对Vector3的表示就彻底是两个东西了，因此传参就涉及到lua类型和c#类型的转换，例如c#将Vector3传给lua，整个流程以下：

1.c#中拿到Vector3的x,y,z三个值

2.push这3个float给lua栈

3.而后构造一个表，将表的x,y,z赋值

4.将这个表push到返回值里

一个简单的传参就要完成3次push参数、表内存分配、3次表插入，性能可想而知。

那么如何优化呢？咱们的测试代表，直接在函数中传递三个float，要比传递Vector3要更快。

例如void SetPos(GameObject obj, Vector3 pos)改成void SetPos(GameObject obj, float x, float y, float z)

具体效果能够看后面的测试数据，提高十分明显。

 

 

 

4.lua和c#之间传参、返回时，尽量不要传递如下类型：

严重类： Vector3/Quaternion等unity值类型，数组

次严重类：bool string 各类object

建议传递：int float double

虽然是lua和c#的传参，可是从传参这个角度讲，lua和c#中间其实还夹着一层c（毕竟lua自己也是c实现的），lua、c、c#因为在不少数据类型的表示以及内存分配策略都不一样，所以这些数据在三者间传递，每每须要进行转换（术语parameter mashalling），这个转换消耗根据不一样的类型会有很大的不一样。

先说次严重类中的bool string类型，涉及到c和c#的交互性能消耗，根据微软官方文档，在数据类型的处理上，c#定义了Blittable Types和Non-Blittable Types，其中bool和string属于Non-Blittable Types，意思是他们在c和c#中的内存表示不同，意味着从c传递到c#时须要进行类型转换，下降性能，而string还要考虑内存分配（将string的内存复制到托管堆，以及utf8和utf16互转）。

能够参考 https://msdn.microsoft.com/zh-cn/library/ms998551.aspx，这里有更详细的关于c和c#交互的性能优化指引。

而严重类，基本上是ulua等方案在尝试lua对象与c#对象对应时的瓶颈所致。

Vector3等值类型的消耗，前面已经有所说起。

而数组则更甚，由于lua中的数组只能以table表示，这和c#下彻底是两码事，没有直接的对应关系，所以从c#的数组转换为lua table只能逐个复制，若是涉及object/string等，更是要逐个转换。

 

 

 

5.频繁调用的函数，参数的数量要控制

不管是lua的pushint/checkint，仍是c到c#的参数传递，参数转换都是最主要的消耗，并且是逐个参数进行的，所以，lua调用c#的性能，除了跟参数类型相关外，也跟参数个数有很大关系。通常而言，频繁调用的函数不要超过4个参数，而动辄十几个参数的函数若是频繁调用，你会看到很明显的性能降低，手机上可能一帧调用数百次就能够看到10ms级别的时间。

 

 

6.优先使用static函数导出，减小使用成员方法导出

前面提到，一个object要访问成员方法或者成员变量，都须要查找lua userdata和c#对象的引用，或者查找metatable，耗时甚多。直接导出static函数，能够减小这样的消耗。

像obj.transform.position = pos。

咱们建议的方法是，写成静态导出函数，相似

class LuaUtil{

  static void SetPos(GameObject obj, float x, float y, float z){obj.transform.position = new Vector3(x, y, z); }

}

而后在lua中LuaUtil.SetPos(obj, pos.x, pos.y, pos.z)，这样的性能会好很是多，由于省掉了transform的频繁返回，并且还避免了transform常常临时返回引发lua的gc。

 

 

7.注意lua拿着c#对象的引用时会形成c#对象没法释放，这是内存泄漏常见的原由

前面说到，c# object返回给lua，是经过dictionary将lua的userdata和c# object关联起来，只要lua中的userdata没回收，c# object也就会被这个dictionary拿着引用，致使没法回收。

最多见的就是gameobject和component，若是lua里头引用了他们，即便你进行了Destroy，也会发现他们还残留在mono堆里。

不过，由于这个dictionary是lua跟c#的惟一关联，因此要发现这个问题也并不难，遍历一下这个dictionary就很容易发现。ulua下这个dictionary在ObjectTranslator类、slua则在ObjectCache类

 

 

8.考虑在lua中只使用本身管理的id，而不直接引用c#的object

想避免lua引用c# object带来的各类性能问题的其中一个方法就是本身分配id去索引object，同时相关c#导出函数再也不传递object作参数，而是传递int。

这带来几个好处：

  1.函数调用的性能更好；

  2.明确地管理这些object的生命周期，避免让ulua自动管理这些对象的引用，若是在lua中错误地引用了这些对象会致使对象没法释放，从而内存泄露

  3.c#object返回到lua中，若是lua没有引用，又会很容易立刻gc，而且删除ObjectTranslator对object的引用。自行管理这个引用关系，就不会频繁发生这样的gc行为和分配行为。

例如，上面的LuaUtil.SetPos(GameObject obj, float x, float y, float z)能够进一步优化为LuaUtil.SetPos(int objID, float x, float y, float z)。而后咱们在本身的代码里头记录objID跟GameObject的对应关系，若是能够，用数组来记录而不是dictionary，则会有更快的查找效率。如此下来能够进一步省掉lua调用c#的时间，而且对象的管理也会更高效。

 

 

9.合理利用out关键字返回复杂的返回值

在c#向lua返回各类类型的东西跟传参相似，也是有各类消耗的。

好比

Vector3 GetPos(GameObject obj)

能够写成

void GetPos(GameObject obj, out float x, out float y, out float z)

表面上参数个数增多了，可是根据生成出来的导出代码（咱们以ulua为准），会从：

LuaDLL.tolua_getfloat3（内含get_field + tonumber 3次）

变成

isnumber + tonumber 3次

get_field本质上是表查找，确定比isnumber访问栈更慢，所以这样作会有更好的性能。

 

 

实测

好了，说了这么多，不拿点数据来看仍是太晦涩

为了更真实地看到纯语言自己的消耗，咱们直接没有使用例子中的gameobj.transform.position，由于这里头有一部分时间是浪费在unity内部的。

咱们重写了一个简化版的GameObject2和Transform2。

class Transform2{

  public Vector3 position = new Vector3();

}

class GameObject2{

   public Transform2 transform = new Transform2();

}

而后咱们用几个不一样的调用方式来设置transform的position

方式1：gameobject.transform.position = Vector3.New(1,2,3)

方式2：gameobject:SetPos(Vector3.New(1,2,3))

方式3：gameobject:SetPos2(1,2,3)

方式4：GOUtil.SetPos(gameobject,  Vector3.New(1,2,3))

方式5：GOUtil.SetPos2(gameobjectid, Vector3.New(1,2,3))

方式6：GOUtil.SetPos3(gameobjectid, 1,2,3)

分别进行1000000次，结果以下（测试环境是windows版本，cpu是i7-4770，luajit的jit模式关闭，手机上会由于luajit架构、il2cpp等因素干扰有所不一样，但这点咱们会在下一篇进一步阐述）：

 

方式1：903ms

方式2：539ms

方式3：343ms

方式4：559ms

方式5：470ms

方式6：304ms

 

 

能够看到，每一步优化，都是提高明显的，尤为是移除.transform获取以及Vector3转换提高更是巨大，咱们仅仅只是改变了对外导出的方式，并不须要付出很高成本，就已经能够 节省66%的时间。

实际上能不能再进一步呢？还能！在方式6的基础上，咱们能够再作到只有200ms！

这里卖个关子，下一篇luajit集成中咱们进一步讲解。通常来讲，咱们推荐作到方式6的水平已经足够。

这只是一个最简单的案例，有不少各类各样的经常使用导出（例如GetComponentsInChildren这种性能大坑，或者一个函数传递十几个参数的状况）都须要你们根据本身使用的状况来进行优化，有了咱们提供的lua集成方案背后的性能原理分析，应该就很容易去考虑怎么作了。

 

 

下一篇将会写lua+unity性能优化的第二部分，luajit集成的性能坑

相比起第一部分这种看导出代码就能大概知道性能消耗的问题，luajit集成的问题要复杂晦涩得多。

 

 

 

附测试用例的c#代码：

 

 

 

 

public class Transform2
{
    public Vector3 position = new Vector3();
}

public class GameObject2
{
    public Transform2 transform = new Transform2();
    public void SetPos(Vector3 pos)
    {
        transform.position = pos;
    }

    public void SetPos2(float x, float y, float z)
    {
        transform.position.x = x;
        transform.position.y = y;
        transform.position.z = z;
    }
}

 
public class GOUtil
{
    private static List<GameObject2> mObjs = new List<GameObject2>();
    public static GameObject2 GetByID(int id)
    {
        if(mObjs.Count == 0)
        {
            for (int i = 0; i < 1000; i++ )
            {
                mObjs.Add(new GameObject2());
            }
        }

        return mObjs[id];
    }

    public static void SetPos(GameObject2 go, Vector3 pos)
    {
        go.transform.position = pos;
    }

    public static void SetPos2(int id, Vector3 pos)
    {
        mObjs[id].transform.position = pos;
    }

    public static void SetPos3(int id, float x, float y ,float z)
    {
        var t = mObjs[id].transform;
        t.position.x = x;
        t.position.y = y;
        t.position.z = z;
    }

}