cJSON源码分析2-接口

最新推荐文章于 2021-02-04 09:42:40 发布
最新推荐文章于 2021-02-04 09:42:40 发布
阅读量488 收藏 6
点赞数 2
分类专栏： C/C++
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/charles1e/article/details/100052898
版权

文章目录

类型判断

函数声明

//这一系列函数检查item的type是不是某一类型
CJSON_PUBLIC(cJSON_bool) cJSON_IsInvalid(const cJSON * const item);
CJSON_PUBLIC(cJSON_bool) cJSON_IsFalse(const cJSON * const item);
CJSON_PUBLIC(cJSON_bool) cJSON_IsTrue(const cJSON * const item);
CJSON_PUBLIC(cJSON_bool) cJSON_IsBool(const cJSON * const item);
CJSON_PUBLIC(cJSON_bool) cJSON_IsNull(const cJSON * const item);
CJSON_PUBLIC(cJSON_bool) cJSON_IsNumber(const cJSON * const item);
CJSON_PUBLIC(cJSON_bool) cJSON_IsString(const cJSON * const item);
CJSON_PUBLIC(cJSON_bool) cJSON_IsArray(const cJSON * const item);
CJSON_PUBLIC(cJSON_bool) cJSON_IsObject(const cJSON * const item);
CJSON_PUBLIC(cJSON_bool) cJSON_IsRaw(const cJSON * const item);

实现原理

取出cJSON节点，判断type是不是指定的type即可

创建

函数声明

//这一系列函数用于创建指定类型的cJSON item
CJSON_PUBLIC(cJSON *) cJSON_CreateNull(void);
CJSON_PUBLIC(cJSON *) cJSON_CreateTrue(void);
CJSON_PUBLIC(cJSON *) cJSON_CreateFalse(void);
CJSON_PUBLIC(cJSON *) cJSON_CreateBool(cJSON_bool boolean);
CJSON_PUBLIC(cJSON *) cJSON_CreateNumber(double num);
CJSON_PUBLIC(cJSON *) cJSON_CreateString(const char *string);
CJSON_PUBLIC(cJSON *) cJSON_CreateRaw(const char *raw);
CJSON_PUBLIC(cJSON *) cJSON_CreateArray(void);
CJSON_PUBLIC(cJSON *) cJSON_CreateObject(void);

//创建，引用到其他的元素，JSON删除时，不会释放。
CJSON_PUBLIC(cJSON *) cJSON_CreateStringReference(const char *string);
CJSON_PUBLIC(cJSON *) cJSON_CreateObjectReference(const cJSON *child);
CJSON_PUBLIC(cJSON *) cJSON_CreateArrayReference(const cJSON *child);

创建数组
CJSON_PUBLIC(cJSON *) cJSON_CreateIntArray(const int *numbers, int count);
CJSON_PUBLIC(cJSON *) cJSON_CreateFloatArray(const float *numbers, int count);
CJSON_PUBLIC(cJSON *) cJSON_CreateDoubleArray(const double *numbers, int count);
CJSON_PUBLIC(cJSON *) cJSON_CreateStringArray(const char **strings, int count);

具体分析

创建某一个类的节点过程大致类似。下面具体分析字符串类型的节点过程

//创建字符串的节点
CJSON_PUBLIC(cJSON *) cJSON_CreateString(const char *string)
{
    cJSON *item = cJSON_New_Item(&global_hooks); //1. 分配空间
    if(item)
    {
        item->type = cJSON_String; //2. 设置类型
        //3. 设置节点的值。这里要拷贝这个字符串
        item->valuestring = (char*)cJSON_strdup((const unsigned char*)string, &global_hooks);
        if(!item->valuestring)
        {
            cJSON_Delete(item);
            return NULL;
        }
    }
    //4. 创建成功，返回
    return item;
}

根据传入的数组，创建JSON数组节点，以int类型为例分析：

//创建int类型的数组
CJSON_PUBLIC(cJSON *) cJSON_CreateIntArray(const int *numbers, int count)
{
    size_t i = 0;
    cJSON *n = NULL;
    cJSON *p = NULL;
    cJSON *a = NULL;

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

    a = cJSON_CreateArray(); //1. 创建数组
    //所有的元素创建的item, 构成双向链表
    for(i = 0; a && (i < (size_t)count); i++) //2. 遍历传入的数字
    {
        n = cJSON_CreateNumber(numbers[i]); //2.1 创建对象
        if (!n)
        {
            cJSON_Delete(a);
            return NULL;
        }
        if(!i) //2.2 链接到数组上
        {
            a->child = n;
        }
        else
        {
            suffix_object(p, n); //2.2 把n放在p的后面, p->n
        }
        p = n;
    }
    //3. 成功，返回创建的数组
    return a; 
}

添加

函数接口

//添加元素到array
CJSON_PUBLIC(void) cJSON_AddItemToArray(cJSON *array, cJSON *item);
CJSON_PUBLIC(void) cJSON_AddItemToObject(cJSON *object, const char *string, cJSON *item);
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);

添加到数组

/* Add item to array/object. */
CJSON_PUBLIC(void) cJSON_AddItemToArray(cJSON *array, cJSON *item)
{
    add_item_to_array(array, item);
}

/*把item添加到array*/
static cJSON_bool add_item_to_array(cJSON *array, cJSON *item)
{
    cJSON *child = NULL;

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

    child = array->child; //1. 获取child

    if (child == NULL) //2.1 如果为空，说明数组没有元素，这个第一个元素，直接添加
    {
        /* list is empty, start new one */
        array->child = item;
    }
    else
    {
        //2.2.1 遍历到最后一个节点
        while (child->next)
        {
            child = child->next;
        }
        //2.2.2 添加到最后
        suffix_object(child, item);
    }

    return true;
}

添加到对象

CJSON_PUBLIC(void) cJSON_AddItemToObject(cJSON *object, const char *string, cJSON *item)
{
    add_item_to_object(object, string, item, &global_hooks, false);
}

/*
object:添加到的对象
string:添加的item的名字
item:添加的item
constant_key:是否为constant key
*/
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;
    }

    if (constant_key) //1.1 是否为constant key,如果是，type中要设置cJSON_StringIsConst
    {
        new_key = (char*)cast_away_const(string); //constant_key, 不用strdup
        new_type = item->type | cJSON_StringIsConst;
    }
    else //1.2 不是constant key,需要拷贝字符串
    {
        
        new_key = (char*)cJSON_strdup((const unsigned char*)string, hooks);
        if (new_key == NULL)
        {
            return false;
        }

        new_type = item->type & ~cJSON_StringIsConst;
    }
    //2. 如果不是const,并且已经存在string了，那么需要先释放
    if (!(item->type & cJSON_StringIsConst) && (item->string != NULL))
    {
        hooks->deallocate(item->string);
    }
    //3. 设置string和type
    item->string = new_key;
    item->type = new_type;
    //4. 添加到array
    return add_item_to_array(object, item);
}

删除

接口

/*移除一个节点*/
CJSON_PUBLIC(void) cJSON_DeleteItemFromArray(cJSON *array, int which);
CJSON_PUBLIC(cJSON *) cJSON_DetachItemFromObject(cJSON *object, const char *string);
CJSON_PUBLIC(cJSON *) cJSON_DetachItemFromObjectCaseSensitive(cJSON *object, const char *string);
CJSON_PUBLIC(void) cJSON_DeleteItemFromObject(cJSON *object, const char *string);
CJSON_PUBLIC(void) cJSON_DeleteItemFromObjectCaseSensitive(cJSON *object, const char *string);

具体分析

以移除数组中的元素为例

//移除which位置的节点，
CJSON_PUBLIC(void) cJSON_DeleteItemFromArray(cJSON *array, int which)
{
    cJSON_Delete(cJSON_DetachItemFromArray(array, which));
}

/*移除array上的第which个节点*/
CJSON_PUBLIC(cJSON *) cJSON_DetachItemFromArray(cJSON *array, int which)
{
    if (which < 0)
    {
        return NULL;
    }

    return cJSON_DetachItemViaPointer(array, get_array_item(array, (size_t)which));
}

/*
获取array中的第index个节点， 如果超出了index会返回NULL
*/
static cJSON* get_array_item(const cJSON *array, size_t index)
{
    cJSON *current_child = NULL;

    if (array == NULL)
    {
        return NULL;
    }

    current_child = array->child;
    while ((current_child != NULL) && (index > 0))
    {
        index--;
        current_child = current_child->next;
    }

    return current_child;
}

/*
把parent的子节点item移除，并返回item
*/
CJSON_PUBLIC(cJSON *) cJSON_DetachItemViaPointer(cJSON *parent, cJSON * const item)
{
    if ((parent == NULL) || (item == NULL))
    {
        return NULL;
    }

    if (item->prev != NULL)
    {
        /* not the first element */
        item->prev->next = item->next;
    }
    if (item->next != NULL)
    {
        /* not the last element */
        item->next->prev = item->prev;
    }

    if (item == parent->child)
    {
        /* first element */
        parent->child = item->next;
    }
    /* make sure the detached item doesn't point anywhere anymore */
    item->prev = NULL;
    item->next = NULL;

    return item;
}

获取

接口

//获取数组的大小
CJSON_PUBLIC(int) cJSON_GetArraySize(const cJSON *array);
/* Retrieve item number "index" from array "array". Returns NULL if unsuccessful. */
//获取第i个节点的元素
CJSON_PUBLIC(cJSON *) cJSON_GetArrayItem(const cJSON *array, int index);
/* Get item "string" from object. Case insensitive. */
//根据名字获取节点
CJSON_PUBLIC(cJSON *) cJSON_GetObjectItem(const cJSON * const object, const char * const string);
//根据名字获取节点，忽略大小写
CJSON_PUBLIC(cJSON *) cJSON_GetObjectItemCaseSensitive(const cJSON * const object, const char * const string);
//判断是否存在这个节点
CJSON_PUBLIC(cJSON_bool) cJSON_HasObjectItem(const cJSON *object, const char *string);

具体分析

//获取数组的大小
CJSON_PUBLIC(int) cJSON_GetArraySize(const cJSON *array)
{
    cJSON *child = NULL;
    size_t size = 0;

    if (array == NULL)
    {
        return 0;
    }

    child = array->child;
    //遍历每个元素
    while(child != NULL)
    {
        size++;
        child = child->next;
    }

    /* FIXME: Can overflow here. Cannot be fixed without breaking the API */

    return (int)size;
}

/*
获取array中的第index个节点， 如果超出了index会返回NULL
*/
static cJSON* get_array_item(const cJSON *array, size_t index)
{
    cJSON *current_child = NULL;

    if (array == NULL)
    {
        return NULL;
    }

    current_child = array->child;
    while ((current_child != NULL) && (index > 0))
    {
        index--;
        current_child = current_child->next;
    }

    return current_child;
}

CJSON_PUBLIC(cJSON *) cJSON_GetArrayItem(const cJSON *array, int index)
{
    if (index < 0)
    {
        return NULL;
    }

    return get_array_item(array, (size_t)index);
}
/*根据名字找到item*/
static cJSON *get_object_item(const cJSON * const object, const char * const name, const cJSON_bool case_sensitive)
{
    cJSON *current_element = NULL;

    if ((object == NULL) || (name == NULL))
    {
        return NULL;
    }

    current_element = object->child;
    if (case_sensitive)
    {
        while ((current_element != NULL) && (current_element->string != NULL) && (strcmp(name, current_element->string) != 0))
        {
            current_element = current_element->next;
        }
    }
    else
    {
        while ((current_element != NULL) && (case_insensitive_strcmp((const unsigned char*)name, (const unsigned char*)(current_element->string)) != 0))
        {
            current_element = current_element->next;
        }
    }

    if ((current_element == NULL) || (current_element->string == NULL)) {
        return NULL;
    }

    return current_element;
}

CJSON_PUBLIC(cJSON *) cJSON_GetObjectItem(const cJSON * const object, const char * const string)
{
    return get_object_item(object, string, false);
}
延禾xy
关注
  • 2
    点赞
  • 踩
  • 6
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
[源码分析]-轻量级JSON-cJson
second60的博客
06-12 1821
[源码分析]-轻量级JSON-cJsonsecond60 201806121. cJSON简介cJson是个轻量级的C语言JSON库，速度快，而且代码少，只有两个文件：cJSON.h和cJSON.c。代码只有七百多行。 使用只需引入cJSON文件，一起编译即可，使用了数学库，要添加-lm库g++ test.c cJSON.c -o testgcc test.c cJSON.c -o test -l...
cJSON源码 C语言库
08-07
Copyright (c) 2009-2017 Dave Gamble and cJSON contributors 使用说明见博客：...
cJSON源码分析
07-26 81
JSON (JavaScript Object Notation) 是一种常见使用的轻量级的数据交换格式，既有利于人工读写，也方便于机器的解析和生成。 关于JSON格式的定义，参看网站[1]。在该网站中，也提供了各类语言的几十个解析库。 cJSON是其中一个代码质量很好、可读性很高的编解码库，通过阅读其代码可以学习其代码风格。本来打算自己写一个源码分析的文章，不过在网上发现已有人捷足先登...
cJSON源码分析（一）
qq_44647223的博客
02-02 418
首先看下cJSON数据结构体（摘自源代码，注释的英文使用机器翻译） /* The cJSON structure: */ typedef struct cJSON { /* next/prev allow you to walk array/object chains. Alternatively, use GetArraySize/GetArrayItem/GetObjectItem 下一步/上一步允许您遍历数组/对象链。或者，使用GetArraySize/GetArrayItem/Ge
Cjson源码分析
weixin_34194551的博客
07-08 84
mark 转载于:https://www.cnblogs.com/bai-jimmy/p/5652714.html
Linux中cJSON源码+部分实例分析
最新发布
10-21
【Linux中的cJSON库解析】 cJSON是一个轻量级的JSON解析器和生成器，它在C语言中实现，适用于嵌入式系统和资源...通过源码分析，我们可以更好地理解JSON操作的底层机制，这对于优化和调试涉及JSON的C程序非常有帮助。
lua-cjson-2.1.0
06-17
**lua-cjson-2.1.0：Lua与JSON交互的核心工具** `lua-cjson`是Lua编程语言中一个高效且功能丰富的JSON（JavaScript Object Notation）解析和序列化库，版本2.1.0提供了稳定性和性能上的优化。这个库使得在Lua环境中...
Lua CJSON 源码
07-10
Lua CJSON 为 Lua 语言提供高性能的 JSON 解析器和编码器，其性能比纯 Lua 库要高 10 到 20 倍。Lua CJSON 完全支持 UTF-8 ，无需依赖其他非 Lua/LuaJIT 的相关包。
cJSON-master(包含完整的中文解析及例程)
03-08
而"cJSON-master"则可能是cJSON的源码库，其中包含了头文件、源代码和可能的示例程序。通过阅读源码和运行示例，你可以更深入地理解cJSON的工作原理和实现方式。 总的来说，cJSON是一个非常实用的C语言JSON处理工具...
对json源码全面分析,详细介绍json功能实现原理
06-01
对json源码全面分析,详细介绍json功能实现原理
cJSON代码，包含cJSON.c和cJSON.h
12-29
里面有详细的cJSON的.c和.h代码 可以参考我的博客链接https://blog.csdn.net/qq_25205045/article/details/85339759学习
cJSON 源码分析
fscanf_fread的博客
05-30 463
源码目录，根目录下有两个子文件夹，其中__MACOSX是提供给MAC OS操作系统的，其他系统看cJSON文件夹就行了 cJSONFiles __MACOSX cJSON 使用
cJSON 源码分析
zhubao124的博客
06-14 1121
JSON入门教程 JSON官方介绍 cJSON源码下载 一、cJSON概述 cJSON是一个非常轻量的C语言库，构建在ANSI C标准之上，用来解析JSON格式的数据。说其轻量是因为该库只包含了一个头文件和一个源文件，总的代码量不到一千行，源码可以在这里下载。本篇博客对cJSON库源码进行分析，旨在弄懂其实现原理和相关技术。我认为可以从以下三个问题入手： 1. 如何表示JSON数据 2. 如何生成JSON数据 3. 如何解析JSON数据 ...
cJSON源码分析（三）
qq_44647223的博客
02-04 358
在构建好一个JSON对象之后，如何访问呢？ 首先试着将json字符串序列化，并全部打印出来看下结构再说： char * string = "{\"name\":\"xxx\", \"name2\":\"xxx2\"}"; cJSON * root = cJSON_Parse(string);//json字符串序列化 printf("%s\n", cJSON_Print(root));//json格式化输出 看源码了解一下cJSON_Print函数大致实现过程吧（cJSON_Parse函数实现的源码可翻阅
cJson源代码解读
weixin_42887343的博客
12-27 684
cJson介绍 首先对于json最好的解释（含图解）：https://www.json.org/json-en.html cJson的源代码链接（github）：https://github.com/DaveGamble/cJSON cJson项目介绍（大致从README.md翻译而来）： cJSON旨在成为您可以完成工作的最愚蠢的解析器。它是C的单个文件，也是单个头文件。 使用： 因为整个库只有一个C文件和一个头文件，所以只需复制cJSON.h和cJSON.c文件到项目源并使用就行。cJSON用ANSI
cJSON源码分析（二）
qq_44647223的博客
02-03 316
在构建好一个JSON对象之后，如何访问呢？ 首先试着将json字符串序列化，并全部打印出来看下结构再说： char * string = "{\"name\":\"xxx\", \"name2\":\"xxx2\"}"; cJSON * root = cJSON_Parse(string);//json字符串序列化 printf("%s\n", cJSON_Print(root));//json格式化输出 看源码了解一下cJSON_Parse函数大致实现过程吧 //用来格式化json字符串所需要的缓存空
cJSON源码解析（超级详细！！！）
zhuikefeng的博客
06-26 4390
1.cJSON结构体定义 typedef struct cJSON { struct cJSON *next,*prev; /* next/prev allow you to walk array/object chains. Alternatively, use GetArraySize/GetArrayItem/GetObjectItem */ struct cJSON *child; /* An array or object item will have a child pointer p
cJSON
俗科技的博客
11-25 537
1.背景最近做一个流媒体服务器，需要通信同事推荐JSON，因此在网上搜索，最终cJSON以轻量(整个库只有cJSON.c和cJSON.h两个文件)，可移植性高。 2.前期准备2.1.cJSON描述 cJSON的目标是成为一个傻瓜式的语言解析器，使用C语言编写，只包括cJSON.c和cJSON.h两个文件。可以通过http://www.json.org/来了解JSON（http://www.jso

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值