介绍
程序没有任何配置文件,那么它对外是全封闭的,一旦程序需要修改一些参数必须要修改程序代码本身并重新编译,为了让程序出厂后还能根据需要进行必要的配置,所以要用配置文件;配置文件有很多种,如INI配置文件,XML配置文件,cfg配置文件,还有就是可以使用系统注册表等。INI ”就是英文 “initialization”的头三个字母的缩写。
文章目录
- 介绍
- INI格式
- 一、使用步骤
- 1.下载
- 2.解压、编译
- 3.编译
- 4. 使用方法
- 二、API 详解
- 加载ini文件
- 获取
- 设置与删除
- 保存
- 三、测试
- 遇到的问题
INI格式
iNI文件的格式很简单,最基本的三个要素是:parameters,sections和comments。
节
[section]
参数(键=值)
name=value
注解
注解使用分号表示(;)。在分号后面的文字,直到该行结尾都全部为注解。
注意: iniparser 的一条原则是 section 和 key 大小写无关,写入的字符串全部小写化,取出的字符串也全部小写化。
一、使用步骤
1.下载
GitHub下载链接: https://github.com/ndevilla/iniparser
2.解压、编译
解压
unzip iniparser-master.zip
或者
tar -zvf
3.编译
到解压得到的文件目录下
make
4. 使用方法
方法1.
拷贝src下的头文件dictionary.h和iniparser.h到系统目录下,/usr/include 或 /usr/local/include.
拷贝压缩包目录下的静态库libiniparser.a和动态库libiniparser.so.1到目标文件系统的对应目录下,/usr/lib 或 lib/
方法2.
直接将src下的dictionary.c,iniparser.c,dictionary.h和iniparser.h到项目目录下,在makefile里编译dictionary.c,iniparser.c,使用时调用头文件就行。
二、API 详解
需要注意的是,定位一个key是用section:key来表示的,所以不同section下的key名称是可以相同的。
加载ini文件
dictionary * dictionary_new(int size);
创建dictionary对象
void iniparser_freedict(dictionary * d);
释放dictionary对象(内存)
dictionary * iniparser_load(const char * ininame);
加载ini文件,将数据存于dictionary结构中。
解析dictionary对象并返回(分配内存)dictionary对象,path文件绝对路径
例:
dictionary *ini = NULL;
const char *path = "./ini_test.ini";
ini = iniparser_load(path);
获取
int iniparser_getnsec(dictionary * d);
获取dictionary对象的section个数
const char * iniparser_getstring(const dictionary * d, const char * key, const char * def);
获取对应key的value。key以组+key的形式体现,如“client:port”。value以字符串形式返回,若未找到对应的key则返回def 的内容。
char * dictionary_get(dictionary * d, const char * key, char * def);
获取dictionary对象的key值, key同样以“client:port”形式表示,若未找到则返回def
int iniparser_getint(dictionary * d, const char * key, int notfound); //返回idictionary对象的section:key对应的整形值
double iniparser_getdouble(dictionary * d, const char * key, double notfound); //返回dictionary对象的section:key对应的双浮点值
int iniparser_getboolean(dictionary * d, const char * key, int notfound); //返回dictionary对象的section:key对应的布尔值
上面三个函数都是获取dictionary对象的key值,当然也可以先用string解析出来,后强制转换为int,double,因为在写入配置文件时都是字符串。
const char ** iniparser_getseckeys(const dictionary * d, const char * s, const char ** keys);
获取dictionary对象某个section下所有的key, 慎用这个函数,因为第三个参数与返回值都是const char ** 类型,搞不好就会:Segmentation fault (core dumped)
char * iniparser_getsecname(dictionary * d, int n);
获取dictionary对象的第n个section的名字
设置与删除
修改文件后要以写或者追加权限修改文件
void dictionary_del(dictionary * vd);
删除dictionary对象
int dictionary_set(dictionary * vd, const char * key, const char * val);
int iniparser_set(dictionary * ini, const char * entry, const char * val);
设置dictionary对象的某个section:key的值
void dictionary_unset(dictionary * d, const char * key);
void iniparser_unset(dictionary * ini, const char * entry);
删除dictionary对象中某个section:key
int iniparser_find_entry(dictionary * ini, const char * entry) ;
判断dictionary对象中是否存在某个section:key,存在返回1,不存在返回0
unsigned dictionary_hash(const char * key);
计算关键词的hash值
保存
保存的文件打开必须要有write权限
void iniparser_dump_ini(dictionary * d, FILE * f);
void iniparser_dump(dictionary * d, FILE * f);
void dictionary_dump(dictionary * d, FILE * out);
保存dictionary对象到file
void iniparser_dump(dictionary * d, FILE * f); 打印整个配置文件信息(f赋值为stdout则输出到终端)
void iniparser_dump_ini(dictionary * d, FILE * f);
保存dictionary对象到file
void iniparser_dumpsection_ini(dictionary * d, char * s, FILE * f);
保存dictionary对象一个section到file
三、测试
配置文件:
;客户端配置
[client]
ip=192.168.0.160
port=12345
;服务端端口配置
[server]
port=8888
获取配置代码:
#include <stdio.h>
#include <stdlib.h>
#include "iniparser.h"
#include "dictionary.h"
int main(char argc, char **argv)
{
dictionary *ini = NULL;
const char *path = "./conf.ini";
FILE *fp = NULL;
const char *ptr = "not found";
int count;
ini = iniparser_load("./conf.ini"); //打开INI文件,解析dictionary对象并返回(分配内存)dictionary对象
if( ini == NULL )
return -1;
iniparser_dump(ini, stdout);//打印到终端
count = iniparser_getnsec(ini); //获取dictionary对象的section个数
printf("dictionary of section number is %d \n", count);
printf("[client] port : %s \n", dictionary_get(ini, "client:port", "NULL"));
printf("[server] port : %s \n", iniparser_getstring(ini, "server:port", "not found"));
printf("第一个section 名字 %s \n", iniparser_getsecname(ini, 0)); //获取dictionary对象的第n个section的名字
printf("section client key 个数 %d \n", iniparser_getsecnkeys(ini, "client"));
//获取dictionary对象某个section下的key个数
fp = fopen(path, "rw");
iniparser_dump_ini(ini, fp);// 保存到文件中
fclose(fp);
return 0;
}
修改配置测试代码:
其实没必要,我们引入配置文件的意义就是直接改文件,而不用每次修改代码,这样操作来的复杂。
#include <stdio.h>
#include <stdlib.h>
#include "iniparser.h"
#include "dictionary.h"
int main(char argc, char **argv)
{
dictionary *ini = NULL;
const char *path = "./conf.ini";
FILE *fp = NULL;
const char *ptr = "not found";
int count;
ini = iniparser_load("./conf.ini"); //打开INI文件,解析dictionary对象并返回(分配内存)dictionary对象
if( ini == NULL )
return -1;
dictionary_set(ini, "client:port", "6666");
iniparser_set(ini, "client:ip", "127.0.0.1");
printf("[client] port and ip changed \n");
iniparser_unset(ini, "server:port");
printf("[server] port delete \n");
printf("[client] port exist ? %d \n", iniparser_find_entry(ini, "client:port"));
fp = fopen(path, "w");
iniparser_dump_ini(ini, fp);// 保存到文件中
fclose(fp);
return 0;
}
修改后配置文件:
[client]
ip = 127.0.0.1
port = 6666
[server]
遇到的问题
1 在获取key值得时并未按照 section:key 方式来传参数,会出现查找失败的情况,返回值是自己设定的值。
2 打开在定义文件流时直接以“W”只写方式打开,之后对ini进行解析,所有的内容都为空。解决方式是以读写的方式打开文件,或者最后在需要对文件进行操作是在打开文件。