零基础学习cJSON 源码详解与应用（二）创建json数据

最新推荐文章于 2024-12-26 20:43:37 发布
原创 最新推荐文章于 2024-12-26 20:43:37 发布 · 3.4k 阅读 · 33 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#json #cjson #嵌入式 #物联网 #智能家居

本文主要介绍了cJSON创建简单JSON数据的方法，包括确定item类型、创建并添加到root节点。详细解析了相关源码，如创建对象、字符串等函数。还提醒注意const和reference的使用，避免内存错误。最后给出更简单的创建cJSON方式，帮助读者掌握JSON与cJSON结构体对应关系。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

文章目录

cJSON系列：

上一篇我们已经介绍了cjson结构体 （一）如何学习cJSON，这节就介绍简单的创建json数据并分析源码。

一，创建一个简单的json

例如创建一个如下的json：

{
    "years": 22,
    "name": "fool",
    "man": true,
    "adult": false,
    "money": null,
    "season": ["spring", "summer", "fall","winter"],
    "child": {
        "girlfriend": "june"
    }
}

首先分析这个json，确定它的所有item类型，其中比较需要注意的是child这个item是一个嵌套子json，所以它的类型应该是object，从item的类型入手，先创建所有的item，再把item添加到root节点上。代码如下：

    char *str_arry[3] = 
    {
        "spring",
        "summer",
        "fall",
        "winter"
    };
    //创建不同类型的item
    cJSON *root = cJSON_CreateObject();
    cJSON *years = cJSON_CreateNumber(22);
    cJSON *name = cJSON_CreateString("fool");
    cJSON *man = cJSON_CreateTrue();
    cJSON *adult = cJSON_CreateFalse();
    cJSON *money = cJSON_CreateNull();
    cJSON *season = cJSON_CreateStringArray(str_arry, 3);
    cJSON *child = cJSON_CreateObject();
    cJSON *girlfriend = cJSON_CreateString("june");

    //将item添加到父节点下
    cJSON_AddItemToObject(root, "years", years);
    cJSON_AddItemToObject(root, "name", name);
    cJSON_AddItemToObject(root, "man", man);
    cJSON_AddItemToObject(root, "adult", adult);
    cJSON_AddItemToObject(root, "money", money);
    cJSON_AddItemToObject(root, "season", season);
    cJSON_AddItemToObject(child, "girlfriend", girlfriend);
    cJSON_AddItemToObject(root, "child", child);

    //将所有json结构体输出成字符串
    char *json=cJSON_Print(root);

    printf("%s\n",json);

    //! 一定要记得用完擦屁股
    cJSON_Delete(root);

这里需要注意的是由于cjson是使用动态内存分配的，当cjson用完后，切记！切记！切记！一定用要用cJSON_Delete释放内存。

打印结果如下：

在这里插入图片描述

二，源码详解

1, CJSON_PUBLIC(cJSON *) cJSON_CreateObject(void);

//创建一个空的json，赋予obj类型
CJSON_PUBLIC(cJSON *) cJSON_CreateObject(void)
{
    cJSON *item = cJSON_New_Item(&global_hooks);
    if (item)
    {
        item->type = cJSON_Object;
    }

    return item;
}

该函数调用的是cJSON_New_Item()，传入参数&global_hooks是全局变量，该变量是有三个函数指针分别指向free(),malloc(),realloc()，用来操作内存的。
cJSON_New_Item()以动态内存分配的形式，申请了一块内存并将内存初始化。返回指向该内存的指针。

//动态内存分配一个cjson并设为0
static cJSON *cJSON_New_Item(const internal_hooks * const hooks)
{

    cJSON* node = (cJSON*)hooks->allocate(sizeof(cJSON));
    if (node)
    {
        memset(node, '\0', sizeof(cJSON));
    }

    return node;
}

2, CJSON_PUBLIC(cJSON *) cJSON_CreateString(const char *string);

//创建字符串值为string的json，string值可被cjson_delete删除
CJSON_PUBLIC(cJSON *) cJSON_CreateString(const char *string)
{
    //创建空cjson
    cJSON *item = cJSON_New_Item(&global_hooks);
    if(item)
    {
        item->type = cJSON_String;
        //将string内容复制给valuestring
        item->valuestring = (char*)cJSON_strdup((const unsigned char*)string, &global_hooks);
        if(!item->valuestring)
        {
            cJSON_Delete(item);
            return NULL;
        }
    }

    return item;
}

cJSON_strdup()也是后续会经常使用的函数，作用是复制字符串。

//开辟一块新内存，并将string复制到内存中，并返回指向内存的指针
static unsigned char* cJSON_strdup(const unsigned char* string, const internal_hooks * const hooks)
{
    size_t length = 0;
    unsigned char *copy = NULL;

    if (string == NULL)
    {
        return NULL;
    }
    //计算所需内存的长度
    length = strlen((const char*)string) + sizeof("");
    //申请内存
    copy = (unsigned char*)hooks->allocate(length);
    if (copy == NULL)
    {
        return NULL;
    }
    memcpy(copy, string, length);

    return copy;
}

3，CJSON_PUBLIC(cJSON *) cJSON_CreateStringArray(const char **strings, int count);

/*
 * 创建字符串型数组的json
 * strings：字符串数组
 * count：数组长度
 * 返回：数组
 */
CJSON_PUBLIC(cJSON *) cJSON_CreateStringArray(const char **strings, int count)
{
    size_t i = 0;
    cJSON *n = NULL;    //next
    cJSON *p = NULL;    //prev
    cJSON *a = NULL;    //arry

    if ((count < 0) || (strings == NULL))
    {
        return NULL;
    }

    //创建数组
    a = cJSON_CreateArray();

    for (i = 0; a && (i < (size_t)count); i++)
    {
        //创建string类型cjson
        n = cJSON_CreateString(strings[i]);
        if(!n)
        {
            cJSON_Delete(a);
            return NULL;
        }
        if(!i)
        {
            //如果是数组第一个，则将n复制给数组cjson的子节点
            a->child = n;
        }
        else
        {
            //将n插入p之后（链表操作）
            suffix_object(p,n);
        }
        p = n;
    }

    return a;
}

4，CJSON_PUBLIC(void) cJSON_AddItemToObject(cJSON *object, const char *string, cJSON *item);

cJSON_AddItemToObject()是调用了add_item_to_object()

/*
 * 将item以键string添加到obj下
 * note：item可以是任何类型的cjson
 * constant_key:指示string是否是外部定义的常量数据
 * 成功：返回 true
 */
static cJSON_bool add_item_to_object(cJSON * const object, const char * const string, cJSON * const item, const internal_hooks * const hooks, const cJSON_bool constant_key)
{
    char *new_key = NULL;
    int new_type = cJSON_Invalid;

    if ((object == NULL) || (string == NULL) || (item == NULL))
    {
        return false;
    }

    //判断key是否是常量数据，若是则不需要重新复制字符串
    if (constant_key)
    {
        //直接取指针，cjson_delete不会删除key
        new_key = (char*)cast_away_const(string);
        //cjson类型设置为常量字符串
        new_type = item->type | cJSON_StringIsConst;
    }
    else
    {
        //复制string
        new_key = (char*)cJSON_strdup((const unsigned char*)string, hooks);
        if (new_key == NULL)
        {
            return false;
        }
        //修改cjson类型
        new_type = item->type & ~cJSON_StringIsConst;
    }

    if (!(item->type & cJSON_StringIsConst) && (item->string != NULL))
    {
        //如果string是常量且不为空则释放内存
        hooks->deallocate(item->string);
    }

	//将key赋值给cjson的键
    item->string = new_key;
    item->type = new_type;

    //最后把item添加到obj
    return add_item_to_array(object, item);
}

在最后调用了add_item_to_array();

/*
 * 添加item到数组最后
 * 成功返回 true
 */
static cJSON_bool add_item_to_array(cJSON *array, cJSON *item)
{
    cJSON *child = NULL;

    if ((item == NULL) || (array == NULL))
    {
        return false;
    }

    //child是数组的第一个成员
    child = array->child;

    //如果数组为空，则item赋予第一个成员child
    if (child == NULL)
    {
        /* list is empty, start new one */
        array->child = item;
    }
    else
    {
        /* append to the end */
        //遍历数组，并在数组最后插入item
        while (child->next)
        {
            child = child->next;
        }
        suffix_object(child, item);
    }

    return true;
}

5，CJSON_PUBLIC(void) cJSON_Delete(cJSON *c);

/*
 * 将item所在链表的及其子节点的所有cjson释放
 */
CJSON_PUBLIC(void) cJSON_Delete(cJSON *item)
{
    cJSON *next = NULL; //指向当前cjson的下一个
    
    
    while (item != NULL)
    {
        //由json结构体的定义可知，json结构体自身，string和valuestring是由动态内存分配获得，需要释放这三部分内存
        next = item->next;
        //如果cjson不是参考外部数据且不为空，则递归调用delete，删除cjson的子节点
        if (!(item->type & cJSON_IsReference) && (item->child != NULL))
        {
            //释放嵌套的json结构体
            cJSON_Delete(item->child);
        }
        //如果cjson不是参考外部数据，则valuestring以及string是由cJSON动态内存分配的，需要释放内存
        if (!(item->type & cJSON_IsReference) && (item->valuestring != NULL))
        {
            global_hooks.deallocate(item->valuestring);
        }
        if (!(item->type & cJSON_StringIsConst) && (item->string != NULL))
        {
            global_hooks.deallocate(item->string);
        }
        //释放当前的cjson
        global_hooks.deallocate(item);
        //准备释放链表中的下一个cjson
        item = next;
    }
}

deallocate();可类比free();
这里需要注意的是释放内存时，要判断cjson结构体的string,valuesstring是否是常量。

当string,valuesstring是动态内存分配时，才能使用deallocate()释放，否则可能出现内存错误。具体原因见下一节

三 注意 const，reference

上面的代码中你会发现有些函数中会出现const,reference，这是cjson允许使用外部定义的变量来作为cjson结构体的成员。这种情况下的字符串需要用const修饰，结构体用reference修饰。

以cJSON_CreateString()为例，在为valuestring赋值时，使用的是动态内存分配的形式申请一块内存，传入参数string复制到内存，在这之后，参数string如何变化对该item的valuestring是没有影响的。

作为对比，以cJSON_CreateStringReference()为例：
在这个函数中，系统不为valuestring分配内存，而只是把它指向string

/*
 * 创建一个string类型的item，其valuestring指向传入参数string，外部定义的string发生变化会影响item的valuestring
 */
CJSON_PUBLIC(cJSON *) cJSON_CreateStringReference(const char *string)
{
    cJSON *item = cJSON_New_Item(&global_hooks);
    if (item != NULL)
    {
        item->type = cJSON_String | cJSON_IsReference;
        item->valuestring = (char*)cast_away_const(string);
    }

    return item;
}

这么做的目的一个方面是可以节约内存，但在使用时需注意参考变量的值不要轻易修改，其他reference类的函数一样，只是参考的变量不同。

CJSON_PUBLIC(cJSON *) cJSON_CreateObjectReference(const cJSON *child);

CJSON_PUBLIC(cJSON *) cJSON_CreateArrayReference(const cJSON *child);

CJSON_PUBLIC(void) cJSON_AddItemToObjectCS(cJSON *object, const char *string, cJSON *item);
CJSON_PUBLIC(void) cJSON_AddItemReferenceToArray(cJSON *array, cJSON *item);
CJSON_PUBLIC(void) cJSON_AddItemReferenceToObject(cJSON *object, const char *string, cJSON *item);

由此造成：当删除一个item时，需要判断其指针是否是外部定义的变量，以此来决定是否使用内存释放函数。

四 更简单的创建cjson

当你熟悉了cjson对json的创建思路后，可用以下更加快的方式创建cjson：

    cJSON_AddNullToObject(root, "money");
    cJSON_AddTrueToObject(root, "man");
    cJSON_AddFalseToObject(root, "adult");
    cJSON_AddNumberToObject(root, "years", 22);
    cJSON_AddStringToObject(root, "name", "fool");

    cJSON *season = cJSON_CreateStringArray(str_arry, 3);
    cJSON_AddItemToObject(root, "season", season);
    
    cJSON *child = cJSON_AddObjectToObject(root, "child");
    cJSON_AddStringToObject(child, "girlfriend", "june");

CJSON_PUBLIC(cJSON*) cJSON_AddStringToObject(cJSON * const object, const char * const name, const char * const string);

可见这个函数本质上是调用了前面提到的cJSON_CreateString();与add_item_to_object();就是两步并作一步走。

/*
 * 添加string类型cjson到obj
 * name ：键
 * string：值
 * 成功返回：string类cjson
 */
CJSON_PUBLIC(cJSON*) cJSON_AddStringToObject(cJSON * const object, const char * const name, const char * const string)
{
    cJSON *string_item = cJSON_CreateString(string);
    if (add_item_to_object(object, name, string_item, &global_hooks, false))
    {
        return string_item;
    }

    cJSON_Delete(string_item);
    return NULL;
}

小结

熟悉完json的创建，对json与cjson结构体的对应关系有了更深的掌握，下一章将解析cJSON_Print();输出json。
在这里插入图片描述

cJSON源码解析之add_item_to_object函数
m0_62599305的博客
06-26 575
在我们的日常编程中，JSON已经成为了一种非常常见的数据交换格式。在C语言中，我们通常使用cJSON库来处理JSON数据。cJSON库提供了一系列的函数来创建、解析和操作JSON数据。其中，add_item_to_object函数是一个关键的函数，它允许我们将一个新的项目添加到一个已存在的JSON对象中。在这篇文章中，我们将深入探讨add_item_to_object函数的内部实现。这段代码的目的是在添加新的键值对到JSON对象时，安全地处理旧的键字符串。if (!= NULL))!
JSON及CJSON详解笔记
Xanthium
09-20 2274
目录 1. JSON 1.1 JSON 概述 1.2 JSON 语法 1.2.1 JSON 对象 1.2.2 JSON 数组 1.2.3 JSON 值 1.2.4 JSON 字符串 1.2.5 JSON 数值 1.2.6 JSON 布尔值 1.2.7 JSON null 1.2.8 JSON 空白 1.2.9JSON 文件 文件 2. CJSON获取和移植 2.1 源...
使用cJSON创建JSON字符串
Hical的博客
12-07 2264
在Linux下，使用C语言编程，开始JSON字符串的创建。我们还是一步步来，逐渐由简单到复制。   1，下载源码 可以从如下网站来下载：https://sourceforge.net/projects/cjson/ 。 2，包含cJSON的源码 下载下来，解压后，从里面找到两个文件（cJSON.c、cJSON.h），复制到我们的工程里面。只需在函数 中包含头文件（#include “cJS
cjson创建数组
weixin_29898767的博客
04-03 3554
cjson创建数组
使用 CJSON 在C语言中进行 JSON 的创建和解析的实例讲解
weixin_33836223的博客
10-18 373
本文用代码简单介绍cjson的使用方法，1）创建json，从json中获取数据。2）创建json数组和解析json数组   1、 创建json，从json中获取数据 1 #include &lt;stdio.h&gt; ...
cJSON源码，用于C语言json数据的构建与解析
06-11
cJSON库的核心是JSON数据结构的C语言实现，包括`cJSON_Structure`（JSON对象）、`cJSON_False`、`cJSON_True`、`cJSON_NULL`、`cJSON_Number`、`cJSON_String`、`cJSON_Array`和`cJSON_Object`等类型。这些类型对应...
cJSON源码（c语言版）
12-15
**cJSON源码详解——C语言实现的JSON解析库** cJSON是一个轻量级的开源JSON解析库，专为C语言设计。它提供了一套API，使得开发者能够方便地进行JSON数据的序列化和反序列化操作。在本文中，我们将深入探讨cJSON的...
cJSON解析json格式文件代码示例（vs2019编译）
01-01
在VS2019中使用cJSON库，你需要先下载cJSON源码，将其包含在项目中。"cJSONTest.sln"是Visual Studio的解决方案文件，它包含了整个项目的配置信息。而"Debug"目录则包含了编译后的调试版本的可执行文件和其他相关...
cJSON1.7.15源码 cJSON1.7.15源码
06-21
cJSON 1.7.15是该库的一个版本，它包含了对JSON格式的支持，包括解析JSON字符串、创建JSON对象以及将JSON对象转换回字符串的功能。 ### cJSON特点 1. **小巧高效**：cJSON库设计简洁，占用内存小，解析速度快，...
cJSON详细剖析（九）----create_objects()/cJSON_AddItemToObject（）函数
热门推荐
qq_40963043的博客
09-20 1万+
这里我们针对test.c里面的create_objects()函数进行向下解析。 如上图框住的部分，我们就此来分析cJSON_AddItemToObject（）函数。根据参数我们先分析cJSON_CreateString（）函数。 cJSON_CreateString（） 此函数在cJSON里面用了一行，为了更好的阅读，我把它按照正常的形式展开了。这段代码很简单，就是新建一个item的c...
cjson构建_使用cJSON库解析和构建JSON字符串
weixin_39924584的博客
12-20 369
使用cJSON库解析和构建JSON字符串前言其实之前的两篇博文已经介绍了json格式和如何使用cJSON库来解析JSON：当时在MCU平台上使用时，会出现时间长了死机的情况，在调用cJSON_Print输出格式化后的JSON数据之后，LOG("JSON数据:\n%s\n", cJSON_Print(root));要使用cJSON_Delete释放内存，否则会导致内存泄漏。cJSON_Delete(...
cJSON_AddItemToObject、cJSON_Delete、JSON打印的理解
weixin_61470035的博客
11-08 557
当我们把JSON项（Item）添加到JSON对象（Object）中可以直接用cJSON_AddItemToObject（），也可以用下列的函数，下列函数本质是对cJSON_Createxxx()与cJSON_AddItemToObject（）的二次封装。）分为NULL、布尔类型、数字、字符串、数组、）由花括号{}、键值对、逗号组成；
c语言解析json数据
buluzhai的专栏
12-17 364
我使用的是cJSON:[url]http://sourceforge.net/projects/cjson/[/url] 先看json的数据结构 c中没有对象，所以json数据是采用链表存储的 [code="c"] typedef struct cJSON { struct cJSON *next,*prev; // 数组 对象数据中用到 struct cJSON *child...
cJSON解析未知数据类型的json串
qq_42548880的博客
09-08 901
cJSON解析未知数据类型的json串废话少说上代码编译命令需要两个依赖文件一个是cJSON.h 一个是cJSON.c 代码，只需要复制到自己的终端创建一下就好了 废话少说上代码 #include <stdio.h> #include <stdlib.h> #include "cJSON.h" static const char *message = "{\ \"aStr\": \"aaaaaaa\", \ \"aStr\": \"aaaaaaa\", \ \"sAr
c语言-json开源库cJSON的使用
weixin_46158019的博客
10-25 2256
一、cJSON的介绍 cJSON是一个开源的JSON解析器，用于解析JSON数据。它是由纯C语言实现，因此跨平台性好，移植简单。下载地址：https://github.com/DaveGamble/cJSON.git https://gitee.com/du-yueqiang/cJSON?_from=gitee_search二、移植方法 cJSON只有一个cjson.c和cjson.h...
使用cJSON库解析和构建JSON字符串
whik1194的博客
07-21 800
使用cJSON库解析和构建JSON字符串 前言 其实之前的两篇博文已经介绍了json格式和如何使用cJSON库来解析JSON： 使用cJSON库解析JSON JSON简介 当时在MCU平台上使用时，会出现时间长了死机的情况，在调用cJSON_Print输出格式化后的JSON数据之后， LOG("JSON数据:\n%s\n", cJSON_Print(root)); 要使用cJSON...
cJson系列——常用cJson库函数
最新发布
qq_39642740的博客
12-26 2686
这里列出常见的Cjson函数函数名作用创建一个空的 JSON 对象创建一个空的 JSON 数组向 JSON 对象中添加字符串类型数据向 JSON 对象中添加数字类型数据获取 JSON 对象中的某个键值将 JSON 对象转换为字符串解析 JSON 字符串，返回 JSON 对象删除 JSON 对象及其包含的所有数据向 JSON 对象添加一个项判断项是否为字符串类型。
C语言 | cJSON的使用详解
嵌入式大杂烩
08-30 5985
前言上周一位小读者问了JSON相关的内容，答应了他会写一篇相关的笔记。JSON(JavaScript Object Notation)是一种轻量级的数据交换格式。JSON在互联网相关开发...
Cjson源码封装拓展教程：简化JSON处理
资源摘要信息: "该压缩包包含了一个名为 'json.zip' 的文件，解压后包含与'Cjson源码封装拓展_JSON_cjson_json封装'相关的内容。Cjson 是一个小型的 JSON 解析库，适用于嵌入式系统，因其代码量小和执行效率高而被...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值