Expo大做戰(三十八)--expo sdk api之 FileSystem(文件操做系統)

 

簡要:本系列文章講會對expo進行全面的介紹,本人從2017年6月份接觸expo以來,對expo的研究斷斷續續,一路走來將近10個月,廢話很少說,接下來你看到內容,講所有來與官網html

我猜去所有機翻+我的修改補充+demo測試的形式,對expo進行一次大補血!歡迎加入expo興趣學習交流羣:597732981react

【以前我寫過一些列關於expo和rn入門配置的東i西,你們能夠點擊這裏查看:從零學習rn開發git

相關文章:github

Expo大做戰(一)--什麼是expo,如何安裝expo clinet和xde,xde如何使用數據庫

Expo大做戰(二)--expo的生命週期,expo社區交流方式,expo學習必備資源,開發使用expo時關注的一些問題json

Expo大做戰(三)--針對已經開發過react native項目開發人員有針對性的介紹了expo,expo的侷限性,開發時項目選型注意點等react-native

Expo大做戰(四)--快速用expo構建一個app,expo中的關鍵術語api

Expo大做戰(五)--expo中app.json 文件的配置信息微信

Expo大做戰(六)--expo開發模式,expo中exp命令行工具,expo中如何查看日誌log,expo中的調試方式網絡

Expo大做戰(七)--expo如何使用Genymotion模擬器

Expo大做戰(八)--expo中的publish以及expo中的link,對link這塊東西沒有詳細看,你們能夠來和我交流

更多>>

寫在二十三章之後的話,以前的翻譯,無論如何,好與很差,終究是告一段落,也把expo基礎理論的東西又深刻的理解了一遍,後續expo大做戰系列將主要介紹expo sdk的api。


文件系統

提供對本地存儲在設備上的文件系統的訪問。每一個Expo應用程序都有獨立的文件系統,沒法訪問其餘Expo應用程序的文件系統。該API將file:// URI指向設備上的本地文件以識別文件。每一個應用程序只能讀取和寫入如下目錄下的位置:

Expo.FileSystem.documentDirectory

file:// URI指向將存儲此應用程序的用戶文檔的目錄。存儲在這裏的文件將保留直到被應用程序明確刪除。尾隨/。示例用途用於用戶保存的文件,以便他們再次看到。

Expo.FileSystem.cacheDirectory

file:// URI指向存儲此應用程序使用的臨時文件的目錄。存儲空間不足時,此處存儲的文件可能會被系統自動刪除。示例用途用於應用程序只須要一次性使用的下載或生成的文件。

所以,例如,應用程序用戶文檔目錄中「myDirectory」下名爲「myFile」的文件的URI將爲Expo.FileSystem.documentDirectory +'myDirectory / myFile'。

建立文件的Expo API一般在這些目錄中運行。這包括音頻錄製,相機照片,ImagePicker結果,SQLite數據庫和takeSnapShotAsync()結果。這容許它們與FileSystem API一塊兒使用。

某些FileSystem功能能夠讀取(但不寫入)其餘位置。目前Expo.FileSystem.getInfoAsync()和Expo.FileSystem.copyAsync()可以從React Native中的CameraRoll.getPhotos()返回的URI中讀取。

Expo.FileSystem.getInfoAsync(fileUri,options)
獲取關於文件或目錄的元數據信息。

參數
fileUri(string) - file://指向文件或目錄的URI,或CameraRoll.getPhotos()返回的URI。

options(object) - 選項圖:

  • md5(boolean) - 是否返回文件的MD5哈希值。默認爲false。
  • size(boolean) - 若是在來自CameraRoll.getPhotos()的源文件上操做,是否包含文件的大小(例如,若是文件存儲在iCloud中,則跳過這能夠防止下載文件)。大小老是返回file://locations。

返回
若是此URI不存在項目,則返回{exists:false,isDirectory:false}。不然返回包含如下字段的對象:

  • exists(boolean) - true。
  • isDirectory(boolean) - 若是這是一個目錄,則爲true;若是是文件,則爲false
  • modificationTime (number)  - 自紀元以來以秒爲單位表示的文件的最後修改時間。
  • size (number)  - 文件的大小(以字節爲單位)。若是在來自CameraRoll.getPhotos()的源上進行操做,則僅在尺寸選項很是真實時才存在。
  • uri (string)  - 指向文件的file:// URI。這與fileUri輸入參數相同。
  • md5 (string)  - 若是md5選項真的存在,則顯示。包含文件的MD5哈希。

Expo.FileSystem.readAsStringAsync(fileURI)
以字符串形式讀取文件的所有內容。

參數
fileUri(string) - 文件://文件或目錄的URI。

返回
包含文件所有內容的字符串。

Expo.FileSystem.writeAsStringAsync(fileUri,contents)
以字符串形式寫入文件的所有內容。

參數
fileUri(string) - file://文件或目錄的URI。

contents(string) - 用來替換文件內容的字符串。

Expo.FileSystem.deleteAsync(fileUri,options)
刪除文件或目錄。若是URI指向一個目錄,則該目錄及其全部內容將被遞歸刪除。

參數
fileUri(string) - file://文件或目錄的URI。

options(object) - 選項圖:

  • idempotent(boolean) - 若是爲true,則在此URI沒有文件或目錄時不要拋出錯誤。默認爲false。

Expo.FileSystem.moveAsync(options)
將文件或目錄移動到新位置。

參數
options(object) - 選項圖:

  • from (string)  - file:// URI到原始位置的文件或目錄。
  • to (string)  - file:// URI指向文件或目錄,該文件或目錄應該是其新位置。

Expo.FileSystem.copyAsync(options)
建立文件或目錄的副本。目錄以其全部內容遞歸複製。

參數
options(object) - 選項圖:

from(string) - file:// URI複製到要複製的文件或目錄,或由CameraRoll.getPhotos()返回的URI。

to(string) - 要建立的新副本的file:// URI。

Expo.FileSystem.makeDirectoryAsync(fileUri,options)
建立一個新的空目錄。

參數
fileUri(string) - file://建立新目錄的URI。

options(object) - 選項圖:

  • intermediates(boolean) - 若是爲true,則在fileUri上建立目錄時建立任何不存在的父目錄。若是爲false,則在任何中間父目錄不存在時引起錯誤。默認爲false。

Expo.FileSystem.readDirectoryAsync(fileURI)
枚舉目錄的內容。

參數
fileUri(string) - file://目錄的URI。

返回
一串字符串,每一個字符串都包含文件或目錄名稱

Expo.FileSystem.downloadAsync(uri,fileUri,options)
將遠程URI處的內容下載到應用程序文件系統中的文件中。

FileSystem.downloadAsync(
  'http://techslides.com/demos/sample-videos/small.mp4',
  FileSystem.documentDirectory + 'small.mp4'
)
  .then(({ uri }) => {
    console.log('Finished downloading to ', uri);
  })
  .catch(error => {
    console.error(error);
  });

參數
url(string) - 要從其下載的遠程URI。

fileUri(string) - 要下載到的文件的本地URI。若是此URI沒有文件,則會建立一個新文件。若是這個URI有一個文件,它的內容將被替換。

options(object) - 選項圖:

  • md5(boolean) - 若是爲true,則在返回的對象中包含文件的MD5哈希。默認爲false。爲方便起見,由於一般在下載後當即檢查文件的完整性。

返回
返回包含如下字段的對象:

uri(string) - 指向文件的file:// URI。這與fileUri輸入參數相同。

status (number)  - 下載網絡請求的HTTP狀態碼。

headers (object)  - 包含全部HTTP標頭字段及其下載網絡請求值的對象。對象的鍵和值分別是標題名稱和值。

md5 (string) - 若是md5選項真的存在,則顯示。包含文件的MD5哈希。

Expo.FileSystem.createDownloadResumable(uri,fileUri,options,callback,resumeData)
建立一個DownloadResumable對象,它能夠啓動,暫停和恢復將遠程URI下載的內容下載到應用文件系統中的文件。請注意:您須要在DownloadResumable實例上調用downloadAsync()以啓動下載。 DownloadResumable對象具備提供下載進度更新的回調。經過使用AsyncStorage存儲DownloadResumable.savable()對象以供往後檢索,能夠跨應用程序從新啓動恢復下載。可保存對象包含在從新啓動應用程序後初始化新的DownloadResumable對象以恢復下載所需的參數。

參數
url(string) - 要從其下載的遠程URI。

fileUri(string) - 要下載到的文件的本地URI。若是此URI沒有文件,則會建立一個新文件。若是這個URI有一個文件,它的內容將被替換。

options(object) - 選項圖:

  • md5(boolean) - 若是爲true,則在返回的對象中包含文件的MD5哈希。默認爲false。爲方便起見,由於一般在下載後當即檢查文件的完整性。
  • headers (object)  - 包含請求所需的任何附加HTTP頭字段的對象。對象的鍵和值分別是標題名稱和值。

callback(function) - 在每次寫入數據時調用此函數以更新下載進度。傳遞如下字段的對象:

  • totalBytesWritten(number) - 下載操做寫入的總字節數。
  • totalBytesExpectedToWrite(number) - 預計由下載操做寫入的字節總數。
  • resumeData(string) - 容許api恢復暫停下載的字符串。這在下載暫停時自動設置在DownloadResumable對象上。初始化新的DownloadResumable時,它應該爲空。

Expo.FileSystem.DownloadResumable.downloadAsync()
將遠程URI處的內容下載到應用程序文件系統中的文件中。

返回
返回包含如下字段的對象:

  • uri(string) - 指向文件的file:// URI。這與fileUri輸入參數相同。
  • status (number) - 下載網絡請求的HTTP狀態碼。
  • headers (object)  - 包含全部HTTP標頭字段及其下載網絡請求值的對象。對象的鍵和值分別是標題名稱和值。
  • md5(string) - 若是md5選項真的存在,則顯示。包含文件的MD5哈希。

Expo.FileSystem.DownloadResumable.pauseAsync()
暫停當前​​的下載操做。在成功暫停操做後,resumeData被添加到DownloadResumable對象中。返回可使用AsyncStorage進行保存以供未來檢索的對象(與調用Expo.FileSystem.DownloadResumable.savable()時返回的對象相同。請參見下面的示例。

返回
返回包含如下字段的對象:

  • url(string) - 要從其下載的遠程URI。
  • fileUri(string) - 要下載到的文件的本地URI。若是此URI沒有文件,則會建立一個新文件。若是這個URI有一個文件,它的內容將被替換。
  • options(object) - 選項圖:
  • md5(boolean) - 若是爲true,則在返回的對象中包含文件的MD5哈希。默認爲false。爲方便起見,由於一般在下載後當即檢查文件的完整性。
  • resumeData(string) - 容許API恢復暫停下載的字符串。

Expo.FileSystem.DownloadResumable.resumeAsync()
恢復暫停的下載操做。

返回
返回包含如下字段的對象:

  • uri(string) - 指向文件的file:// URI。這與fileUri輸入參數相同。
  • status (number) - 下載網絡請求的HTTP狀態碼。
  • headers (object)  - 包含全部HTTP標頭字段及其下載網絡請求值的對象。對象的鍵和值分別是標題名稱和值。
  • md5(string) - 若是md5選項真的存在,則顯示。包含文件的MD5哈希。

Expo.FileSystem.DownloadResumable.savable()
返回能夠與AsyncStorage一塊兒保存的對象以供未來檢索。

返回
返回包含如下字段的對象:

url(string) - 要從其下載的遠程URI。

fileUri(string) - 要下載到的文件的本地URI。若是此URI沒有文件,則會建立一個新文件。若是這個URI有一個文件,它的內容將被替換。

options(object) - 選項圖:

  • md5(boolean) - 若是爲true,則在返回的對象中包含文件的MD5哈希。默認爲false。爲方便起見,由於一般在下載後當即檢查文件的完整性。
  • resumeData(string) - 容許api恢復暫停下載的字符串。

const callback = downloadProgress => {
  const progress =
    downloadProgress.totalBytesWritten /
    downloadProgress.totalBytesExpectedToWrite;
  this.setState({
    downloadProgress: progress,
  });
};

const downloadResumable = FileSystem.createDownloadResumable(
  'http://techslides.com/demos/sample-videos/small.mp4',
  FileSystem.documentDirectory + 'small.mp4',
  {},
  callback
);

try {
  const { uri } = await downloadResumable.downloadAsync();
  console.log('Finished downloading to ', uri);
} catch (e) {
  console.error(e);
}

try {
  await downloadResumable.pauseAsync();
  console.log('Paused download operation, saving for future retrieval');
  AsyncStorage.setItem(
    'pausedDownload',
    JSON.stringify(downloadResumable.savable())
  );
} catch (e) {
  console.error(e);
}

try {
  const { uri } = await downloadResumable.resumeAsync();
  console.log('Finished downloading to ', uri);
} catch (e) {
  console.error(e);
}

//To resume a download across app restarts, assuming the the DownloadResumable.savable() object was stored:
const downloadSnapshotJson = await AsyncStorage.getItem('pausedDownload');
const downloadSnapshot = JSON.parse(downloadJson);
const downloadResumable = new FileSystem.DownloadResumable(
  downloadSnapshot.url,
  downloadSnapshot.fileUri,
  downloadSnapshot.options,
  callback,
  downloadSnapshot.resumeData
);

try {
  const { uri } = await downloadResumable.resumeAsync();
  console.log('Finished downloading to ', uri);
} catch (e) {
  console.error(e);
}

下一張繼續介紹,這一篇主要介紹了:expo sdk api之 FileSystem(文件操做系統)歡迎你們關注個人微信公衆號,這篇文章是否被你們承認,個人衡量標準就是公衆號粉絲增加人數。歡迎你們轉載,但必須保留本人博客連接!

 

相關文章
相關標籤/搜索