FileUtils 文档详细介绍

最新推荐文章于 2025-11-03 03:50:35 发布

转载最新推荐文章于 2025-11-03 03:50:35 发布 · 1.8k 阅读

coco2dx 专栏收录该内容

53 篇文章

订阅专栏

本文详细介绍了游戏开发中FileUtils类的功能与使用方法，包括文件读取、查找、判断及写入等操作，并通过实例展示了如何利用这些功能来创建游戏精灵。

游戏中其实不需要什么复杂的文件读写操作。

而FileUtils类主要的功能：设置加载、保存文件的所在路径。

内容结构：

1、文件读取

getDataFromFile、getStringFromFile、getFileDataFromZip

2、文件查找

文件字典(Dictionary)、搜索路径(SearchPaths)、子区分路径(SearchResolutionsOrder)

fullPathForFilename、fullPathFromRelativeFile

3、文件判断

isFileExist、isAbsolutePath、PopupNotify

4、文件写入

getWritablePath、UserDefault、RenderTexture

5、文件查找的应用

举例：精灵的创建

【FileUtils】

0、获取单例对象

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

//

    static FileUtils* getInstance();   //获得单例对象

    static void destroyInstance();     //释放单例对象资源

    virtual void purgeCachedEntries(); //清理文件查找缓存

//

1、文件读取

> getDataFromFile

> getStringFromFile

> getFileDataFromZip

//

    //读取文件内容.

    virtual Data getDataFromFile(const std::string& filename);          //数据.     返回: data

    virtual std::string getStringFromFile(const std::string& filename); //数据内容. 返回: data.getBytes()

    //读取zip中某资源文件的内容

    // 
 [in]    zip文件路径 , 相对zip的文件路径

    // 
 [out]   size. 若文件读取成功，这个值为数据大小，否则为零

    // 
 如果成功，则返回数据指针，否则返回 nullptr.

    virtual unsigned char* getFileDataFromZip(const std::string& zipFilePath, const std::string& filename, ssize_t *size);

//

2、文件查找

2.1、设置文件查找路径

> 文件字典（Dictionary）

> 搜索路径（SearchPaths）

> 子区分路径（SearchResolutionsOrder）

具体用法见下面的 2.3 。

//

    //设置文件词典. 相当于给文件起别名

    //map["sprite.png"] = "sp.png"

    virtual void setFilenameLookupDictionary(const ValueMap& filenameLookupDict);

    virtual void loadFilenameLookupDictionaryFromFile(const std::string &filename); //plist加载文件词典

    //设置搜索路径(可以是绝对路径、相对路径)

    virtual void setSearchPaths(const std::vector<std::string>& searchPaths); //清除之前add的全部搜索路径（除了默认路径"Resources"）

    void addSearchPath(const std::string & path, const bool front=false);

    virtual const std::vector<std::string>& getSearchPaths() const;

    //设置子区分路径

    virtual void setSearchResolutionsOrder(const std::vector<std::string>& searchResolutionsOrder); //清除之前add的全部子区分路径

    virtual void addSearchResolutionsOrder(const std::string &order,const bool front=false);

    virtual const std::vector<std::string>& getSearchResolutionsOrder();

//

2.2、查找文件

> fullPathForFilename

> fullPathFromRelativeFile

当然查找之前，先判断filename是否存在文件字典，若有将替换。

//

    //获取文件的完整路径（绝对路径）

    //注意: 查找的是文件 , 而不是文件夹

    virtual std::string fullPathForFilename(const std::string &filename);

    //路径拼接

    //relativeFile.substr(0, relativeFile.rfind('/')+1) + getNewFilename(filename);

    virtual std::string fullPathFromRelativeFile(const std::string &filename, const std::string &relativeFile);

//

请注意fullPathFromRelativeFile的用法：

（1）保留relativeFile最后一个'/'前面的路径（如："xyz/123"）

（2）通过文件字典替换filename（如："sprite.png" -> "sp.png"）

（3）路径拼接："xyz/sp.png"

（4）若relativeFile = "xyz/123/"，则路径拼接："xyz/123/sp.png"

2.3、举例

//

    map["sprite.png"] = "bg.png";

    void        setFilenameLookupDictionary(map);    //设置字典

    void        setSearchPaths("C:/Res/xyz", "xyz"); //设置搜索路径

    void        setSearchResolutionsOrder("1", "2"); //设置子区分路径

    std::string fullPathForFilename("sprite.png");   //获取完整路径

//

查找过程：

查找 "sprite.png"

（1）先根据字典替换别名 "sprite.png" --> "bg.png"

（2）然后查找"bg.png"（若无字典，直接查找"sprite.png"）

（3）按以下顺序查找，并返回"sprite.png"的完整路径（如"C:/Res/xyz/bg.png"）。

（4）若未找到，返回"sprite.png"

C:/Res/xyz/1/bg.png

C:/Res/xyz/2/bg.png

C:/Res/xyz/bg.png

C:/projects/MyGame/Resources/xyz/1/bg.png

C:/projects/MyGame/Resources/xyz/2/bg.png

C:/projects/MyGame/Resources/xyz/bg.png

C:/projects/MyGame/Resources/1/bg.png

C:/projects/MyGame/Resources/2/bg.png

C:/projects/MyGame/Resources/bg.png

注意：若找不到"bg.png"。即使"C:/Res/xyz/"路径下存在"sprite.png"，也显示找不到。

3、文件判断

> isFileExist

> isAbsolutePath

> PopupNotify

//

    //检查文件是否存在(相对路径、绝对路径，都可以)

    virtual bool isFileExist(const std::string& filename) const;

    //检查路径是不是绝对路径

    //在Android平台上，若path是相对于"assets/"，该方法会把它当成绝对路径true

    virtual bool isAbsolutePath(const std::string& path) const;

    //设置图片加载失败时,是否弹出消息框

    virtual void setPopupNotify(bool notify);

    virtual bool isPopupNotify();

//

4、文件写入

4.1、获取写入路径

写入路径一般无法修改。

//

    virtual std::string getWritablePath() const = 0;

//

不同的平台,文件写入的路径不同，如：

> Win32 ：在exe文件所在的目录。（如“proj.win32/Debug.win32/”）

> Andriod："/data/data" 目录。

> IOS ："document folder" 目录。

4.2、写入文件的方法

可以通过以下两个类来保存游戏的数据：

> UserDefault ：用于保存游戏中的用户数据。

> RenderTexture：用于保存游戏中创建的图片数据。

具体操作，请学习UserDefault、RenderTexture两个类。

5、文件查找的应用（精灵的创建）

精灵的创建需要一张图片资源，而图片资源是从哪里来的呢？

> 创建sprite的过程中，首先会调用fullPathForFilename("sprite.png")。

> 先查找图片所在路径，然后根据图片来创建sprite精灵。

如果不设置文件查找的路径的话，Win32项目默认会在"Resources"中查找图片，而Android项目默认会在"assets"中查找资源图片。

在这里还是通过 2.3 中的例子分析：

//

    map["sprite.png"] = "bg.png";

    void         setFilenameLookupDictionary(map);    //设置字典

    void         setSearchPaths("C:/Res/xyz", "xyz"); //设置搜索路径

    void         setSearchResolutionsOrder("1", "2"); //设置子区分路径

    Sprite* sp = Sprite::create("sprite.png");        //创建精灵

//