HarmonyOS NEXT实战:沙箱工具

简介: 本教程介绍如何在HarmonyOS中通过SDK实现沙箱文件管理。主要内容包括:获取应用沙箱路径、使用fs模块进行文件操作,如打开、复制、读写和删除文件等。通过封装SandboxUtil工具类,实现保存文件到沙箱及清除沙箱文件功能,帮助开发者掌握HarmonyOS应用文件管理技巧。

HarmonyOS Next实战##HarmonyOS SDK应用服务##教育

目标:封装沙箱工具,通过沙箱工具保存文件到沙箱中和清除沙箱文件。

知识点:
使用该功能模块对文件/目录进行操作前,需要先获取其应用沙箱路径,获取方式及其接口:getContext().cacheDir

fs:使用该功能模块对文件/目录进行操作前,需要先获取其应用沙箱路径。表示沙箱路径的字符串称为path,获取方式及其接口用法请参考:应用上下文Context-获取应用文件路径。
将指向资源的字符串称为URI。对于只支持path作为入参的接口可使用构造fileUri对象并获取其path属性的方式将URI转换为path,然后使用文件接口。

fs.open:打开文件,使用Promise异步回调。

open(path: string, mode?: number): Promise<File>

path:文件的应用沙箱路径或文件URI。
mode:打开文件的选项,必须指定如下选项中的一个,默认以只读方式打开:

  • OpenMode.READ_ONLY(0o0):只读打开。
  • OpenMode.WRITE_ONLY(0o1):只写打开。
  • OpenMode.READ_WRITE(0o2):读写打开。
    给定如下功能选项,以按位或的方式追加,默认不给定任何额外选项:
  • OpenMode.CREATE(0o100):若文件不存在,则创建文件。
  • OpenMode.TRUNC(0o1000):如果文件存在且文件具有写权限,则将其长度裁剪为零。
  • OpenMode.APPEND(0o2000):以追加方式打开,后续写将追加到文件末尾。
  • OpenMode.NONBLOCK(0o4000):如果path指向FIFO、块特殊文件或字符特殊文件,则本次打开及后续 IO 进行非阻塞操作。
  • OpenMode.DIR(0o200000):如果path不指向目录,则出错。不允许附加写权限。
  • OpenMode.NOFOLLOW(0o400000):如果path指向符号链接,则出错。
  • OpenMode.SYNC(0o4010000):以同步IO的方式打开文件。

fs.access:检查当前进程是否可访问某文件,使用Promise异步回调。
fs.mkdirSync:以同步方法创建目录。
fs.copyFile:复制文件,使用Promise异步回调。
fs.close:关闭文件,使用Promise异步回调。
fs.rmdir:删除整个目录,使用Promise异步返回。
fs.listFileSync:以同步方式列出文件夹下所有文件名。支持递归列出所有文件名(包含子目录下),支持文件过滤。

实战:SandboxUtil

import fs from '@ohos.file.fs';
import {
    util } from '@kit.ArkTS';
import {
    BusinessError } from '@kit.BasicServicesKit';

/**
 * 沙箱工具类
 */
class SandboxUtil {
   
  private sandboxDir:string ='/sandbox'

  /**
   * 保存文件到沙箱
   * @param src
   * @returns 沙箱地址
   */
  async saveToSandbox(src: string): Promise<string> {
   
    let sandboxUri: string = ''
    for (let index = 0; index < src.length; index++) {
   
      const uri = src;
      try {
   
        const originalFile = await fs.open(uri)
        const targetFileDirPath = getContext().cacheDir + this.sandboxDir
        const fileName = util.generateRandomUUID() + uri.split("/").pop() ?? ''
        if (!fs.accessSync(targetFileDirPath)) {
   
          fs.mkdirSync(targetFileDirPath, true)
        }
        const targetFile =
          await fs.open(`${
     targetFileDirPath}/${
     fileName}`,
            fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE)
        await fs.copyFile(originalFile.fd, targetFile.fd)
        await fs.close(originalFile.fd);
        await fs.close(targetFile.fd);
        sandboxUri=targetFile.path
      } catch (e) {
   
        const err = e as BusinessError
        console.error(`[log]MediaPicker saveToSandbox, err=${
     JSON.stringify(err)}`); //err.code == 13900001 文件失效
      }
    }
    return sandboxUri
  }

  /**
   * 清除沙箱文件
   */
  clear() {
   
    const targetFileDirPath = getContext().cacheDir + this.sandboxDir
    fs.rmdir(targetFileDirPath);
  }

  /**
   * 获取沙箱路径下所有文件名,支持递归列出所有文件名(包含子目录下),并以日志形式打印
   * 用于检查沙箱情况
   */
  print() {
   
    const targetFileDir = getContext().cacheDir + this.sandboxDir
    if (fs.accessSync(targetFileDir)) {
   
      let listFile = fs.listFileSync(targetFileDir, {
    recursion: true })
      let listFileStr = listFile.join('\n');
      console.log(`[log]postVideoSandbox print, listFileStr=${
     JSON.stringify(listFileStr)}`);
    } else {
   
      console.log(`[log]postVideoSandbox print, 目标文件不存在, targetFileDir=${
     JSON.stringify(targetFileDir)}`);
    }
  }
}

const sandboxUtil = new SandboxUtil()

export default sandboxUtil

使用

import sandboxUtil from './SandboxUtil';

@Entry
@Component
struct SandboxDemoPage {
   
  @State message: string = 'SandboxDemo';

  build() {
   
    Column() {
   
      Text(this.message)
        .fontSize($r('app.float.page_text_font_size'))
        .fontWeight(FontWeight.Bold)
      Button('保存文件')
        .onClick(()=>{
   
          sandboxUtil.saveToSandbox('fielPath')
        })
      Button('删除文件')
        .onClick(()=>{
   
          sandboxUtil.clear()
        })
    }
    .height('100%')
    .width('100%')
  }
}
目录
相关文章
|
4月前
|
容器
HarmonyOS NEXT仓颉开发语言实战案例:外卖App
仓颉语言实战分享,教你如何用仓颉开发外卖App界面。内容包括页面布局、导航栏自定义、搜索框实现、列表模块构建等,附完整代码示例。轻松掌握Scroll、List等组件使用技巧,提升HarmonyOS应用开发能力。
|
3月前
|
移动开发 前端开发 JavaScript
鸿蒙NEXT时代你所不知道的全平台跨端框架:CMP、Kuikly、Lynx、uni-app x等
本篇基于当前各大活跃的跨端框架的现状,对比当前它们的情况和未来的可能,帮助你在选择框架时更好理解它们的特点和差异。
312 0
|
4月前
|
安全 API 开发工具
【HarmonyOS NEXT】一键扫码功能
这些Kit为我们应用开发提升了极大地效率。很多简单的功能,如果不需要太深的定制化需求,直接调用kit提供的API就可以实现,在android或者ios上需要很多代码才能实现的功能效果。
119 0
HarmonyOS NEXT仓颉开发语言实战案例:电影App
周末好!本文分享使用仓颉语言重构ArkTS实现的电影App案例,对比两者在UI布局、组件写法及语法差异。内容包括页面结构、列表分组、分类切换与电影展示等。通过代码演示仓颉在HarmonyOS开发中的应用。##仓颉##ArkTS##HarmonyOS开发
|
4月前
|
容器
HarmonyOS NEXT仓颉开发语言实战案例:健身App
本期分享一个健身App首页的布局实现,顶部采用Stack容器实现重叠背景与偏移效果,列表部分使用List结合Scroll实现可滚动内容。代码结构清晰,适合学习HarmonyOS布局技巧。
HarmonyOS NEXT仓颉开发语言实战案例:小而美的旅行App
本文分享了一个旅行App首页的设计与实现,使用List容器搭配Row、Column布局完成个人信息、功能列表及推荐模块的排版,详细展示了HarmonyOS下的界面构建技巧。
|
18天前
|
存储 缓存 5G
鸿蒙 HarmonyOS NEXT端云一体化开发-云存储篇
本文介绍用户登录后获取昵称、头像的方法,包括通过云端API和AppStorage两种方式,并实现上传头像至云存储及更新用户信息。同时解决图片缓存问题,添加上传进度提示,支持自动登录判断,提升用户体验。
90 0
|
18天前
|
存储 负载均衡 数据库
鸿蒙 HarmonyOS NEXT端云一体化开发-云函数篇
本文介绍基于华为AGC的端云一体化开发流程,涵盖项目创建、云函数开通、应用配置及DevEco集成。重点讲解云函数的编写、部署、调用与传参,并涉及环境变量设置、负载均衡、重试机制与熔断策略等高阶特性,助力开发者高效构建稳定云端服务。
178 0
鸿蒙 HarmonyOS NEXT端云一体化开发-云函数篇
|
18天前
|
存储 JSON 数据建模
鸿蒙 HarmonyOS NEXT端云一体化开发-云数据库篇
云数据库采用存储区、对象类型、对象三级结构,支持灵活的数据建模与权限管理,可通过AGC平台或本地项目初始化,实现数据的增删改查及端侧高效调用。
50 0
|
18天前
|
存储 开发者 容器
鸿蒙 HarmonyOS NEXT星河版APP应用开发-ArkTS面向对象及组件化UI开发使用实例
本文介绍了ArkTS语言中的Class类、泛型、接口、模块化、自定义组件及状态管理等核心概念,并结合代码示例讲解了对象属性、构造方法、继承、静态成员、访问修饰符等内容,同时涵盖了路由管理、生命周期和Stage模型等应用开发关键知识点。
150 0
鸿蒙 HarmonyOS NEXT星河版APP应用开发-ArkTS面向对象及组件化UI开发使用实例