Lua 模块与包

     从 Lua 5.1 开始，Lua 加入了标准的模块管理机制，可以把一些公用的代码放在一个文件里，以 API 接口的形式在其他地方调用，有利于代码的重用和降低代码耦合度。

Lua 的模块是由变量、函数等已知元素组成的 table，因此创建一个模块很简单，就是创建一个 table，然后把需要导出的常量、函数放入其中，最后返回这个 table 就行。

-- 文件名为 module.lua
-- 定义一个名为 module 的模块

module = {}

-- 定义一个常量
module.constant = "这是一个常量"

-- 定义一个函数
function module.func1()
    io.write("这是一个公有函数！\n")
end

local function func2()
    print("这是一个私有函数！")
end

function module.func3()
    func2()
end

return module

由上可知，模块的结构就是一个 table 的结构，因此可以像操作调用 table 里的元素那样来操作调用模块里的常量或函数。

上面的 func2 声明为程序块的局部变量，即表示一个私有函数，因此是不能从外部访问模块里的这个私有函数，必须通过模块里的公有函数来调用。

require 函数

     Lua提供了一个名为require的函数用来加载模块。要加载一个模块，只需要简单地调用就可以了。

require("<模块名>")
--或者
require "<模块名>"

执行 require 后会返回一个由模块常量或函数组成的 table，并且还会定义一个包含该 table 的全局变量。

-- test_module.lua 文件
-- module 模块为上文提到到 module.lua

--require("module")

--print(module.constant)

--module.func3()

--以上代码执行结果为：

--这是一个常量
--这是一个私有函数！

或者给加载的模块定义一个别名变量，方便调用：

-- test_module2.lua 文件
-- module 模块为上文提到到 module.lua
-- 别名变量 m
--local m = require("module")

--print(m.constant)

--m.func3()
--以上代码执行结果为：

--这是一个常量
--这是一个私有函数！

Lua 元表(Metatable)

     在 Lua table 中我们可以访问对应的key来得到value值，但是却无法对两个 table 进行操作。因此 Lua 提供了元表(Metatable)，允许我们改变table的行为，每个行为关联了对应的元方法。例如，使用元表我们可以定义Lua如何计算两个table的相加操作a+b。

     当Lua试图对两个表进行相加时，先检查两者之一是否有元表，之后检查是否有一个叫”__add”的字段，若找到，则调用对应的值。”__add”等即时字段，其对应的值（往往是一个函数或是table）就是”元方法”。

有两个很重要的函数来处理元表：

setmetatable(table,metatable): 对指定table设置元表(metatable)，如果元表(metatable)中存在__metatable键值，setmetatable会失败 。

getmetatable(table): 返回对象的元表(metatable)。

以下实例演示了如何对指定的表设置元表：

mytable = {}                          -- 普通表 

mymetatable = {}                      -- 元表

setmetatable(mytable,mymetatable)     -- 把 mymetatable 设为 mytable 的元表 
--以上代码也可以直接写成一行：

mytable = setmetatable({},{})

--以下为返回对象元表：

getmetatable(mytable)                 -- 这回返回mymetatable

__index 元方法

这是 metatable 最常用的键。当你通过键来访问 table 的时候，如果这个键没有值，那么Lua就会寻找该table的metatable（假定有metatable）中的__index 键。如果__index包含一个表格，Lua会在表格中查找相应的键。

other = { foo = 3 } 
  t = setmetatable({}, { __index = other }) 

  print(t.foo) --3
  print(t.bar)   --nil

如果__index包含一个函数的话，Lua就会调用那个函数，table和键会作为参数传递给函数。__index 元方法查看表中元素是否存在，如果不存在，返回结果为 nil；如果存在则由 __index 返回结果。

mytable = setmetatable({key1 = "value1"}, {
  __index = function(mytable, key)
    if key == "key2" then
      return "metatablevalue"
    else
      return nil
    end
  end
})

print(mytable.key1,mytable.key2)

--实例输出结果为：
--value1    metatablevalue

我们可以将以上代码简单写成:

mytable = setmetatable({key1 = "value1"}, { __index = { key2 = "metatablevalue" } })

print(mytable.key1,mytable.key2)

总结

Lua查找一个表元素时的规则，其实就是如下3个步骤:

  • 1.在表中查找，如果找到，返回该元素，找不到则继续。
  • 2.判断该表是否有元表，如果没有元表，返回nil，有元表则继续。
  • 3.判断元表有没有__index方法，如果__index方法为nil，则返回nil；如果__index方法是一个表，则重复1、2、3；如果__index方法是一个函数，则返回该函数的返回值。

__newindex 元方法

     __newindex 元方法用来对表更新，__index则用来对表访问 。当你给表的一个缺少的索引赋值，解释器就会查找__newindex 元方法：如果存在则调用这个函数而不进行赋值操作。

以下实例演示了 __newindex 元方法的应用：

mymetatable = {}
mytable = setmetatable({key1 = "value1"}, { __newindex = mymetatable })

print(mytable.key1)

mytable.newkey = "新值2"
print(mytable.newkey,mymetatable.newkey)

mytable.key1 = "新值1"
print(mytable.key1,mymetatable.key1)

--以上实例执行输出结果为：
--value1
--nil    新值2
--新值1    nil

我们通过输出结果发现，在对新索引键（newkey）赋值时（mytable.newkey = “新值2”），会调用元方法，而不进行赋值。而如果对已存在的索引键（key1），则会进行赋值，而不调用元方法 __newindex。并不是我们想要的理想效果

以下实例使用了 rawset 函数来更新表：

mytable = setmetatable({key1 = "value1"}, {
  __newindex = function(mytable, key, value)
        rawset(mytable, key, "\""..value.."\"")

  end
})

mytable.key1 = "new value"
mytable.key2 = 4

print(mytable.key1,mytable.key2)

--以上实例执行输出结果为：
--new value    "4"

介绍到这里。对元表的理解和运用已经有了初步了解了。下面我们就用一个两表相加作为结束案例吧。

-- 自定义计算表中最大键值函数 table_maxn，即计算表的元素个数
function table_maxn(t)
    local mn = 0
    for k, v in pairs(t) do
        if mn < k then
            mn = k
        end
    end
    return mn
end

-- 两表相加操作
mytable = setmetatable({ 1, 2, 3 }, {
  __add = function(mytable, newtable)
    for i = 1, table_maxn(newtable) do
      table.insert(mytable, table_maxn(mytable)+1,newtable[i])
    end
    return mytable
  end
})

secondtable = {4,5,6}

mytable = mytable + secondtable
    for k,v in ipairs(mytable) do
print(k,v)
end
--以上实例执行输出结果为：
1    1
2    2
3    3
4    4
5    5
6    6

表中对应的操作列表如下：(注意：__是两个下划线)

模式

描述

__add

对应的运算符 ‘+’.

__sub

对应的运算符 ‘-‘.

__mul

对应的运算符 ‘*’.

__div

对应的运算符 ‘/’.

__mod

对应的运算符 ‘%’.

__unm

对应的运算符 ‘-‘.

__concat

对应的运算符 ‘..’.

__eq

对应的运算符 ‘==’.

__lt

对应的运算符 ‘<’.

__le

对应的运算符 ‘<=’.