codecamp

快应用 文件存储

接口声明

{"name": "system.file"}

导入模块

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

接口定义

file.move(OBJECT)

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

参数：

参数名 类型 必填 说明
srcUri String 是 源文件的uri，不能是应用资源路径和tmp类型的uri
dstUri String 是 目标文件的uri，不能是应用资源路径和tmp类型的uri
success Function 否 成功回调，返回目标文件的uri
fail Function 否 失败回调
complete Function 否 执行结束后的回调
fail返回错误代码：
错误码 说明
202 参数错误
300 I/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描述请参考 文件组织

参数：

参数名 类型 必填 说明
srcUri String 是 源文件的uri
dstUri String 是 目标文件的uri，不能是应用资源路径和tmp类型的uri
success Function 否 成功回调，返回目标文件的uri
fail Function 否 失败回调
complete Function 否 执行结束后的回调
fail返回错误代码：
错误码 说明
202 参数错误
300 I/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描述请参考 文件组织

参数：

参数名 类型 必填 说明
uri String 是 目录uri，不能是应用资源路径和tmp类型的uri
success Function 否 成功回调，返回{fileList:[{uri:'file1',lastModifiedTime:1234456, length:123456} ...]}
fail Function 否 失败回调
complete Function 否 执行结束后的回调
success返回值：
参数名 类型 说明
fileList Array 文件列表，每个文件的格式为{uri:'file1',lastModifiedTime:1234456, length:123456}
每个文件的元信息：
参数名 类型 说明
uri String 文件的 uri，该 uri 可以被其他组件或 Feature 访问
length Number 文件大小，单位B
lastModifiedTime Number 文件的保存是的时间戳，从 1970/01/01 00:00:00 GMT 到当前时间的毫秒数
fail返回错误代码：
错误码 说明
202 参数错误
300 I/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，不能是应用资源路径
recursive 1060+Boolean否是否递归获取子目录文件列表。默认false
successFunction否成功回调，返回 { uri:'file1', length:123456, lastModifiedTime:1233456 }
failFunction否失败回调
completeFunction否执行结束后的回调
success返回值：
参数名类型说明
uriString文件的 uri，该 uri 可以被其他组件或 Feature 访问
lengthNumber文件大小，单位 B
lastModifiedTimeNumber文件的保存是的时间戳，从 1970/01/01 08:00:00 到当前时间的毫秒数
type 1060+String文件类型，dir：目录；file：文件
subFiles 1060+Array文件列表，recursive为true且type为dir时递归返回子目录文件细信息，否则不返回
fail返回错误代码：
错误码 说明
202 参数错误
300 I/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 描述请参考 文件组织

参数：

参数名 类型 必填 说明
uri String 是 需要删除的文件 uri，不能是应用资源路径和 tmp 类型的 uri
success Function 否 成功回调
fail Function 否 失败回调
complete Function 否 执行结束后的回调
fail返回错误代码：
错误码 说明
202 参数错误
300 I/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
append 1060+Boolean否是否追加模式，默认 false
successFunction否成功回调
failFunction否失败回调
completeFunction否执行结束后的回调
fail返回错误代码：
错误码 说明
202 参数错误
300 I/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
append 1060+Boolean否是否追加模式，默认 false。当为 true 时， position 参数无效
successFunction否成功回调
failFunction否失败回调
completeFunction否执行结束后的回调
fail返回错误代码：
错误码 说明
202 参数错误
300 I/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+

从文件中读取文本

参数：

参数名 类型 必填 说明
uri String 是 本地文件路径
encoding String 否 编码格式，默认 UTF-8
success Function 否 成功回调
fail Function 否 失败回调
complete Function 否 执行结束后的回调
success返回值：
参数名 类型 说明
text String 读取的文本
fail返回错误代码：
错误码 说明
202 参数错误
300 I/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

参数：

参数名 类型 必填 说明
uri String 是 本地文件路径
position Number 否 读取的起始位置，默认值为文件的起始位置
length Number 否 读取的长度，不填写则读取到文件结尾
success Function 否 成功回调
fail Function 否 失败回调
complete Function 否 执行结束后的回调
success返回值：
参数名 类型 说明
buffer Uint8Array 读取的文件内容
fail返回错误代码：
错误码 说明
202 参数错误
300 I/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}`)
  }
})

file.access(OBJECT)1060+

判断文件或目录是否存在

参数：

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

示例：

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

file.mkdir(OBJECT)1060+

创建目录

参数：

参数名类型必填说明
uriString是目录的 uri，不能是应用资源路径和 tmp 类型的 uri
recursiveBoolean否是否递归创建该目录的上级目录后再创建该目录。默认 false
successFunction否成功回调
failFunction否失败回调
completeFunction否执行结束后的回调
fail 返回错误代码：
错误码说明
202参数错误
300I/O 错误

示例：

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

file.rmdir(OBJECT)1060+

删除目录

参数：

参数名类型必填说明
uriString是目录的 uri，不能是应用资源路径和 tmp 类型的 uri
recursiveBoolean否是否递归删除子文件和子目录。默认 false
successFunction否成功回调
failFunction否失败回调
completeFunction否执行结束后的回调
fail 返回错误代码：
错误码说明
202参数错误
300I/O 错误

示例：

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

后台运行限制

无限制。

后台运行详细用法参见 后台运行脚本。


快应用 数据存储
快应用 交换数据
温馨提示
下载编程狮App，免费阅读超1000+编程语言教程
取消
确定
目录

快应用 指南

快应用 教程

快应用 总述

快应用 入门教程

快应用 框架教程

快应用 组件教程

快应用 平台教程

快应用 接口

快应用 其他

快应用 工具

快应用 参考手册

快应用 框架概述

快应用 组件文档

快应用 通用组件

快应用 容器组件

快应用 基础组件

快应用 表单组件

快应用 媒体组件

快应用 其他组件

快应用 画布组件

快应用 第三方组件

快应用 接口文档

快应用 界面交互

快应用 网络访问

快应用 文件数据

快应用 系统能力

快应用 安全

快应用 图形图像

快应用 声音音频

快应用 厂商服务

快应用 第三方服务

快应用 厂商开发者平台

OPPO开放平台 快应用文档

快应用 开发工具

快应用 厂商开发者账号申请

快应用 资源下载

关闭

 MIP.setData({ 'pageTheme' : getCookie('pageTheme') || {'day':true, 'night':false}, 'pageFontSize' : getCookie('pageFontSize') || 20 }); MIP.watch('pageTheme', function(newValue){ setCookie('pageTheme', JSON.stringify(newValue)) }); MIP.watch('pageFontSize', function(newValue){ setCookie('pageFontSize', newValue) }); function setCookie(name, value){ var days = 1; var exp = new Date(); exp.setTime(exp.getTime() + days*24*60*60*1000); document.cookie = name + '=' + value + ';expires=' + exp.toUTCString(); } function getCookie(name){ var reg = new RegExp('(^| )' + name + '=([^;]*)(;|$)'); return document.cookie.match(reg) ? JSON.parse(document.cookie.match(reg)[2]) : null; }