前言
本篇来聊聊数据持久化,这个东西呢,在应用开发很重要,我对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
#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 = [
"//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
#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 = [
"//commonlibrary/utils_lite/include",
]
}
编写app下的BUILD.gn文件:
编译烧录调试:
首先第一次启动开发板会提示我们文件不存在,并且创建好文件。
此后重启开发板,都会正常读取到数据。
断开开发板与主机,再次连接,启动开发板也可以读取到文件数据。
结束语
本篇介绍了一下如何基于轻量系统进行数据的持久化,包括简单的KV存储和文件的IO,希望能够帮助到各位,感谢支持!