教程 其他 框架 组件 接口

文件存储

接口声明

{ "name": "system.file" }

导入模块

import file from '@system.file'const file = require('@system.file')

接口定义

file.move(OBJECT)

将源文件移动到指定位置,接口中使用的 URI 描述请参考文件组织

参数:

参数名类型必填说明
srcUriString源文件的 uri,不能是应用资源路径和 tmp 类型的 uri
dstUriString目标文件的 uri,不能是应用资源路径和 tmp 类型的 uri
successFunction成功回调,返回目标文件的 uri
failFunction失败回调
completeFunction执行结束后的回调
fail 返回错误代码:
错误码说明
202参数错误
300I/O 错误

示例:

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}`)
  }
})

file.copy(OBJECT)

将源文件复制一份并存储到指定位置,接口中使用的 URI 描述请参考文件组织

参数:

参数名类型必填说明
srcUriString源文件的 uri
dstUriString目标文件的 uri,不能是应用资源路径和 tmp 类型的 uri
successFunction成功回调,返回目标文件的 uri
failFunction失败回调
completeFunction执行结束后的回调
fail 返回错误代码:
错误码说明
202参数错误
300I/O 错误

示例:

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}`)
  }
})

file.list(OBJECT)

获取指定目录下的文件列表,接口中使用的 URI 描述请参考文件组织

参数:

参数名类型必填说明
uriString目录 uri,不能是应用资源路径和 tmp 类型的 uri
successFunction成功回调,返回{fileList:[{uri:'file1',lastModifiedTime:1234456, length:123456} ...]}
failFunction失败回调
completeFunction执行结束后的回调
success 返回值:
参数名类型说明
fileListArray文件列表,每个文件的格式为{uri:'file1',lastModifiedTime:1234456, length:123456}
每个文件的元信息:
参数名类型说明
uriString文件的 uri,该 uri 可以被其他组件或 Feature 访问
lengthNumber文件大小,单位 B
lastModifiedTimeNumber文件的保存是的时间戳,从 1970/01/01 00:00:00 GMT 到当前时间的毫秒数
fail 返回错误代码:
错误码说明
202参数错误
300I/O 错误

示例:

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

file.get(OBJECT)

获取本地文件的文件信息,接口中使用的 URI 描述请参考文件组织

参数:

参数名类型必填说明
uriString文件的 uri,不能是应用资源路径
successFunction成功回调,返回{uri:'file1', length:123456, lastModifiedTime:1233456}
failFunction失败回调
completeFunction执行结束后的回调
success 返回值:
参数名类型说明
uriString文件的 uri,该 uri 可以被其他组件或 Feature 访问
lengthNumber文件大小,单位 B
lastModifiedTimeNumber文件的保存是的时间戳,从 1970/01/01 08:00:00 到当前时间的毫秒数
fail 返回错误代码:
错误码说明
202参数错误
300I/O 错误

示例:

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}`)
  }
})

file.delete(OBJECT)

删除本地存储的文件,接口中使用的 URI 描述请参考文件组织

参数:

参数名类型必填说明
uriString需要删除的文件 uri,不能是应用资源路径和 tmp 类型的 uri
successFunction成功回调
failFunction失败回调
completeFunction执行结束后的回调
fail 返回错误代码:
错误码说明
202参数错误
300I/O 错误

示例:

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}`)
  }
})

file.writeText(OBJECT)1010+

写文本到文件

参数:

参数名类型必填说明
uriString本地文件路径,不支持资源文件路径和 tmp 分区,如果文件不存在会创建文件
textString需要写入的字符串
encodingString编码格式,默认 UTF-8
successFunction成功回调
failFunction失败回调
completeFunction执行结束后的回调
fail 返回错误代码:
错误码说明
202参数错误
300I/O 错误

示例:

file.writeText({
  uri: 'internal://files/work/demo.txt',
  text: 'test',
  success: function() {
    console.log('handling success')
  },
  fail: function(data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})

file.writeArrayBuffer(OBJECT)1010+

写 Buffer 到文件

参数:

参数名类型必填说明
uriString本地文件路径,不支持资源文件路径和 tmp 分区,如果文件不存在会创建文件
bufferUint8Array需要写入的 Buffer
positionNumber指向文件开始写入数据的位置的偏移量,默认 0
successFunction成功回调
failFunction失败回调
completeFunction执行结束后的回调
fail 返回错误代码:
错误码说明
202参数错误
300I/O 错误

示例:

file.writeArrayBuffer({
  uri: 'internal://files/work/demo',
  buffer: buffer,
  success: function() {
    console.log('handling success')
  },
  fail: function(data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})

file.readText(OBJECT)1010+

从文件中读取文本

参数:

参数名类型必填说明
uriString本地文件路径
encodingString编码格式,默认 UTF-8
successFunction成功回调
failFunction失败回调
completeFunction执行结束后的回调
success 返回值:
参数名类型说明
textString读取的文本
fail 返回错误代码:
错误码说明
202参数错误
300I/O 错误
301文件不存在

示例:

file.readText({
  uri: 'internal://files/work/demo.txt',
  success: function(data) {
    console.log('text: ' + data.text)
  },
  fail: function(data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})

file.readArrayBuffer(OBJECT)1010+

从文件中读取 Buffer

参数:

参数名类型必填说明
uriString本地文件路径
positionNumber读取的起始位置,默认值为文件的起始位置
lengthNumber读取的长度,不填写则读取到文件结尾
successFunction成功回调
failFunction失败回调
completeFunction执行结束后的回调
success 返回值:
参数名类型说明
bufferUint8Array读取的文件内容
fail 返回错误代码:
错误码说明
202参数错误
300I/O 错误
301文件不存在

示例:

file.readArrayBuffer({
  uri: 'internal://files/work/demo',
  position: 100,
  length: 100,
  success: function(data) {
    console.log('buffer.length: ' + data.buffer.length)
  },
  fail: function(data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})

条匹配 "" 的结果

    没有搜索到与 "" 相关的内容