主要翻譯自lua文檔,加上了programming lua中自己的一些理解

require(modname)

加載給定的模塊.函數(shù)首先檢查表package.loaded來判定modname是否已經(jīng)存在.如果存在,則require返回package.loaded[modname]所存儲(chǔ)的值否則它嘗試為模塊找到一個(gè)加載器(loader).

要找到一個(gè)加載器,require首先查詢package.preloaded[modname].如果它有值,該值(應(yīng)該是一個(gè)函數(shù))就是加載器.如果沒值require使用package.path中存儲(chǔ)的路徑查找一個(gè)Lua的加載器.如果該查找也失敗,它使用package.cpath中存儲(chǔ)的路徑查找一個(gè)C語(yǔ)言加載器(C loader).如果還是失敗,它嘗試使用all-in-one加載器(如下)

當(dāng)加載一個(gè)C庫(kù)的時(shí)候,require首先使用動(dòng)態(tài)鏈接工具將應(yīng)用程序與庫(kù)連接起來.之后它嘗試找到一個(gè)該庫(kù)中的C函數(shù),該函數(shù)要被當(dāng)做加載器使用.這個(gè)C函數(shù)的名稱是字符串"luaopen_"連接著復(fù)制的模塊名(模塊名稱中的每個(gè)點(diǎn)號(hào)"."都被替換為一個(gè)下劃線).此外,如果模塊名稱含有連字符"-",則第一個(gè)連字符的前綴(包括連字符)都被移除.比如,如果模塊名稱是a.v1-b.c,則函數(shù)名稱將是luaopen_b_c.

如果require即沒有為模塊找到一個(gè)Lua庫(kù)也沒有為模塊找到一個(gè)C庫(kù),他將調(diào)用all-in-one加載器.該加載器為給定模塊的根名稱查找C路徑找到對(duì)應(yīng)庫(kù)(原文:this loader searches the C path for a library for the root name of the given module).例如,當(dāng)require a.b.c時(shí),它將為a查找一個(gè)庫(kù).如果找到,它查詢?cè)搸?kù)內(nèi)部為子模塊找到一個(gè)開放函數(shù)(open function);在我們這個(gè)例子中將會(huì)是luaopen_a_b_c.使用這個(gè)便利機(jī)制(facility),一個(gè)包可以將幾個(gè)子模塊打包進(jìn)單個(gè)的庫(kù)中,同時(shí)每個(gè)子模塊保存著它本來的開放函數(shù).

一旦找到一個(gè)加載器,require使用單個(gè)的參數(shù)modname調(diào)用加載器.如果加載器返回任何值,require將其賦值給package.loaded[modname].如果加載器沒有返回值且沒有給package.loaded[modname]賦與任何值,則require為該條目賦值為true.無論如何,require返回package.loaded[modname]的最終值.

如果加載或者運(yùn)行模塊有任何錯(cuò)誤,或者他不能為模塊找到一個(gè)加載器,則require發(fā)出一個(gè)錯(cuò)誤信號(hào).

require函數(shù)的實(shí)現(xiàn)原理如下:

[plain] view plaincopyprint?

1. --require 函數(shù)的實(shí)現(xiàn)  
2. function require(name)  
3.     if not package.loaded[name] then  
4.         local loader = findloader(name) //這一步演示在代碼中以抽象函數(shù)findloader來表示  
5.         if loader == nil then  
6.             error("unable to load module" .. name)  
7.         end  
8.         package.loaded[name] = true  
9.         local res = loader(name)  
10.         if res ~= nil then  
11.             package.loaded[name] = res  
12.         end  
13.     end  
14.     return package.loaded[name]  
15. end  

--require 函數(shù)的實(shí)現(xiàn)
function require(name)
	if not package.loaded[name] then
		local loader = findloader(name)	//這一步演示在代碼中以抽象函數(shù)findloader來表示
		if loader == nil then
			error("unable to load module" .. name)
		end
		package.loaded[name] = true
		local res = loader(name)
		if res ~= nil then
			package.loaded[name] = res
		end
	end
	return package.loaded[name]
end

package.cpath

由require使用查找C加載器的路徑

Lua初始化C路徑package.cpath的方法與初始化Lua路徑package.path的相同,使用LUA_CPATH中的環(huán)境變量(另外一個(gè)默認(rèn)的路徑在luaconf.h中定義)

package.loaded

一個(gè)用于控制哪些模塊已經(jīng)加載的表,該表由require使用.當(dāng)require一個(gè)模塊名為modname的模塊且package.loaded[modname]不為false時(shí),require僅返回package.loaded[modname]存儲(chǔ)的值.

package.loadlib(libname,funcname)

使用C庫(kù)libname動(dòng)態(tài)鏈接到宿主程序.在這個(gè)庫(kù)中,尋找函數(shù)funcname并將該函數(shù)作為一個(gè)C函數(shù)返回.(所以,funcname必須遵守協(xié)議(參見lua_CFunction)).

這是一個(gè)底層函數(shù).它完全繞過了package和module系統(tǒng).與require不同,它不執(zhí)行任何路徑查找且不自動(dòng)添加擴(kuò)展名.libname必須是C庫(kù)中完整的文件名,如果必要的話還要包含路徑和擴(kuò)展名.funcname必須是原封不動(dòng)的C庫(kù)中導(dǎo)出的名字(這可能取決于使用的C編譯器和鏈接器).

這個(gè)函數(shù)不被ANSI C支持.就其本身而言,它只在一些平臺(tái)上才能使用(Windows,Linux,Mac OS X,Solaris,BSD,加上其他支持dlfcn標(biāo)準(zhǔn)的Unix系統(tǒng))

package.path

require用于查找Lua加載器的路徑

在啟動(dòng)時(shí),Lua使用環(huán)境變量LUA_PATH或者如果環(huán)境變量未定義就使用luaconf.h中定義的默認(rèn)值來初始化該值.環(huán)境變量中的任何"::"都被替換為默認(rèn)路徑.

路徑是一系列由分號(hào)隔開的模板(templates).對(duì)于每個(gè)模板,require將每個(gè)模板中的問號(hào)替換為filename,filename是modname中每個(gè)點(diǎn)都被替換成"目錄分隔符"(比如Unix中的"/")(這句感覺翻譯不準(zhǔn)確,原文:For each template,require will change each interrogation mark in the template by filename,which is modname with each dot replaced by a "directory separator"(such as "/" in Unix));之后他將加載產(chǎn)生的文件名.因此,舉個(gè)例子,如果Lua路徑是"./?.lua;./?.lc;/usr/local/?/init.lua",為模塊foo查找一個(gè)Lua加載器將會(huì)嘗試以如下順序加載文件./foo.lua,./foo.lc和/usr/local/foo/init.lua

package.preload

為特定模塊存儲(chǔ)加載器的一個(gè)表(參見require)

package.seeall(module)

為module設(shè)置一個(gè)元表,module的__index只想全局環(huán)境(global environment),以便該module繼承全局環(huán)境中的值.作為函數(shù)module中的一個(gè)選項(xiàng)來使用.

在Programming Lua中是這么講的:

默認(rèn)情況下,module不提供外部訪問.必須在調(diào)用它之前,為需要訪問的外部函數(shù)或模塊聲明適當(dāng)?shù)木植孔兞?也可以通過繼承來實(shí)現(xiàn)外部訪問,只需在調(diào)用module時(shí)附加一個(gè)選項(xiàng)package.seeall.這個(gè)選項(xiàng)等價(jià)于如下代碼:

[plain] view plaincopyprint?

1. setmetatable(M,{__index = _G})  

setmetatable(M,{__index = _G})

[plain] view plaincopyprint?

1. module(...,package.seeall)  

module(...,package.seeall)

module(name,[,...])

創(chuàng)建一個(gè)模塊.如果在package.loaded[name]中有表,該表便是創(chuàng)建的模塊.否則,如果有一個(gè)全局表t其名稱與給定名稱相同,則該全局表便是創(chuàng)建的模塊.否則創(chuàng)建一個(gè)新的表t