OpenHarmony基線功能之文件管理

作者：紀春祥 2022-03-10 14:45:23

本文將重點關注文件管理部分的API，試圖厘清文件管理在OpenHarmony如何從應用到操作系統，如何工作的。

??https://ost.51cto.com??

概述

文件管理作為操作系統的一個核心基本功能，為每個應用開發者所關注，操作系統本身的許多功能亦基于文件，而對于應用來說，可以說沒有文件系統，就不能有應用的業務，可能會有很多人反駁，可以把數據保存到數據庫，但數據庫歸根結底還是文件。大家在HarmonyOS官網看API參考時，可以看到OpenHarmony提供了三種API：JAVA API參考、Native API參考和JS API參考。

https://developer.harmonyos.com/cn/docs/documentation/doc-references/reference-document-outline-0000001115016824。

本文將重點關注文件管理部分的API，試圖厘清文件管理在OpenHarmony如何從應用到操作系統，如何工作的。重點梳理三個方面：

文件管理都有哪些接口供應用調用。
怎么調用到操作系統的。
操作系統怎么工作的。

希望讀者能盡可能多的參與進來一起評論，查漏補缺，以便筆者逐步完善內容，讓開源越來越好。

接口

備注：

1、限于表格限制，不會列所有，詳細可以查閱官方api文檔：https://developer.harmonyos.com/cn/docs/documentation/doc-references/files-0000001054678506#ZH-CN_TOPIC_0000001054678506__createFile-java_nio_file_Path-java_nio_file_attribute_FileAttribute___-。

2、Native API也可以用標準c、c++進行文件操作。

3、JS API @ohos.fileio提供了三種調用方式，分別是Promise、Callback和同步方式。

4、@ohos.fileio：基于手機(Phone)、平板(Tablet)、智慧屏(TV)或智能穿戴(Wearable)的模板進行開發時使用。

5、@system.file：基于輕量級智能穿戴(Lite Wearable)的模板進行開發時使用。

JS API文件接口的使用

接口文檔中都提供了樣例，開發者可以比較清楚地知道怎么調用API以實現功能。

import fileio from '@ohos.fileio';
let fd = fileio.openSync(path, 0o2);
let buf = new ArrayBuffer(4096);
let res = await fileio.read(fd, buf);

打開DevEco Studio 3.0.0.800，在應用代碼中調用JS API樣例。

可以看到@ohos.fileio定義在External Libraries/Gradle:ACE JS-common-3.0.0.1\common里面。

打開@ohos.fileio.d.ts可以看到所有函數的定義。

這里出現了一個大問號，為什么只有定義沒有實現呢?這里就引入下一章節，是所有JS API的通用技術，并非文件管理專有。因為OpenHarmony是基于Linux的，最終要調用到c實現，對于JAVA API應該是調用到JAVA虛擬機直接進行文件操作，java也是c實現的，Native API直接調用c函數實現，所以這里只追一下JS API是如何實現調用到操作系統api的。

NAPI

NAPI：JavaScript API框架。

介紹比較全面的，可以參見(https://harmonyos.51cto.com/posts/8390)。

模塊都有一個export()方法，將js的api映射到具體的c++函數。

實現

以@fileio.read和@fileio.readSync為例：

${KaihongOS}\foundation\distributeddatamgr\distributedfile\interfaces\kits\js\src\mod_fileio\class_dir\dir_n_exporter.cpp。

napi_value DirNExporter::Read(napi_env env, napi_callback_info info)
{
    NFuncArg funcArg(env, info);
    if (!funcArg.InitArgs(NARG_CNT::ZERO, NARG_CNT::ONE)) {
        UniError(EINVAL).ThrowErr(env, "Number of arguments unmatched");
        return nullptr;
    }
    auto dirEntity = NClass::GetEntityOf<DirEntity>(env, funcArg.GetThisVar());
    if (!dirEntity) {
        UniError(EIO).ThrowErr(env, "Cannot get entity of Dir");
        return nullptr;
    }
    if (!dirEntity || !dirEntity->dir_) {
        UniError(EBADF).ThrowErr(env, "Dir has been closed yet");
        return nullptr;
    }
    DIR *dir = dirEntity->dir_.get();
    auto arg = make_shared<DirReadArgs>(NVal(env, funcArg.GetThisVar()));
    auto cbExec = [arg, dir, dirEntity](napi_env env) -> UniError {
        struct dirent tmpDirent;
        lock_guard(dirEntity->lock_);
        errno = 0;
        dirent *res = nullptr;
        do {
            res = readdir(dir);
            if (res == nullptr && errno) {
                return UniError(errno);
            } else if (res == nullptr) {
                return UniError(ERRNO_NOERR);
            } else if (string(res->d_name) == "." || string(res->d_name) == "..") {
                continue;
            } else {
                tmpDirent = *res;
                break;
            }
        } while (true);
        arg->dirRes = tmpDirent;
        return UniError(ERRNO_NOERR);
    };
    auto cbCompl = [arg](napi_env env, UniError err) -> NVal {
        return DoReadCompile(env, err, arg);
    };
    NVal thisVar(env, funcArg.GetThisVar());

    if (funcArg.GetArgc() == NARG_CNT::ZERO) {
        return NAsyncWorkPromise(env, thisVar).Schedule("fileioDirRead", cbExec, cbCompl).val_;
    } else {
        NVal cb(env, funcArg[NARG_POS::FIRST]);
        return NAsyncWorkCallback(env, thisVar, cb).Schedule("fileioDirRead", cbExec, cbCompl).val_;
    }
}

1、讀取參數。

2、遞歸讀取路徑readdir。

3、返回Promise或者回調。

napi_value DirNExporter::ReadSync(napi_env env, napi_callback_info info)
{
    NFuncArg funcArg(env, info);
    if (!funcArg.InitArgs(NARG_CNT::ZERO)) {
        UniError(EINVAL).ThrowErr(env, "Number of arguments unmatched");
        return nullptr;
    }   
    DirEntity *dirEntity = GetDirEntity(env, info);
    if (!dirEntity || !dirEntity->dir_) {
        UniError(EBADF).ThrowErr(env, "Dir has been closed yet");
        return nullptr;
    }
    struct dirent tmpDirent;
    {
        lock_guard(dirEntity->lock_);
        errno = 0;
        dirent *res = nullptr;
        do {
            res = readdir(dirEntity->dir_.get());
            if (res == nullptr && errno) {
                UniError(errno).ThrowErr(env);
                return nullptr;
            } else if (res == nullptr) {
                return NVal::CreateUndefined(env).val_;
            } else if (string(res->d_name) == "." || string(res->d_name) == "..") {
                continue;
            } else {
                tmpDirent = *res;
                break;
            }
        } while (true);
    }
    napi_value objDirent = NClass::InstantiateClass(env, DirentNExporter::className_, {});
    if (!objDirent) {
        return nullptr;
    }
    auto direntEntity = NClass::GetEntityOf<DirentEntity>(env, objDirent);
    if (!direntEntity) {
        return nullptr;
    }
    direntEntity->dirent_ = tmpDirent;
    return objDirent;
}