想了解更多關于開源的內容，請訪問：

51CTO 開源基礎軟件社區

https://ost.51cto.com

前言

本篇來聊聊數據持久化，這個東西呢，在應用開發很重要，我對SSM，Vue2 + 3，也有了解，做過相關的Web開發（自己做著玩的，半拉子工程），以后也打算學習一些OpenHarmony北向相關的應用開發。（想南北通吃）

數據持久化簡介

在我們之前玩Hi3861開發板的時候啊，每次重啟，點擊復位鍵，都會以一個全新的效果展現在我們面前，很顯然，這樣的案例都是沒有做數據持久化的，我們的案例運行時的數據僅僅存在于計算機的內存中，當程序關閉（重啟），內存就會釋放或者重新分配，原有的數據就會丟失。常見的數據持久化的方式其實大家都見過，可能沒有意識到，比如最早的時候有光盤，現在每個電腦都有SSD硬盤，還有網盤，我個人也是非常喜歡網盤的，數據可以進行網絡層面的持久化，不占本地空間，需要什么文件，再去獲取，特別適合收藏學習文件然后放進去吃灰。數據庫也是，我們開發的APP，用戶進行注冊，用戶的信息就會永久地存放在數據庫中而不會丟失了。簡而言之，就是以一種手段，把程序運行過程中的數據保存起來。當然，安全性也是需要考慮到的，數據是敏感的，但這里不久細說了。

OpenHarmony數據持久化

強大的OpenHarmony當然也是有數據持久化的，在公共子系統集中，還是看一下OpenHarmony官網的架構圖：

公共子系統及中，有可以幫助我們實現數據持久化的API，下面會具體說。

kv_store庫

kv_store.h跟ohos_init.h在一起，看庫名也知道了，key - value 的形式存儲數據，是一種常見的存儲形式，在數據結構Map，以及JSON文件等都是KV鍵值對的存儲形式。下面來看看他的API有什么。

API

UtilsGetValue：

int UtilsGetValue(const char* key, char* value, unsigned int len);

從文件系統或cache中讀取指定鍵的值

參數解釋：

• key：鍵；小寫字母、數字、下劃線、點(.)；最大32字節（包括字符串結束符）。
• value：用于存儲值的緩沖區；輸出參數。
• len：值的長度。

返回值：

• 操作成功返回值的長度；參數錯誤返回-9；其他情況返回-1；如果值是從cache中讀取的，則返回0。

UtilsSetValue：

int UtilsSetValue(const char* key, const char* value);

在文件系統或cache中添加或更新鍵值

參數解釋：

• key：鍵；小寫字母、數字、下劃線、點(.)；最大32字節（包括字符串結束符）。
• value：要添加或更新的值；最大128字節（包括字符串結束符）。

返回值：

• 操作成功返回0；參數錯誤返回-9；其他情況返回-1

UtilsDeleteValue：

int UtilsDeleteValue(const char* key);

在文件系統或cache中刪除鍵值

參數解釋：

• key：鍵；小寫字母、數字、下劃線、點(.)；最大32字節（包括字符串結束符）。

返回值：

• 操作成功返回0；參數錯誤返回-9；其他情況返回-1

ClearKVCache：

int ClearKVCache(void);

清除緩存中的所有鍵值對

參數解釋：無

返回值：成功時返回0，否則返回-1

案例：鍵值存儲

任務：

將一個數據持久化，“key” - > “value”。

最終效果：

在完成案例后，第一次啟動開發板，通過“key”作為鍵去過去值，獲取失敗，因為什么都沒存儲嘛，然后就會獲得一個小于0的返回值，表示獲取失敗了，我們就可以進行鍵值對的添加，添加完成后，在后續的斷電重啟開發板中，無論啟動多少次，都可以通過“key”去獲取我們的值。

創建如下目錄：

編寫源碼：

kv_demo.c：

#include <stdio.h>
#include "ohos_init.h"
// kv_store 庫
#include "kv_store.h"

void kvTest(void){
    // 創建我們的鍵
    const char *key = "key";
    // 創建我們的值，這個值就是一個指針，如果能夠獲取成功，就會通過指針獲取到相應的值。
    char value[32] = {0};
    // 通過 鍵 去讀取我們的 值
    int resGet = UtilsGetValue(key, value, 32);
    // resGet < 0 說明讀取失敗，我們沒有 “key” 的數據 
    if(resGet < 0){
        // 輸出提示信息
        printf("[KVTEST] failed to read the key!\r\n");
        // 添加鍵值對數據，進行數據持久化
        int resSet = UtilsSetValue(key, "value");
        // 輸出提示信息
        if(resSet == 0){
            printf("[KVTEST] success to store!\r\n");
        } else {
            printf("[KVTEST] failed to store!\r\n");
        }
    } else {
        // 如果讀取成功，則直接輸出鍵值數據
        printf("[KVTEST] success to read the key, key = %s, value = %s.\r\n", key, value);
    }
}

APP_FEATURE_INIT(kvTest);

BUILD.gn：

static_library("kvTest"){
    sources = [
        "kv_demo.c"
    ]
    include_dirs = [
        "http://commonlibrary/utils_lite/include",
    ]
}

修改app下的BUILD.gn：

編譯燒錄串口調試：

當我們第一次進行串口調試的時候，會觀察到，我們寫的提示信息，先讀取失敗，再進行數據存儲。

再次重啟開發板，可以觀察到，讀取成功了。

斷開電源，即將開發板與主機斷開連接，再次連接，啟動開發板，可以看到仍然能夠成功讀取。數據持久化成功。

報錯分享

在編譯的時候也是出現了一個很奇怪的bug。

嗯…我也是一頭霧水不知道怎么辦，感覺像是環境問題，卻又不知道具體怎么改，最后我去到了kv_store的接口里，修改了一下他的BUILD.gn文件。

可能是posix下的文件有些問題吧，然后我修改了他的編譯文件，讓他去編譯hal下的kv_store.c 最后就是這么個意思，不管什么情況都去編譯hal下的文件。等效于下圖所示：

雖然不太清楚什么問題，但是似乎換一個文件編譯，整個編譯就成功通過了，運行起來的結果也和預期一樣，沒有bug出現。都是kv_store.c文件，可能也是為了適配不同的需求吧才分了兩個出來吧，如果有知道這個是什么問題的話，也可以評論區留言，我也來學習一下，或者你也出現了跟我一樣的bug，可以試一試按照我的方法進行修改，修改后親測是沒有問題的。

utils_file庫

數據持久化，我們更多的還是傾向于數據庫，文件，這種簡單的kv入門就可以了。文件的操作則更為重要，下面介紹utils_file庫，它可以幫助我們對文件進行IO操作，實現數據持久化。

API

UtilsFileOpen：

int UtilsFileOpen(const char* path, int oflag, int mode);

參數解釋：

• path：指定要打開或創建的文件的路徑。
• oflag：指定文件的打開模式。支持的模式有：

• O_RDONLY_FS：以只讀模式打開文件。
• O_WRONLY_FS：以只寫模式打開文件。
• O_RDWR_FS：以讀寫模式打開文件。
• O_CREAT_FS：如果文件不存在，則創建文件。
• O_EXCL_FS：與O_CREAT_FS一起使用，如果文件已存在，則打開失敗。
• O_TRUNC_FS：如果文件存在，將其截斷為空文件。
• O_APPEND_FS：以追加模式打開文件，在文件末尾寫入數據。 這些模式可以組合使用，每個模式之間使用按位或運算符"|"進行標識。

• mode：用于函數兼容性，該參數在任何情況下均不起作用。

返回值：

如果文件成功打開或創建，將返回文件描述符，否則返回-1。

UtilsFileClose：

int UtilsFileClose(int fd);

參數解釋：

fd：指定要關閉的文件的文件描述符。

返回值：

如果文件成功關閉，函數將返回0；否則返回-1。

UtilsFileRead：

int UtilsFileRead(int fd, char* buf, unsigned int len);

參數解釋：

• fd：表示要讀取的文件的文件描述符（file descriptor）。
• buf：指向存儲讀取數據的緩沖區的指針。這是一個輸出參數，函數將讀取的數據寫入到該緩沖區中。
• len：表示要讀取的數據的長度。

返回值：

• 如果成功讀取數據，函數將返回實際讀取的字節數。
• 如果讀取操作失敗，函數將返回-1。

UtilsFileWrite：

int UtilsFileWrite(int fd, const char* buf, unsigned int len);

參數解釋：

• fd：表示要寫入數據的文件的文件描述符（file descriptor）。
• buf：指向要寫入的數據的指針。
• len：表示要寫入的數據的長度。

返回值：

• 如果成功寫入數據，函數將返回實際寫入的字節數。
• 如果寫入操作失敗，函數將返回-1。

UtilsFileDelete：

int UtilsFileDelete(const char* path);

參數解釋：

• path：表示要刪除的文件的路徑。

返回值：

• 如果成功刪除文件，函數將返回0。
• 如果刪除文件操作失敗，函數將返回-1。

UtilsFileStat：

int UtilsFileStat(const char* path, unsigned int* fileSize);

參數解釋：

• path：表示文件名。
• fileSize：表示文件大小的變量指針。這是一個輸出參數，用于存儲獲取到的文件大小。

返回值：

• 如果成功獲取文件大小，函數將返回0。
• 如果獲取文件大小操作失敗，函數將返回-1。

案例：文件IO

預期效果：

打開指定的文件讀取數據庫的用戶名和密碼，如果文件不存在就先創建文件，再寫入數據。在之后的訪問中，均可成功打開數據讀取數據。跟剛剛的kv流程其實很像。

創建如下目錄：

編寫源碼：

file.c：

#include <stdio.h>
#include "ohos_init.h"
// 文件IO庫
#include "utils_file.h"

void fileTest(void){
    // 定義文件名
    char fileName[] = "MyFileName";
    // 定義文件大小，用于獲取文件大小
    int fileSize = 0;
    
    // 統計文件數據
    int resGetFile = UtilsFileStat(fileName, &fileSize);
    
    // 文件不存在時，打開失敗，返回值為 -1
    if(resGetFile == -1){
        // 輸出提示信息
        printf("[FILETEST] failed to open the file, file is not exits!\r\n");
        
        // 創建文件，并寫入數據
        // 定義數據
        char data[] = "root,password";
        // 打開文件
        int resOpenFile = UtilsFileOpen(fileName, O_WRONLY_FS | O_CREAT_FS | O_TRUNC_FS, 0);
        // 寫入數據
        int resWriteFilw = UtilsFileWrite(resOpenFile, data, strlen(data));
        // 關閉文件
        int resCloseFile = UtilsFileClose(resOpenFile);
        
        // 輸出提示信息
        printf("[FILETEST] success to create a file!\r\n");
    } else {
        // 輸出提示信息
        printf("[FILETEST] the file is exist!\r\n");
        
        // 文件存在，讀取文件內容
        int resOpenFile = UtilsFileOpen(fileName, O_CREAT_FS, 0);
        // 定義數據，用于讀取文件數據
        char getData[64];
        int resLen = UtilsFileRead(resOpenFile, getData, 13);
        
        // 輸出讀取的數據
        printf("[FILETEST] get the data = %s.\r\n", getData);
    }
}

APP_FEATURE_INIT(fileTest);

BUILD.gn：

static_library("file"){
    sources = [
        "file.c"
    ]
    include_dirs = [
        "http://commonlibrary/utils_lite/include",
    ]
}

編寫app下的BUILD.gn文件：

編譯燒錄調試：

首先第一次啟動開發板會提示我們文件不存在，并且創建好文件。

此后重啟開發板，都會正常讀取到數據。

斷開開發板與主機，再次連接，啟動開發板也可以讀取到文件數據。

結束語

本篇介紹了一下如何基于輕量系統進行數據的持久化，包括簡單的KV存儲和文件的IO，希望能夠幫助到各位，感謝支持！

想了解更多關于開源的內容，請訪問：

51CTO 開源基礎軟件社區

https://ost.51cto.com