Lua 函數(shù)

在Lua中，函數(shù)是對(duì)語句和表達(dá)式進(jìn)行抽象的主要方法。既可以用來處理一些特殊的工作，也可以用來計(jì)算一些值。

Lua 提供了許多的內(nèi)建函數(shù)，你可以很方便的在程序中調(diào)用它們，如print()函數(shù)可以將傳入的參數(shù)打印在控制臺(tái)上。

Lua 函數(shù)主要有兩種用途：

• 1.完成指定的任務(wù)，這種情況下函數(shù)作為調(diào)用語句使用；

• 2.計(jì)算并返回值，這種情況下函數(shù)作為賦值語句的表達(dá)式使用。

函數(shù)定義

Lua 編程語言函數(shù)定義格式如下：

optional_function_scope function function_name( argument1, argument2, argument3..., argumentn)
    function_body
    return result_params_comma_separated
end

解析：

• optional_function_scope: 該參數(shù)是可選的制定函數(shù)是全局函數(shù)還是局部函數(shù)，未設(shè)置該參數(shù)默認(rèn)為全局函數(shù)，如果你需要設(shè)置函數(shù)為局部函數(shù)需要使用關(guān)鍵字 local。

• function_name: 指定函數(shù)名稱。

• argument1, argument2, argument3..., argumentn: 函數(shù)參數(shù)，多個(gè)參數(shù)以逗號(hào)隔開，函數(shù)也可以不帶參數(shù)。

• function_body: 函數(shù)體，函數(shù)中需要執(zhí)行的代碼語句塊。

• result_params_comma_separated: 函數(shù)返回值，Lua語言函數(shù)可以返回多個(gè)值，每個(gè)值以逗號(hào)隔開。

在線示例

以下示例定義了函數(shù) max()，參數(shù)為 num1, num2，用于比較兩值的大小，并返回最大值：

示例

--[[ 函數(shù)返回兩個(gè)值的最大值 --]]
function max(num1, num2)

   if (num1 > num2) then
      result = num1;
   else
      result = num2;
   end

   return result; 
end
-- 調(diào)用函數(shù)
print("兩值比較最大值為 ",max(10,4))
print("兩值比較最大值為 ",max(5,6))

以上代碼執(zhí)行結(jié)果為：

兩值比較最大值為     10
兩值比較最大值為     6

Lua 中我們可以將函數(shù)作為參數(shù)傳遞給函數(shù)，如下示例：

示例

myprint = function(param)
   print("這是打印函數(shù) -   ##",param,"##")
end

function add(num1,num2,functionPrint)
   result = num1 + num2
   -- 調(diào)用傳遞的函數(shù)參數(shù)
   functionPrint(result)
end
myprint(10)
-- myprint 函數(shù)作為參數(shù)傳遞
add(2,5,myprint)

以上代碼執(zhí)行結(jié)果為：

這是打印函數(shù) -   ##    10    ##
這是打印函數(shù) -   ##    7    ##

多返回值

Lua函數(shù)可以返回多個(gè)結(jié)果值，比如string.find，其返回匹配串"開始和結(jié)束的下標(biāo)"（如果不存在匹配串返回nil）。

> s, e = string.find("www.jixiangtaizi.com.cn", "nhooo") 
> print(s, e)
5    10

Lua函數(shù)中，在return后列出要返回的值的列表即可返回多值，如：

示例

function maximum (a)
    local mi = 1             -- 最大值索引
    local m = a[mi]          -- 最大值
    for i,val in ipairs(a) do
       if val > m then
           mi = i
           m = val
       end
    end
    return m, mi
end

print(maximum({8,10,23,12,5}))

以上代碼執(zhí)行結(jié)果為：

23    3

可變參數(shù)

Lua 函數(shù)可以接受可變數(shù)目的參數(shù)，和 C 語言類似，在函數(shù)參數(shù)列表中使用三點(diǎn) ...  表示函數(shù)有可變的參數(shù)。

function add(...)  
local s = 0  
  for i, v in ipairs{...} do   --> {...} 表示一個(gè)由所有變長(zhǎng)參數(shù)構(gòu)成的數(shù)組  
    s = s + v  
  end  
  return s  
end  
print(add(3,4,5,6,7))  --->25

我們可以將可變參數(shù)賦值給一個(gè)變量。

例如，我們計(jì)算幾個(gè)數(shù)的平均值：

示例

function average(...)
   result = 0
   local arg={...}    --> arg 為一個(gè)表，局部變量
   for i,v in ipairs(arg) do
      result = result + v
   end
   print("總共傳入 " .. #arg .. " 個(gè)數(shù)")
   return result/#arg
end

print("平均值為",average(10,5,3,4,5,6))

以上代碼執(zhí)行結(jié)果為：

總共傳入 6 個(gè)數(shù)
平均值為    5.5

我們也可以通過 select("#",...) 來獲取可變參數(shù)的數(shù)量:

示例

function average(...)
   result = 0
   local arg={...}
   for i,v in ipairs(arg) do
      result = result + v
   end
   print("總共傳入 " .. select("#",...) .. " 個(gè)數(shù)")
   return result/select("#",...)
end

print("平均值為",average(10,5,3,4,5,6))

以上代碼執(zhí)行結(jié)果為：

總共傳入 6 個(gè)數(shù)
平均值為    5.5

有時(shí)候我們可能需要幾個(gè)固定參數(shù)加上可變參數(shù)，固定參數(shù)必須放在變長(zhǎng)參數(shù)之前:

示例

function fwrite(fmt, ...)  ---> 固定的參數(shù)fmt
    return io.write(string.format(fmt, ...))     
end

fwrite("nhooo\n")       --->fmt = "nhooo", 沒有變長(zhǎng)參數(shù)。  
fwrite("%d%d\n", 1, 2)   --->fmt = "%d%d", 變長(zhǎng)參數(shù)為 1 和 2

輸出結(jié)果為：

nhooo
12

通常在遍歷變長(zhǎng)參數(shù)的時(shí)候只需要使用 {…}，然而變長(zhǎng)參數(shù)可能會(huì)包含一些 nil，那么就可以用 select 函數(shù)來訪問變長(zhǎng)參數(shù)了：select('#', …) 或者 select(n, …)

• select('#', …) 返回可變參數(shù)的長(zhǎng)度。

• select(n, …) 用于返回參數(shù)列表中的第 n 個(gè)參數(shù)。

調(diào)用 select 時(shí)，必須傳入一個(gè)固定實(shí)參 selector(選擇開關(guān)) 和一系列變長(zhǎng)參數(shù)。如果 selector 為數(shù)字 n，那么 select 返回參數(shù)列表中的第 n 個(gè)參數(shù)，否則只能為字符串 #，這樣 select 返回變長(zhǎng)參數(shù)的總數(shù)。

示例代碼：

示例

do  
    function foo(...)  
        for i = 1, select('#', ...) do  -->獲取參數(shù)總數(shù)
            local arg = select(i, ...); -->讀取參數(shù)
            print("arg", arg);  
        end  
    end  
  
    foo(1, 2, 3, 4);  
end

輸出結(jié)果為：

arg    1
arg    2
arg    3
arg    4