文件存储

更新时间: 2021-07-09 15:29

说明

从API Version 6开始，该接口不再维护，推荐使用文件管理接口（@ohos.fileio）进行文件存储管理。

涉及到文件目录的请参考下述表格：

支持设备

说明

file.writeText、file.writeArrayBuffer、file.readText和file.readArrayBuffer仅支持文本文档读写。

导入模块

import file from '@system.file';

权限列表

无

file.move(OBJECT)

将指定文件移动到其他指定位置。

• 参数

fail返回错误代码：

• 示例

  file.move({
      srcUri: 'internal://app/myfiles1',
      dstUri: 'internal://app/myfiles2',
      success: function(uri) {
          console.log('call success callback success');
      },
      fail: function(data, code) {
          console.error('call fail callback fail, code: ' + code + ', data: ' + data);
      },
  });
  

file.copy(OBJECT)

将指定文件拷贝并存储到指定位置，接口所使用的URI描述详见文件组织。

• 参数

fail返回错误代码：

• 示例

  file.copy({
      srcUri: 'internal://app/file.txt',
      dstUri: 'internal://app/file_copy.txt',
      success: function(uri) {
          console.log('call success callback success');
      },
      fail: function(data, code) {
          console.error('call fail callback fail, code: ' + code + ', data: ' + data);
      },
  });
  

file.list(OBJECT)

获取指定路径下全部文件的列表，接口所使用的 URI 描述详见文件组织。

• 参数

success返回值：

fail返回错误代码：

• 示例

  file.list({
      uri: 'internal://app/pic',
      success: function(data) {
          console.log(data.fileList);
      },
      fail: function(data, code) {
          console.error('call fail callback fail, code: ' + code + ', data: ' + data);
      },
  });
  

file.get(OBJECT)

获取指定本地文件的信息，URI请参考文件组织。

• 参数

success返回值：

fail返回错误代码：

• 示例

  file.get({
      uri: 'internal://app/file',
      success: function(data) {
          console.log(data.uri);
      },
      fail: function(data, code) {
          console.error('call fail callback fail, code: ' + code + ', data: ' + data);
      },
  });
  

file.delete(OBJECT)

删除本地文件，使用的URI参考文件组织。

• 参数

fail返回错误代码：

• 示例

  file.delete({
      uri: 'internal://app/my_file',
      success: function() {
          console.log('call delete success.');
      },
      fail: function(data, code) {
          console.error('call fail callback fail, code: ' + code + ', data: ' + data);
      },
  });
  

file.writeText(OBJECT)

写文本内容到指定文件。

• 参数

fail返回错误代码：

• 示例

  file.writeText({
      uri: 'internal://app/workspace/test.txt',
      text: 'Text that just for test.',
      success: function() {
          console.log('call writeText success.');
      },
      fail: function(data, code) {
          console.error('call fail callback fail, code: ' + code + ', data: ' + data);
      },
  });
  

file.writeArrayBuffer(OBJECT)

写Buffer内容到指定文件。

• 参数

fail返回错误代码：

• 示例

  file.writeArrayBuffer({
      uri: 'internal://app/workspace/test',
      buffer: buffer, //buffer为Uint8Array类型
      success: function() {
          console.log('call writeArrayBuffer success.');
      },
      fail: function(data, code) {
          console.error('call fail callback fail, code: ' + code + ', data: ' + data);
      },
  });
  

file.readText(OBJECT)

从指定文件中读取文本内容。

• 参数

success返回值：

fail返回错误代码：

• 示例

  file.readText({
      uri: 'internal://app/workspace/text.txt',
      success: function(data) {
          console.log('call readText success: ' + data.text);
      },
      fail: function(data, code) {
          console.error('call fail callback fail, code: ' + code + ', data: ' + data);
      },
  });
  

file.readArrayBuffer(OBJECT)

从指定文件中读取Buffer内容。

• 参数

success返回值：

fail返回错误代码：

• 示例

  file.readArrayBuffer({
      uri: 'internal://app/workspace/test',
      position: 10,
      length: 200,
      success: function(data) {
          console.log('call readArrayBuffer success: ' + data.buffer);
      },
      fail: function(data, code) {
          console.error('call fail callback fail, code: ' + code + ', data: ' + data);
      },
  });
  

file.access(OBJECT)

判断指定文件或目录是否存在。

• 参数

fail返回错误代码：

• 示例

  file.access({
      uri: 'internal://app/test',
      success: function() {
          console.log('call access success.');
      },  
      fail: function(data, code) {
          console.error('call fail callback fail, code: ' + code + ', data: ' + data);
      },
  });
  

file.mkdir(OBJECT)

创建指定目录。

• 参数

fail返回错误代码：

• 示例

  file.mkdir({
      uri: 'internal://app/test_directory',
      success: function() {
          console.log('call mkdir success.');
      },  
      fail: function(data, code) {
          console.error('call fail callback fail, code: ' + code + ', data: ' + data);
       },
   });
  

file.rmdir(OBJECT)

删除指定目录。

• 参数

fail返回错误代码：

• 示例

  file.rmdir({
      uri: 'internal://app/test_directory',
      success: function() {
          console.log('call rmdir success.');
      },  
      fail: function(data, code) {    
          console.error('call fail callback fail, code: ' + code + ', data: ' + data);
      },
  });