鸿蒙0基础学习【应用及文件系统空间统计】文件基础服务

摘要：本文介绍了HarmonyOS系统中文件空间管理的相关接口，包括获取应用存储空间大小、系统内置存储空间大小以及文件系统剩余空间的统计方法。提供了6个关键接口说明和开发示例，涵盖异步/同步获取总空间、可用空间以及应用存储统计等功能。开发者可通过这些接口监控系统剩余空间，合理控制应用占用空间，避免因系统配额限制导致的问题。

蒸糕笑QAQ

848人浏览 · 2025-06-12 14:50:01

蒸糕笑QAQ · 2025-06-12 14:50:01 发布

在系统中，可能出现系统空间不够或者cacheDir等目录受系统配额限制等情况，需要应用开发者关注系统剩余空间，同时控制应用自身占用的空间大小。

接口说明

表1 文件系统空间和应用空间统计

模块	接口名	功能
@ohos.file.storageStatistics	getCurrentBundleStats	获取当前应用的存储空间大小（单位为Byte）。
@ohos.file.storageStatistics	getFreeSize	异步获取内置存储的可用空间大小（单位为Byte）。说明：从API version 15开始，支持该接口。
@ohos.file.storageStatistics	getFreeSizeSync	同步获取内置存储的可用空间大小（单位为Byte）。说明：从API version 15开始，支持该接口。
@ohos.file.storageStatistics	getTotalSize	异步获取内置存储的总空间大小（单位为Byte）。说明：从API version 15开始，支持该接口。
@ohos.file.storageStatistics	getTotalSizeSync	同步获取内置存储的总空间大小（单位为Byte）。说明：从API version 15开始，支持该接口。
@ohos.file.statvfs	getFreeSize	获取指定文件系统的剩余空间大小（单位为Byte）。
@ohos.file.statvfs	getTotalSize	获取指定文件系统的总空间大小（单位为Byte）。

表2 应用空间统计

注意

表格中统计路径列涉及的目录均指应用的沙箱路径，查看路径前需要先进入对应的应用沙箱空间。进入沙箱空间需要执行以下命令：

hdc shell。
nsenter -t {pid} -m sh。

BundleStats属性	含义	统计路径
appSize	应用安装文件大小（单位为Byte）	应用安装文件保存在以下目录：/data/storage/el1/bundle
cacheSize	应用缓存文件大小（单位为Byte）	应用的缓存文件保存在以下目录：/data/storage/el1/base/cache/data/storage/el1/base/haps/entry/cache/data/storage/el2/base/cache/data/storage/el2/base/haps/entry/cache
dataSize	应用文件存储大小（除应用安装文件和缓存文件）（单位为Byte）	应用文件由本地文件、分布式文件以及数据库文件组成。本地文件保存在以下目录（注意缓存文件目录为以下目录的子目录）：/data/storage/el1/base/data/storage/el2/base分布式文件保存在以下目录：/data/storage/el2/distributedfiles数据库文件保存在以下目录：/data/storage/el1/database/data/storage/el2/database

开发示例

获取文件系统数据分区剩余空间大小。

import { statfs } from '@kit.CoreFileKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { common } from '@kit.AbilityKit';


// 请在组件内获取context，确保this.getUIContext().getHostContext()返回结果为UIAbilityContext
let context = this.getUIContext().getHostContext() as common.UIAbilityContext; 
let path = context.filesDir;
statfs.getFreeSize(path, (err: BusinessError, number: number) => {
  if (err) {
    console.error(`Invoke getFreeSize failed, code is ${err.code}, message is ${err.message}`);
  } else {
    console.info(`Invoke getFreeSize succeeded, size is ${number}`);
  }
});

获取当前应用的存储空间大小。

import { storageStatistics } from '@kit.CoreFileKit';
import { BusinessError } from '@kit.BasicServicesKit';


storageStatistics.getCurrentBundleStats((err: BusinessError, bundleStats: storageStatistics.BundleStats) => {
  if (err) {
    console.error(`Invoke getCurrentBundleStats failed, code is ${err.code}, message is ${err.message}`);
  } else {
    console.info(`Invoke getCurrentBundleStats succeeded, appsize is ${bundleStats.appSize}`);
  }
});

异步获取内置存储的总空间大小。

import { storageStatistics } from '@kit.CoreFileKit';
import { BusinessError } from '@kit.BasicServicesKit';


storageStatistics.getTotalSize().then((number: number) => {
  console.info(`getTotalSize successfully, number is ${number}`);
}).catch((err: BusinessError) => {
  console.error(`getTotalSize failed with error, code is ${err.code}, message is ${err.message}`);
});

同步获取内置存储的总空间大小。

import { storageStatistics } from '@kit.CoreFileKit';
import { BusinessError } from '@kit.BasicServicesKit';


try {
  let number = storageStatistics.getTotalSizeSync();
  console.info(`getTotalSizeSync successfully, number is ${number}`);
} catch (err) {
  let error: BusinessError = err as BusinessError;
  console.error(`getTotalSizeSync failed with error, code is ${error.code}, message is ${error.message}`);
}

异步获取内置存储的可用空间大小。

import { storageStatistics } from '@kit.CoreFileKit';
import { BusinessError } from '@kit.BasicServicesKit';


storageStatistics.getFreeSize().then((number: number) => {
  console.info(`getFreeSize successfully, number is ${number}`);
}).catch((err: BusinessError) => {
  console.error(`getFreeSize failed with error, code is ${err.code}, message is ${err.message}`);
});

同步获取内置存储的可用空间大小。

import { storageStatistics } from '@kit.CoreFileKit';
import { BusinessError } from '@kit.BasicServicesKit';


try {
  let number = storageStatistics.getFreeSizeSync();
  console.info(`getFreeSizeSync successfully, number is ${number}`);
} catch (err) {
  let error: BusinessError = err as BusinessError;
  console.error(`getFreeSizeSync failed with error, code is ${error.code}, message is ${error.message}`);
}