C语言项目实战：用cJSON库读写配置文件，告别手写解析的烦恼

C语言项目实战：用cJSON库读写配置文件，告别手写解析的烦恼

在嵌入式系统和物联网项目中，配置文件的管理往往是个令人头疼的问题。传统的手写解析代码不仅耗时耗力，还容易出错。而cJSON这个轻量级的C语言JSON解析库，正能完美解决这些痛点。

1. 为什么选择cJSON处理配置文件？

在C/C++项目中，我们通常会用以下几种方式处理配置：

• INI文件：结构简单但功能有限
• XML：过于冗长，解析复杂
• 自定义格式：维护成本高
• JSON：结构清晰，易于扩展

cJSON的优势在于：

• 纯C实现，跨平台兼容性好
• 单文件库，集成简单
• 内存占用小，适合嵌入式环境
• 支持完整的JSON标准

// 典型配置文件示例 config.json { "device": { "id": "ESP32-001", "mode": "station" }, "network": { "ssid": "IoT_Network", "password": "secure123", "retry_count": 3 }, "sensors": [ {"type": "temperature", "interval": 5}, {"type": "humidity", "interval": 10} ] }

2. 环境准备与基础操作

2.1 集成cJSON到项目

获取cJSON非常简单：

1. 从GitHub克隆源码：git clone https://github.com/DaveGamble/cJSON
2. 只需将cJSON.c和cJSON.h添加到你的工程
3. 包含头文件：#include "cJSON.h"

注意：在内存受限的嵌入式系统中，可以开启CJSON_NO_HEAP宏定义使用静态内存分配

2.2 核心数据结构

cJSON使用链表结构存储数据：

typedef struct cJSON { struct cJSON *next, *prev; // 同级节点链表 struct cJSON *child; // 子节点 int type; // 数据类型 char *valuestring; // 字符串值 int valueint; // 整数值 double valuedouble; // 浮点值 char *string; // 键名 } cJSON;

数据类型定义如下：

3. 配置文件读写全流程

3.1 读取和解析配置文件

cJSON* load_config(const char* filename) { FILE* fp = fopen(filename, "r"); if (!fp) return NULL; fseek(fp, 0, SEEK_END); long len = ftell(fp); fseek(fp, 0, SEEK_SET); char* data = (char*)malloc(len + 1); fread(data, 1, len, fp); data[len] = '\0'; fclose(fp); cJSON* config = cJSON_Parse(data); free(data); return config; }

3.2 访问配置项

void print_network_config(cJSON* config) { cJSON* network = cJSON_GetObjectItem(config, "network"); if (!network) return; printf("SSID: %s\n", cJSON_GetStringValue(cJSON_GetObjectItem(network, "ssid"))); printf("Retry: %d\n", cJSON_GetNumberValue(cJSON_GetObjectItem(network, "retry_count"))); // 安全获取可能不存在的配置项 cJSON* dhcp = cJSON_GetObjectItem(network, "dhcp"); if (dhcp) { printf("DHCP: %s\n", cJSON_IsTrue(dhcp) ? "enabled" : "disabled"); } }

3.3 修改并保存配置

void update_interval(cJSON* config, const char* sensor_type, int new_interval) { cJSON* sensors = cJSON_GetObjectItem(config, "sensors"); if (!sensors) return; cJSON* sensor = NULL; cJSON_ArrayForEach(sensor, sensors) { cJSON* type = cJSON_GetObjectItem(sensor, "type"); if (type && strcmp(type->valuestring, sensor_type) == 0) { cJSON* interval = cJSON_GetObjectItem(sensor, "interval"); if (interval) { cJSON_SetNumberValue(interval, new_interval); } } } } void save_config(const char* filename, cJSON* config) { char* json = cJSON_Print(config); FILE* fp = fopen(filename, "w"); if (fp) { fputs(json, fp); fclose(fp); } free(json); }

4. 实战技巧与避坑指南

4.1 内存管理最佳实践

cJSON需要开发者自行管理内存，常见内存问题包括：

• 忘记释放cJSON_Parse()生成的树
• 漏掉cJSON_Print()返回的字符串
• 未处理错误情况下的内存释放

void safe_config_operation(const char* filename) { cJSON* config = load_config(filename); if (!config) { printf("Failed to load config\n"); return; } // 操作配置... update_interval(config, "temperature", 10); char* json = cJSON_Print(config); if (json) { // 保存配置... free(json); } cJSON_Delete(config); // 必须调用！ }

4.2 处理复杂嵌套结构

对于多层嵌套的配置，可以采用递归方式处理：

void print_config_recursive(cJSON* item, int depth) { if (!item) return; for (int i = 0; i < depth; i++) printf(" "); switch (item->type) { case cJSON_Object: printf("%s: {\n", item->string); cJSON* child = item->child; while (child) { print_config_recursive(child, depth + 1); child = child->next; } for (int i = 0; i < depth; i++) printf(" "); printf("}\n"); break; case cJSON_Array: printf("%s: [\n", item->string); cJSON_ArrayForEach(child, item) { print_config_recursive(child, depth + 1); } for (int i = 0; i < depth; i++) printf(" "); printf("]\n"); break; default: printf("%s: %s\n", item->string, item->type == cJSON_String ? item->valuestring : item->type == cJSON_Number ? (item->valueint == item->valuedouble ? itoa(item->valueint) : dtoa(item->valuedouble)) : item->type == cJSON_True ? "true" : item->type == cJSON_False ? "false" : "null"); } }

4.3 性能优化技巧

在资源受限的嵌入式设备上：

• 使用cJSON_PrintUnformatted()节省空间
• 开启CJSON_NO_HEAP使用静态内存
• 避免频繁解析，缓存配置对象
• 对大文件使用流式解析

// 最小内存配置示例 #define CJSON_NO_HEAP #define CJSON_STACK_SIZE 512 static char cjson_stack[CJSON_STACK_SIZE]; void process_config() { cJSON_Hooks hooks = { .malloc_fn = my_malloc, .free_fn = my_free }; cJSON_InitHooks(&hooks); // ...其余代码不变 }

5. 实际项目集成案例

5.1 物联网设备配置管理

典型物联网设备配置可能包含：

• 网络参数（WiFi/蜂窝）
• 传感器校准数据
• 上报间隔设置
• 设备标识信息

typedef struct { char device_id[32]; char ssid[32]; char password[64]; int report_interval; float calibration[3]; } DeviceConfig; int load_device_config(DeviceConfig* cfg) { cJSON* json = load_config("device.json"); if (!json) return -1; cJSON* device = cJSON_GetObjectItem(json, "device"); if (device) { strncpy(cfg->device_id, cJSON_GetStringValue(cJSON_GetObjectItem(device, "id")), sizeof(cfg->device_id)); } // 加载其他配置项... cJSON_Delete(json); return 0; }

5.2 动态配置更新

通过结合文件监控机制，可以实现配置热更新：

#ifdef _WIN32 #include <windows.h> #else #include <sys/inotify.h> #endif void watch_config_changes() { #ifdef __linux__ int fd = inotify_init(); inotify_add_watch(fd, "config.json", IN_MODIFY); while (1) { struct inotify_event event; read(fd, &event, sizeof(event)); if (event.mask & IN_MODIFY) { reload_config(); } } #endif }

6. 测试与验证

完善的配置系统需要良好的测试覆盖：

void test_config_operations() { // 创建测试配置 cJSON* config = cJSON_CreateObject(); cJSON_AddStringToObject(config, "test_key", "test_value"); // 测试序列化/反序列化 char* json = cJSON_Print(config); cJSON* parsed = cJSON_Parse(json); assert(cJSON_GetObjectItem(parsed, "test_key") != NULL); // 测试修改 cJSON_SetStringValue(cJSON_GetObjectItem(parsed, "test_key"), "new_value"); assert(strcmp(cJSON_GetStringValue(cJSON_GetObjectItem(parsed, "test_key")), "new_value") == 0); // 清理 cJSON_Delete(config); cJSON_Delete(parsed); free(json); }

7. 扩展应用场景

cJSON不仅能用于配置文件，还可用于：

• 网络通信协议（HTTP API交互）
• 数据持久化存储
• 动态UI配置
• 设备间数据交换

// 与Web服务交互示例 void send_device_status() { cJSON* status = cJSON_CreateObject(); cJSON_AddStringToObject(status, "device_id", get_device_id()); cJSON_AddNumberToObject(status, "uptime", get_uptime()); char* payload = cJSON_PrintUnformatted(status); http_post("/api/status", payload); free(payload); cJSON_Delete(status); }

在嵌入式开发中合理使用cJSON处理配置文件，可以大幅提升开发效率和代码可维护性。相比手写解析器，它能减少约70%的代码量，同时提供更好的扩展性和健壮性。