微信小游戲開發(fā)文檔-小游戲開發(fā)文件系統(tǒng)能力教程

文件系統(tǒng)

微信小游戲文件系統(tǒng)有兩類文件：代碼包文件和本地文件。

文件系統(tǒng)管理接口

通過 wx.getFileSystemManager() 可以獲取到全局唯一的文件系統(tǒng)管理器，所有文件系統(tǒng)的管理操作通過 FileSystemManager 來調(diào)用。

var fs = wx.getFileSystemManager()

代碼包文件

代碼包文件指的是在項目目錄中添加的文件。由于代碼包文件大小限制，代碼包文件適用于放置首次加載時需要的文件，對于內(nèi)容較大或需要動態(tài)替換的文件，不推薦用添加到代碼包中，推薦在小游戲啟動之后再用下載接口下載到本地。

訪問代碼包文件

代碼包文件的訪問方式是從項目根目錄開始寫文件路徑。

修改代碼包文件

代碼包內(nèi)的文件無法在運行后動態(tài)修改或刪除，修改代碼包文件需要重新發(fā)布版本。

本地文件

本地文件指的是小程序被用戶添加到手機后，會有一塊獨立的文件存儲區(qū)域，以用戶維度隔離。即同一臺手機，每個微信用戶不能訪問到其他登錄用戶的文件，同一個用戶不同 appId 之間的文件也不能互相訪問。

本地文件的文件路徑均為以下格式：

{{協(xié)議名}}://文件路徑

其中，協(xié)議名在 iOS/Android 客戶端為 "wxfile"，在開發(fā)者工具上為 "http"，開發(fā)者無需關注這個差異，也不應在代碼中去硬編碼完整文件路徑。

本地臨時文件

本地臨時文件只能通過調(diào)用特定接口產(chǎn)生，不能直接寫入內(nèi)容。本地臨時文件產(chǎn)生后，僅在當前生命周期內(nèi)有效，重啟之后即不可用。因此，不可把本地臨時文件路徑存儲起來下次使用。如果需要下次在使用，可通過 FileSystemManager.saveFile() 或 FileSystemManager.copyFile() 接口把本地臨時文件轉(zhuǎn)換成本地存儲文件或本地用戶文件。

示例

wx.chooseImage({
  success: function (res) {
    var tempFilePaths = res.tempFilePaths // tempFilePaths 的每一項是一個本地臨時文件路徑
  }
})

本地緩存文件

本地存儲文件只能通過調(diào)用特定接口產(chǎn)生，不能直接寫入內(nèi)容。本地緩存文件產(chǎn)生后，重啟之后仍可用。本地緩存文件只能通過 FileSystemManager.saveFile() 接口將本地臨時文件保存獲得。

示例

fs.saveFile({
  tempFilePath: '', // 傳入一個本地臨時文件路徑
  success(res) {
    console.log(res.savedFilePath) // res.savedFilePath 為一個本地緩存文件路徑
  }
})

本地緩存文件是最初的設計，1.7.0 版本開始，提供了功能更完整的本地用戶文件，可以完全覆蓋本地緩存文件的功能，如果不需要兼容低于 1.7.0 版本，可以不使用本地緩存文件。

本地用戶文件

本地用戶文件是從 1.7.0 版本開始新增的概念。我們提供了一個用戶文件目錄給開發(fā)者，開發(fā)者對這個目錄有完全自由的讀寫權限。通過 wx.env.USER_DATA_PATH 可以獲取到這個目錄的路徑。

示例

// 在本地用戶文件目錄下創(chuàng)建一個文件 a.txt，寫入內(nèi)容 "hello, world"
const fs = wx.getFileSystemManager()
fs.writeFileSync(`${wx.env.USER_DATA_PATH}/hello.txt`, 'hello, world', 'utf8')

讀寫權限