app-fs-space-statistics.md 2.9 KB
Newer Older
Z
zengyawen 已提交
1 2 3 4 5 6
# 应用及文件系统空间统计

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

## 接口说明

Z
zengyawen 已提交
7
API的详细介绍请参见[ohos.file.statvfs](../reference/apis/js-apis-file-statvfs.md)[ohos.file.storageStatistics](../reference/apis/js-apis-file-storage-statistics.md)
Z
zengyawen 已提交
8 9 10

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

Z
zengyawen 已提交
11
| 模块 | 接口名 | 功能 |
Z
zengyawen 已提交
12
| -------- | -------- | -------- |
Z
zengyawen 已提交
13
| \@ohos.file.storageStatistics | getCurrentBundleStats | 获取当前应用的存储空间大小(单位为Byte)。 | 
Z
zengyawen 已提交
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
| \@ohos.file.statvfs | getFreeSize | 获取指定文件系统的剩余空间大小(单位为Byte)。 | 
| \@ohos.file.statvfs | getTotalSize | 获取指定文件系统的总空间大小(单位为Byte)。 | 

**表2** 应用空间统计

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

## 开发示例

- 获取文件系统数据分区剩余空间大小。
    
  ```ts
  import statvfs from '@ohos.file.statvfs';
31
  import { BusinessError } from '@ohos.base';
Z
zengyawen 已提交
32 33
  
  let path = "/data";
34
  statvfs.getFreeSize(path, (err: BusinessError, number: number) => {
Z
zengyawen 已提交
35 36 37 38 39 40 41 42 43 44 45 46
    if (err) {
      console.error(`Invoke getFreeSize failed, code is ${err.code}, message is ${err.message}`);
    } else {
      console.info(`Invoke getFreeSize succeeded, size is ${number}`);
    }
  });
  ```

- 获取当前应用的存储空间大小。
    
  ```ts
  import storageStatistics from "@ohos.file.storageStatistics";
47
  import { BusinessError } from '@ohos.base';
Z
zengyawen 已提交
48
  
49
  storageStatistics.getCurrentBundleStats((err: BusinessError, bundleStats: storageStatistics.BundleStats) => {
Z
zengyawen 已提交
50 51 52 53 54 55 56
    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}`);
    }
  });
  ```