Lua中的userdata

【话从这里提及】

在我发表《Lua中的类型与值》这篇文章时，就有读者给我留言了，说：你应该好好总结一下Lua中的function和userdata类型。如今是时候总结了。对于function，我在《Lua中的函数》这篇文章中进行了总结，而这篇文章将会对Lua中的userdata进行仔细的总结。对于文章，你们若是有任何疑议，均可以在文章的下方给我留言，也能够关注个人新浪微博与我互动。学习，就要分享，我期待你的加入。

【userdata是啥？】

userdata是啥？简单直译就是用户数据，若是再文艺一点，就叫作用户自定义数据。要这货有什么好处呢？首先，让咱们来想象一个场景，你能够在C中定义struct，当你在C中定义了一个struct，你有么有想过，如何让Lua表示这个struct，也就是说，Lua和C要进行沟通，如何让Lua也能正确的访问这个struct呢？这是一个符合实际且实用的需求。遇到这种需求，怎么办？这个时候，实用userdata就能大展身手了，所以Lua为此提供了一种基本的类型——userdata。userdata提供了一块原始的内存区域，能够用来存储任何东西。而且，在Lua中userdata没有任何预约义的操做。先来看看怎么使用userdata。

函数lua_newuserdata会根据指定的大小分配一块内存，并将对应的userdata压入栈中，最后返回这个内存块的地址：

void *lua_newuserdata(lua_State *L, size_t size);

下面，就经过一简单的实例来讲说userdata的使用。

static struct StudentTag
{
    char *strName; // 学生姓名
    char *strNum; // 学号
    int iSex; // 学生性别
    int iAge; // 学生年龄
};

定义一个学生结构体，以后的操做，都在这个学生结构体上进行，包括设置学生姓名，学号，性别和年龄。

static int Student(lua_State *L)
{
    size_t iBytes = sizeof(struct StudentTag);
    struct StudentTag *pStudent;
    pStudent = (struct StudentTag *)lua_newuserdata(L, iBytes);

    return 1; // 新的userdata已经在栈上了
}

建立一个新的学生结构体，使用的lua_newuserdata函数，建立完成之后，这个新的userdata就在栈上，能够直接返回给Lua。下面就以设置姓名和获取姓名为例子。

static int GetName(lua_State *L)
{
    struct StudentTag *pStudent = (struct StudentTag *)lua_touserdata(L, 1);
    luaL_argcheck(L, pStudent != NULL, 1, "Wrong Parameter");
    lua_pushstring(L, pStudent->strName);

    return 1;
}

static int SetName(lua_State *L)
{
    // 第一个参数是userdata
    struct StudentTag *pStudent = (struct StudentTag *)lua_touserdata(L, 1);
    luaL_argcheck(L, pStudent != NULL, 1, "Wrong Parameter");

    // 第二个参数是一个字符串
    const char *pName = luaL_checkstring(L, 2);
    luaL_argcheck(L, pName != NULL && pName != "", 2, "Wrong Parameter");
    pStudent->strName = pName;
    return 0;
}

在GetName函数中，只有一个参数，那就是使用Student函数建立的userdata，而后使用C语言的方式，从中取出名字，放到栈中，返回到Lua中。

在SetName函数中，须要传入两个参数，第一个参数是userdata，第二个参数是须要设置的值，而后直接赋值就行了，使用起来比较简单，没有很复杂的步骤，你觉的呢？

【元表】

上述的代码有一个很严重的问题，为何这么说呢？我先把上一个例子的Lua代码贴出来：

require "userdatademo1"

local objStudent = Student.new()
Student.setName(objStudent, "果冻想")
Student.setAge(objStudent, 15)

local strName = Student.getName(objStudent)
local iAge = Student.getAge(objStudent)

print(strName)
print(iAge)

调用Student的new获得一个Student实例之后，之后调用Student的其它函数时，第一个参数都是使用Student函数获得的userdata，也就是上面代码中的objStudent。在C模块侧，咱们只是简单的判断了一下传进来的userdata是否为NULL，并无办法判断传进来的userdata参数是使用Student函数获得的；若是我传一个错误的userdata进去，程序也会继续运行，但有可能使内存遭到破坏。那如何肯定咱们传入的userdata正是咱们须要的userdata呢？咱们须要一种这样的机制来确保参数的合法性。

一种辨别不一样类型的userdata的方法是，为每种类型建立一个惟一的元表（什么是元表？）。每当建立了一个userdata后，就用相应的元表来标记它。而每当获得一个userdata后，就检查它是否拥有正确的元表。因为Lua代码不能改变userdata的元表，所以也就没法欺骗代码了。

为每一个userdata都建立一个元表，那就须要有个地方来存储这个新的元表。在Lua中，一般习惯是将全部新的C类型注册到注册表中，以一个类型名做为key，元表做为value。因为注册表中还有其它的内容，因此必须当心地选择类型名，以免与key冲突。

Lua的辅助库中提供了一些函数来帮助实现上面说的内容，可使用的辅助库函数有：

int luaL_newmetatable(lua_State *L, const char *tname);
void luaL_getmetatable(lua_State *L, const char *tname);
void *luaL_checkudata(lua_State *L, int index, const char *tname);

luaL_newmetatable函数会建立一个新的table用做元表，并将其压入栈顶，而后将这个table与注册表中的指定名称关联起来。luaL_getmetatable函数能够在注册表中检索与tname关联的元表。luaL_checkudata能够检查栈中指定位置上是否为一个userdata，而且是否具备与给定名称相匹配的元表，若是该对象不是一个userdata，或者它不具备正确的元表，就会引起一个错误；不然它就会返回这个userdata的地址。如今来重写上面的那个例子：

int luaopen_userdatademo2(lua_State *L)
{
    // 建立一个新的元表
    luaL_newmetatable(L, "Student");
    luaL_register(L, "Student", arrayFunc);
    return 1;
}

建立一个新元表，做为该userdata的惟一标识。

static int Student(lua_State *L)
{
    size_t iBytes = sizeof(struct StudentTag);
    struct StudentTag *pStudent;
    pStudent = (struct StudentTag *)lua_newuserdata(L, iBytes);

    // 设置元表
    luaL_getmetatable(L, "Student");
    lua_setmetatable(L, -2);

    return 1; // 新的userdata已经在栈上了
}

在建立userdata的时候，设置该userdata的元表。在使用的时候，咱们就能够调用luaL_checkudata对参数进行检查。

static int GetName(lua_State *L)
{
    struct StudentTag *pStudent = (struct StudentTag *)luaL_checkudata(L, 1, "Student");
    lua_pushstring(L, pStudent->strName);
    return 1;
}

当写下一下Lua语句时：

Student.getAge(io.stdin)

就会抛出这样的异常错误：

bad argument #1 to 'getAge' (Student expected, got userdata)

如今，我想你应该懂得了如何去简单的使用userdata了吧。接下来，上点难的东西。单击这里下载完整项目工程userdatademo2.zip。

面向对象的访问

关于Lua的面向对象对象编程，我在《Lua中的面向对象编程》这篇文章中进行了总结，若是你对Lua中的面向对象编程还不是很熟悉，能够再去阅读一下《Lua中的面向对象编程》。

在上面的Lua代码中，能够看到，我都是使用如下方式调用函数的：

local strName = Student.getName(objStudent)

这种调用方式无可厚非，可是从面向对象的角度来讲，我new了一个对象，这就是一个独立的对象，我应该这样调用，才能更好理解啊。

local strName = objStudent:getName()

是吧。这又回到了《Lua中的面向对象编程》一文中说到的问题，因为getName、setName等这些函数都是在Student中定义的，而在objStudent对象中，并无这些函数的定义，怎么办？仍是老办法，咱们须要设置objStudent的元表，设置__index字段，当在objStudent中找不到对应的函数时，就去Student中查找，以前在《Lua中的面向对象编程》一文中，也是介绍的这个办法。来吧，实现一下吧。

int luaopen_userdatademo3(lua_State *L)
{
    // 建立一个新的元表
    luaL_newmetatable(L, "Student_Metatable");

    // 元表.__index = 元表
    lua_pushvalue(L, -1);
    lua_setfield(L, -2, "__index");
    luaL_register(L, NULL, arrayFunc_meta);
    luaL_register(L, "Student", arrayFunc);

    return 1;
}

上述代码中，有两个地方要特别注意。首先要设置Student.__index = Student，使用上面代码中的第七、8行实现的。还有一个须要注意的地方是luaL_register的特殊用法。在第一次调用luaL_register时，它的第二个参数是NULL，这样的话，luaL_register不会建立任何用于存储函数的table，而是以栈顶的table做为存储函数的table，而如今栈顶的table就是luaL_newmetatable建立的元表。代码中，两个luaL_register的第三个参数是不同的，它们的定义以下：

static struct luaL_reg arrayFunc[] =
{
    { "new", Student },
    { NULL, NULL }
};

static struct luaL_reg arrayFunc_meta[] =
{
    { "getName", GetName },
    { "setName", SetName },
    { "getAge", GetAge },
    { "setAge", SetAge },
    { "getSex", GetSex },
    { "setSex", SetSex },
    { "getNum", GetNum },
    { "setNum", SetNum },
    {NULL, NULL}
};

最终调用luaL_register(L, “Student”, arrayFunc);获得的Student表中，就只有一个函数new；而元表Student_Metatable中则有arrayFunc_meta数组中包含的全部方法。我在把Lua代码贴上来，而后再详细的分析一下流程。

require "userdatademo3"

local objStudent = Student.new()
objStudent:setName("果冻想")
objStudent:setAge(15)
local strName = objStudent:getName()
local iAge = objStudent:getAge()

print(strName)
print(iAge)

1. 调用require “userdatademo3″将获得一个Student表，在该表中，只有一个函数——new；
2. 调用Student.new()将获得一个Student结构体的userdata，该userdata的元表为Student_Metatable；
3. 因为在userdata中自己就没有key，因此在userdata中没有table中那样的key的概念；当调用objStudent:setName时，就会去元表Student_Metatable中找setName，而后完成调用；
4. 因为Student自己没有被设置元表Student_Metatable；当调用Student.setName(objStudent, “果冻想”)时，就会出错。这样也好，Student自己就不是一个实际的“学生”对象，只是一个模板，使用Student直接调用setName出错，彻底符合语义。

固然了，除了__index能够从新被定义之外，其它预约义的元方法也能够被从新定义。在完整的项目工程中提供了__tostring元方法的实现，单击这里下载完整工程userdatademo3.zip。

轻量级userdata

怎么又有了一个轻量级userdata了？这货又是什么？专业点，叫作“light userdata”。我在前面总结的userdata叫作“full userdata”。

轻量级userdata是一种表示C指针的值（即void *）。因为它是一个值，因此不用建立它。要将一个轻量级userdata放入栈中，只须要调用lua_pushlightuserdata便可。

void lua_pushlightuserdata(lua_State *L, void *p);

尽管两种userdata在名称上差很少，但它们之间仍是存在很大不一样的。轻量级userdata不是缓冲，只是一个指针而已。它也没有元表，就像数字同样，轻量级userdata不受到垃圾收集器的管理。

轻量级userdata的真正用途是相等性判断。一个彻底userdata是一个对象，它只与自身相等。而一个轻量级userdata则表示了一个C指针的值。所以，它与全部表示同一个指针的轻量级userdata相等。能够将轻量级userdata用于查找Lua中的C对象。

如今就来讲一种轻量级userdata的使用，还记的我在《再说C模块的编写（2）》中总结的注册表么？谈及注册表的key的时候，说使用UUID是一种不错的方案，如今就使用轻量级的userdata结合static来实现无冲突的key。

// 压入轻量级userdata，一个static变量的地址
static char key = 'k';
lua_pushlightuserdata(L, (void *)&key);
lua_pushstring(L, "JellyThink");
lua_settable(L, LUA_REGISTRYINDEX);

因为静态变量的地址在一个进程中具备惟一性，因此绝对不会出现重复key的问题。

// 从注册表中取对应的值
lua_pushlightuserdata(L, (void *)&key);
lua_gettable(L, LUA_REGISTRYINDEX);