說明:
基于 C 語言的 Json 庫 – cJson。cJSON 是一個超輕巧,攜帶友善,單檔案,簡單的可以作為 ANSI-C 标準的 JSON 解析器。
cJSON 是一個開源項目,github 下載下傳位址:
https://github.com/DaveGamble/cJSON
編譯指令:
mkdir build
cd build
cmake ..
make install如果需要,請安裝它。預設情況下,它将頭檔案/usr/local/include/cjson和庫安裝到/usr/local/lib
cJSON,目前來說,主要的檔案有兩個,一個 cJSON.c 一個 cJSON.h。使用的時候,将頭檔案 include 進去即可。
如果是在 Linux 作業系統中使用,編譯 到時候需要添加數學庫 libm.so
cJSON 結構體:
typedef struct cJSON {
struct cJSON *next,*prev;
struct cJSON *child;
int type;
char *valuestring; // value值是字元串類型
int valueint;
double valuedouble;
char *string; // 對象中的key
} cJSON;
資料結構說明如下:
- cJOSN 結構體是一個雙向連結清單,并且可通過 child 指針通路下一層。
- 結構體成員 type 變量用于描述資料元素的類型(如果是鍵值對表示 value 值的類型),資料元素可以是字元串可以是整形,也可以是浮點型。
- 如果是整形值的話可通過 valueint 将值取出
- 如果是浮點型的話可通過 valuedouble 将值取出
- 如果是字元串類型的話可通過 valuestring 将值取出
- 結構體成員 string 表示鍵值對中鍵值的名稱。
- cJSON 作為 Json 格式的解析庫,其主要功能就是建構和解析 Json 格式了,比如要發送資料:用途就是發送端将要發送的資料以 json 形式封裝,然後發送,接收端收到此資料後,還是按 json 形式解析,就得到想要的資料了。
cJson API
Json 格式的資料無外乎有兩種 Json對象和 Json數組,建立的 Json 資料串可能是二者中 的一種,也可能是二者的組合,不管哪一種通過調用相關的 API 函數都可以輕松的做到這一點。
主要使用函數
檢查元素類型
/* These functions check the type of an item */
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.h 頭檔案中可以看到一些函數聲明,通過調用這些建立函數就可以将 Json 支援的資料類型封裝為 cJSON 結構體類型:
// 空值類型
extern cJSON *cJSON_CreateNull(void);
// 布爾類型
extern cJSON *cJSON_CreateTrue(void);
extern cJSON *cJSON_CreateFalse(void);
extern cJSON *cJSON_CreateBool(int b);
// 數值類型
extern cJSON *cJSON_CreateNumber(double num);
// 字元串類型
extern cJSON *cJSON_CreateString(const char *string);
// json數組(建立空數組)
extern cJSON *cJSON_CreateArray(void);
// json對象(建立空對象)
extern cJSON *cJSON_CreateObject(void);
數組資料的封裝
// 建立一個Json數組, 元素為整形
extern cJSON *cJSON_CreateIntArray(const int *numbers,int count);
// 建立一個Json數組, 元素為浮點
extern cJSON *cJSON_CreateFloatArray(const float *numbers,int count);
extern cJSON *cJSON_CreateDoubleArray(const double *numbers,int count);
// 建立一個Json數組, 元素為字元串類型
extern cJSON *cJSON_CreateStringArray(const char **strings,int count);
Json 對象操作
當得到一個 Json 對象之後,就可以往對象中添加鍵值對了,可以使用 cJSON_AddItemToObject()
extern void cJSON_AddItemToObject(cJSON *object,const char *string,cJSON *item);
在 cJSON 庫中節點的從屬關系是通過樹來維護的,每一層節點都是通過連結清單來維護的,這樣就能分析出該函數參數的含義:
- object:要添加的鍵值對從屬于那個節點
- string:添加的鍵值對的鍵值
- item:添加的鍵值對的 value 值(需要先将其封裝為 cJSON 類型的結構體)
為了讓我的操作更加友善,cJson 庫還給我們提供了一些宏函數,友善我們快速的往 Json 對象中添加鍵值對
cJSON_AddItemToObject(object, name, cJSON_CreateNull())
cJSON_AddItemToObject(object, name, cJSON_CreateTrue())
cJSON_AddItemToObject(object, name, cJSON_CreateFalse())
cJSON_AddItemToObject(object, name, cJSON_CreateBool(b))
cJSON_AddItemToObject(object, name, cJSON_CreateNumber(n))
cJSON_AddItemToObject(object, name, cJSON_CreateString(s))
cJSON 格式化輸出
extern char *cJSON_Print(cJSON *item);
extern char *cJSON_PrintUnformatted(cJSON *item);
extern char *cJSON_PrintBuffered(cJSON *item,int prebuffer,int fmt);
- 調用 cJSON_Print() 函數我們可以得到一個帶格式的 Json 字元串(有換行,看起來更直覺)
- 調用 cJSON_PrintUnformatted() 函數會得到一個沒有格式的 Json 字元串(沒有換行,所有的資料都在同一行)。
-
調用 cJSON_PrintBuffered() 函數使用緩沖政策将 Json 實體轉換為字元串,參數 prebuffer
是指定緩沖區的大小,參數 fmt0 表示未格式化,fmt1 表示格式化。
Json 字元串的解析
如果我們得到了一個 Json 格式的字元串,想要讀出裡邊的資料,就需要對這個字元串進行解析,處理方式就是将字元串轉換為 cJSON 結構體,然後再基于這個結構體讀裡邊的原始資料,轉換函數的函數原型如下:
extern cJSON *cJSON_Parse(const char *value);
cJSON 記憶體釋放
當我們将資料封裝為 cJSON 結構類型的節點之後都會得到一塊堆記憶體,當我們釋放某個節點的時候可以調用 cJson 庫提供的删除函數 cJSON_Delete(),函數原型如下:
extern void cJSON_Delete(cJSON *c);
在進行記憶體位址釋放的時候,目前節點以及其子節點都會被删除。
Json 資料的封裝
#include<stdio.h>
#include<stdlib.h>
#include<string.h>
#include<cjson/cJSON.h>
int main()
{
cJSON * root;
cJSON *arry;
root=cJSON_CreateObject(); // 建立根資料對象
cJSON_AddStringToObject(root,"name","hou"); // 添加鍵值對
cJSON_AddStringToObject(root,"sex","女"); // 添加鍵值對
cJSON_AddNumberToObject(root,"age",24); // 添加鍵值對
char *out = cJSON_Print(root); // 将json形式轉換成字元串
printf("%s\n",out);
// 釋放記憶體
cJSON_Delete(root);
free(out);
}
運作結構:
{
"name": "hou",
"sex": "女",
"age": 24
}
- cJSON_CreateObject 函數可建立一個根對象,傳回的是一個 cJSON 指針,在這個指針用完了以後,需要手動調用cJSON_Delete(root) 進行記憶體回收。
- 函數 cJSON_Print() 内部封裝了 malloc 函數,是以需要使用 free() 函數釋放被 out 占用的記憶體空間。
Json 數組操作
建立一個數組,并向數組添加一個字元串和一個數字。
int main(int argc, char **argv)
{
cJSON *root;
root = cJSON_CreateArray();
cJSON_AddItemToArray(root, cJSON_CreateString("xian"));
cJSON_AddItemToArray(root, cJSON_CreateNumber(10));
// char *s = cJSON_Print(root);
char *s = cJSON_PrintUnformatted(root);
if(s)
{
printf(" %s \n",s);
free(s);
}
cJSON_Delete(root);
return 0;
}
運作結果:
["xian",10]
Json 對象、數組嵌套使用
int main(int argc, char **argv)
{
cJSON *root, *body, *list;
// josn 對象 root
root = cJSON_CreateObject();
// root 添加鍵值對 person:json數組A
cJSON_AddItemToObject(root,"person", body = cJSON_CreateArray());
// json數組A 添加Json對象B
cJSON_AddItemToArray(body, list = cJSON_CreateObject());
// 在json對象B中添加鍵值對: "name":"hou"
cJSON_AddStringToObject(list,"name","hou");
// 在json對象B中添加鍵值對: "age":24
cJSON_AddNumberToObject(list,"age",24);
// char *s = cJSON_Print(root);
char *s = cJSON_PrintUnformatted(root);
if(s)
{
printf(" %s \n",s);
free(s);
}
if(root)
{
cJSON_Delete(root);
}
return 0;
}
{
"person":[{
"name":"hou",
"age":24
}]
}
解析 Json 字元串
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include<cjson/cJSON.h>
int main()
{
cJSON *json, *name, *sex, *age;
char* out="{\"name\":\"hou\",\"sex\":\"man\",\"age\":24}";
json = cJSON_Parse(out); //解析成json形式
name = cJSON_GetObjectItem(json, "name"); //擷取鍵值内容
sex = cJSON_GetObjectItem(json, "sex");
age = cJSON_GetObjectItem(json, "age");
printf("name:%s,sex:%s,age:%d\n", name->valuestring, sex->valuestring, age->valueint);
cJSON_Delete(json); //釋放記憶體
}
解析嵌套的 Json 對象
int main()
{
char *s = "{\"list\":{\"name\":\"hou\",\"age\":24},\"other\":{\"name\":\"qiushi\"}}";
cJSON *root = cJSON_Parse(s);
if(!root)
{
printf("get root faild !\n");
return -1;
}
cJSON *js_list = cJSON_GetObjectItem(root, "list");
if(!js_list)
{
printf("no list!\n");
return -1;
}
printf("list type is %d\n",js_list->type);
cJSON *name = cJSON_GetObjectItem(js_list, "name");
if(!name)
{
printf("No name !\n");
return -1;
}
printf("name type is %d\n",name->type);
printf("name is %s\n",name->valuestring);
cJSON *age = cJSON_GetObjectItem(js_list, "age");
if(!age)
{
printf("no age!\n");
return -1;
}
printf("age type is %d\n", age->type);
printf("age is %d\n",age->valueint);
cJSON *js_other = cJSON_GetObjectItem(root, "other");
if(!js_other)
{
printf("no list!\n");
return -1;
}
printf("list type is %d\n",js_other->type);
cJSON *js_name = cJSON_GetObjectItem(js_other, "name");
if(!js_name)
{
printf("No name !\n");
return -1;
}
printf("name type is %d\n",js_name->type);
printf("name is %s\n",js_name->valuestring);
if(root)
{
cJSON_Delete(root);
}
return 0;
}
解析 Json 數組
int main(int argc, char **argv)
{
char *s = "{\"names\":[\"hou\",\"cai\"]}";
cJSON *root = cJSON_Parse(s);
if(!root)
{
printf("get root faild !\n");
return -1;
}
cJSON *js_list = cJSON_GetObjectItem(root, "names");
if(!js_list)
{
printf("no list!\n");
return -1;
}
int array_size = cJSON_GetArraySize(js_list);
printf("array size is %d\n",array_size);
for(int i=0; i< array_size; i++)
{
cJSON *item = cJSON_GetArrayItem(js_list, i);
printf("item type is %d\n",item->type);
printf("%s\n",item->valuestring);
}
if(root)
{
cJSON_Delete(root);
}
return 0;
}
解析嵌套的 Json 對象和數組
- 根節點是一個 Json 對象,基于根節點中的 key 值取出對應的 value 值,得到一個 Json 數組.
- 讀出 Json 數組的大小,周遊裡邊的各個元素,每個元素都是一個 Json 對象.
- 将 Json 對象中的鍵值對根據 key 值取出對應的 value 值.
- 從取出的 Value 值中讀出實際類型對應的數值.
#include "cJSON.h"
#include <stdio.h>
#include <stdlib.h>
int main(int argc, char **argv)
{
char *s = "{\"list\":[{\"name\":\"luffy\",\"age\":19},{\"name\":\"sabo\",\"age\":21}]}";
cJSON *root = cJSON_Parse(s);
if(!root)
{
printf("get root faild !\n");
return -1;
}
cJSON *list = cJSON_GetObjectItem(root, "list");
if(!list)
{
printf("no list!\n");
return -1;
}
int array_size = cJSON_GetArraySize(list);
printf("array size is %d\n",array_size);
for(int i=0; i< array_size; i++)
{
cJSON* item = cJSON_GetArrayItem(list, i);
cJSON* name = cJSON_GetObjectItem(item, "name");
printf("name is %s\n",name->valuestring);
cJSON* age = cJSON_GetObjectItem(item, "age");
printf("age is %d\n",age->valueint);
}
if(root)
{
cJSON_Delete(root);
}
return 0;
}