跳转至

文件系统(io)

一、文件系统（io）的概述

Air780EP 模组的文件系统为用户代码运行过程中动态创建的文件提供了存储空间。这个空间被称为文件系统分区，总空间为 288KB，其中系统配置占用约 44KB，因此用户可用空间约为 244KB。用户可以在这个空间内创建、读取、写入和删除文件，以支持模组在各种应用场景中的需求。

三、准备硬件环境

参考：硬件环境清单第二章节内容，准备以及组装好硬件环境。

四、软件环境

“凡事预则立，不预则废。”在详细阐述本功能示例之前，我们需先精心筹备好以下软件环境。

1. Luatools工具；

2. 内核固件文件（底层core固件文件）：LuatOS-SoC_V2002_Air780EP；参考项目使用的内核固件；

3. luatos需要的脚本和资源文件

lib脚本文件：使用Luatools烧录时，勾选 添加默认lib 选项，使用默认lib脚本文件；

准备好软件环境之后，接下来查看如何烧录项目文件到Air780EP核心板，将本篇文章中演示使用的项目文件烧录到Air780EP核心板中。

四、文件系统（io）基本用法

4.1 本教程实现的功能定义：

  • 此次 demo 验证文件创建、文件追加、文件删除、文件重命名、文件拷贝、文件移动、文件大小、文件枚举的函数接口的介绍和使用。

4.2 文章内容引用

4.3 文件创建

文件创建是指新建一个空文件或向一个不存在的文件路径写入内容，从而生成该文件。

使用例子：

-- 方法1：使用io.open创建空文件（如果文件已存在，则覆盖）  
local fd = io.open("/newfile.txt", "w")  
if fd then
  -- 文件已成功创建（或覆盖），此时文件为空    
  fd:close()   
  log.info("文件创建成功（空文件）")  
else  
  log.error("文件创建失败")  
end  
-- 方法2：通过写入内容创建文件  
local content = "这是文件的内容"  
local fd = io.open("/newfile_with_content.txt", "w")  
if fd then    
  fd:write(content)   
  fd:close()    
  log.info("文件创建成功并写入内容")  
else    
  log.error("文件创建失败")  
end

注：

  • 使用 io.open 函数并传入文件路径和模式（如 "w" 表示写模式）来创建文件。如果文件已存在，写模式会覆盖原有内容。
  • 创建文件后，务必使用 :close 方法关闭文件，以确保数据正确写入并释放资源。
  • 可以通过写入内容来同时创建文件并填充数据。
  • 常见问题：
  • 文件创建失败：可能由于路径不存在、权限不足或磁盘空间不足等原因。
  • 文件内容未写入：可能是因为文件未正确关闭或写入过程中发生错误。

4.4 文件追加

文件追加是指在文件的末尾添加内容，而不覆盖原有内容。如果文件不存在，追加模式会自动创建文件。

使用例子：

log.info("-------------------文件追加---------------")  
-- 打开文件以追加模式  
local fd = io.open("/data/newfile_with_content.txt", "rb")  
if fd then    
  local data_old = fd:read("*a")
  log.info("文件创建初始内容：",data_old) 
  -- 关闭文件
  fd:close()
  local fd1 = io.open("/data/newfile_with_content.txt", "a")
  -- 写入内容
  fd1:write("我是追加的内容\n")
  -- 关闭文件 
  fd1:close()
  local fd2 = io.open("/data/newfile_with_content.txt", "rb")
  local data_new = fd2:read("*a")
  log.info("文件追加之后的内容：",data_new) 
  -- 关闭文件
  fd2:close() 
end

注：使用 io.open 函数以 "a" 模式打开文件，然后使用 :write 方法写入内容，最后使用 :close 方法关闭文件。

4.5 文件删除

文件删除是指从文件系统中移除指定的文件。无法删除只读文件或不存在的文件。

使用例子：

-- 删除文件  
local success, err = os.remove("/destination/source.txt")  
if success then   
  log.info("文件删除成功")  
else 
  log.error("文件删除失败：" .. err)  
end

注 ：使用 os.remove 函数并传入文件路径来删除文件。函数返回两个值：成功时为 true，失败时为 nil 和错误原因字符串。

4.6 文件重命名

文件重命名是指将文件从一个名称更改为另一个名称，无法重命名只读文件或跨文件系统重命名文件，可以确保新文件路径所在的目录存在，以避免重命名失败。

使用例子：

("----------------命名文件---------------")  
-- 重命名文件  
local success, err = os.rename("/data/newfile_with_content.txt", "/data/newname.txt")  
if success then    
  log.info("文件重命名成功")  
else
  log.error("文件重命名失败：" .. err)  
end

注：使用 os.rename 函数并传入旧文件路径和新文件路径来重命名文件。函数返回两个值：成功时为 true，失败时为 nil 和错误原因字符串。

4.7 文件拷贝

文件拷贝是指将文件的内容从一个位置复制到另一个位置。

使用例子（注意：LuatOS 标准 API 未直接提供文件拷贝函数，但可以通过读取源文件并写入目标文件来实现）：

log.info("----------------文件拷贝---------------")  
---文件拷贝
-- 读取源文件内容  
local fd_src = io.open("/data/newname.txt", "rb")  
if fd_src then   
  local content = fd_src:read("*a")    
  fd_src:close()    
-- 写入目标文件  
  local fd_dest = io.open("/data/destination.txt", "wb")  
  if fd_dest then      
    fd_dest:write(content)     
    fd_dest:close()     
    log.info  ("文件拷贝成功") 
  else     
    log.error("无法打开目标文件") 
  end  
else 
  log.error("无法打开源文件")  
end

注：通过读取源文件内容并将其写入目标文件来实现文件拷贝。

4.8 文件移动

文件移动是指将文件从一个位置移动到另一个位置，这通常通过重命名文件（如果目标位置在同一文件夹）或先拷贝再删除源文件来实现。

使用例子（注意：LuatOS 标准 API 未直接提供文件移动函数，但可以通过重命名或拷贝 + 删除来实现）：

log.info("----------------移动文件---------------")  
local ret, errio = io.mkdir("/destination/")
if ret then     
  log.info  ("文件夹创建成功")  
else      
  log.error("文件夹创建失败")  
end
-- 移动文件：重命名（适用于同一文件系统）  
local success, err = os.rename("/data/newname.txt", "/destination/source.txt")  
if success then 
  log.info  ("文件移动成功（重命名）")  
else
  log.error("文件移动失败（重命名）：" .. err)  
end

注：根据目标位置与源文件位置的关系，选择重命名或拷贝 + 删除的方法来实现文件移动。

4.9 文件大小

获取文件的大小（以字节为单位）。

使用例子：

-- 获取文件大小  
local size = io.fileSize("/data/newname.txt")  
if size then
  log.info("文件大小：" .. size .. " 字节")  
else
  log.error("无法获取文件大小")  
end

注：使用 io.fileSize 函数并传入文件路径来获取文件大小。函数返回一个整数表示文件大小（以字节为单位），如果失败则返回 nil。

4.10 文件枚举

列出指定目录下的所有文件。

使用例子：

local ret, data = io.lsdir("/data/",10,0)  
if ret then
   log.info("fs", "lsdir", json.encode(data))
else
   log.info("fs", "lsdir", "fail", ret, data)
end

注：使用 io.lsdir 函数并传入目录路径来列出该目录下的所有文件。函数返回两个值：成功时为 true 和一个包含文件名的数组，失败时为 nil 和错误信息。

五、文件系统整体演示

5.1 成果演示与深度解析：视频 + 图文全面展示

5.1.1 成果运行精彩呈现

5.1.2 演示视频生动展示

5.1.3 完整实例深度剖析

-- main.lua文件
-- LuaTools需要PROJECT和VERSION这两个信息
PROJECT = "文件系统（io）_demo"
VERSION = "1.0.0"

log.info("---------------------文件创建---------------")  
local ret, errio = io.mkdir("/data/")
if ret then       
  log.info("文件夹创建成功")   
else       
  log.error("文件夹创建失败")  
end
--[[
-- 方法1：使用io.open创建空文件（如果文件已存在，则覆盖）  
local fd = io.open("/newfile.txt", "w")  
if fd then
  -- 文件已成功创建（或覆盖），此时文件为空  fd:close()    log.info("文件创建成功（空文件）")  
else   log.error("文件创建失败")  
end  
]]
-- 方法2：通过写入内容创建文件  

log.info("---------------------文件创建---------------")  

local content = "这是文件的内容"  
local fd = io.open("/data/newfile_with_content.txt", "w")  
if fd then    
  fd:write(content)   
  fd:close()    
  og.info("文件创建成功并写入内容")  
else    
  log.error("文件创建失败")  
end

log.info("-------------------文件追加---------------")  
-- 打开文件以追加模式  
local fd = io.open("/data/newfile_with_content.txt", "rb")  
if fd then    
local data_old = fd:read("*a") log.info("文件创建初始内容：",data_old) 
-- 关闭文件 
fd:close()
local fd1 = io.open("/data/newfile_with_content.txt", "a")
--写内容 
fd1:write("我是追加的内容\n")
-- 关闭文件
fd1:close()
local fd2 = io.open("/data/newfile_with_content.txt", "rb")
local data_new = fd2:read("*a") log.info("文件追加之后的内容：",data_new) 
-- 关闭文件 
fd2:close() 
end

log.info("----------------命名文件---------------")  
-- 重命名文件  
local success, err = os.rename("/data/newfile_with_content.txt", "/data/newname.txt")  
if success then    
  log.info("文件重命名成功")  
else 
  log.error("文件重命名失败：" .. err)  
end
log.info("----------------文件拷贝---------------")  
---文件拷贝
-- 读取源文件内容  
local fd_src = io.open("/data/newname.txt", "rb")  
if fd_src then    
  local content = fd_src:read("*a")    
  fd_src:close()    
  -- 写入目标文件   
  local fd_dest = io.open("/data/destination.txt", "wb")    
  if fd_dest then       
    fd_dest:write(content)       
    fd_dest:close()      
    log.info("文件拷贝成功")   
  else       
    log.error("无法打开目标文件")   
  end  
else  
  log.error("无法打开源文件")  
end
log.info("----------------移动文件---------------")  
local ret, errio = io.mkdir("/destination/")
if ret then      
  log.info("文件夹创建成功")   
else       
  log.error("文件夹创建失败")  
end

-- 移动文件：重命名（适用于同一文件系统）  
local success, err = os.rename("/data/newname.txt", "/destination/source.txt")  
if success then   
  log.info("文件移动成功（重命名）")  
else 
  log.error("文件移动失败（重命名）：" .. err)  
end  

-- 获取文件大小  
local size = io.fileSize("/data/newname.txt")  
if size then 
  log.info("文件大小：" .. size .. " 字节")  
else 
  log.error("无法获取文件大小")  
end

-- 列出目录下的文件  

local ret, data = io.lsdir("/data/",10,0)  
if ret then
   log.info("fs", "lsdir", json.encode(data))
 else
   log.info("fs", "lsdir", "fail", ret, data)
 end

-- 删除文件  
local success, err = os.remove("/destination/source.txt")  
if success then   
  log.info("文件删除成功")  
else   
  log.error("文件删除失败：" .. err)  
end

六、总结

  • 在 Lua 编程语言中，文件系统操作主要通过 io 库来实现。io 库提供了一系列函数，用于文件的打开、读取、写入、关闭以及目录的遍历等操作。
  • 首先，io 库提供了两种文件处理接口风格：隐式文件句柄和显式文件句柄。隐式文件句柄通过 io 表提供的函数进行操作，而显式文件句柄则通过 io.open 函数返回的文件句柄对象的方法进行操作。
  • 在文件打开方面，io.open 函数是关键，它接受文件名和模式作为参数，并返回一个文件句柄对象。文件模式包括只读（"r"）、只写（"w"）、追加（"a"）等，还可以加上"b"来表示二进制模式。如果文件打开失败，io.open 函数会返回 nil 和错误信息。
  • 文件读取操作主要通过文件句柄对象的 read 方法来实现。read 方法可以接受不同的参数来读取文件的不同部分，如读取下一行、读取整个文件等。
  • 文件写入操作则通过文件句柄对象的 write 方法来实现。write 方法将字符串或数字写入文件。如果文件以只读模式打开，则无法进行写入操作。
  • 完成文件操作后，应使用文件句柄对象的 close 方法关闭文件，以释放系统资源。
  • 此外，io 库还提供了一些其他有用的函数，如 io.input 和 io.output，它们可以设置默认的输入输出文件，使得后续的输入输出操作都针对这些默认文件。io.lines 函数则返回一个迭代器，用于从文件中逐行读取内容。
  • 需要注意的是，虽然 io 库提供了强大的文件系统操作功能，但在进行文件操作时仍需谨慎，以避免文件损坏或数据丢失等风险。同时，对于跨文件系统的文件移动等操作，可能需要结合其他函数或方法来实现。

七、常见问题：

7.1 文件操作失败时如何定位问题？

  • 检查文件路径是否正确。
  • 确认文件是否存在且可访问。
  • 检查磁盘空间是否充足。
  • 查看错误日志以获取更多信息。

7.2 如何提高文件操作的效率？

  • 对于大文件操作，可以考虑使用流式处理或分块处理来减少内存占用。
  • 使用合适的文件打开模式（如只读、只写等）以减少不必要的操作。

八、扩展

  • 文件加密与解密：可以结合加密库对文件进行加密存储和解密读取，以提高数据的安全性。
  • 文件备份与恢复：可以定期将文件备份到外部存储设备或云存储中，并在需要时恢复文件。
  • 文件系统监控：可以监控文件系统的变化（如文件创建、删除、修改等），以便及时响应和处理。

给读者的话

本篇文章由永仔开发；

本篇文章描述的内容，如果有错误、细节缺失、细节不清晰或者其他任何问题，总之就是无法解决您遇到的问题；

请登录合宙技术交流论坛，点击文档找错赢奖金-Air780EP-LuatOS-软件指南-基础服务-文件系统；

用截图标注+文字描述的方式跟帖回复，记录清楚您发现的问题；

我们会迅速核实并且修改文档；

同时也会为您累计找错积分，您还可能赢取月度找错奖金！