文件存储

接口声明

{ "name": "blueos.storage.file" }

导入模块

import file from '@blueos.storage.file'

注意：下面文件操作仅支持 URI 的写法，不支持文件绝对路径。

接口定义

file.move(OBJECT)

将源文件移动到指定位置

参数：

参数名	类型	必填	说明
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 描述请参考文件组织

参数：

参数名	类型	必填	说明
uri	String	是	文件的 uri，不能是应用资源路径。 支持应用资源路径
recursive	Boolean	否	是否递归获取子目录文件列表。默认 false
success	Function	否	成功回调，返回{uri:‘file1’, length:123456, lastModifiedTime:1233456}
fail	Function	否	失败回调
complete	Function	否	执行结束后的回调

success 返回值：

参数名	类型	说明
uri	String	文件的 uri，该 uri 可以被其他组件或 Feature 访问
length	Number	文件大小，单位 B
lastModifiedTime	Number	文件的保存是的时间戳，从 1970/01/01 08:00:00 到当前时间的毫秒数
type	String	文件类型，dir：目录；file：文件
subFiles	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)

写文本到文件

参数：

参数名	类型	必填	说明
uri	String	是	本地文件路径，不支持资源文件路径和 tmp 分区，如果文件不存在会创建文件
text	String	是	需要写入的字符串
encoding	String	否	编码格式，默认 UTF-8
append	Boolean	否	是否追加模式，默认 false
success	Function	否	成功回调
fail	Function	否	失败回调
complete	Function	否	执行结束后的回调

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)

写 Buffer 到文件

参数：

参数名	类型	必填	说明
uri	String	是	本地文件路径，不支持资源文件路径和 tmp 分区，如果文件不存在会创建文件
buffer	Uint8Array	是	需要写入的 Buffer
position	Number	否	指向文件开始写入数据的位置的偏移量，默认 0
append	Boolean	否	是否追加模式，默认 false。当为 true 时，position 参数无效
success	Function	否	成功回调
fail	Function	否	失败回调
complete	Function	否	执行结束后的回调

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)

从文件中读取文本

参数：

参数名	类型	必填	说明
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)

从文件中读取 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.byteLength: ' + data.buffer.byteLength)
  },
  fail: function (data, code) {
    console.log(`handling fail, code = ${code}`)
  },
})

file.access(OBJECT)

判断文件或目录是否存在

参数：

参数名	类型	必填	说明
uri	String	是	目录或文件 uri，不能是应用资源路径和 tmp 类型的 uri。 支持应用资源路径
success	Function	否	成功回调
fail	Function	否	失败回调
complete	Function	否	执行结束后的回调

fail 返回错误代码：

错误码	说明
202	参数错误
300	I/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)

创建目录

参数：

参数名	类型	必填	说明
uri	String	是	目录的 uri，不能是应用资源路径和 tmp 类型的 uri
recursive	Boolean	否	是否递归创建该目录的上级目录后再创建该目录。默认 false
success	Function	否	成功回调
fail	Function	否	失败回调
complete	Function	否	执行结束后的回调

fail 返回错误代码：

错误码	说明
202	参数错误
300	I/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)

删除目录

参数：

参数名	类型	必填	说明
uri	String	是	目录的 uri，不能是应用资源路径和 tmp 类型的 uri
recursive	Boolean	否	是否递归删除子文件和子目录。默认 false
success	Function	否	成功回调
fail	Function	否	失败回调
complete	Function	否	执行结束后的回调

fail 返回错误代码：

错误码	说明
202	参数错误
300	I/O 错误

示例：

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

通用 fail 回调参数定义

属性	类型	说明
data	string	接口失败信息描述
code	FailCodeEnum	接口失败业务码

FailCodeEnum

属性	说明
202	参数错误
300	I/O 错误
301	文件不存在
302	存储空间不足