cJSON内存管理：cJSON_Delete函数的正确使用

11 次阅读

cJSON是C语言生态中使用非常广泛的JSON解析库，它以轻量、易集成、接口简单等特点，被大量嵌入式项目、网络通信程序以及服务端应用采用。然而，C语言不像Java、Python等高级语言拥有自动垃圾回收机制，开发者必须主动管理内存。如果使用cJSON创建JSON对象后没有正确释放，就容易造成内存泄漏，严重时甚至会导致程序长期运行后崩溃。

cJSON_Delete函数是cJSON提供的核心内存释放接口，用于递归释放由cJSON创建的JSON对象及其内部节点。理解它的工作机制、适用场景以及常见误区，是保证C程序稳定运行的重要基础。

cJSON内存管理机制简介

cJSON内部采用链表结构保存JSON节点，每一个JSON对象、数组、字符串、数字等元素，都会对应一个cJSON结构体。

一个典型的cJSON结构如下：

C
typedef struct cJSON
{
    struct cJSON *next;
    struct cJSON *prev;
    struct cJSON *child;

    int type;

    char *valuestring;
    int valueint;
    double valuedouble;

    char *string;

} cJSON;

其中：

  • next和prev用于维护同级节点链表；

  • child指向对象或数组内部的子节点；

  • valuestring保存字符串数据；

  • string保存JSON键名。

当使用cJSON_CreateObject()、cJSON_CreateArray()或者cJSON_Parse()创建JSON结构时，cJSON会动态申请内存：

C
cJSON *root = cJSON_CreateObject();

此时：

root
 |
 +-- JSON节点内存

如果程序执行结束前没有释放：

C
cJSON_Delete(root);

这些动态分配的内存就会一直占用。

cJSON_Delete函数作用解析

cJSON_Delete函数定义通常如下：

C
void cJSON_Delete(cJSON *item);

参数：

  • item：需要释放的cJSON对象指针。

它的主要功能包括：

  1. 释放当前JSON节点；

  2. 递归释放所有子节点；

  3. 释放动态申请的字符串空间；

  4. 释放整个JSON树结构。

例如：

C
cJSON *json = cJSON_Parse(
    "{"name":"Tom","age":20}"
);

if(json)
{
    cJSON_Delete(json);
}

执行过程：

json对象
 |
 +-- name节点
 |      |
 |      +-- "Tom"
 |
 +-- age节点
        |
        +-- 20

调用：

C
cJSON_Delete(json);

后，整个树结构都会被释放。

为什么必须正确使用cJSON_Delete

很多初学者认为C语言程序退出后操作系统会自动回收内存，因此忽略释放操作。

对于短生命周期程序，这种问题可能不明显。但对于以下场景：

  • Web服务器；

  • 长时间运行的后台服务；

  • 嵌入式设备；

  • 网络通信程序；

  • 高频JSON解析任务；

内存泄漏会不断累积。

例如：

C
while(1)
{
    cJSON *json = cJSON_Parse(buffer);

    // 处理数据

}

如果没有：

C
cJSON_Delete(json);

每循环一次都会泄漏一次JSON树占用的内存。

运行数小时甚至数天后，可能出现：

  • 内存持续增长；

  • 系统响应变慢；

  • malloc失败；

  • 程序异常退出。

因此，cJSON_Delete是cJSON内存生命周期管理中不可缺少的一环。

cJSON_Parse之后必须调用cJSON_Delete

cJSON_Parse()是最容易产生内存泄漏的位置。

例如：

错误示例：

C
char *text = "{"user":"admin"}";

cJSON *root = cJSON_Parse(text);

cJSON *user = cJSON_GetObjectItem(root,"user");

printf("%s
",user->valuestring);

问题：

root申请的内存没有释放。

正确方式：

C
char *text = "{"user":"admin"}";

cJSON *root = cJSON_Parse(text);

if(root)
{
    cJSON *user = cJSON_GetObjectItem(root,"user");

    if(user)
    {
        printf("%s
",user->valuestring);
    }

    cJSON_Delete(root);
}

释放根节点即可，因为子节点属于root管理范围。

不要单独释放cJSON子节点

这是cJSON使用中的常见错误。

例如：

C
cJSON *root = cJSON_Parse(
    "{"name":"Jack"}"
);

cJSON *name = cJSON_GetObjectItem(root,"name");

free(name);

这种方式是错误的。

原因：

name节点属于root的子节点，由cJSON统一管理。

如果手动释放：

  • root仍然保存name指针；

  • 后续删除root时可能重复释放；

  • 可能造成堆损坏。

正确方式：

C
cJSON_Delete(root);

让cJSON递归释放全部内容。

cJSON_Delete与cJSON_DeleteItemFromObject区别

cJSON提供了多个删除相关函数。

cJSON_Delete

用于释放整个JSON树：

C
cJSON_Delete(root);

适用于：

  • JSON解析完成；

  • 整个对象不再使用。

cJSON_DeleteItemFromObject

用于删除对象中的指定成员：

C
cJSON_DeleteItemFromObject(root,"name");

例如：

原JSON：

JSON
{
    "name":"Tom",
    "age":18
}

执行：

C
cJSON_DeleteItemFromObject(root,"name");

结果：

JSON
{
    "age":18
}

此时：

  • name节点被释放；

  • root仍然有效。

cJSON_DeleteItemFromArray

用于删除数组元素：

C
cJSON_DeleteItemFromArray(array,0);

删除数组第一个元素。

创建JSON对象后的释放规范

使用cJSON创建数据时，也需要遵守释放规则。

例如：

C
cJSON *root = cJSON_CreateObject();

cJSON_AddStringToObject(root,"name","Alice");
cJSON_AddNumberToObject(root,"age",25);

char *out = cJSON_Print(root);

printf("%s
",out);

free(out);

cJSON_Delete(root);

这里有两个不同的内存区域：

cJSON_Print产生的字符串

C
char *out = cJSON_Print(root);

这个字符串由cJSON动态分配：

必须：

C
free(out);

释放。

cJSON对象树

C
cJSON_Delete(root);

释放。

二者不能混淆。

cJSON_Delete释放字符串问题

cJSON内部默认使用：

C
malloc()
free()

管理内存。

例如：

C
cJSON *json = cJSON_CreateString("hello");

cJSON_Delete(json);

释放过程中：

  • 节点释放；

  • "hello"字符串释放。

开发者无需：

C
free(json->valuestring);

否则可能产生二次释放。

使用自定义内存管理时的注意事项

部分项目会通过：

C
cJSON_InitHooks()

修改内存函数。

例如：

C
cJSON_Hooks hooks;

hooks.malloc_fn = my_malloc;
hooks.free_fn = my_free;

cJSON_InitHooks(&hooks);

此时：

cJSON_Delete内部调用的是自定义释放函数。

因此：

  • 创建和释放必须使用同一套内存管理机制；

  • 不要混用系统free和自定义free。

否则可能导致：

  • 堆结构破坏；

  • 内存异常；

  • 难以定位的崩溃。

常见cJSON内存管理错误

错误一：忘记释放Parse结果

错误：

C
cJSON *root = cJSON_Parse(data);

没有：

C
cJSON_Delete(root);

后果：

内存泄漏。

错误二：释放后继续访问

错误：

C
cJSON_Delete(root);

printf("%s",root->string);

释放后的指针属于悬空指针。

正确：

C
cJSON_Delete(root);
root = NULL;

错误三：重复释放

错误：

C
cJSON_Delete(root);
cJSON_Delete(root);

第二次释放可能导致程序崩溃。

推荐：

C
cJSON_Delete(root);
root = NULL;

错误四：释放Print结果错误

错误：

C
char *str=cJSON_Print(root);

cJSON_Delete(str);

str不是cJSON对象。

正确：

C
free(str);
cJSON_Delete(root);

如何检查cJSON内存泄漏

在大型项目中，可以结合内存检测工具。

Linux环境使用Valgrind

示例：

Bash
valgrind --leak-check=full ./program

如果存在：

definitely lost

通常说明存在未释放内存。

使用AddressSanitizer

编译：

Bash
gcc test.c -fsanitize=address -g

运行后可以检测：

  • 内存泄漏；

  • 越界访问；

  • 重复释放。

嵌入式环境

可以通过：

  • 统计malloc/free次数；

  • 记录分配地址；

  • 包装内存接口；

定位cJSON相关泄漏。

cJSON内存管理最佳实践

为了避免问题，推荐遵循以下原则：

1. 谁创建，谁释放

例如：

C
cJSON *obj=cJSON_CreateObject();

对应：

C
cJSON_Delete(obj);

2. 始终释放根节点

无论JSON层级多复杂：

C
cJSON_Delete(root);

即可。

3. 不直接操作内部指针

不要：

C
free(item->valuestring);

使用cJSON提供接口管理生命周期。

4. 释放后立即置空

推荐：

C
cJSON_Delete(root);
root=NULL;

减少悬空指针风险。

5. 明确字符串所有权

区分：

  • cJSON管理的数据；

  • 用户自己分配的数据；

  • Print生成的数据。

不同来源采用不同释放方式。

总结

cJSON_Delete是cJSON库中最重要的内存管理函数之一，它负责释放JSON树结构中的节点、字符串以及所有关联资源。正确理解它的使用方式，可以有效避免C语言项目中常见的内存泄漏、重复释放和野指针问题。

实际开发过程中，应遵循“谁创建，谁释放”的原则。通过统一管理JSON对象生命周期、避免手动释放内部节点、合理使用内存检测工具，可以让基于cJSON的程序更加稳定、安全，尤其适用于服务器程序、嵌入式系统以及长期运行的C语言应用。

文章标签
cJSON cJSON_Delete C语言内存管理 JSON解析 内存泄漏排查