Linux-C 简单的键值对配置读写
一、简述
记--linux下使用C语言进行简单的键值对配置读写,类似Qt的QSetting。
二、测试代码
配置读:使用fgets函数读取每一行数据,然后匹配key,再取value
配置写:如果没有这个key就追加,如果已有就修改value,再重新写入文件, 注意修改的内容可能会导致文件大小变小,此时需要重新设置文件大小进行文件截断。如果修改后文件大小变大它会自动拓展,此时可不用设置文件大小。
#include
#include
#include
#define SETTING_FILE"/home/liang/Setting_dir/test.conf"/* 配置文件路径 */
#define SETTING_VERSION_VALUE"100"/* 配置版本value */
#define SETTING_VERSION_KEY"VERSION"/* 配置版本key */
#define SETTING_LINE_MAX32/* 最大配置行行数 */
#define SETTING_LINE_MAX_LEN256/* 最大配置行长度 */
#define SETTING_KEY_MAX_LEN64/* 最大key长度 */
#define SETTING_VALUE_MAX_LEN190 //(SETTING_LINE_MAX-SETTING_KEY_MAX_LEN-2) /* 最大value长度 预留'\0', '='*/
#define SETTING_SPLIT_CHAR'='/* key和value的分隔符 */
/*********************************************************************************
* 函数名: GetSetting
* 功能:根据key获取value
* 形参:const char *path -> 配置文件
* const char *key -> 键
* const char *key -> value
* int value_max_len -> value的最大长度
* 返回值:1:已获取到value 0:未找到key <0:获取失败
*******************************************************************************/
int GetSetting(const char *path, const char *key, char *value, int value_max_len)
{
int ret = 0;
int cnt = 0;
int key_len;
int line_len;
int value_len;
FILE *fp;
char line_buf[SETTING_LINE_MAX_LEN] = {0};
/* 合法性判断 */
if (NULL == path || NULL == key || NULL == value || 0 >= value_max_len) {
return -1;
}
key_len = strlen(key);
if (0 >= key_len || SETTING_KEY_MAX_LEN < key_len) {
return -2;
}
if (F_OK != access(path, F_OK)) {
return -3;
}
/* 打开文件 */
fp = fopen(path, "r");
if (NULL == fp) {
return -4;
}
/* 遍历行,匹配Key */
while(NULL != fgets(line_buf, SETTING_LINE_MAX_LEN-1, fp)) {
line_len = strlen(line_buf);
if (line_len > key_len) {
/* 找到key */
if (0 == strncmp(line_buf, key, key_len) && SETTING_SPLIT_CHAR == line_buf[key_len]) {
ret = 1;
break;
}
}
memset(line_buf, 0, sizeof(line_buf));
/* 最大查找行限制 */
cnt++;
if (SETTING_LINE_MAX < cnt) {
break;
}
}
/* 关闭文件 */
fclose(fp);
/* 找到key,返回value */
if (1 == ret) {
value_len = line_len - key_len - 1;
if (0 < value_len) {
if (value_len > value_max_len) {
value_len = value_max_len;
}
/* 拷贝value */
strncpy(value, &line_buf[key_len + 1], value_len);
value[value_len] = '\0';
/* 去掉结尾的换行符 */
if ('\n' == value[value_len-1]) {
value[value_len-1] = '\0';
}
if (2 <= value_len && '\r' == value[value_len-2]) {
value[value_len-2] = '\0';
}
} else {
value[0] = '\0';
}
}
return ret;
}
/*********************************************************************************
* 函数名: SetSetting
* 功能:根据key设置value,如果key不存在就会追加
* 形参:const char *path -> 配置文件
* const char *key -> 键
* const char *key -> value
* 返回值:>=0:设置成功 <0:获取失败
*******************************************************************************/
int SetSetting(const char *path, const char *key, const char *value)
{
int i, j;
int fd;
int tmp_data_cnt = 0;
int ret = 0;
int cnt = 0;
int key_len;
int line_len;
int value_len;
int len;
FILE *fp = NULL;
char tmp_key[SETTING_KEY_MAX_LEN+1] = {0};
char tmp_value[SETTING_VALUE_MAX_LEN+1] = {0};
char line_buf[SETTING_LINE_MAX_LEN] = {0};
char tmp_data_buf[SETTING_LINE_MAX][SETTING_LINE_MAX_LEN] = {0};
/* 合法性判断 */
if (NULL == path || NULL == key || NULL == value) {
return -1;
}
key_len = strlen(key);
if (0 >= key_len || SETTING_KEY_MAX_LEN < key_len) {
return -2;
}
/* key去掉\r\n */
for (i = 0, j = 0; i < key_len; i++) {
if ('\r' == key[i] || '\n' == key[i]) {
break;
}
tmp_key[j++] = key[i];
}
key_len = j;
value_len = strlen(value);
if (SETTING_VALUE_MAX_LEN < value_len) {
value_len = SETTING_VALUE_MAX_LEN;
} else if (value_len <= 0) {
value_len = 0;
}
/* value去掉\r\n */
for (i = 0, j = 0; i < value_len; i++) {
if ('\r' == value[i] || '\n' == value[i]) {
break;
}
tmp_value[j++] = value[i];
}
value_len = j;
/* 配置不存在就新建配置文件 */
if (F_OK != access(path, F_OK)) {
fp = fopen(path, "w+");
if (NULL == fp) {
return -3;
}
/*写入版本信息 */
sprintf(line_buf, "%s%c%s\n", SETTING_VERSION_KEY, SETTING_SPLIT_CHAR, SETTING_VERSION_VALUE);
line_len = strlen(line_buf);
ret = fwrite(line_buf, 1, line_len, fp);
/* 新建key */
memset(line_buf, 0, sizeof(line_buf));
sprintf(line_buf, "%s%c%s\n", tmp_key, SETTING_SPLIT_CHAR, tmp_value);
line_len = strlen(line_buf);
if (line_len != fwrite(line_buf, 1, line_len, fp)) {
ret = -4;
} else {
ret = 2;
}
fclose(fp);
return ret;
}
/* 打开文件 */
if (NULL == fp) {
fp = fopen(path, "r+");
if (NULL == fp) {
return -5;
}
}
/* 遍历行,匹配Key */
while(NULL != fgets(line_buf, SETTING_LINE_MAX_LEN-1, fp)) {
line_len = strlen(line_buf);
if (line_len > key_len) {
if (1 != ret && 0 == strncmp(line_buf, tmp_key, key_len) && SETTING_SPLIT_CHAR == line_buf[key_len]) {
ret = 1;
/* 修改value */
sprintf(line_buf, "%s%c%s\n", tmp_key, SETTING_SPLIT_CHAR, tmp_value);
}
}
/* 备份数据,有修改就需要重新写入文件*/
strcpy(tmp_data_buf[tmp_data_cnt++], line_buf);
memset(line_buf, 0, sizeof(line_buf));
/* 最大查找行限制 */
cnt++;
if (SETTING_LINE_MAX < cnt) {
break;
}
}
/* 找到key,需要重新写入数据并更新文件大小 */
if (1 == ret) {
rewind(fp);
for (i = 0; i < tmp_data_cnt; i++) {
fputs(tmp_data_buf[i], fp);
}
/* 重新设置文件大小 */
len = ftell(fp);
fd = fileno(fp);
ftruncate(fd, len);
} else { /* 新的key,在最后面追加 */
if (SETTING_LINE_MAX > cnt) {
sprintf(line_buf, "%s%c%s\n", tmp_key, SETTING_SPLIT_CHAR, tmp_value);
line_len = strlen(line_buf);
if (line_len != fwrite(line_buf, 1, line_len, fp)) {
ret = -6;
}
} else {
ret = -7;
}
}
/* 关闭文件 */
fclose(fp);
return ret;
}
int main(int argc, char *argv[])
{
int ret;
char value[16];
/* 读取版本 */
memset(value, 0, sizeof(value));
ret = GetSetting(SETTING_FILE, SETTING_VERSION_KEY, value, 10);
printf("GetSetting %s ret:%d, value:[%s]\n", SETTING_VERSION_KEY, ret, value);
/* 设置name */
ret = SetSetting(SETTING_FILE, "name", "Genven_Liang");
printf("SetSetting name ret:%d\n", ret);
/* 读取name */
memset(value, 0, sizeof(value));
ret = GetSetting(SETTING_FILE, "name", value, sizeof(value));
printf("GetSetting name ret:%d, value:[%s]\n", ret, value);
/* 设置name */
ret = SetSetting(SETTING_FILE, "name", "");
printf("SetSetting name ret:%d\n", ret);
/* 读取name */
memset(value, 0, sizeof(value));
ret = GetSetting(SETTING_FILE, "name", value, sizeof(value));
printf("GetSetting name ret:%d, value:[%s]\n", ret, value);
/* 设置name */
ret = SetSetting(SETTING_FILE, "name", "zhangsan\r\n123");
printf("SetSetting name ret:%d\n", ret);
/* 读取name */
memset(value, 0, sizeof(value));
ret = GetSetting(SETTING_FILE, "name", value, sizeof(value));
printf("GetSetting name ret:%d, value:[%s]\n", ret, value);
/* 读取版本 */
memset(value, 0, sizeof(value));
ret = GetSetting(SETTING_FILE, SETTING_VERSION_KEY, value, 10);
printf("GetSetting %s ret:%d, value:[%s]\n", SETTING_VERSION_KEY, ret, value);
return 0;
}
三、测试效果