OpenHarmony輕量系統(tǒng)數(shù)據(jù)持久化—簡單KV存儲(chǔ)&文件IO
想了解更多關(guān)于開源的內(nèi)容,請?jiān)L問:
前言
本篇來聊聊數(shù)據(jù)持久化,這個(gè)東西呢,在應(yīng)用開發(fā)很重要,我對SSM,Vue2 + 3,也有了解,做過相關(guān)的Web開發(fā)(自己做著玩的,半拉子工程),以后也打算學(xué)習(xí)一些OpenHarmony北向相關(guān)的應(yīng)用開發(fā)。(想南北通吃)
數(shù)據(jù)持久化簡介
在我們之前玩Hi3861開發(fā)板的時(shí)候啊,每次重啟,點(diǎn)擊復(fù)位鍵,都會(huì)以一個(gè)全新的效果展現(xiàn)在我們面前,很顯然,這樣的案例都是沒有做數(shù)據(jù)持久化的,我們的案例運(yùn)行時(shí)的數(shù)據(jù)僅僅存在于計(jì)算機(jī)的內(nèi)存中,當(dāng)程序關(guān)閉(重啟),內(nèi)存就會(huì)釋放或者重新分配,原有的數(shù)據(jù)就會(huì)丟失。常見的數(shù)據(jù)持久化的方式其實(shí)大家都見過,可能沒有意識到,比如最早的時(shí)候有光盤,現(xiàn)在每個(gè)電腦都有SSD硬盤,還有網(wǎng)盤,我個(gè)人也是非常喜歡網(wǎng)盤的,數(shù)據(jù)可以進(jìn)行網(wǎng)絡(luò)層面的持久化,不占本地空間,需要什么文件,再去獲取,特別適合收藏學(xué)習(xí)文件然后放進(jìn)去吃灰。數(shù)據(jù)庫也是,我們開發(fā)的APP,用戶進(jìn)行注冊,用戶的信息就會(huì)永久地存放在數(shù)據(jù)庫中而不會(huì)丟失了。簡而言之,就是以一種手段,把程序運(yùn)行過程中的數(shù)據(jù)保存起來。當(dāng)然,安全性也是需要考慮到的,數(shù)據(jù)是敏感的,但這里不久細(xì)說了。
OpenHarmony數(shù)據(jù)持久化
強(qiáng)大的OpenHarmony當(dāng)然也是有數(shù)據(jù)持久化的,在公共子系統(tǒng)集中,還是看一下OpenHarmony官網(wǎng)的架構(gòu)圖:
公共子系統(tǒng)及中,有可以幫助我們實(shí)現(xiàn)數(shù)據(jù)持久化的API,下面會(huì)具體說。
kv_store庫
kv_store.h跟ohos_init.h在一起,看庫名也知道了,key - value 的形式存儲(chǔ)數(shù)據(jù),是一種常見的存儲(chǔ)形式,在數(shù)據(jù)結(jié)構(gòu)Map,以及JSON文件等都是KV鍵值對的存儲(chǔ)形式。下面來看看他的API有什么。
API
UtilsGetValue:
int UtilsGetValue(const char* key, char* value, unsigned int len);
從文件系統(tǒng)或cache中讀取指定鍵的值
參數(shù)解釋:
- key:鍵;小寫字母、數(shù)字、下劃線、點(diǎn)(.);最大32字節(jié)(包括字符串結(jié)束符)。
- value:用于存儲(chǔ)值的緩沖區(qū);輸出參數(shù)。
- len:值的長度。
返回值:
- 操作成功返回值的長度;參數(shù)錯(cuò)誤返回-9;其他情況返回-1;如果值是從cache中讀取的,則返回0。
UtilsSetValue:
int UtilsSetValue(const char* key, const char* value);
在文件系統(tǒng)或cache中添加或更新鍵值
參數(shù)解釋:
- key:鍵;小寫字母、數(shù)字、下劃線、點(diǎn)(.);最大32字節(jié)(包括字符串結(jié)束符)。
- value:要添加或更新的值;最大128字節(jié)(包括字符串結(jié)束符)。
返回值:
- 操作成功返回0;參數(shù)錯(cuò)誤返回-9;其他情況返回-1
UtilsDeleteValue:
int UtilsDeleteValue(const char* key);
在文件系統(tǒng)或cache中刪除鍵值
參數(shù)解釋:
- key:鍵;小寫字母、數(shù)字、下劃線、點(diǎn)(.);最大32字節(jié)(包括字符串結(jié)束符)。
返回值:
- 操作成功返回0;參數(shù)錯(cuò)誤返回-9;其他情況返回-1
ClearKVCache:
int ClearKVCache(void);
清除緩存中的所有鍵值對
參數(shù)解釋:無
返回值:成功時(shí)返回0,否則返回-1
案例:鍵值存儲(chǔ)
任務(wù):
將一個(gè)數(shù)據(jù)持久化,“key” - > “value”。
最終效果:
在完成案例后,第一次啟動(dòng)開發(fā)板,通過“key”作為鍵去過去值,獲取失敗,因?yàn)槭裁炊紱]存儲(chǔ)嘛,然后就會(huì)獲得一個(gè)小于0的返回值,表示獲取失敗了,我們就可以進(jìn)行鍵值對的添加,添加完成后,在后續(xù)的斷電重啟開發(fā)板中,無論啟動(dòng)多少次,都可以通過“key”去獲取我們的值。
創(chuàng)建如下目錄:
編寫源碼:
kv_demo.c:
#include <stdio.h>
#include "ohos_init.h"
// kv_store 庫
#include "kv_store.h"
void kvTest(void){
// 創(chuàng)建我們的鍵
const char *key = "key";
// 創(chuàng)建我們的值,這個(gè)值就是一個(gè)指針,如果能夠獲取成功,就會(huì)通過指針獲取到相應(yīng)的值。
char value[32] = {0};
// 通過 鍵 去讀取我們的 值
int resGet = UtilsGetValue(key, value, 32);
// resGet < 0 說明讀取失敗,我們沒有 “key” 的數(shù)據(jù)
if(resGet < 0){
// 輸出提示信息
printf("[KVTEST] failed to read the key!\r\n");
// 添加鍵值對數(shù)據(jù),進(jìn)行數(shù)據(jù)持久化
int resSet = UtilsSetValue(key, "value");
// 輸出提示信息
if(resSet == 0){
printf("[KVTEST] success to store!\r\n");
} else {
printf("[KVTEST] failed to store!\r\n");
}
} else {
// 如果讀取成功,則直接輸出鍵值數(shù)據(jù)
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:
編譯燒錄串口調(diào)試:
當(dāng)我們第一次進(jìn)行串口調(diào)試的時(shí)候,會(huì)觀察到,我們寫的提示信息,先讀取失敗,再進(jìn)行數(shù)據(jù)存儲(chǔ)。
再次重啟開發(fā)板,可以觀察到,讀取成功了。
斷開電源,即將開發(fā)板與主機(jī)斷開連接,再次連接,啟動(dòng)開發(fā)板,可以看到仍然能夠成功讀取。數(shù)據(jù)持久化成功。
報(bào)錯(cuò)分享
在編譯的時(shí)候也是出現(xiàn)了一個(gè)很奇怪的bug。
嗯…我也是一頭霧水不知道怎么辦,感覺像是環(huán)境問題,卻又不知道具體怎么改,最后我去到了kv_store的接口里,修改了一下他的BUILD.gn文件。
可能是posix下的文件有些問題吧,然后我修改了他的編譯文件,讓他去編譯hal下的kv_store.c 最后就是這么個(gè)意思,不管什么情況都去編譯hal下的文件。等效于下圖所示:
雖然不太清楚什么問題,但是似乎換一個(gè)文件編譯,整個(gè)編譯就成功通過了,運(yùn)行起來的結(jié)果也和預(yù)期一樣,沒有bug出現(xiàn)。都是kv_store.c文件,可能也是為了適配不同的需求吧才分了兩個(gè)出來吧,如果有知道這個(gè)是什么問題的話,也可以評論區(qū)留言,我也來學(xué)習(xí)一下,或者你也出現(xiàn)了跟我一樣的bug,可以試一試按照我的方法進(jìn)行修改,修改后親測是沒有問題的。
utils_file庫
數(shù)據(jù)持久化,我們更多的還是傾向于數(shù)據(jù)庫,文件,這種簡單的kv入門就可以了。文件的操作則更為重要,下面介紹utils_file庫,它可以幫助我們對文件進(jìn)行IO操作,實(shí)現(xiàn)數(shù)據(jù)持久化。
API
UtilsFileOpen:
int UtilsFileOpen(const char* path, int oflag, int mode);
參數(shù)解釋:
- path:指定要打開或創(chuàng)建的文件的路徑。
- oflag:指定文件的打開模式。支持的模式有:
- O_RDONLY_FS:以只讀模式打開文件。
- O_WRONLY_FS:以只寫模式打開文件。
- O_RDWR_FS:以讀寫模式打開文件。
- O_CREAT_FS:如果文件不存在,則創(chuàng)建文件。
- O_EXCL_FS:與O_CREAT_FS一起使用,如果文件已存在,則打開失敗。
- O_TRUNC_FS:如果文件存在,將其截?cái)酁榭瘴募?/li>
- O_APPEND_FS:以追加模式打開文件,在文件末尾寫入數(shù)據(jù)。 這些模式可以組合使用,每個(gè)模式之間使用按位或運(yùn)算符"|"進(jìn)行標(biāo)識。
- mode:用于函數(shù)兼容性,該參數(shù)在任何情況下均不起作用。
返回值:
如果文件成功打開或創(chuàng)建,將返回文件描述符,否則返回-1。
UtilsFileClose:
int UtilsFileClose(int fd);
參數(shù)解釋:
fd:指定要關(guān)閉的文件的文件描述符。
返回值:
如果文件成功關(guān)閉,函數(shù)將返回0;否則返回-1。
UtilsFileRead:
int UtilsFileRead(int fd, char* buf, unsigned int len);
參數(shù)解釋:
- fd:表示要讀取的文件的文件描述符(file descriptor)。
- buf:指向存儲(chǔ)讀取數(shù)據(jù)的緩沖區(qū)的指針。這是一個(gè)輸出參數(shù),函數(shù)將讀取的數(shù)據(jù)寫入到該緩沖區(qū)中。
- len:表示要讀取的數(shù)據(jù)的長度。
返回值:
- 如果成功讀取數(shù)據(jù),函數(shù)將返回實(shí)際讀取的字節(jié)數(shù)。
- 如果讀取操作失敗,函數(shù)將返回-1。
UtilsFileWrite:
int UtilsFileWrite(int fd, const char* buf, unsigned int len);
參數(shù)解釋:
- fd:表示要寫入數(shù)據(jù)的文件的文件描述符(file descriptor)。
- buf:指向要寫入的數(shù)據(jù)的指針。
- len:表示要寫入的數(shù)據(jù)的長度。
返回值:
- 如果成功寫入數(shù)據(jù),函數(shù)將返回實(shí)際寫入的字節(jié)數(shù)。
- 如果寫入操作失敗,函數(shù)將返回-1。
UtilsFileDelete:
int UtilsFileDelete(const char* path);
參數(shù)解釋:
- path:表示要?jiǎng)h除的文件的路徑。
返回值:
- 如果成功刪除文件,函數(shù)將返回0。
- 如果刪除文件操作失敗,函數(shù)將返回-1。
UtilsFileStat:
int UtilsFileStat(const char* path, unsigned int* fileSize);
參數(shù)解釋:
- path:表示文件名。
- fileSize:表示文件大小的變量指針。這是一個(gè)輸出參數(shù),用于存儲(chǔ)獲取到的文件大小。
返回值:
- 如果成功獲取文件大小,函數(shù)將返回0。
- 如果獲取文件大小操作失敗,函數(shù)將返回-1。
案例:文件IO
預(yù)期效果:
打開指定的文件讀取數(shù)據(jù)庫的用戶名和密碼,如果文件不存在就先創(chuàng)建文件,再寫入數(shù)據(jù)。在之后的訪問中,均可成功打開數(shù)據(jù)讀取數(shù)據(jù)。跟剛剛的kv流程其實(shí)很像。
創(chuàng)建如下目錄:
編寫源碼:
file.c:
#include <stdio.h>
#include "ohos_init.h"
// 文件IO庫
#include "utils_file.h"
void fileTest(void){
// 定義文件名
char fileName[] = "MyFileName";
// 定義文件大小,用于獲取文件大小
int fileSize = 0;
// 統(tǒng)計(jì)文件數(shù)據(jù)
int resGetFile = UtilsFileStat(fileName, &fileSize);
// 文件不存在時(shí),打開失敗,返回值為 -1
if(resGetFile == -1){
// 輸出提示信息
printf("[FILETEST] failed to open the file, file is not exits!\r\n");
// 創(chuàng)建文件,并寫入數(shù)據(jù)
// 定義數(shù)據(jù)
char data[] = "root,password";
// 打開文件
int resOpenFile = UtilsFileOpen(fileName, O_WRONLY_FS | O_CREAT_FS | O_TRUNC_FS, 0);
// 寫入數(shù)據(jù)
int resWriteFilw = UtilsFileWrite(resOpenFile, data, strlen(data));
// 關(guān)閉文件
int resCloseFile = UtilsFileClose(resOpenFile);
// 輸出提示信息
printf("[FILETEST] success to create a file!\r\n");
} else {
// 輸出提示信息
printf("[FILETEST] the file is exist!\r\n");
// 文件存在,讀取文件內(nèi)容
int resOpenFile = UtilsFileOpen(fileName, O_CREAT_FS, 0);
// 定義數(shù)據(jù),用于讀取文件數(shù)據(jù)
char getData[64];
int resLen = UtilsFileRead(resOpenFile, getData, 13);
// 輸出讀取的數(shù)據(jù)
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文件:
編譯燒錄調(diào)試:
首先第一次啟動(dòng)開發(fā)板會(huì)提示我們文件不存在,并且創(chuàng)建好文件。
此后重啟開發(fā)板,都會(huì)正常讀取到數(shù)據(jù)。
斷開開發(fā)板與主機(jī),再次連接,啟動(dòng)開發(fā)板也可以讀取到文件數(shù)據(jù)。
結(jié)束語
本篇介紹了一下如何基于輕量系統(tǒng)進(jìn)行數(shù)據(jù)的持久化,包括簡單的KV存儲(chǔ)和文件的IO,希望能夠幫助到各位,感謝支持!