lua文件操作详解

Lua文件操作：两种调用方式，一次讲透

Lua的I/O库其实只提供了两种文件处理路径，但很多新手会在两者之间犯迷糊。一种是通过io表来操作，另一种是直接操作文件句柄。先说结论：前者适合快速读写，后者适合精细控制。两者的核心区别在于——你用io.open拿到一个文件描述后，后续所有操作都是围绕这个描述进行的；而io表本身还预置了三个默认文件描述：io.stdin、io.stdout、io.stderr。多数I/O函数在调用失败时会返回nil外加错误信息，有些函数成功时反而返回nil，这得特别留意。

io表调用方式

使用io.open打开文件，拿到文件句柄后，所有的读写都围绕这个句柄展开。而io表自带的三个预定义句柄——io.stdin、io.stdout、io.stderr——可以直接用于输入输出，省去手动打开的步骤。

文件句柄直接调用方式

也就是用file:XXX()的形式进行调用，这里的file就是io.open()返回的文件句柄。这种写法更直观，也更容易控制资源的生命周期。

IO核心函数全解析

io.close ([file])
关闭文件。如果不传参数，则关闭默认输出文件。

io.flush ()
相当于file:flush()，把缓冲区里所有内容强制写入默认输出文件。这在需要确保数据即时落盘时非常有用。

io.lines ([filename])
打开指定文件为读模式，返回一个迭代函数。每次调用迭代函数，会返回文件中的一行内容；读到文件尾时返回nil，并自动关闭文件。如果不带参数，io.lines()等价于io.input():lines()，从默认输入设备读取内容，但结束时不自动关闭文件。来看一个典型用法：

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

io.open (filename [, mode])
这是最常用的函数。参数mode决定了打开方式：

• "r"：读模式，默认值。
• "w"：写模式，会清空文件。
• "a"：追加模式，从文件尾开始写。
• "r+"：更新模式，保留原有数据。
• "w+"：更新模式，但会清除原有数据。
• "a+"：追加更新模式，保留原有数据，只允许在文件尾添加。
• "b"：二进制模式，某些系统下需要加上这个标志。

io.read (...)
按格式读取输入。后面在file:read部分会详细说明格式。

io.type (obj)
检测一个对象是否为可用的文件句柄。返回值有三种：

• "file"：表示一个打开的文件句柄。
• "closed file"：表示一个已关闭的文件句柄。
• nil：表示根本不是文件句柄。

io.write (...)
相当于io.output():write(...)，向默认输出文件写入内容。

File对象的方法

file:close()
关闭文件句柄。需要注意的是，当文件句柄被垃圾回收时，文件也会自动关闭，但此时句柄会变成一个不可预知的值，所以最好显式调用close。

file:flush()
把缓冲区中所有数据写入文件。在写文件时，如果不调用flush，数据可能还留在内存里没真正落盘。

file:lines()
返回一个迭代函数，用法和io.lines类似，但不会自动关闭文件。每次调用返回文件中的一行，到文件尾返回nil。

for line in file:lines() do
  -- 处理每一行
end

file:read(...)
按指定格式读取文件。每个格式返回一个字符串或数字；如果无法正确读取则返回nil；不指定格式时默认按行读取。支持的格式：

• "n"：读取一个数字。
• "a"：从当前位置读取整个文件，如果已是文件尾则返回空字符串。
• "l"：默认值，读取下一行，文件尾时返回nil。
• number：读取指定字节数的字符，如果已是文件尾则返回nil；若数字为0则返回空字符串。

file:seek([whence] [, offset])
设置或获取当前文件位置。成功返回最终位置（按字节），失败返回nil加错误信息。参数whence有三种：

• "set"：从文件头开始计算。
• "cur"：从当前位置开始（默认）。
• "end"：从文件尾开始。

offset默认为0。不带参数调用file:seek()返回当前位置；file:seek("set")定位到文件头；file:seek("end")定位到文件尾并返回文件大小。这个函数常用于计算文件长度或实现随机读写。

file:write(...)
按指定参数向文件写入内容。参数必须是字符串或数字。如果需要写入其他类型，得先用tostring或string.format转换。

实战：四个常用函数封装

下面这几个函数在实际项目中几乎每天都会用到，直接拿过去用就行。

读取文件所有内容

function readfile(path)
  local file = io.open(path, "r")
  if file then
    local content = file:read("*a")
    io.close(file)
    return content
  end
  return nil
end

写入内容到文件

function writefile(path, content, mode)
  mode = mode or "w+b"
  local file = io.open(path, mode)
  if file then
    if file:write(content) == nil then return false end
    io.close(file)
    return true
  else
    return false
  end
end

获取文件大小

-- @return : 文件字节数
function filesize(path)
  local size = false
  local file = io.open(path, "r")
  if file then
    local current = file:seek()
    size = file:seek("end")
    file:seek("set", current)
    io.close(file)
  end
  return size
end

检查文件是否存在

function fileExists(path)
  local file = io.open(path, "r")
  if file then
    io.close(file)
    return true
  end
  return false
end

以上这些就是Lua I/O库最核心的内容。实际开发中，只要记住两条：一是分清io表和句柄调用的差异，二是记得及时关闭文件句柄，基本就不会出大问题。