纯C语言不借助第三方库如何实现读写ini配置文件？

在现代软件开发中，配置文件是应用程序不可或缺的一部分，它们允许用户或管理员在不重新编译代码的情况下调整程序的行为、设置参数和存储用户偏好，在众多配置文件格式中，INI（Initialization）文件以其简洁、直观和人类可读的特点，至今仍在许多项目中，尤其是 C 语言项目中，占有一席之地，本文将深入探讨如何在 C 语言环境中高效、稳健地读写 INI 配置文件。

INI 文件基础结构

INI 文件的结构非常简单，主要由“节”、“键”和“值”组成，一个典型的 INI 文件如下所示：

; 这是一个注释行
[Database]
host = localhost
port = 3306
username = admin
password = secret123
[Logging]
level = debug
file_path = /var/log/myapp.log

• 节：由方括号 [ 和 ] 包围的名称，用于对相关的配置项进行分组。[Database]。
• 键：位于每个节下，等号 左侧的标识符。host。
• 值：位于等号 右侧的数据，是与键关联的具体配置内容。localhost。
• 注释：通常以分号 或井号 开头，用于提供说明,解析器通常会忽略这些行。

理解这一基本结构是手动或使用库进行解析的前提。

C 语言原生读写方法

理论上，我们可以仅使用 C 标准库来读写 INI 文件，这种方法有助于理解底层逻辑,但在实际项目中往往繁琐且容易出错。

手动读取

手动读取的核心思路是逐行扫描文件,然后对每一行进行解析。

1. 打开文件：使用 fopen() 函数以只读模式 ("r") 打开 INI 文件。
2. 逐行读取：在一个循环中，使用 fgets() 函数读取文件的每一行到一个字符缓冲区中。
3. ：
   • 检查是否为空行或注释行（以 或 开头），如果是,则跳过。
   • 检查是否为节行（以 [ 开头并以 ] ，如果是,则提取节名。
   • 否则，假定它是一个键值对，使用 strchr() 找到等号 的位置，然后将其分割为键和值,需要注意去除键和值两端的空白字符。
4. 存储数据：将解析出的节、键、值存储在合适的数据结构中,例如一个结构体数组或链表。
5. 关闭文件：使用 fclose() 关闭文件。

这个过程需要处理大量的字符串操作和边界条件（如格式错误的行）,代码会变得冗长且难以维护。

手动写入

手动写入相对简单一些，使用 fopen() 以写入模式 ("w") 或追加模式 ("a") 打开文件，然后使用 fprintf() 函数按照 INI 格式将节、键和值写入文件即可。fprintf(fp, "[%s]n", section_name); 和 fprintf(fp, "%s=%sn", key, value);。

实践之选：使用 inih 库

对于任何严肃的项目，推荐使用一个成熟、轻量级的第三方库。inih (INI Not Invented Here) 是一个极佳的选择，它是一个用 ANSI C 编写的、简单的 INI 文件解析器，只有一个头文件 (ini.h) 和一个实现文件 (ini.c)，无任何外部依赖,集成非常方便。

inih 的读取机制：回调函数

inih 的核心设计是基于回调函数，你不需要手动逐行解析，而是提供一个处理函数，inih 在解析到每个节、键、值时都会调用这个函数。

其回调函数原型如下：

int handler(void* user, const char* section, const char* name, const char* value);

• user: 一个用户自定义的指针，通常用于传递一个结构体,以便将解析结果存入其中。
• section: 当前解析到的节名。
• name: 当前解析到的键名。
• value: 当前解析到的值。
• 返回值: 返回 1 表示继续解析，返回 0 表示停止解析。

使用 inih 读取配置示例

假设我们有上面的 config.ini 文件，下面是如何使用 inih 来读取它。

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "ini.h" // 引入 inih 库头文件
// 定义一个结构体来存储配置
typedef struct {
    char db_host[100];
    int db_port;
    char db_username[50];
    char db_password[50];
    char log_level[20];
    char log_file_path[200];
} configuration;
// 回调函数实现
static int handler(void* user, const char* section, const char* name,
                   const char* value)
{
    configuration* pconfig = (configuration*)user;
    // 匹配 [Database] 节下的键
    if (strcmp(section, "Database") == 0) {
        if (strcmp(name, "host") == 0) { strcpy(pconfig->db_host, value); }
        else if (strcmp(name, "port") == 0) { pconfig->db_port = atoi(value); }
        else if (strcmp(name, "username") == 0) { strcpy(pconfig->db_username, value); }
        else if (strcmp(name, "password") == 0) { strcpy(pconfig->db_password, value); }
    }
    // 匹配 [Logging] 节下的键
    else if (strcmp(section, "Logging") == 0) {
        if (strcmp(name, "level") == 0) { strcpy(pconfig->log_level, value); }
        else if (strcmp(name, "file_path") == 0) { strcpy(pconfig->log_file_path, value); }
    }
    return 1; // 继续解析
}
int main(int argc, char* argv[])
{
    configuration config;
    // 初始化配置，设置默认值
    strcpy(config.db_host, "127.0.0.1");
    config.db_port = 5432;
    // ...其他默认值
    if (ini_parse("config.ini", handler, &config) < 0) {
        printf("Can't load 'config.ini'n");
        return 1;
    }
    printf("Config loaded from 'config.ini':n");
    printf("  Database:n");
    printf("    Host: %sn", config.db_host);
    printf("    Port: %dn", config.db_port);
    printf("    Username: %sn", config.db_username);
    printf("  Logging:n");
    printf("    Level: %sn", config.log_level);
    printf("    File Path: %sn", config.log_file_path);
    return 0;
}

实现写入功能

inih 本身是一个只读的解析器，要实现写入功能，通常需要自己编写一个函数，它接收一个配置结构体，并将其格式化写入 INI 文件。

void write_config_file(const char* filename, const configuration* config) {
    FILE* fp = fopen(filename, "w");
    if (!fp) {
        perror("Failed to open file for writing");
        return;
    }
    fprintf(fp, "; Configuration file generated by myappn");
    fprintf(fp, "[Database]n");
    fprintf(fp, "host = %sn", config->db_host);
    fprintf(fp, "port = %dn", config->db_port);
    fprintf(fp, "username = %sn", config->db_username);
    fprintf(fp, "password = %sn", config->db_password);
    fprintf(fp, "n");
    fprintf(fp, "[Logging]n");
    fprintf(fp, "level = %sn", config->log_level);
    fprintf(fp, "file_path = %sn", config->log_file_path);
    fclose(fp);
}

两种方式的对比

高级注意事项与最佳实践

1. 数据类型转换：INI 文件中的所有值都是字符串，在 C 程序中使用时，需要将它们转换为所需的数据类型，常用函数包括 atoi() (转整数)、atof() (转浮点数) 和 strcmp() (比较字符串)。
2. 错误处理：检查 fopen()、ini_parse() 等函数的返回值，如果文件不存在或解析失败，程序应有明确的错误提示和回退机制（例如使用硬编码的默认配置）。
3. 文件路径：配置文件的存放位置需要仔细考虑，可以放在可执行文件同目录，也可以放在系统标准的配置目录（如 Linux 的 /etc/）或用户的家目录下。
4. 线程安全：如果配置可能在运行时被多个线程读取，确保在加载完成后，配置数据结构是只读的,或者使用互斥锁来保护对它的访问。

相关问答 (FAQs)

问题1：如果我的 INI 文件中，同一个节里出现了重复的键，inih 会如何处理？

解答：inih 会按照文件中出现的顺序，为每一个键值对调用一次你的回调函数，这意味着，如果你的回调函数逻辑是简单地覆盖（如 strcpy(pconfig->db_host, value);），那么最终在配置结构体中保留的值将是文件中最后一个出现的键所对应的值，这是一种常见且合理的行为，最佳实践是避免在 INI 文件中出现重复的键，因为这会造成混淆和潜在的配置错误，如果业务逻辑需要处理多值，应该考虑使用不同的格式（如键后加索引 key1, key2）或更复杂的配置格式（如 JSON 或 XML）。

问题2：inih 可以处理包含非 ASCII 字符（如中文）的 INI 文件吗？

解答：可以，但需要注意编码问题。inih 本身对编码是“无知”的，它将文件内容视为一个字节流，并按字节寻找分隔符（如 [, ], , n），只要你的 INI 文件、你的 C 源代码文件和你的编译器/终端使用兼容的编码（通常是 UTF-8），inih 就能正确地将包含中文字符的字符串传递给你的回调函数，在你的程序中，你需要确保正确地处理这些 UTF-8 编码的字符串，使用 strlen() 计算的是字节数，而不是字符数，如果你需要进行复杂的字符处理（如截取中文字符），可能需要使用专门的 Unicode 处理库，对于简单的存储和显示，只要环境统一，直接使用 char* 和 printf 是没有问题的。