cJSON的使用

文章目录

• 一、CJSON初识
• 二、CJSON解析器基础
• 三、CJSON解析数据
• • JSON解析基础
  • CJSON解析数组数据
  • CJSON解析嵌套数据
• 五、创建JSON数据

一、CJSON初识

JSON (JavaScript Object Notation)是一种轻量级的数据交换格式，常用于在网络之间传输数据。它是一种文本格式，易于人阅读和编写，同时也易于机器解析和生成。JSON基于JavaScript语言的一部分，但已经成为独立于编程语言的通用数据格式。

以下是JSON的几个常见用途：

1.数据交换: JSON是一种广泛使用的数据交换格式，它可以在客户端和服务器之间传输各种类型的数据结构，例如配置信息、日志、用户数据等。

2.Web应用程序: JSON作为JavaScript的一种数据格式，广泛应用于Web应用程序的前端设计。JavaScript的Ajax请求通常会使用JSON来与后端进行通信。

3.NoSQL数据库: NoSQL数据库，如MongoDB、CouchDB等，通常使用JSON格式存储数据。这些数据库支持JSON数据类型，使得存储和查询JSON数据非常方便。

4.配置文件:JSON格式非常易于阅读和编写，因此可以用作应用程序的配置文件。由于JSON具有层级因此可以将复杂配置文件分解为易于管理的部分。

5.移动应用程序: JSON用于移动应用程序通常涉及与Web API的交互，读取和保存本地数据和共享数据

JSON在Web开发中得到广泛应用，特别是在前后端数据交互方面。许多APl(Application Programming Interface)以SON格式返回数据，因为它易于解析和生成，同时具有良好的可读性。前端框架（如React、Angular、vue)通常使用)SON格式来处理数据.
JSON的简洁性和通用性使其成为一种理想的数据交换格式，不仅在Web开发中使用广泛，而且在各种应用程序和领域中都有着重要的作用。

源码下载：

github：https://github.com/DaveGamble/cJSON/releases

gitee：https://gitee.com/mirrors/cJSON

二、CJSON解析器基础

1.对象(Object):用花括号表示，包含一组无序的键值对。每个键值对之间用逗号分隔。

{
    "key1":"value1",
    "key2":"value2",
    "key3":"value3"
}

⒉.数组(Array):用方括号[表示，包含一组有序的值。每个值之间用逗号分隔。

{
    "arraykey":[1,2,3,4]
}

3.值(value):可以是字符串、数字、布尔值、对象、数组、null等。

{
    "stringKey": "Hello, JSON",
    "numberKey": 42,
    "booleanKey": true,
    "nullKey": null
}

4.字符串(String):由双引号括起来的Unicode字符序列。

{
    "name": "John Doe",
    "city" : "New York"
}

5.数字(Number) :可以是整数或浮点数。

{
    "integer": 42,
    "flaot": 3.14
}

6.布尔值(Boolean) :表示真或假。

{
    "isTrue": true,
    "isFalse": false
}

7.null：表示空值

{
    "emptyValue": null
}

//基本流程与相关API
//1.创建cJsoN指针
cJSON json=NULL;
//2.解析整段JsON数据,返回cJsoN指针
(cJSON*) cJSON_Parse (const char *value) ;
//3.根据键值对的名称从链表中取出对应的值，返回该键值对的地址
(cJSON*) cJsON_GetObjectItem(const cJSON * const object，const char * const string);
//4.根据类型提取相关值
//5.释放
void cJSON_Delete(cJSON* item) ;

cJSON结构：

type:

三、CJSON解析数据

JSON解析基础

int main()
{
    const char* json_data = {"{\"name:lihua\",\"age\":18}"};
    cJSON* json = NULL;
    json = cJSON_Parse(json_data);
    if(json == NULL)
    {
        printf("error:%s",cJSON_ErrorPtr());
    }
    else
    {
        cJSON* json_name = cJSON_GetObjectItem(json,"name");
        //if(json_name->type == cJSON_String)
        //{
        //    printf("%s\n",json_name->valuestring);
        //}
        if(cJSON_IsString(json_name))
        {
            printf("%s\n",json_name->valuestring);
        }
        cJSON* json_age = cJSON_GetObjectItem(json,"age");
        //if(json_name->type == cJSON_Number)
        //{
        //    printf("%d\n",json_name->valueint);
        //}
        if(cJSON_IsNumber(json_age))
        {
            printf("%d\n",json_name->valueint);
        }
        cJSON_Delete(json);
    }
    return 0;
}

CJSON解析数组数据

cJSON解析数组：

//基本流程与相关API
//1.创建cJsON指针
cJSON json=NULL;
//2.解析整段JsON数据,返回cJsoN指针
(cJSON*) cJSON_Parse (const char *value) ;
//3.根据键值对的名称从链表中取出对应的值，返回该键值对的地址
(cJSON *) cJSON_GetObjectItem(const cJSON * const object，const char * const string);
//4.读取数组
//先获取大小
(int) cJSON_GetArraySize(const cJSON* array);
//再序号读取
(cJSON*) cJSON_GetArrayItem(const cJSON* array,int index);
//5.释放
void cJSON_Delete(cJSON* item);

案例：

void testArray()
{
    const char* json_data = "[1,2,3,4,5,6,]";
    cJSON* root = cJSON_Parse(json_data);
    if(root == NULL)
    {
        printf("%s\n",cJSON_ErrorPtr());
        return;
    }
    if(cJSON_IsArray(root))
    {
        int array_size = cJSON_GetArraySize(root);
        for(int i = 0;i < array_size;i++)
        {
            cJSON* item = cJSON_GetArrayItem(root,i);
            if(cJSON_IsNumber(item))
            {
                int value = item->valueint;
                printf("%d ",value);
            }
            printf("%\n");
        }
    }
    cJSON_Delete(root);
}

// 读取带键的二维数组
void testArray2D()
{
    const char* json_data = "{\"array\":[[1,2,3],[4,5,6],[7,8,9]]}";
    cJSON* root = cJSON_Parse(json_data);
    cJSON* array = cJSON_GetObjectItem(root,"array");
    int rows = cJSON_GetArraySize(array);
    for(int i = 0;i < rows;i++)
    {
        cJSON* rowJSON = cJSON_GetArrayItem(array,i);
        int cols = cJSON_GetArraySize(rowJSON);
        for(int j = 0;j < cols;j++)
        {
            int value = cJSON_GetArrayItem(array,j)->valueint;
            printf("%d ",value);
        }
        printf("\n");
    }
    cJSON_Delete(root);
}
int main()
{
    return 0;
}

CJSON解析嵌套数据

// 读取想要读取的数据
void test_by_oneself()
{
    const char* json_data = "{\"name\":\"lihua\",\"age\":18,\"address\":{\"city\":\"chongqing\",\"phone\":[\"123456\",\"78910\"]}}";
    cJSON* root = cJSON_Parse(json_data);
    if(root == NULL)
    {
        printf("%s\n",cJSON_ErrorPtr());
        return;
    }
    cJSON* address = cJSON_GetObjectItem(root,"address");
    cJSON* city = cJSON_GetObjectItem(address,"city");
    if(cJSON_IsString(city))
    {
        printf("%s\n",city->valuestring);
    }
    cJSON_Delete(root);
}

递归的方式：

void read_json(cJSON* root)
{
    if(root == NULL)
    {
        return;
    }
    switch(root->type)
    {
        case cJSON_Object:
        {
            cJSON* child = root->child;
            if(child)
            {
                read_json(child);
                child = child->next;
            }
        }
            break;
        case cJSON_Array:
        {
			int array_size = cJSON_GetArraySize(root);
            for(int i = 0;i < array_size;i++)
            {
                cJSON* item = cJSON_GetArrayItem(root,i);
                printf("%s\n",root->string);
                read_json(item);
            }
        }
            break;
        case cJSON_String:
            printf("%s : %s\n",root->string,root->valuestring);
            break;
        case cJSON_Number:
            if(root->valueint - root->valuedouble == 0)
            {
                printf("%s : %d\n",root->string,root->valueint);
            }
            else
            {
                printf("%s : %lf",root->string,root->valuedouble);
            }
            break;
        case cJSON_True:
            printf("true\n");
            break;
        case cJSON_False:
            printf("false\n");
            break;
        case cJSON_NULL:
            printf("NULL\n");
            break;
        default:
            break;
    }
}

// 递归方式
void test_read_json()
{
    const char* json_data = "{\"name\":\"lihua\",\"age\":18,\"address\":{\"city\":\"chongqing\",\"phone\":[\"123456\",\"78910\"]}}";
    cJSON* root = cJSON_Parse(json_data);
    if(root == NULL)
    {
        printf("%s\n",cJSON_ErrorPtr());
        return;
    }
    read_json(root);
    cJSON_Delete(root);
}

五、创建JSON数据

创建空的JSON对象：

cJSON* cJSON_CreateObject();

添加基本内容：

cJSON_AddNumberToObject(cJSON * const object, const char * const name, const double number)
cJSON_AddStringToObject(cJSON * const object, const char * const name, const double number)

添加嵌套:

cJSON_AddItemToObject(cJSON *object, const char *string, cJSON*item)

添加数组:

cJSON_AddItemToArray(cJSON *array, cJSON *item)

打印JSON:

cJSON_Print(const cJSON*item)

案例：

#include <stdio.h>
#include <stdlib.h>
#include <time.h>
#include "cJSON.h" 
int main()
{
    srand(time(NULL));
    cJSON* root = cJSON_CreateObject();
    // 添加基本内容
    cJSON_AddStringToObject(root,"name","lihua");
    cJSON_AddNumberToObject(root,"age",18);
    
    // 添加嵌套
    cJSON* address = cJSON_CreateObject();
    cJson_AddStringToObject(address,"city","chongqing");
    cJSON_AddItemToObject(root,"address",address);
    
    // 添加数组
    cJSON* score = cJSON_CreateArray();
    for(int i = 0;i < 5;i++)
    {
        cJSON_AddItemToArray(score,cJSON_CreateNumber(rand() % 10 + 90));
    }
    cJSON_AddItemToObject(root,"score",score);
    printf("%s\n",cJSON_Print(root));
    cJSON_Delete(root);
    return 0;
}