文件存储

接口声明

在manifest.json文件的 features属性中增加如下配置。

{"name": "system.file"}

导入模块

在调用接口页面的<script>部分增加如下配置。

import file from '@system.file'

或

var file = require("@system.file")

使用限制

接口定义

[h2]file.move(OBJECT)

描述

将源文件移动到指定位置。

OBJECT参数

fail返回错误码：

示例代码

file.move({
  srcUri: "internal://cache/path/to/file",
  dstUri: "internal://files/path/to/file",
  success: function(uri) {
    console.log("move success: " + uri);
  },
  fail: function(data, code) {
    console.log("handling fail, code=" + code);
  }
})

[h2]file.copy(OBJECT)

描述

将源文件复制一份并存储到指定位置。

OBJECT参数

fail返回错误码：

示例代码

file.copy({
  srcUri: "internal://cache/path/to/file",
  dstUri: "internal://files/path/to/file",
  success: function(uri) {
    console.log("copy success: " + uri);
  },
  fail: function(data, code) {
    console.log("handling fail, code=" + code);
  }
})

[h2]file.list(OBJECT)

描述

获取指定目录下的文件列表。

OBJECT参数

success返回值：

文件元信息说明：

fail返回错误码：

示例代码

file.list({
  uri: "internal://files/movies/"
  success: function(data) {
    console.log(data.fileList)
  },
  fail: function(data, code) {
    console.log("handling fail, code=" + code);
  }
})

[h2]file.get(OBJECT)

描述

获取本地文件的文件信息。

OBJECT参数

success返回值：

fail返回错误码：

示例代码

file.get({
  uri: 'internal://files/path/to/file',
  success: function(data) {
    console.log(data.uri);
    console.log(data.length);
    console.log(data.lastModifiedTime);
  },
  fail: function(data, code) {
    console.log("handling fail, code=" + code);
  }
})

[h2]file.delete(OBJECT)

描述

删除本地存储的文件。

OBJECT参数

fail返回错误码：

示例代码

file.delete({
  uri: 'internal://files/path/to/file',
  success: function(data) {
    console.log("handling success");
  },
  fail: function(data, code) {
    console.log("handling fail, code=" + code);
  }
})

[h2]file.writeText(OBJECT)（1010+）

描述

将文本内容写入指定文件。

OBJECT参数

fail返回错误码：

示例代码

file.writeText({
    uri: 'internal://cache/test/test.txt',
    text: 'nihaadpafsafa fsafass faf  sfsa sf',
    encoding: 'UTF-8',
    success: function() {
        console.log('success');               
    },
    fail: function(errmsg, errcode) {
        console.log('failed ' + errmsg+' errcode = '+errcode);
   }
})

[h2]file.writeArrayBuffer(OBJECT)（1010+）

描述

将内容写入Buffer。

OBJECT参数

fail返回错误码：

示例代码

file.writeArrayBuffer({
    uri: 'internal://cache/test/test1.txt',
    buffer: uint8array,
    position: 0,
    success: function() {
        console.log('success ');
    },
    fail: function(errmsg, errcode) {
        console.log('failed ' + errmsg+' errcode = '+errcode);
    }
})

[h2]file.readArrayBuffer(OBJECT)（1010+）

描述

从Buffer中读取内容。

OBJECT参数

success返回值：

fail返回错误码：

示例代码

file.readArrayBuffer({
    uri: 'internal://cache/test/test1.txt',
    position:0,
    length: 3,
    success: function(data) {
        console.log("data buffer  = "+data.buffer)
    },
    fail: function(errmsg, errcode) {
        console.log('failed ' + errmsg+' errcode = '+errcode);
    }
})

[h2]file.readText(OBJECT)（1010+）

描述

读取文本。

OBJECT参数

success返回值：

fail返回错误码：

示例代码

file.readText({
    uri: 'internal://cache/test/test.txt',
    encoding: 'UTF-8',
    success: function(data) {
        console.log('success data.text = '+data.text);
    },
    fail: function(errmsg, errcode) {
        console.log('failed ' + errmsg+' errcode = '+errcode);
    }
})

[h2]file.access(OBJECT)（1060+）

描述

判断文件/目录是否存在。

OBJECT参数

fail返回错误码：

示例代码

file.access({
  uri: 'internal://files/test',
  success: function () {
    console.log('handling success')
  },
  fail: function (data, code) {
    console.log(`handling fail, code `)
  }
})

[h2]file.mkdir(OBJECT)（1060+）

描述

创建目录。

OBJECT参数

fail返回错误码：

示例代码

file.mkdir({
  uri: 'internal://files/dir/',
  success: function () {
    console.log('handling success')
  },
  fail: function (data, code) {
    console.log(`handling fail`)
  }
})

[h2]file.rmdir(OBJECT)（1060+）

描述

删除目录。

删除目录文件夹时，如果存在子目录或者文件，需要将recursive设为true才能删除成功，否则会提示 code = 300 错误。

OBJECT参数

fail返回错误码：

示例代码

file.rmdir({
  uri: 'internal://files/dir/',
  success: function () {
    console.log('handling success')
  },
  fail: function (data, code) {
    console.log(`handling fail`)
  }
})

[h2]file.copyFileToPublicDir(OBJECT)（1078+）

描述

复制文件到系统公共目录。

需要获得用户的存储权限授权。

参数

fail返回错误码

示例代码

file.copyFileToPublicDir({
    srcPath: '/Common/test.mp3',
    destPath: 'external://DIRECTORY_DOCUMENTS/test.mp3',
    success: function (ret) {
      console.log("copy success: " + ret);
    },
    fail: function (data, code) {          
      console.log("handling fail, code=" + code)       
    }
})

Demo

<template>
  <div class="container">

    <div class="item-container">
      <!-- download file -->
      <div class="item-content">
        <text class="txt">downloadFile: {{fileDownloadData}}</text>
      </div>
      <input type="button" class="btn" onclick="downloadFile"  value="Download File" />

      <!-- move file -->
      <div class="item-content">
        <text class="txt">moveFile: {{fileMoveData}}</text>
      </div>
      <input type="button" class="btn" onclick="moveFile" value="Move File" />

      <!-- move file to folder -->
      <div class="item-content">
        <text class="txt">moveFileToFolder: {{fileMoveToFolderData}}</text>
      </div>
      <input type="button" class="btn" onclick="moveFileToFolder" value="Move File to Folder" />

      <!-- copy file -->
      <div class="item-content">
        <text class="txt">copyFile: {{fileCopyData}}</text>
      </div>
      <input type="button" class="btn" onclick="copyFile" value="Copy File" />

      <!-- file list -->
      <div class="item-content">
        <text class="txt">getFileList: {{fileGetListData}}</text>
      </div>
      <input type="button" class="btn" onclick="getFileList"  value="Get File List" />

      <!-- get file information -->
      <div class="item-content">
        <text class="txt">getFileInfo: {{fileGetData}}</text>
      </div>
      <input type="button" class="btn" onclick="getFile"
        value="Get File Info" />

      <!-- delete file -->
      <div class="item-content">
        <text class="txt">DeleteFile: {{fileDeleteData}}</text>
      </div>
      <input type="button" class="btn" onclick="deleteFile"  value="Delete File" />

      <!-- write file -->
      <div class="item-content">
        <text class="txt">writeFile: {{fileWriteData}}</text>
      </div>
      <input type="button" class="btn" onclick="writeFile"   value="Write File" />

      <!-- read file -->
      <div class="item-content">
        <text class="txt">readFile: {{fileReadData}}</text>
      </div>
      <input type="button" class="btn" onclick="readFile" value="Read File" />
      <!-- write Buffer -->
      <div class="item-content">
        <text class="txt">writeBuffer: {{writeBufferData}}</text>
      </div>
      <input type="button" class="btn" onclick="writeBuffer"  value="Write Buffer" />

      <!-- read Buffer -->
      <div class="item-content">
        <text class="txt">ReadBuffer: {{readBufferData}}</text>
      </div>
      <input type="button" class="btn" onclick="readBuffer"  value="Read Buffer" />
      <!-- if file is exist -->
      <div class="item-content">
        <text class="txt">fileExist: {{fileAccessData}}</text>
      </div>
      <input type="button" class="btn" onclick="access" value="File Exist" />

      <!-- make directory -->
      <div class="item-content">
        <text class="txt">makeDir: {{makeDir}}</text>
      </div>
      <input type="button" class="btn" onclick="mkDir" value="Make Dir" />

      <!-- delete directory -->
      <div class="item-content">
        <text class="txt">deletDir: {{deletDir}}</text>
      </div>
      <input type="button" class="btn" onclick="rmDir" value="Delet Dir" />
    </div>
    <!-- read text -->
      <div class="item-content">
        <text class="txt">readText: {{textContent}}</text>
      </div>
      <input type="button" class="btn" onclick="readText" value="Read Text" />
      <!-- read text -->
      <div class="item-content">
        <text class="txt">result: {{result}}</text>
      </div>
      <input type="button" class="btn" onclick="copyFileToPublicDir" value="copyFileToPublicDir" />

  </div>
</template>

<style>
.container{
  flex: 1;
  flex-direction: column;
}

  .item-container {
    margin-bottom: 50px;
    margin-right: 60px;
    margin-left: 60px;
    flex-direction: column;
  }

  .item-content {
    flex-direction: column;
    background-color: #ffffff;
    padding-left: 30px;
    padding-right: 30px;
    padding-top: 20px;
    padding-bottom: 20px;
    margin-bottom: 30px;
    align-items: flex-start;
  }

  .txt {
    padding-top: 15px;
    padding-bottom: 15px;
  }
  .btn {
  height: 80px;
  text-align: center;
  border-radius: 5px;
  margin-right: 60px;
  margin-left: 60px;
  margin-bottom: 50px;
  color: #ffffff;
  font-size: 30px;
  background-color: #0faeff;
}
</style>

<script>
  import file from '@system.file'
  import fetch from '@system.fetch'

  export default {
    data: {
      componentName: 'file',
      fileDownloadData: '',
      fileMoveData: '',
      fileMoveToFolderData: '',
      fileCopyData: '',
      fileGetListData: '',
      fileGetData: '',
      fileDeleteData: '',
      fileWriteData: '',
      fileReadData: '',
      writeBufferData: '',
      readBufferData: '',
      fileAccessData: '',
      makeDir: '',
      deletDir: '',
      textContent:'',
      result:''
    },
    onInit: function () {
      this.$page.setTitleBar({ text: 'file' })
    },
    downloadFile: function () {
      var that = this
      fetch.fetch({
        url: 'https://developer.huawei.com/dev_index/img/logo_ch.png',
        success: function (ret) {
          that.fileDownloadData = ret.data
          console.log("wlj"+ret.data);
          that.fileDeleteData = that.fileDownloadData
          console.log('file_download_data--------' + JSON.stringify(ret))
        }
      })
    },
    moveFile: function () {
      var that = this
      var dstUri = 'internal://files/testfile/file.png'
      file.move({
        srcUri: this.fileDownloadData,
        dstUri: dstUri,
        success: function (ret) {
          that.fileMoveData = dstUri
          that.fileDownloadData = dstUri
          that.fileDeleteData = that.fileDownloadData
          console.log('file_save--------success ' + JSON.stringify(ret))
        },
        fail: function (errmsg, errcode) {
          that.fileMoveData = errcode + '---' + errmsg
          console.log('file_save--------fail ' + errcode + ': ' + errmsg)
        }
      })
    },
    moveFileToFolder: function () {
      var that = this
      var dstUri = 'internal://files/testfile/'
      file.move({
        srcUri: this.fileDownloadData,
        dstUri: dstUri,
        success: function (ret) {
          that.fileMoveToFolderData = ret
          that.fileDownloadData = ret
          that.fileDeleteData = ret
          console.log('file_save--------success ' + JSON.stringify(ret))
        },
        fail: function (errmsg, errcode) {
          that.fileMoveToFolderData = errcode + '---' + errmsg
          console.log('file_save--------fail ' + errcode + ': ' + errmsg)
        }
      })
    },
    copyFile: function () {
      var that = this
      var dstUri = 'internal://files/testfile/filecopy.png'
      file.copy({
        srcUri: that.fileDownloadData,
        dstUri: dstUri,
        success: function (ret) {
          that.fileCopyData = ret
          console.log('file_list_data-------- success ' + JSON.stringify(ret))
        },
        fail: function (errmsg, errcode) {
          that.fileCopyData = errcode + '---' + errmsg
          console.log('file_list_data--------complete ' + errcode + ': ' + errmsg)
        }
      })
    },
    getFileList: function () {
      var that = this
      file.list({
        uri: 'internal://files/testfile',
        success: function (ret) {
          that.fileGetListData = JSON.stringify(ret)
          console.log('file_get_data---------success ' + JSON.stringify(ret))
        },
        fail: function (errmsg, errcode) {
          that.fileGetListData = errcode + '---' + errmsg
          console.log('file_get_data---------fail ' + errcode + ': ' + errmsg)
        }
      })
    },
    getFile: function () {
      var that = this
      file.get({
        uri: 'internal://files/testfile',
        recursive: true,
        success: function (ret) {
          that.fileGetData = JSON.stringify(ret)
          console.log('file_get_data---------success ' + JSON.stringify(ret))
        },
        fail: function (errmsg, errcode) {
          that.fileGetData = errcode + '---' + errmsg
          console.log('file_get_data---------fail ' + errcode + ': ' + errmsg)
        }
      })
    },
    deleteFile: function () {
      var that = this
      file.delete({
        uri: that.fileDownloadData,
        success: function (ret) {
          that.fileDownloadData = ''
          that.fileMoveData = ''
          that.fileMoveToFolderData = ''
          that.fileCopyData = ''
          that.fileGetListData = ''
          that.fileGetData = ''
          that.fileDeleteData = JSON.stringify(ret)
          console.log('file_remove_data---------success ' + JSON.stringify(ret))
        },
        fail: function (errmsg, errcode) {
          that.fileDeleteData = errcode + '---' + errmsg
          console.log('file_remove_data---------fail ' + errcode + ': ' + errmsg)
        }
      })
    },

    writeFile: function () {
      var that = this
      file.writeText({
        uri: 'internal://cache/test/test.txt',
        text: 'hello quickapp',
        encoding: 'UTF-8',
        append: true,
        success: function () {
          console.log('file_write_data---------success ')
          that.fileWriteData = 'Success'
        },
        fail: function (errmsg, errcode) {
          that.fileWriteData = 'Fail'
          console.log('file_write_data---------failed ' + errmsg + ' errcode = ' + errcode)
        }
      })
    },

    readFile: function () {
      var that = this
      file.readText({
        uri: 'internal://cache/test/test.txt',
        encoding: 'UTF-8',
        success: function (data) {
          console.log(`success data.text = ${data.text}`)
          that.fileReadData = data.text
        },
        fail: function (errmsg, errcode) {
          console.log('failed ' + errmsg + ' errcode = ' + errcode)
          that.fileReadData = 'Failed'
        }
      })
    },
    writeBuffer: function () {
      var that = this
      var uint8 = new Uint8Array(3)
      uint8[0] = 198
      uint8[1] = 31
      uint8[2] = 219
      file.writeArrayBuffer({
        uri: 'internal://cache/test/test1.txt',
        buffer: uint8,
        position: 0,
        append: true,
        success: function () {
          console.log('success ')
          that.writeBufferData = 'Success'
        },
        fail: function (errmsg, errcode) {
          console.log('failed ' + errmsg + ' errcode = ' + errcode)
          that.writeBufferData = 'Failed'
        }
      })
    },

    readBuffer: function () {
      var that = this
      file.readArrayBuffer({
        uri: 'internal://cache/test/test1.txt',
        success: function (data) {
          that.readBufferData = data.buffer
          console.log('data buffer  = ' + data.buffer)
        },
        fail: function (errmsg, errcode) {
          console.log('failed ' + errmsg + ' errcode = ' + errcode)
        }
      })
    },

    access: function () {
      var that = this
      file.access({
        uri: 'internal://cache/test/test1.txt',
        success: function (data) {
          that.fileAccessData = 'accessible'
          console.log('success')
        },
        fail: function (errmsg, errcode) {
          that.fileAccessData = 'can not access'
          console.log('failed ' + errmsg + ' errcode = ' + errcode)
        }
      })
    },

    mkDir: function () {
      var that = this
      file.mkdir({
        uri: 'internal://cache/../test/',
        recursive: false,
        success: function (data) {
          that.makeDir = 'success'
          console.log('success')
        },
        fail: function (errmsg, errcode) {
          that.makeDir = 'fail'
          console.log('failed ' + errmsg + ' errcode = ' + errcode)
        }
      })
    },

    rmDir: function () {
      var that = this
      file.rmdir({
        uri: 'internal://cache/test/',
        recursive: true,
        success: function (data) {
          console.log('success')
          that.deletDir = 'success'
        },
        fail: function (errmsg, errcode) {
          that.deletDir = 'fail'
          console.log('failed ' + errmsg + ' errcode = ' + errcode)
        }
      })
    },
    readText() {
      var that = this
      file.readText({
        uri: 'internal://cache/test/test.txt',
        encoding: 'UTF-8',
        success: function(data) {
           console.log('success data.text = '+data.text);
           that.textContent = data.text
        },
        fail: function(errmsg, errcode) {
           console.log('failed ' + errmsg+' errcode = '+errcode);
           that.textContent = errcode
        }
      })
    },
    copyFileToPublicDir() {
      var that = this
      file.copyFileToPublicDir({
        srcPath: '/Common/logo.png',
        destPath: 'external://DIRECTORY_DOCUMENTS/test.mp3',
        success: function (ret) {
           console.log("copy success: " + ret);
           that.result = ret
      },
       fail: function (data, code) {          
           console.log("handling fail, code=" + code)
           that.result = 'fail'       
      }
    })
    }
  }
</script>

效果图如下：

版本更新说明

相关链接

[h2]FAQ

文件存储file接口与数据存储storage接口的存储机制一样吗？