13.模块与包

1.模块：

就是可以把一些公用的代码放在一个文件里，以 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

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

2.require 函数

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

require("模块名")

或者

require "模块名"

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

module.luarequire("module")
print(module.constant)
module.func3()

执行结果为：
这是一个常量
这是一个私有函数！

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

别名变量 m

local m = require("module")
print(m.constant)
m.func3()

执行结果为：
这是一个常量
这是一个私有函数！

3.加载机制

1.对于自定义的模块，模块文件不是放在哪个文件目录都行，函数 require 有它自己的文件路径加载策略，它会尝试从 Lua 文件或 C 程序库中加载模块。

2.require 用于搜索 Lua 文件的路径是存放在全局变量 package.path 中（dll文件为package.cpath），当 Lua 启动后，会以环境变量 LUA_PATH 的值来初始这两个全局变量。如果没有找到该环境变量，则使用一个编译时定义的默认路径来初始化这两个全局变量。

3.如果没有 LUA_PATH 这个环境变量则可以自己在系统环境变量中添加，环境变量的值可以设置为比如:

.lua文件，比如设置为：C:\test\?.lua

.dll文件，比如设置为: C:\test\?.dll

另一种方法是通过在lua文件里设置package.path(package.cpath)全局变量来添加搜索路径，比如：

local p ="F:/lua5.3/lua5.3/test/test_module/"

--lua文件查找

local m_package_path = package.path  

package.path = string.format("%s;%s?.lua",m_package_path, p)  

--dll文件查找

local m_package_cpath = package.cpath  

package.cpath = string.format("%s;%s?.dll",m_package_cpath, p)  

4.lua调用C++ DLL接口

例：

C++ DLL库代码：

#include <iostream>
extern "C" {
#include <lua.h>  
#include <lauxlib.h>  
#include <lualib.h>  
}
//求平均
static int avr(lua_State *L)
{
   int n = lua_gettop(L);
   double sum = 0;
   int i;
   for (i = 1; i <= n; i++)
     sum += lua_tonumber(L, i);
   lua_pushnumber(L, sum / n);
   lua_pushnumber(L, sum);
   return 2;
}
//乘2
static int doubles(lua_State *L)
{
   double d = lua_tonumber(L, 1);
   d = d * 2;
   lua_pushnumber(L, d);
   return 1;
}
 
static int str(lua_State *L)
{
   int n = lua_gettop(L);
   int i;
   for (i = 1; i <= n; i++)
     std::cout <<lua_tostring(L,i) << std::endl;
   return 0;
}
 
static const struct luaL_Reg mylib[] =
{
   { "avr",avr },
   { "doubles",doubles },
   {"str",str},
   { NULL,NULL }
};
 
extern "C" __declspec(dllexport) int luaopen_test_dll(lua_State* luaEnv)
{
   lua_newtable(luaEnv);
   //先把一个table压入VS，然后在调用luaL_setfuncs就会把所有的func存到table中
   luaL_setfuncs(luaEnv, mylib, 0);
   //e.g local clib = require "libname". 这样就不会污染全局环境。比luaL_register更好。
   return 1;
}

Lua中调用：

clib = require("test_dll")  
 
result = clib.doubles(10,20,30,40)
print(result)
-- output: 20.0 (只接收了首个参数)

avr,sum = clib.avr(10,20,30,40)
print(avr,sum)
-- output: 25.0 100.0

clib.str("123","测试","23456")