JSON简介及具体的JSON消息示例

简介: 在互联网软件前端与后台进行消息交互的过程中,需要有一种标准的数据交换格式供前后端采用。在众多的数据交换格式中,JSON(JavaScript Object Notation,JS 对象标记)是应用得比较广泛的,它采用完全独立于编程语言的文本格式来存储和表示数据。

在互联网软件前端与后台进行消息交互的过程中,需要有一种标准的数据交换格式供前后端采用。在众多的数据交换格式中,JSON(JavaScript Object Notation,JS 对象标记)是应用得比较广泛的,它采用完全独立于编程语言的文本格式来存储和表示数据。JSON的层次结构简洁、清晰,易于阅读和编写,同时也易于机器解析和生成,这有效地提升了网络传输效率。

本文首先对JSON进行简单的介绍,然后用具体的C代码示范了各类JSON消息的构造方法。

JSON简介
JSON 的语法规则可以用下面的四句话来概括:
第一,对象表示为键值对。
第二,数据由逗号分隔。
第三,花括号保存对象。
第四,方括号保存数组。

具体而言,每条JSON消息都是包裹在大括号之内的,键值对组合中的键名写在前面并用双引号包裹,键和值使用冒号分隔,冒号后面紧接着值,如:”name”: “zhou”;数组是用方括号包裹起来的,如:[“zhou”, “zhang”]。

JSON消息示例
本部分用实际的C代码来示范了各类常用的JSON消息的构造方法。在编写代码之前,要到https://sourceforge.net/projects/cjson/上去下载C语言版的JSON封装API。

在JSON的API中,我们常用到的有如下几个函数:

1)cJSON_CreateObject():创建JSON对象。
2)cJSON_Delete(cJSON *c):删除一个JSON结构。
3)cJSON_AddStringToObject(object,name,s):将一个字符串添加到对象中。
4)cJSON_AddNumberToObject(object,name,n):将一个整数添加到对象中。
5)cJSON_Print(cJSON *item):将JSON消息以文本消息的样式输出。
6)cJSON_AddItemToObject(cJSON *object,const char *string,cJSON *item):将一个数据(通常为对象)添加到一个对象中。
7)cJSON_CreateString(const char *string):生成字符串数据。
8)cJSON_AddItemToArray(cJSON *array, cJSON *item):将一个数据添加到一个数组中。
9)cJSON_CreateArray():创建JSON数组。

下面,我们开始编写C代码来生成JSON消息。
1.如果要实现如下JSON消息:

{
    name:"zhou",
    age:30
}

则编写C代码函数如下:

int MakeJsonNameAge(char *pszJsonContent, int iJsonLen)
{
    cJSON *root = NULL;
    char  *out  = NULL;

    // 判断函数参数是否合法
    if (pszJsonContent == NULL)
    {
        printf("MakeJsonNameAge: pszJsonContent is NULL!");

        return -1;
    }

    root = cJSON_CreateObject();
    if(NULL == root)
    {
        printf("MakeJsonNameAge: exec cJSON_CreateObject to get root failed!");

        return -1;
    }

    cJSON_AddStringToObject(root, "name", "zhou");

    cJSON_AddNumberToObject(root, "age", 30);

    out=cJSON_Print(root);
    strncpy(pszJsonContent, out, iJsonLen - 1);
    pszJsonContent[iJsonLen - 1] = '\0';

    cJSON_Delete(root);
    free(out);

    return 0;
}

2.如果要实现如下JSON消息:

{
    personinfo:{
        name:"zhou",
        age:30
    }
}

则编写C代码函数如下:

int MakeJsonPersonInfo(char *pszJsonContent, int iJsonLen)
{
    cJSON *root        = NULL;
    cJSON *JsonLevel1  = NULL;
    char  *out         = NULL;

    // 判断函数参数是否合法
    if (pszJsonContent == NULL)
    {
        printf("MakeJsonPersonInfo: pszJsonContent is NULL!");

        return -1;
    }

    root = cJSON_CreateObject();
    if(NULL == root)
    {
        printf("MakeJsonPersonInfo: exec cJSON_CreateObject to get root failed!");

        return -1;
    }

    JsonLevel1 = cJSON_CreateObject();
    if(NULL == JsonLevel1)
    {
        printf("MakeJsonPersonInfo: exec cJSON_CreateObject to get JsonLevel1 failed!");

        cJSON_Delete(root);
        return -1;
    }   

    cJSON_AddStringToObject(JsonLevel1, "name", "zhou");

    cJSON_AddNumberToObject(JsonLevel1, "age", 30);

    cJSON_AddItemToObject(root, "personinfo", JsonLevel1);

    out=cJSON_Print(root);
    strncpy(pszJsonContent, out, iJsonLen - 1);
    pszJsonContent[iJsonLen - 1] = '\0';

    cJSON_Delete(root);
    free(out);

    return 0;
}

3.如果要实现如下JSON消息:

{
    personinfo1:{
        name:"zhou",
        age:30
    },
    personinfo2:{
        name:"zhang",
        age:41
    }
}

则编写C代码函数如下:

int MakeJsonTwoPersonInfo(char *pszJsonContent, int iJsonLen)
{
    cJSON *root        = NULL;
    cJSON *JsonLevel1  = NULL;
    char  *out         = NULL;

    // 判断函数参数是否合法
    if (pszJsonContent == NULL)
    {
        printf("MakeJsonTwoPersonInfo: pszJsonContent is NULL!");

        return -1;
    }

    root = cJSON_CreateObject();
    if(NULL == root)
    {
        printf("MakeJsonTwoPersonInfo: exec cJSON_CreateObject to get root failed!");

        return -1;
    }

    //---------------
    JsonLevel1 = cJSON_CreateObject();
    if(NULL == JsonLevel1)
    {
        printf("MakeJsonTwoPersonInfo: exec cJSON_CreateObject to get JsonLevel1 failed 1!");

        cJSON_Delete(root);
        return -1;
    }   

    cJSON_AddStringToObject(JsonLevel1, "name", "zhou");

    cJSON_AddNumberToObject(JsonLevel1, "age", 30);

    cJSON_AddItemToObject(root, "personinfo1", JsonLevel1);

    //---------------
    JsonLevel1 = cJSON_CreateObject();
    if(NULL == JsonLevel1)
    {
        printf("MakeJsonTwoPersonInfo: exec cJSON_CreateObject to get JsonLevel1 failed 2!");

        cJSON_Delete(root);
        return -1;
    }   

    cJSON_AddStringToObject(JsonLevel1, "name", "zhang");

    cJSON_AddNumberToObject(JsonLevel1, "age", 40);

    cJSON_AddItemToObject(root, "personinfo2", JsonLevel1);

    out=cJSON_Print(root);
    strncpy(pszJsonContent, out, iJsonLen - 1);
    pszJsonContent[iJsonLen - 1] = '\0';

    cJSON_Delete(root);
    free(out);

    return 0;
}

4.如果要实现如下JSON消息:

{
    id:"123456",
    personinfo:{
        name:"zhou",
        age:30
    }
}

则编写C代码函数如下:

int MakeJsonIDPersonInfo(char *pszJsonContent, int iJsonLen)
{
    cJSON *root        = NULL;
    cJSON *JsonLevel1  = NULL;
    char  *out         = NULL;

    // 判断函数参数是否合法
    if (pszJsonContent == NULL)
    {
        printf("MakeJsonIDPersonInfo: pszJsonContent is NULL!");

        return -1;
    }

    root = cJSON_CreateObject();
    if(NULL == root)
    {
        printf("MakeJsonIDPersonInfo: exec cJSON_CreateObject to get root failed!");

        return -1;
    }

    cJSON_AddStringToObject(root, "id", "123456");

    JsonLevel1 = cJSON_CreateObject();
    if(NULL == JsonLevel1)
    {
        printf("MakeJsonIDPersonInfo: exec cJSON_CreateObject to get JsonLevel1 failed!");

        cJSON_Delete(root);
        return -1;
    }   

    cJSON_AddStringToObject(JsonLevel1, "name", "zhou");

    cJSON_AddNumberToObject(JsonLevel1, "age", 30);

    cJSON_AddItemToObject(root, "personinfo", JsonLevel1);

    out=cJSON_Print(root);
    strncpy(pszJsonContent, out, iJsonLen - 1);
    pszJsonContent[iJsonLen - 1] = '\0';

    cJSON_Delete(root);
    free(out);

    return 0;
}

5.如果要实现如下JSON消息:

{
    personname:[
        "zhou",
        "zhang"
    ]
}

则编写C代码函数如下:

int MakeJsonPersonNameInfo(char *pszJsonContent, int iJsonLen)
{
    cJSON *root        = NULL;
    cJSON *JsonLevel1  = NULL;
    cJSON *JsonLevel2  = NULL;
    char  *out         = NULL;

    // 判断函数参数是否合法
    if (pszJsonContent == NULL)
    {
        printf("MakeJsonPersonNameInfo: pszJsonContent is NULL!");

        return -1;
    }

    root = cJSON_CreateObject();
    if (NULL == root)
    {
        printf("MakeJsonPersonNameInfo: exec cJSON_CreateObject to get root failed!");

        return -1;
    }

    JsonLevel1 = cJSON_CreateArray();
    if (NULL == JsonLevel1)
    {
        printf("MakeJsonPersonNameInfo: exec cJSON_CreateArray to get JsonLevel1 failed!");

        cJSON_Delete(root);
        return -1;
    }

    cJSON_AddItemToObject(root, "personname", JsonLevel1);

    JsonLevel2 = cJSON_CreateString("zhou");
    cJSON_AddItemToArray(JsonLevel1, JsonLevel2);

    JsonLevel2 = cJSON_CreateString("zhang");
    cJSON_AddItemToArray(JsonLevel1, JsonLevel2);

    out=cJSON_Print(root);
    strncpy(pszJsonContent, out, iJsonLen - 1);
    pszJsonContent[iJsonLen - 1] = '\0';

    cJSON_Delete(root);
    free(out);

    return 0;
}

6.如果要实现如下JSON消息:

{
    id:"123456",
    personname:[
        "zhou",
        "zhang"
    ],
    personinfo:{
        phonenumber:"15696192591",
        age:30
    }
}

则编写C代码函数如下:

int MakeJsonIDPersonNameInfo(char *pszJsonContent, int iJsonLen)
{
    cJSON *root        = NULL;
    cJSON *JsonLevel1  = NULL;
    cJSON *JsonLevel2  = NULL;
    char  *out         = NULL;

    // 判断函数参数是否合法
    if (pszJsonContent == NULL)
    {
        printf("MakeJsonIDPersonNameInfo: pszJsonContent is NULL!");

        return -1;
    }

    root = cJSON_CreateObject();
    if (NULL == root)
    {
        printf("MakeJsonIDPersonNameInfo: exec cJSON_CreateObject to get root failed!");

        return -1;
    }

    cJSON_AddStringToObject(root, "id", "123456");

    JsonLevel1 = cJSON_CreateArray();
    if (NULL == JsonLevel1)
    {
        printf("MakeJsonIDPersonNameInfo: exec cJSON_CreateArray to get JsonLevel1 failed 1!");

        cJSON_Delete(root);
        return -1;
    }

    cJSON_AddItemToObject(root, "personname", JsonLevel1);

    JsonLevel2 = cJSON_CreateString("zhou");
    cJSON_AddItemToArray(JsonLevel1, JsonLevel2);

    JsonLevel2 = cJSON_CreateString("zhang");
    cJSON_AddItemToArray(JsonLevel1, JsonLevel2);

    //-----------------
    JsonLevel1 = cJSON_CreateObject();
    if(NULL == JsonLevel1)
    {
        printf("MakeJsonIDPersonNameInfo: exec cJSON_CreateObject to get JsonLevel1 failed 2!");

        cJSON_Delete(root);
        return -1;
    }   

    cJSON_AddStringToObject(JsonLevel1, "name", "zhou");

    cJSON_AddNumberToObject(JsonLevel1, "age", 30);

    cJSON_AddItemToObject(root, "personinfo", JsonLevel1);

    out=cJSON_Print(root);
    strncpy(pszJsonContent, out, iJsonLen - 1);
    pszJsonContent[iJsonLen - 1] = '\0';

    cJSON_Delete(root);
    free(out);

    return 0;
}

7.如果要实现如下JSON消息:

{
    personinfo:{
        personname:[
        "zhou",
        "zhang"
        ],
        age:30
    }
}

则编写C代码函数如下:

int MakeJsonAgePersonNameInfo(char *pszJsonContent, int iJsonLen)
{
    cJSON *root        = NULL;
    cJSON *JsonLevel1  = NULL;
    cJSON *JsonLevel2  = NULL;
    cJSON *JsonLevel3  = NULL;
    char  *out         = NULL;

    // 判断函数参数是否合法
    if (pszJsonContent == NULL)
    {
        printf("MakeJsonAgePersonNameInfo: pszJsonContent is NULL!");

        return -1;
    }

    root = cJSON_CreateObject();
    if (NULL == root)
    {
        printf("MakeJsonAgePersonNameInfo: exec cJSON_CreateObject to get root failed!");

        return -1;
    }

    JsonLevel1 = cJSON_CreateObject();
    if(NULL == JsonLevel1)
    {
        printf("MakeJsonAgePersonNameInfo: exec cJSON_CreateObject to get JsonLevel1 failed!");

        cJSON_Delete(root);
        return -1;
    }   

    cJSON_AddItemToObject(root, "personinfo", JsonLevel1);

    //------------------
    JsonLevel2 = cJSON_CreateArray();
    if (NULL == JsonLevel2)
    {
        printf("MakeJsonAgePersonNameInfo: exec cJSON_CreateArray to get JsonLevel2 failed!");

        cJSON_Delete(root);
        return -1;
    }

    cJSON_AddItemToObject(JsonLevel1, "personname", JsonLevel2);

    JsonLevel3 = cJSON_CreateString("zhou");
    cJSON_AddItemToArray(JsonLevel2, JsonLevel3);

    JsonLevel3 = cJSON_CreateString("zhang");
    cJSON_AddItemToArray(JsonLevel2, JsonLevel3);

    //------------------
    cJSON_AddNumberToObject(JsonLevel1, "age", 30);


    out=cJSON_Print(root);
    strncpy(pszJsonContent, out, iJsonLen - 1);
    pszJsonContent[iJsonLen - 1] = '\0';

    cJSON_Delete(root);
    free(out);

    return 0;
}

8.如果要实现如下JSON消息:

{
    personinfo:[
    {
        name:"zhou",
        age:30
    },
    {
        name:"zhang",
        age:41
    }
    ]
}

则编写C代码函数如下:

int MakeJsonPersonsInfo(char *pszJsonContent, int iJsonLen)
{
    cJSON *root        = NULL;
    cJSON *JsonLevel1  = NULL;
    cJSON *JsonLevel2  = NULL;
    char  *out         = NULL;

    // 判断函数参数是否合法
    if (pszJsonContent == NULL)
    {
        printf("MakeJsonPersonsInfo: pszJsonContent is NULL!");

        return -1;
    }

    root = cJSON_CreateObject();
    if (NULL == root)
    {
        printf("MakeJsonPersonsInfo: exec cJSON_CreateObject to get root failed!");

        return -1;
    }

    JsonLevel1 = cJSON_CreateArray();
    if (NULL == JsonLevel1)
    {
        printf("MakeJsonPersonsInfo: exec cJSON_CreateArray to get JsonLevel1 failed!");

        cJSON_Delete(root);
        return -1;
    }

    cJSON_AddItemToObject(root, "personinfo", JsonLevel1);

    //---------------
    JsonLevel2 = cJSON_CreateObject();
    if(NULL == JsonLevel2)
    {
        printf("MakeJsonPersonsInfo: exec cJSON_CreateObject to get JsonLevel2 failed 1!");

        cJSON_Delete(root);
        return -1;
    }   

    cJSON_AddItemToArray(JsonLevel1, JsonLevel2);

    cJSON_AddStringToObject(JsonLevel2, "name", "zhou");

    cJSON_AddNumberToObject(JsonLevel2, "age", 30);

    //---------------
    JsonLevel2 = cJSON_CreateObject();
    if(NULL == JsonLevel2)
    {
        printf("MakeJsonPersonsInfo: exec cJSON_CreateObject to get JsonLevel2 failed 2!");

        cJSON_Delete(root);
        return -1;
    }   

    cJSON_AddItemToArray(JsonLevel1, JsonLevel2);

    cJSON_AddStringToObject(JsonLevel2, "name", "zhang");

    cJSON_AddNumberToObject(JsonLevel2, "age", 41);     

    //---------------
    out=cJSON_Print(root);
    strncpy(pszJsonContent, out, iJsonLen - 1);
    pszJsonContent[iJsonLen - 1] = '\0';

    cJSON_Delete(root);
    free(out);

    return 0;
}

总结
以上是常见JSON消息的C代码实现方法,大家可以编写测试代码来看最终生成的JSON消息是否是我们描述的那样。我编写了一个完整的测试代码,放到了GitHub上,欢迎下载阅读:https://github.com/zhouzxi/TestJson。(本测试程序是运行在Linux上的,大家可以使用这个命令进行编译:gcc -g -o TestJson TestJson.c cJSON.c -pthread -lc -lm)

目录
相关文章
|
10月前
|
JSON JavaScript 前端开发
小白一眼就能懂的JSON简介与基本使用指南
小白一眼就能懂的JSON简介与基本使用指南
|
10月前
|
编解码 JavaScript 前端开发
TypeScript【第三方声明文件、自定义声明文件、tsconfig.json文件简介、tsconfig.json 文件结构与配置】(六)-全面详解(学习总结---从入门到深化)
TypeScript【第三方声明文件、自定义声明文件、tsconfig.json文件简介、tsconfig.json 文件结构与配置】(六)-全面详解(学习总结---从入门到深化)
444 0
|
2月前
|
JSON 前端开发 搜索推荐
关于商品详情 API 接口 JSON 格式返回数据解析的示例
本文介绍商品详情API接口返回的JSON数据解析。最外层为`product`对象,包含商品基本信息(如id、name、price)、分类信息(category)、图片(images)、属性(attributes)、用户评价(reviews)、库存(stock)和卖家信息(seller)。每个字段详细描述了商品的不同方面,帮助开发者准确提取和展示数据。具体结构和字段含义需结合实际业务需求和API文档理解。
|
9天前
|
JSON API 数据格式
淘宝商品评论数据API接口详解及JSON示例返回
淘宝商品评论数据API接口是淘宝开放平台提供的一项服务,旨在帮助开发者通过编程方式获取淘宝商品的评论数据。这些数据包括评论内容、评论时间、评论者信息、评分等,对于电商分析、用户行为研究、竞品分析等领域都具有极高的价值。
|
2月前
|
JSON 缓存 API
解析电商商品详情API接口系列,json数据示例参考
电商商品详情API接口是电商平台的重要组成部分,提供了商品的详细信息,支持用户进行商品浏览和购买决策。通过合理的API设计和优化,可以提升系统性能和用户体验。希望本文的解析和示例能够为开发者提供参考,帮助构建高效、可靠的电商系统。
51 12
|
4月前
|
JSON API 数据安全/隐私保护
拍立淘按图搜索API接口返回数据的JSON格式示例
拍立淘按图搜索API接口允许用户通过上传图片来搜索相似的商品,该接口返回的通常是一个JSON格式的响应,其中包含了与上传图片相似的商品信息。以下是一个基于淘宝平台的拍立淘按图搜索API接口返回数据的JSON格式示例,同时提供对其关键字段的解释
|
4月前
|
JSON API 数据格式
Amazon商品详情API,json数据格式示例参考
亚马逊商品详情API接口返回的JSON数据格式通常包含丰富的商品信息,以下是一个简化的JSON数据格式示例参考
|
4月前
|
JSON API 数据格式
店铺所有商品列表接口json数据格式示例(API接口)
当然,以下是一个示例的JSON数据格式,用于表示一个店铺所有商品列表的API接口响应
|
5月前
|
JSON API 数据安全/隐私保护
拍立淘按图搜索json数据格式示例(API接口)
拍立淘按图搜索API接口为电商平台和购物应用提供了强大的图像搜索功能,能够显著提升用户的购物体验和搜索效率。开发者可以根据自己的需求调用此接口,并处理返回的JSON格式数据来展示推荐商品
|
5月前
|
JSON API 数据格式
商品详情数据JSON格式示例参考(api接口)
JSON数据格式的商品详情数据通常包含商品的多个层级信息,以下是一个综合多个来源信息的JSON数据格式的商品详情数据示例参考: