鸿蒙语言基础类库：【@system.file (文件存储)】

于 2024-07-16 20:36:22 发布
阅读量527 收藏 12
点赞数 8
分类专栏： 鸿蒙开发学习笔录 文章标签： harmonyos 鸿蒙 鸿蒙开发 OpenHarmony 程序员 存储 移动开发
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/2301_76813281/article/details/140476161
版权

文件存储

说明：

  • 从API Version 6开始，该接口不再维护，推荐使用新接口[@ohos.fileio]。
  • 本模块首批接口从API version 3开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import file from '@system.file';

file.move

move(Object): void

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

系统能力： SystemCapability.FileManagement.File.FileIO

参数：

参数名类型必填说明
srcUristring是要移动的文件的uri。字符串最大长度为128，且不能包含“"*+,:;<=>?[]
dstUristring是文件要移动到的位置的uri。字符串最大长度为128，且不能包含“"*+,:;<=>?[]
successFunction否接口调用成功的回调函数，返回文件要移动到的位置的uri。
failFunction否接口调用失败的回调函数。
completeFunction否接口调用结束的回调函数。

fail返回错误代码：

错误码说明
202出现参数错误。
300出现I/O错误。
301文件或目录不存在。

示例：

export default {    
  move() {        
    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

copy(Object): void

将指定文件拷贝并存储到指定位置。

系统能力： SystemCapability.FileManagement.File.FileIO

参数：

参数名类型必填说明
srcUristring是要拷贝的文件的uri。
dstUristring是文件要拷贝到的位置的uri。 不支持用应用资源路径或tmp类型的uri。
successFunction否接口调用成功的回调函数，返回文件要拷贝到的位置的uri。
failFunction否接口调用失败的回调函数。
completeFunction否接口调用结束的回调函数。

fail返回错误代码：

错误码说明
202出现参数错误。
300出现I/O错误。
301文件或目录不存在。

示例：

export default {    
  copy() {        
    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

list(Object): void

获取指定路径下全部文件的列表。

系统能力： SystemCapability.FileManagement.File.FileIO

参数：

参数名类型必填说明
uristring是目录uri。字符串最大长度为128，且不能包含“"*+,:;<=>?[]
successFunction否接口调用成功的回调函数。
failFunction否接口调用失败的回调函数。
completeFunction否接口调用结束的回调函数。

success返回值：

参数名类型说明
fileListArray获取的文件列表，其中每个文件的信息的格式为： { uri:‘file1’, lastModifiedTime:1589965924479, length:10240, type: ‘file’ }

表1 FileInfo

参数名类型说明
uristring文件的 uri。
lastModifiedTimenumber文件上一次保存时的时间戳，显示从1970/01/01 00:00:00 GMT到当前时间的毫秒数。
lengthnumber文件的大小，单位为字节。
typestring文件的类型，可选值为： - dir：目录； - file：文件。

fail返回错误代码：

错误码说明
202出现参数错误。
300出现I/O错误。
301文件或目录不存在。

示例：

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

file.get

get(Object): void

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

系统能力： SystemCapability.FileManagement.File.FileIO

参数：

参数名类型必填说明
uristring是文件的uri。
recursiveboolean否是否进行递归获取子目录文件列表，缺省为false。
successFunction否接口调用成功的回调函数。
failFunction否接口调用失败的回调函数。
completeFunction否接口调用结束的回调函数。

success返回值：

参数名类型说明
uristring文件的uri。
lengthnumber文件字节长。
lastModifiedTimenumber文件保存时的时间戳，从1970/01/01 00:00:00到当前时间的毫秒数。
typestring文件类型，可选值为： - dir：目录； - file：文件。
subFilesArray文件列表。

fail返回错误代码：

错误码说明
202出现参数错误。
300出现I/O错误。
301文件或目录不存在。

示例：

export default {    
  get() {        
    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

delete(Object): void

删除本地文件。

系统能力： SystemCapability.FileManagement.File.FileIO

参数：

参数名类型必填说明
uristring是删除文件的uri，不能是应用资源路径。
successFunction否接口调用成功的回调函数。
failFunction否接口调用失败的回调函数。
completeFunction否接口调用结束的回调函数。

fail返回错误代码：

错误码说明
202参数错误。
300I/O错误。
301文件或目录不存在。

示例：

export default {    
  delete() {        
    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

writeText(Object): void

写文本内容到指定文件。仅支持文本文档读写。

系统能力： SystemCapability.FileManagement.File.FileIO

参数：

参数名类型必填说明
uristring是本地文件uri，如果文件不存在会创建文件。
textstring是写入的字符串。
encodingstring否编码格式，默认为UTF-8。
appendboolean否是否追加模式，默认为false。
successFunction否接口调用成功的回调函数。
failFunction否接口调用失败的回调函数。
completeFunction否接口调用结束的回调函数。

fail返回错误代码：

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

示例：

export default {    
  writeText() {        
    file.writeText({            
      uri: 'internal://app/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

writeArrayBuffer(Object): void

写Buffer内容到指定文件。仅支持文本文档读写。

系统能力： SystemCapability.FileManagement.File.FileIO

参数：

参数名类型必填说明
uristring是本地文件uri，如果文件不存在会创建文件。
bufferUint8Array是写入的Buffer。
positionnumber否文件开始写入数据的位置的偏移量，默认为0。
appendboolean否是否追加模式，默认为false。当设置为true时，position参数无效。
successFunction否接口调用成功的回调函数。
failFunction否接口调用失败的回调函数。
completeFunction否接口调用结束的回调函数。

fail返回错误代码：

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

示例：

export default {    
  writeArrayBuffer() {       
    file.writeArrayBuffer({           
      uri: 'internal://app/test',           
      buffer: new Uint8Array(8), //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

readText(Object): void

从指定文件中读取文本内容。仅支持文本文档读写。

系统能力： SystemCapability.FileManagement.File.FileIO

参数：

参数名类型必填说明
uristring是本地文件uri。
encodingstring否编码格式，缺省为UTF-8。
positionnumber否读取的起始位置，默认值为文件的起始位置。
lengthnumber否读取的长度，默认值为4096。
successFunction否接口调用成功的回调函数。
failFunction否接口调用失败的回调函数。
completeFunction否接口调用结束的回调函数。

success返回值：

参数名类型说明
textstring读取到的文本内容。

fail返回错误代码：

错误码说明
202出现参数错误。
300出现I/O错误。
301文件或目录不存在。
302要读取的文件内容超过4KB。

示例：

export default {    
  readText() {        
    file.readText({            
      uri: 'internal://app/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

readArrayBuffer(Object): void

从指定文件中读取Buffer内容。仅支持文本文档读写。

系统能力： SystemCapability.FileManagement.File.FileIO

参数：

参数名类型必填说明
uristring是本地文件uri。
positionnumber否读取的起始位置，缺省为文件的起始位置。
lengthnumber否需要读取的长度，缺省则读取到文件结尾。
successFunction否接口调用成功的回调函数。
failFunction否接口调用失败的回调函数。
completeFunction否接口调用结束的回调函数。

success返回值：

参数名类型说明
bufferUint8Array读取到的文件内容。

fail返回错误代码：

错误码说明
202出现参数错误。
300出现I/O错误。
301文件或目录不存在。

示例：

export default {    
  readArrayBuffer() {        
    file.readArrayBuffer({            
      uri: 'internal://app/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

access(Object): void

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

系统能力： SystemCapability.FileManagement.File.FileIO

参数：

参数名类型必填说明
uristring是目录或文件uri。
successFunction否接口调用成功的回调函数。
failFunction否接口调用失败的回调函数。
completeFunction否接口调用结束的回调函数。

fail返回错误代码：

错误码说明
202出现参数错误。
300出现I/O 错误。
301文件或目录不存在。

示例：

export default {    
  access() {        
    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

mkdir(Object): void

创建指定目录。

系统能力： SystemCapability.FileManagement.File.FileIO

参数：

参数名类型必填说明
uristring是目录的uri路径。
recursiveboolean否是否递归创建该目录的上级目录，缺省为false。
successFunction否接口调用成功的回调函数。
failFunction否接口调用失败的回调函数。
completeFunction否接口调用结束的回调函数。

fail返回错误代码：

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

示例：

export default {    
  mkdir() {        
    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

rmdir(Object): void

删除指定目录。

系统能力： SystemCapability.FileManagement.File.FileIO

参数：

参数名类型必填说明
uristring是目录的uri路径。
recursiveboolean否是否递归删除子文件和子目录，缺省为false。
successFunction否接口调用成功的回调函数。
failFunction否接口调用失败的回调函数。
completeFunction否接口调用结束的回调函数。

fail返回错误代码：

错误码说明
202出现参数错误。
300出现I/O 错误。
301文件或目录不存在。HarmonyOS与OpenHarmony鸿蒙文档籽料：结尾扫直接拿

在这里插入图片描述

示例：

export default {    
  rmdir() {        
    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);            
      },
    });    
  }
}
爱桥代码的程序媛
关注
  • 8
    点赞
  • 踩
  • 12
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
记录一次开机内存分析的全过程(1)，2024年最新HarmonyOS鸿蒙 面试题库
2401_84167109的博客
04-21 911
dumpsys这个指令很有用，除了可“dumpsys meminfo+包名”以抓取内存，还可以“dumpsys package +包名”查看包信息（此前有看到其他同事使用这个指令查看应用是否有system flag来确定是否是因为没有system标识而被冻结导致的ANR），“dumpsys gfxinfo +包名”查看显示渲染信息进而查看卡顿情况。■ meminfo 内存■ gfxinfo 帧率■ display 显示■ power 电源■ battery 电池。
VC++中的glut类库：glaux.h gl.h glu.h glext.h 下载
03-15
内容索引:VC/C++源码,控件相关,glut,OpenGL　VC++中的glut类库：glaux.h gl.h glu.h glext.h 下载，OpenGL辅助开发类库的所需文件，发觉有不少朋友在找这些文件，但是网上竟然搜不到啊，巨汗！笔者电脑上幸亏有，...
鸿蒙开发ArkUI-X基础知识：【ArkUI代码工程及构建介绍】
m0_62167422的博客
05-24 1150
ArkUI作为OpenHarmony的默认开发框架，在本项目（ArkUI-X）中需要做到一套代码同时支持多平台构建，所以会采取共仓开发的方式，部分仓直接指向OpenHarmony相关开源仓。代码工程的目录结构如下： 具体的代码结构及指向，见下表：OpenHarmony相关代码仓，指向OpenHarmony master分支的固定tag点，定期同步，默认按照OpenHarmony的Weekly分支频率进行同步。ArkUI引擎核心代码仓 的目录结构以及每个目录的内容如下： 编译构建流程 为了支持一
HarmonyOS开发详解（三）——鸿蒙程序结构详解以及真机运行调试
u013272092的专栏
12-02 3944
通过本篇详细讲解鸿蒙程序的逻辑结构和物理结构组成，以及程序重要的目录和配置文件，让你可以对鸿蒙的程序结构有一个详细了解；在此基础上通过讲解本地虚拟机、远程真机、本地真机配置调试、运行一个官方程序，特别是本地真机运行程序希望能给你带来“总算跑亲自起来一个鸿蒙应用啦”的真实感和自信。
HarmonyOS JS UI
woyebuzhidao321的博客
03-11 1901
什么是鸿蒙鸿蒙操作系统 (HarmonyOS、鸿蒙OS) 是一款面向全场景的分布式操作系统。其开源项目为OpenHarmony。历史2012 年，华为开始规划自有操作系统“鸿蒙”2019 年 8 月 9 日，华为在发布鸿蒙 1.02020 年 9 月 10 日，华为发布鸿蒙 2.02021 年 6 月 2 日，鸿蒙正式商用（华为正式发布 HarmonyOS 2 及多款搭载 HarmonyOS 2 的新产品）鸿蒙的三大特征超级小程序H5 只能使用浏览器的功能。
HarmonyOS分布式文件系统开发指导
hdbdhdbh的博客
02-17 1067
分布式文件系统（hmdfs，HarmonyOS Distributed File System）提供跨设备的文件访问能力，适用于如下场景：● 两台设备组网，用户可以利用一台设备上的编辑软件编辑另外一台设备上的文档。● 平板保存的音乐，车载系统直接可见并可播放。● 户外拍摄的照片，回家打开平板直接访问原设备拍摄的照片。hmdfs 在分布式软总线动态组网的基础上，为网络上各个设备结点提供一个全局一致的访问视图，支持开发者通过基础文件系统接口进行读写访问，具有高性能、低延时等优点。
android混合式开发实现Vue调用原生相机及文件系统
ct1104的博客
11-17 4013
Android7.0之后文件系统禁止向外面公开file://URL路径，必须使用FileProvider通过content://URL 来向外部分享文件 在Android项目的清单列表加入 <provider android:name="androidx.core.content.FileProvider" android:authorities="com.example.demo2.fileprovider" andro
写给Android开发者的HarmonyOS入门指南
2401_83048197的博客
03-21 1492
一路看下来，相信你对HarmonyOS项目如何上手已经有了思路，作为Android开发者，我在写这篇文章的时候更多的是在寻找HarmonyOS和Android开发的相似之处，通过这样的对比，我们不需要从头了解HarmonyOS开发，就能更快的入手了。最后分享一份鸿蒙（HarmonyOS）开发学习指南需要的可以扫码免费领取！！！
一、Java入门&IDEA&基础语法 ★ ✔（模块一）【知识：jdk目录、数据类型、jdk jre jvm、字节、javac java】
蓝天it（让亿万孩子在蓝天下共享优质教育）
06-26 1008
Java是一门非常优秀的计算机语言语言：人与人交流沟通的表达方式计算机语言：人与计算机之间进行信息交流沟通的一种特殊语言Java之父：詹姆斯·高斯林（James Gosling）知道了Java是什么之后，大家就会想，我们学完Java可以做什么呢？下面，我们就来聊一聊，那什么是IDEA呢？**IDEA：**全称Intellij IDEA，是用于Java语言开发的集成环境，是业界公认的目前用于Java程序开发最好的工具。
go技术文章梳理（2018）
热门推荐
NicolasLearner的博客
03-02 8万+
gocn_news_2018-12-31 1. Go 入门简介：http://t.cn/EbjzeSt 2. Go GraphQL 新手指南： https://tutorialedge.net/golang/go-graphql-beginners-tutorial/ 3. 你需要 Go web 框架吗：https://medium.com/@tusharsoni/do-you-need-a-web-framework-for-go-51171bb0ea8c 4. OpenEdge：开放的边缘计算平
鸿蒙原生应用开发-ArkTS语言基础类库单次IO.docx
04-24
华为 鸿蒙原生应用开发-ArkTS语言基础类库单次IO
.NET Core类库System.Reflection.DispatchProxy实现简易Aop的方法
10-17
主要给大家介绍了关于.NET Core类库System.Reflection.DispatchProxy实现简易Aop的相关资料，文中通过示例代码结束的非常详细，需要的朋友可以参考借鉴，下面随着小编来一起学习学习吧
nanoFramework.System.Text.RegularExpressions:nanoFramework System.Text.RegularExpressions类库
04-11
欢迎使用nanoFramework System.Text.RegularExpressions存储库！建置状态成分建置状态NuGet软件包System.Text.RegularExpressions System.Text.RegularExpressions（预览） 重要提示：此正则表达式解析器将满足您的...
C#类库System.Memory.dll版本号是4.0.1.2
01-06
C#类库System.Memory.dll版本号是4.0.1.2
玩转HarmonyOS NEXT之组件导航与路由跳转一
断线的风筝
07-10 1164
Navigation通过事件提供自定义转场动画的能力，通过如下三步可以定义一个自定义的转场动画。构建一个自定义转场动画工具类，通过一个Map管理各个页面自定义动画对象CustomTransition，页面在创建的时候将自己的自定义转场动画对象注册进去，销毁的时候解注册。实现一个转场协议对象。
玩转鸿蒙NXET之组件导航与路由跳转二
最新发布
断线的风筝
07-12 889
页面路由指在应用程序中实现不同页面之间的跳转和数据传递。模块通过不同的url地址，可以方便地进行页面路由，轻松地访问不同的页面。本文将从页面跳转、页面返回、页面返回前增加一个询问框和命名路由几个方面介绍模块提供的功能。页面跳转是开发过程中的一个重要组成部分。在使用应用程序时，通常需要在不同的页面之间跳转，有时还需要将数据从一个页面传递到另一个页面。 参数接收 通过调用方法获取Index页面传递过来的自定义参数 页面返回 页面返回 当用户在一个页面完成操作后，通常需要返回到上一个页面或者指定页面，这就需要用到
鸿蒙语言基础类库：【@ohos.util.TreeSet (非线性容器TreeSet)】
2301_76813281的博客
07-10 892
TreeSet基于[TreeMap]实现，在TreeSet中，只对value对象进行处理。TreeSet可用于存储一系列值的集合，元素中value唯一且有序。
【HarmonyOS NEXT】鸿蒙 代码混淆
wu1004019946的博客
07-10 1182
针对工程源码的混淆可以降低工程被破解攻击的风险，缩短代码的类与成员的名称，减小应用的大小。DevEco Studio提供代码混淆的能力并默认开启，API 10及以上版本的Stage模型、编译模式为release时自动进行代码混淆。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值