C语言中使用cJSON库处理JSON数据详解

1. JSON基础与cJSON库概览

JSON作为现代数据交换的事实标准，其简洁的键值对结构和跨平台特性使其成为C/C++项目中处理配置和数据交换的首选方案。不同于XML的冗长标签，JSON采用纯文本格式，例如一个用户数据可以表示为：

json复制{
  "username": "dev_001",
  "permissions": ["read", "write"],
  "metadata": {
    "created_at": "2023-01-01",
    "active": true
  }
}

在嵌入式系统和性能敏感场景中，cJSON因其单文件、零依赖的特性成为C语言项目的理想选择。这个仅有约2000行代码的库，却完整实现了：

• JSON文本→内存树形结构的解析器（cJSON_Parse()）
• 内存结构→JSON文本的生成器（cJSON_Print()）
• 类型安全的访问接口（cJSON_GetObjectItemCaseSensitive()）
• 内存自动回收机制（cJSON_Delete()）

实际项目中选择cJSON而非rapidjson等C++库的关键考量：当项目需要保持纯C环境或运行在资源受限设备（如STM32）时，cJSON 50KB左右的代码体积和确定性内存管理更具优势。

2. cJSON核心数据结构深度解析

cJSON使用链式结构组织JSON数据，其核心结构体定义如下（简化版）：

c复制typedef struct cJSON {
    struct cJSON *next, *prev;  // 同级节点链表
    struct cJSON *child;        // 子节点（对象/数组用）
    int type;                   // 数据类型标识
    char *valuestring;          // 字符串值
    int valueint;               // 整数值
    double valuedouble;         // 浮点值
    char *string;               // 键名
} cJSON;

类型系统通过type字段实现，包含以下常见枚举值：

• cJSON_Object：键值对集合
• cJSON_Array：有序列表
• cJSON_String：UTF-8字符串
• cJSON_Number：双精度浮点
• cJSON_True/cJSON_False：布尔值

内存管理示例：

c复制// 创建含数组的JSON对象
cJSON *root = cJSON_CreateObject();
cJSON *arr = cJSON_CreateArray();
for(int i=0; i<3; i++) {
    cJSON_AddItemToArray(arr, cJSON_CreateNumber(i));
}
cJSON_AddItemToObject(root, "values", arr);

// 使用后必须释放
cJSON_Delete(root);  // 递归释放整个树

3. 结构体与JSON互转工程实践

3.1 基础手动映射方法

对于简单结构体，可采用直接映射方式：

c复制typedef struct {
    int id;
    char name[32];
    float price;
} Product;

// 结构体→JSON
cJSON *product_to_json(Product *p) {
    cJSON *obj = cJSON_CreateObject();
    cJSON_AddNumberToObject(obj, "id", p->id);
    cJSON_AddStringToObject(obj, "name", p->name);
    cJSON_AddNumberToObject(obj, "price", p->price);
    return obj;
}

// JSON→结构体
void json_to_product(cJSON *obj, Product *p) {
    cJSON *item = cJSON_GetObjectItem(obj, "id");
    if (cJSON_IsNumber(item)) p->id = item->valueint;
    
    item = cJSON_GetObjectItem(obj, "name");
    if (cJSON_IsString(item)) strncpy(p->name, item->valuestring, 32);
    
    item = cJSON_GetObjectItem(obj, "price");
    if (cJSON_IsNumber(item)) p->price = item->valuedouble;
}

3.2 自动化映射方案

对于复杂嵌套结构，推荐使用CSON这类扩展库。其核心是通过注册结构体描述信息实现自动转换：

c复制// 定义数据结构模型
CsonModel product_model[] = {
    CSON_MODEL_OBJ(Product),
    CSON_MODEL_INT(Product, id),
    CSON_MODEL_STRING(Product, name),
    CSON_MODEL_FLOAT(Product, price)
};

// 使用示例
Product p = {1, "Widget", 9.99};
char *json = csonEncode(&p, product_model, 
                       sizeof(product_model)/sizeof(CsonModel),
                       1024, 1);  // 缓冲区大小和格式化标志

Product *decoded = csonDecode(json, product_model, 
                             sizeof(product_model)/sizeof(CsonModel));

4. 性能优化与安全实践

4.1 内存管理策略

• 解析阶段：cJSON默认使用malloc分配内存，在实时系统中可替换为静态内存池：

  c复制void *(*old_malloc)(size_t) = cJSON_hooks.malloc;
  void (*old_free)(void *) = cJSON_hooks.free;
  
  cJSON_Hooks hooks = {my_malloc, my_free};
  cJSON_InitHooks(&hooks);
  

• 字符串处理：对于已知最大长度的字段，优先使用strncpy而非指针赋值：

  c复制char name[32];
  strncpy(name, cJSON_GetStringValue(item), sizeof(name)-1);
  name[sizeof(name)-1] = '\0';
  

4.2 安全防护措施

1. 输入验证：解析前检查JSON最大长度

   c复制#define MAX_JSON_LEN 4096
   if(strlen(json_str) > MAX_JSON_LEN) {
       // 拒绝处理
   }
   

2. 防溢出：数字类型转换时检查范围

   c复制long val = cJSON_GetNumberValue(item);
   if(val < INT_MIN || val > INT_MAX) {
       // 错误处理
   }
   

3. 循环引用检测：手动构建JSON时避免环形引用

   c复制cJSON *obj1 = cJSON_CreateObject();
   cJSON *obj2 = cJSON_CreateObject();
   cJSON_AddItemToObject(obj1, "link", obj2);
   // 危险操作：cJSON_AddItemToObject(obj2, "backlink", obj1);
   

5. 复杂场景处理技巧

5.1 动态数组处理

c复制// 结构体包含动态数组
typedef struct {
    int count;
    float *values;
} Dataset;

// 序列化处理
cJSON *serialize_dataset(Dataset *ds) {
    cJSON *arr = cJSON_CreateArray();
    for(int i=0; i<ds->count; i++) {
        cJSON_AddItemToArray(arr, cJSON_CreateNumber(ds->values[i]));
    }
    return arr;
}

// 反序列化处理
void deserialize_dataset(cJSON *json, Dataset *ds) {
    ds->count = cJSON_GetArraySize(json);
    ds->values = malloc(ds->count * sizeof(float));
    
    cJSON *item;
    int i=0;
    cJSON_ArrayForEach(item, json) {
        if(cJSON_IsNumber(item)) {
            ds->values[i++] = item->valuedouble;
        }
    }
}

5.2 多态类型支持

通过type字段实现运行时类型判断：

c复制typedef enum { TYPE_A, TYPE_B } VariantType;

typedef struct {
    VariantType type;
    union {
        int number;
        char *string;
    } data;
} Variant;

cJSON *serialize_variant(Variant *var) {
    cJSON *obj = cJSON_CreateObject();
    cJSON_AddNumberToObject(obj, "type", var->type);
    
    switch(var->type) {
        case TYPE_A:
            cJSON_AddNumberToObject(obj, "data", var->data.number);
            break;
        case TYPE_B:
            cJSON_AddStringToObject(obj, "data", var->data.string);
            break;
    }
    return obj;
}

6. 调试与问题排查

常见问题及解决方案：

调试建议：

1. 使用cJSON_Print()输出中间结果
2. 为每个JSON操作添加错误检查：

   c复制cJSON *root = cJSON_Parse(json_str);
   if(!root) {
       fprintf(stderr, "Parse error: %s\n", cJSON_GetErrorPtr());
       return -1;
   }
   

3. 使用Valgrind检测内存问题

在嵌入式Linux项目中，我们曾遇到JSON解析导致的内存碎片问题。最终通过以下方案解决：

• 预分配内存池供cJSON使用
• 限制单个JSON文档最大深度（32层）
• 对高频使用的结构体实现定制化解析器

对于需要处理GB级JSON数据的场景，建议改用流式解析器（如yajl），但cJSON在99%的中小规模应用中仍是性价比最高的选择。