[TOC]

Lua常用包

OS模块

Lua文件操作

Lua I/O 库用于读取和处理文件。分为简单模式（和C一样）、完全模式。

简单模式（simple model）拥有一个当前输入文件和一个当前输出文件，并且提供针对这些文件相关的操作。
完全模式（complete model）使用外部的文件句柄来实现。它以一种面对对象的形式，将所有的文件操作定义为文件句柄的方法

简单模式在做一些简单的文件操作时较为合适。但是在进行一些高级的文件操作的时候，简单模式就显得力不从心。例如同时读取多个文件这样的操作，使用完全模式则较为合适。

其他常用文件操作函数

os.remove(filename) 删除文件或空目录，失败返回nil以及描述信息

os.rename(oldname,newname)重命名文件或目录，失败返回nil以及描述信息

打开文件操作语句如下：

file = io.open (filename [, mode])

mode 的值有：

模式	描述
r	以只读方式打开文件，该文件必须存在。
w	打开只写文件，若文件存在则文件长度清为0，即该文件内容会消失。若文件不存在则建立该文件。
a	以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。（EOF符保留）
r+	以可读写方式打开文件，该文件必须存在。
w+	打开可读写文件，若文件存在则文件长度清为零，即该文件内容会消失。若文件不存在则建立该文件。
a+	与a类似，但此文件可读可写
b	二进制模式，如果文件是二进制文件，可以加上b
+	号表示对文件既可以读也可以写

简单模式

简单模式使用标准的 I/O 或使用一个当前输入文件和一个当前输出文件。

以下为 file.lua 文件代码，操作的文件为test.lua(如果没有你需要创建该文件)，代码如下：

-- 以只读方式打开文件
file = io.open("test.lua", "r")

-- 设置默认输入文件为 test.lua
io.input(file)

-- 输出文件第一行
print(io.read())

-- 关闭打开的文件
io.close(file)

-- 以附加的方式打开只写文件
file = io.open("test.lua", "a")

-- 设置默认输出文件为 test.lua
io.output(file)

-- 在文件最后一行添加 Lua 注释
io.write("--  test.lua 文件末尾注释")

-- 关闭打开的文件
io.close(file)

执行以上代码，你会发现，输出了 test.ua 文件的第一行信息，并在该文件最后一行添加了 lua 的注释。如我这边输出的是：

-- test.lua 文件

在以上实例中我们使用了 io."x" 方法，其中 io.read() 中我们没有带参数，参数可以是下表中的一个：

模式	描述
"*n"	读取一个数字并返回它。例：file.read("*n")
"*a"	从当前位置读取整个文件。例：file.read("*a")
"*l"(默认)	读取下一行，在文件尾 (EOF) 处返回 nil。例：file.read("*l")
number	返回一个指定字符个数的字符串，或在 EOF 时返回 nil。例：file.read(5)

其他的 io 方法有：

io.tmpfile():返回一个临时文件句柄，该文件以更新模式打开，程序结束时自动删除
io.type(file): 检测obj是否一个可用的文件句柄
io.flush(): 向文件写入缓冲中的所有数据
io.lines(optional file name): 返回一个迭代函数,每次调用将获得文件中的一行内容,当到文件尾时，将返回nil,但不关闭文件

完全模式

通常我们需要在同一时间处理多个文件。我们需要使用 file:function_name 来代替 io.function_name 方法。以下实例演示了如何同时处理同一个文件:

-- 以只读方式打开文件
file = io.open("test.lua", "r")

-- 输出文件第一行
print(file:read())

-- 关闭打开的文件
file:close()

-- 以附加的方式打开只写文件
file = io.open("test.lua", "a")

-- 在文件最后一行添加 Lua 注释
file:write("--test")

-- 关闭打开的文件
file:close()

执行以上代码，你会发现，输出了 test.ua 文件的第一行信息，并在该文件最后一行添加了 lua 的注释。如我这边输出的是：

-- test.lua 文件

read 的参数与简单模式一致。

其他方法:

file:seek(optional whence, optional offset): 设置和获取当前文件位置,成功则返回最终的文件位置(按字节),失败则返回nil加错误信息。

参数 whence 值可以是:

"set": 从文件头开始
"cur": 从当前位置开始[默认]
"end": 从文件尾开始
offset:默认为0

不带参数file:seek()则返回当前位置,file:seek("set")则定位到文件头,file:seek("end")则定位到文件尾并返回文件大小

file:flush(): 向文件写入缓冲中的所有数据
io.lines(optional file name): 打开指定的文件filename为读模式并返回一个迭代函数,每次调用将获得文件中的一行内容,当到文件尾时，将返回nil,并自动关闭文件。

若不带参数时io.lines() <=> io.input():lines(); 读取默认输入设备的内容，但结束时不关闭文件,如

for line in io.lines("main.lua") do

　　print(line)

　　end

以下实例使用了 seek 方法，定位到文件倒数第 25 个位置并使用 read 方法的 *a 参数，即从当期位置(倒数第 25 个位置)读取整个文件。

-- 以只读方式打开文件
file = io.open("test.lua", "r")

file:seek("end",-25)
print(file:read("*a"))

-- 关闭打开的文件
file:close()

我这边输出的结果是：

st.lua 文件末尾--test

时间处理

os.date([format [, time]]) 用来格式化时间戳为可读时间，time为可选时间戳，省略时取当下

os.time ([table]) 默认获取当前时间戳，也可以指定table参数

时间处理案例

--2018-05-09 09:20:04
local now = os.date("%Y-%m-%d %H:%M:%S")

-- %a abbreviated weekday name (e.g., Wed)
-- %A full weekday name (e.g., Wednesday)
-- %b abbreviated month name (e.g., Sep)
-- %B full month name (e.g., September)
-- %c date and time (e.g., 09/16/98 23:48:10)
-- %d 一个月里的几号[01–31]
-- %H 24小时[00–23]
-- %I 12小时[01–12]
-- %j 一年中的第几天[001–366]
-- %M 分[00–59]
-- %m 月份[01–12]
-- %p am(上午)，pm(下午)
-- %S 秒[00–60]
-- %w 星期几[0–6 = 星期天–星期六]
-- %x date (e.g., 09/16/98)
-- %X time (e.g., 23:48:10)
-- %y two-digit year (98) [00–99]
-- %Y 年(1998)
-- %% the character ‘%’

--获取当前时间戳秒-1525829060
local secs = os.time()

local year = string.sub(now,1,4)
local month = string.sub(now,6,7)
local day = string.sub(now,9,10)
local hour = string.sub(now,12,13)
local minute = string.sub(now,15,16)
local second = string.sub(now,18,19)

--获取7天前的时间
ta = {
    year=year,
    month=month,
    day=day-7,
    hour=hour,
    min=minute,
    sec=second
}
--2018-05-02 09:50:57
local t = os.date("%Y-%m-%d %H:%M:%S", os.time(ta))


--获取本年2月份的天数
--3月份开头减去1天就是2月份的最后一天
ta = {
    year=year,
    month=3,
    day=0,
}

--28
local days = os.date("%d", os.time(ta))

退出程序

os.exit(0) 结束程序并返回状态码，0代表成功

获取坏境变量

os.getenv("HOME")

执行操作系统命令并返回状态码

os.execute(cmd) 执行操作系统命令并返回状态码，0代表成功，此函数等同于c语言中的system函数

local stat = os.execute('ls -al')

Json库

目前 Lua 也有几个 JSON 库，本人用过 cjson、dkjson。其中 cjson的语法严格(比如 unicode \u002 0\u7eaf )，要求符合规范否则会解析失败(如 \u002)，而 dkjson 相对宽松，当然也可以通过修改 cjson 的源码来完成一些特殊要求。而在使用dkjson 时也没有遇到性能问题，目前使用的就是 dkjson。使用时要特别注意的是大部分 JSON库都仅支持 UTF-8 编码;因此如果你的字符编码是如 GBK 则需要先转换为 UTF-8 然后进行处理。

cjson库

cjson在安装openresty时会自动安装

local cjson = require("cjson")

--lua对象到字符串

local obj = {
    id = 1,
    name = "zhangsan",
    age = nil,
    is_male = false,
    hobby = { "film", "music", "read" }
}

local str = cjson.encode(obj)
ngx.say(str, "
")

--字符串到lua对象
str = '{"hobby":["film","music","read"],"is_male":false,"name":"zhangsan","id":1,"age":null}'
local obj = cjson.decode(str)

ngx.say(obj.age, "
")
ngx.say(obj.age == nil, "
")
ngx.say(obj.age == cjson.null, "
")
ngx.say(obj.hobby[1], "
")

--循环引用
obj = {
    id = 1
}

obj.obj = obj
-- Cannot serialise, excessive nesting
--ngx.say(cjson.encode(obj), "
")
local cjson_safe = require("cjson.safe")
--nil
ngx.say(cjson_safe.encode(obj), "
")

null 将会转换为 cjson.null;

循环引用会抛出异常 Cannot serialise, excessive nesting，默认解析嵌套深度是 1000，可以通过 cjson.encode_max_depth() 设置深度提高性能;使用 cjson.safe 不会抛出异常而是返回 ni l。

返回值

{"hobby":["film","music","read"],"is_male":false,"name":"zhangsan","id":1} null
false
true
film nil

dkjson库

下载

进入lualib目录,不知道lualib是干嘛的话,看一下Nginx中使用安装lua支持篇
cd /usr/example/lualib/
wget http://dkolf.de/src/dkjson-lua.fsl/raw/dkjson.lua?name=16cbc26080996d9da827df42cb0844a25518eeb3 -O dkjson.

代码

默认情况下解析的 json 的字符会有缩排和换行，使用 {indent = true} 配置将把所有内容放在一行。和 cjson 不同的是解析 json 字符串中的 null 时会得到 nil。


local dkjson = require("dkjson")

--lua对象到字符串

local obj = {
    id = 1,
    name = "zhangsan",
    age = nil,
    is_male = false,
    hobby = { "film", "music", "read" }
}

local str = dkjson.encode(obj, { indent = true })
ngx.say(str, "
")

--字符串到lua对象

str = '{"hobby":["film","music","read"],"is_male":false,"name":"zhangsan","id":1,"age":null}'
local obj, pos, err = dkjson.decode(str, 1, nil)

ngx.say(obj.age, "
")
ngx.say(obj.age == nil, "
")
ngx.say(obj.hobby[1], "
")



--循环引用
obj = {
    id = 1 }
obj.obj = obj
--reference cycle
--ngx.say(dkjson.encode(obj), "
")

返回参数

{ "hobby":["film","music","read"], "is_male":false, "name":"zhangsan", "id":1 } 
nil
true
film

编码转换

我们在使用一些类库时会发现大部分库仅支持UTF-8编码，因此如果使用其他编码的话就需要进行编码转换的处理；而Linux上最常见的就是iconv，而lua-iconv就是它的一个Lua API的封装

安装 lua-iconv 可以通过如下两种方式:

ubuntu 下可以使用如下方式:

apt-get install luarocks
luarocks install lua-iconv
cp /usr/local/lib/lua/5.1/iconv.so /usr/example/lualib/

源码安装方式，需要有 gcc 环境:

wget https://github.com/do^Cloads/ittner/lua-iconv/lua-iconv-7.tar.gz
tar -xvf lua-iconv-7.tar.gz
cd lua-iconv-7
gcc -O2 -fPIC -I/usr/include/lua5.1 -c luaiconv.c -o luaiconv.o -I/usr/include gcc -shared -o iconv.so -L/usr/local/lib luaiconv.o -L/usr/lib
cp iconv.so /usr/example/lualib/

1、test_iconv.lua

    ngx.say("中文")

此时文件编码必须为UTF-8，即Lua文件编码为什么里边的字符编码就是什么。

2、example.conf配置文件

    location ~ /lua_iconv {  
       default_type 'text/html';  
       charset gbk;  
       lua_code_cache on;  
       content_by_lua_file /usr/example/lua/test_iconv.lua;  
    }

通过charset告诉浏览器我们的字符编码为gbk。

3、访问 http://192.168.1.2/lua_iconv会发现输出乱码；

此时需要我们将test_iconv.lua中的字符进行转码处理：

local iconv = require("iconv")  
local togbk = iconv.new("gbk", "utf-8")  
local str, err = togbk:iconv("中文")  
ngx.say(str)

通过转码我们得到最终输出的内容编码为gbk，使用方式iconv.new(目标编码, 源编码)。

有如下可能出现的错误：

nil     
    没有错误成功。  
iconv.ERROR_NO_MEMORY  
    内存不足。  
iconv.ERROR_INVALID  
    有非法字符。  
iconv.ERROR_INCOMPLETE  
    有不完整字符。  
iconv.ERROR_FINALIZED  
    使用已经销毁的转换器，比如垃圾回收了。  
iconv.ERROR_UNKNOWN   
    未知错误

iconv在转换时遇到非法字符或不能转换的字符就会失败，此时可以使用如下方式忽略转换失败的字符

local togbk_ignore = iconv.new("GBK//IGNORE", "UTF-8")

另外在实际使用中进行UTF-8到GBK转换过程时，会发现有些字符在GBK编码表但是转换不了，此时可以使用更高的编码GB18030来完成转换。

Lua常用包

Lua常用包

OS模块

Lua文件操作

其他常用文件操作函数

简单模式

完全模式

时间处理

退出程序

获取坏境变量

执行操作系统命令并返回状态码

Json库

cjson库

dkjson库

编码转换

你可能感兴趣的:(Lua常用包)