局部变量
最后更新于：2022-04-01 02:17:43
# 局部变量
#### 定义
Lua中的局部变量要用local关键字来显示定义，不用local显示定义的变量就是全局变量：
~~~
g_var = 1 -- global var
local l_var = 2 -- local var
~~~
#### 作用域
局部变量的生命周期是有限的，它的作用域仅限于声明它的块（block）。 一个块是一个控制结构的执行体、或者是一个函数的执行体再或者是一个程序块（chunk）。我们可以通过下面这个例子来理解一下局部变量作用域的问题：
> 示例代码test.lua
~~~
x = 10
local i = 1 --程序块中的局部变量i
while i <=x do
local x = i * 2 --while循环体中的局部变量x
print(x) --打印2, 4, 6, 8, ...(实际输出格式不是这样的，这里只是表示输出结果)
i = i + 1
end
if i > 20 then
local x --then中的局部变量x
x = 20
print(x + 2) --如果i > 20 将会打印22，此处的x是局部变量
else
print(x) --打印10， 这里x是全局变量
end
print(x) --打印10
~~~
#### 使用局部变量的好处
使用局部变量的一个好处是，局部变量可以避免将一些无用的名称引入全局环境，避免全局环境的污染。另外，访问局部变量比访问全局变量更快。同时，由于局部变量出了作用域之后生命周期结束，这样可以被垃圾回收器及时释放。
在Lua中，应该尽量让定义变量的语句靠近使用变量的语句，这也可以被看做是一种良好的编程风格。在C这样的语言中，强制程序员在一个块（或一个过程）的起始处声明所有的局部变量，所以有些程序员认为在一个块的中间使用声明语句是一种不良好地习惯。实际上，在需要时才声明变量并且赋予有意义的初值，这样可以提高代码的可读性。对于程序员而言，相比在块中的任意位置顺手声明自己需要的变量，和必须跳到块的起始处声明，大家应该能掂量哪种做法比较方便了吧？
“尽量使用局部变量”是一种良好的编程风格。然而，初学者在使用Lua时，很容易忘记加上“local”来定义局部变量，这时变量就会自动变成全局变量，很可能导致程序出现意想不到的问题。那么我们怎么检测哪些变量是全局变量呢？我们如何防止全局变量导致的影响呢？下面给出一段代码，利用元表的方式来自动检查全局变量，并打印必要的调试信息：
#### 检查模块的函数使用全局变量
> 把下面代码保存在foo.lua文件中。
~~~
module(..., package.seeall) --使用module函数定义模块很不安全。如何定义和使用模块请查看模块章节
local function add(a, b) --两个number型变量相加
return a + b
end
function update_A() --更新变量值
A = 365
end
getmetatable(foo).__newindex = function (table, key, val) --防止foo模块更改全局变量
error('attempt to write to undeclared variable "' .. key .. '": ' .. debug.traceback())
end
~~~
> 把下面代码保存在use_foo.lua文件中。该文件和foo.lua在相同目录。
~~~
A = 360 --定义全局变量
local foo = require("foo") --使用模块foo，如何定义和使用模块请查看模块章节
local b = foo.add(A, A)
print("b = ", b)
foo.update_A()
print("A = ", A)
~~~
运行use_foo.lua文件，输出结果如下:
~~~
b = 720
lua: .\foo.lua:13: attempt to write to undeclared variable "A": stack traceback:
.\foo.lua:13: in function <.\foo.lua:12>
.\foo.lua:9: in function 'update_A'
my.lua:7: in main chunk
[C]: ?
stack traceback:
[C]: in function 'error'
.\foo.lua:13: in function <.\foo.lua:12>
.\foo.lua:9: in function 'update_A'
my.lua:7: in main chunk
[C]: ?
~~~
在 _update_A()_ 函数使用全局变量"A"时，抛出异常。这利用了模块，想了解更多元表的内容，可以查看[模块](#)章节。
Lua 上下文中应当严格避免使用自己定义的全局变量。可以使用一个 lua-releng 工具来扫描 Lua 代码，定位使用 Lua 全局变量的地方。lua-releng 的相关链接：[http://wiki.nginx.org/HttpLuaModule#Lua_Variable_Scope](http://wiki.nginx.org/HttpLuaModule#Lua_Variable_Scope)
把lua-releng.pl文件和上述两个文件放在相同目录下，然后进入该目录，运行lua-releng.pl，得到如下结果：
~~~
# ~/work/conf$ perl lua-releng.pl
WARNING: No "_VERSION" or "version" field found in `foo.lua`.
Checking use of Lua global variables in file foo.lua...
op no. line instruction args ; code
8 [7] SETGLOBAL 1 -4 ; update_A
2 [8] SETGLOBAL 0 -1 ; A
Checking line length exceeding 80...
WARNING: No "_VERSION" or "version" field found in `use_foo.lua`.
Checking use of Lua global variables in file use_foo.lua...
op no. line instruction args ; code
2 [1] SETGLOBAL 0 -1 ; A
7 [4] GETGLOBAL 2 -1 ; A
8 [4] GETGLOBAL 3 -1 ; A
18 [8] GETGLOBAL 4 -1 ; A
Checking line length exceeding 80...
~~~
结果显示：在foo.lua文件中，第7行设置了一个全局变量update_A（注意：在lua中函数也是变量），第8行设置了一个全局变量A；在use_foo.lua文件中，第1行设置了一个全局变量A，第4行使用了两次全局变量A，第8行使用了一次全局变量A。