Cocos2d-x 文件工具类

Cocos2dx 3.0+

FileUtils 单例对象

FileUtils是一个单例类，可通过getInstance()获取单例对象。

1. 获取文件工具类单例对象

-- 获取共享实例的类
static FileUtils* getInstance()

-- 示例：quick-cocos2dx
local fileUtils = cc.FileUtils:getInstance()

2. 释放单例对象资源

static void destroyInstance()

3. 清理文件查找缓存

virtual void purgeCachedEntries()

文件读取

1. 读取文件内容

-- 读取文件内容并返回数据
virtual Data getDataFromFile(const std::string& filename)

virtual std::string getStringFromFile(const std::string& filename)
-- 读取文件内容并返回数据内容，data.getBytes() 获取数据。
-- 示例
local fileUtil = cc.FileUtil:getInstance()
local fileContent = fileUtil:getStringFromFile('text.txt')
print(fileContent)

-- 读取zip中资源文件内容
-- [in] zipFilePath zip文件路径即相对zip的文件路径
-- [out] size 若文件读取成功则获取数据的大小，否则为0.
-- 读取成功返回数据指针，否则返回nullptr。
virtual unsigned char* getFileFromZip(
  const std::string& zipFilePath, 
  const std::string& filename,
  ssize_t *size
)

-- fullPathForFilename
-- 访问res目录，若文件存在在res目录下，则需添加搜索目录。
local file = cc.FileUtils:getInstance():fullPathForFilename('test.txt')

-- isFileExist(arg)
-- 判断文件是否存在
local isExist = cc.FileUtils:getInstance():isExist('text.txt')

-- getWritablePath
-- 可写入目录
local writablePath = cc.FileUtils:getInstance():getWritablePath()

-- 判断文件是否存在
local function fileExists(file)
  local fileUtils = cc.FileUtils:getInstance()
  local isExist = fileUtils:isFileExist(file)
  if isExists==true then
    local filename = fileUtils:fullPathForFilename(file)
    -- return filename
    print('exists')
  else
    -- return false
    print('fail')
  end
end

2. 文件查找

-- 设置文件查找路径

当文件加载失败是否弹出messagebox

-- 当文件加载失败是否淡出消息
void setPopupNotify(bool notify)

-- 示例：quick-cocos2dx
local fileUtils = cc.FileUtils:getInstance()
fileUtils:setPopupNotify(false)

异常处理

Lua中异常处理分为pcall、xpcall、debug，若需在Lua中处理错误，必须使用 pcall(protected call) 来包装所需执行的代码。

1. pcall

if pcall(fname, args...) then
  return true
else
  return false
end

pcall接收一个函数和所要传递给函数的参数，并执行函数，函数执行有错误则返回true，无错误则返回false。

pcall以一种保护模式来调用第一个参数，因此pcall可以捕获函数执行中的任何错误。

2. xpcall

通常在错误发生时，希望获得更多的调试信息，而不只是发生错误的位置。pcall返回时已经销毁了调用栈的部分内容。

Lua提供了xpcall，接收第二个参数，即一个错误处理函数。当错误发生时，Lua会在调用栈展看 unwind 前调用错误处理函数，于是可以在xpcall中使用debug库来获取关于错误的额外信息。

3. debug

debug库提供了两个通用的错误处理函数：

debug.debug 提供一个Lua提示符，让用户来获取错误的原因。
debug.traceback 根据调用栈来构建一个可扩展的错误信息

加载模块

1. require(modName)

require 会加载给定的模块，首先检查表package.loaded来判定模块是否已经存在。若存在则加载返回package.loaded[modName]所存储的值，否则尝试为模块找到一个加载器。

要找到一个加载器，require首先查询package.preload[modName]，若有值且是一个函数则断定就是一个加载。若没有值require使用package.path中存储的路径查找一个Lua的加载器。若该查找也失败，则使用package.cpath中存储的路径查找一个C语言加载，若仍然失败则尝试使用all-in-one加载器。

当加载一个C语言库时，require首先使用动态链接工具将应用程序与库连接起来，之后尝试找到该库中的C函数，该函数要被当做加载器使用。这个C函数的名字是字符串luaopen_连接着复制的模块名。此外，若模块名称中函数连字符-，则第一个连字符的前缀包括连字符都会被移除。

若require既没有为模块查找到一个Lua库，也没有为模块找到一个C库，它将调用all-in-one加载器。该加载器为给定模块的根名称，查找C路径并找到对应的库。

一旦找到一个加载器，require会使用单个参数modName调用加载器。若加载器返回任何值，则require会将其赋值给package.loaded[modName]。若加载器无返回值且没有给package.loaded[modName]赋与任何值，则require为该条目赋值为true。无论如何，require返回package.loaded[modName]的最终值。

若加载或运行模块有任何错误或不能为模块寻找一个加载器，则require会发出一个错误信号。

2. LuaLoadChunksFromZIP

require 和 LuaLoadChunksFromZIP 的区别：

require 加载包的顺序是 package.loaded、package.preload...
LuaLoadChunksFromZIP 会解压包并加载数据到内存中，可在package.preload中查看使用LuaLoadChunksFromZIP加载的包package。

若加载到内存中的包，使用require就只能是完全能对应的包名，但若是文件的话可以在package.path中查找。

Cocos2d-x 文件工具类