鸿蒙三方库 | harmony-utils之FileUtil文件读写操作详解
前言文件读写是最基础的文件操作pura/harmony-utils的FileUtil封装了简洁的文件读写方法支持文本和二进制数据的读写开发者无需手动管理文件流。本文将从API说明、代码实战、进阶用法、常见问题等多个维度进行全面讲解帮助开发者快速掌握并应用到实际项目中。一、FileUtil读写核心APIFileUtil提供了以下文件读写方法方法说明返回类型使用场景readTextSync(path)同步读取文本string配置文件读取writeTextSync(path, text)同步写入文本void日志文件写入readArrayBufferSync(path)同步读取二进制ArrayBuffer图片/音频读取writeArrayBufferSync(path, buffer)同步写入二进制void二进制数据保存1.1 核心特性简洁易用封装复杂API为一行调用降低使用门槛类型安全完整的TypeScript类型定义编译期即可发现错误异常处理内置异常捕获机制避免运行时崩溃双模式支持同时支持文本和二进制读写1.2 读写模式对照模式方法适用数据性能文本模式readTextSync/writeTextSync字符串适合小文件二进制模式readArrayBufferSync/writeArrayBufferSyncArrayBuffer适合所有文件二、完整使用步骤2.1 安装依赖ohpminstallpura/harmony-utils2.2 文本文件读写import{FileUtil}frompura/harmony-utils;Button(写入文本文件).width(100%).onClick((){try{letpathFileUtil.getFilesDir()/test.txt;FileUtil.writeTextSync(path,Hello harmony-utils!);this.result写入成功 ✅\n路径:${path};}catch(e){this.result异常: e;}})Button(读取文本文件).width(100%).onClick((){try{letpathFileUtil.getFilesDir()/test.txt;letcontentFileUtil.readTextSync(path);this.result读取成功 ✅\n内容:${content};}catch(e){this.result异常: e;}})2.3 二进制文件读写Button(写入二进制).width(100%).onClick((){try{letpathFileUtil.getFilesDir()/data.bin;letbuffernewArrayBuffer(4);FileUtil.writeArrayBufferSync(path,buffer);this.result二进制写入成功;}catch(e){this.result异常: e;}})三、完整页面示例import{FileUtil}frompura/harmony-utils;EntryComponentstruct FileRWDemo{Stateresult:string;build(){Column({space:12}){Button(写入文件).width(100%).onClick((){try{letpathFileUtil.getFilesDir()/demo.txt;FileUtil.writeTextSync(path,Hello World!);this.result写入成功;}catch(e){this.result异常: e;}});Button(读取文件).width(100%).onClick((){try{letpathFileUtil.getFilesDir()/demo.txt;letcontentFileUtil.readTextSync(path);this.result内容:${content};}catch(e){this.result异常: e;}});Text(this.result).fontSize(14).fontColor(#333333)}.padding(16)}}四、进阶用法4.1 JSON配置文件读写import{FileUtil}frompura/harmony-utils;functionsaveConfig(config:Recordstring,Object):void{letpathFileUtil.getFilesDir()/config.json;FileUtil.writeTextSync(path,JSON.stringify(config));}functionloadConfig():Recordstring,Object{letpathFileUtil.getFilesDir()/config.json;letcontentFileUtil.readTextSync(path);returnJSON.parse(content)asRecordstring,Object;}4.2 日志文件追加functionappendLog(message:string):void{letpathFileUtil.getFilesDir()/app.log;letexisting;try{existingFileUtil.readTextSync(path);}catch(e){}FileUtil.writeTextSync(path,existingmessage\n);}五、注意事项同步方法读写方法为同步调用大文件建议使用流式操作文件路径路径必须为应用沙箱内的有效路径编码格式文本读写默认使用UTF-8编码初始化依赖使用前需确保AppUtil.init()已调用文件大小大文件读写可能导致内存溢出六、常见问题Q1: 读取文件时提示文件不存在先检查文件路径是否正确再使用FileUtil.exists()确认文件是否存在。Q2: 写入文件后读不到内容确认写入路径和读取路径一致检查是否写入成功。Q3: 如何追加内容而不是覆盖先读取原内容拼接新内容后再写入。Q4: 二进制文件和文本文件有什么区别文本文件以字符串形式读写二进制文件以ArrayBuffer形式读写。图片、音频等应使用二进制模式。总结FileUtil的文件读写方法为应用数据持久化提供了基础支持。本文详细介绍了核心API、使用步骤、完整示例、进阶用法以及常见问题的解决方案。开发者可以根据数据类型选择合适的读写模式。本文基于pura/harmony-utils工具库更多功能请参考官方文档与后续系列文章。

相关新闻