JSON格式解析和libjson使用簡介
JSON簡介：
JSON(JavaScript Object Notation) 是一種輕量級的數據交換格式，可以把JSON的結構理解成無序的、可嵌套的key-value鍵值對集合，這些key-value鍵值對是以結構體或數組的形式來組織的。同一級的key-value鍵值對之間是用一個“,”（逗號）隔開，每個key-value鍵值對是由一個key後面緊接一個“:”（冒號），冒號後面是這個key對應的value。Key是一個word，由大小寫字母、下劃線及數字組成，可以由雙引號封閉，也可以不加雙引號；而value的取值集爲：Number、Boolean(true或false)、null、String、Object及Array，如圖一：
1、Number：數值，包括整形數與浮點數，如：123、0.83、-2.7e10。其結構如圖二：
2、String：字符串，是以雙引號封閉起來的一串字符，使用反斜槓來轉義，如：\\、\n等，JSON中字符串的概念與C/C++或者JAVA語言裏的字符串概念差不多，如：”abc”。其結構如圖三：
3、Object：對象，也可理解成一個結構體，是以一對大括號封閉起來的無序的key-value鍵值對集合，例如：{name:"Susan", age:27, birthday:{year:1984, month:2, day:11}}；也可以寫成：{"name":"Susan", "age":27, "birthday":{"year":1984, "month":2, "day":11}}；其結構如圖四：
4、Array：數組，JSON的數組是一個以中括號封閉起來的value的集合，即數組內的各個成員的數據類型可以不一樣，這一點就跟C/JAVA的數組概念不同了。每個value之間是由一個“,”(逗號)隔開，例如：[123, abc, false, {name:mj}]；其結構如圖五：
關於JSON的詳細說明與教程請自行到網絡上搜索，有很多。
下面我們就來動手寫一個例子：
{
result:true,
root:{
version:"201007091640",
channels:[
{
name:"新聞中心",
subchnls:[
{
title:"焦點新聞",
link:"http://news.mtc.sohu.com/news/channel/1/news.rss",
desc:"家事、國事、天下事"
},
{
title:"新聞頻道",
link:"http://news.mtc.sohu.com/news/channel/2/news.rss",
desc:"讓您實時掌握國際動態"
},
{
title:"軍事頻道",
link:"http://news.mtc.sohu.com/news/channel/3/news.rss",
desc:"軍事"
}
]
},
{
name:"體育新聞",
subchnls:[
{
title:"體育要聞彙總",
link:"http://news.mtc.sohu.com/news/channel/4/news.rss",
desc:"erewr"
},
{
title:"國際足壇",
link:"http://news.mtc.sohu.com/news/channel/5/news.rss",
desc:"werewr"
}
]
}
]
}
}
這段JSON描述了一個對象（最外層大括號包圍的部分），爲了方便區分，我們就將其稱爲對象A吧。對象A有兩個Item（即key-value鍵值對），一個是result，其值爲true；一個是root，其值爲一個對象，稱爲對象B。對象B也有兩個Item，一個是version，其值爲一個字串” 201007091640”；一個是channels，其值是一個數組，而數組的成員都是一個對象，每個對象又包含兩個Item，一個是name，值分別爲字串"新聞中心"和"體育新聞"；一個是subchnls，值都是數組，每個數組又分別有若干個成員，每個subchnls成員也都是一個對象，每個對象都有三個Item：title、link和desc。也許你看到這，已經是一頭大汗了，不過沒關係，我們來帖張這段JSON文本對應的結構圖，有圖就有真相，請看圖六：
在RssReader中使用了開源庫cJSON來解析JSON，所以在此就介紹下cJSON的使用：
在CJSON中，一個key-value鍵值對被解析並存放在一個cJSON結構體變量中，其value取值集爲：FALSE，TRUE，NULL，NUMBER，STRING，OBJECT，ARRAY。它們分別被存放在CJSON對象的child、valuestring、valueint、valuedouble變量中，而用於判斷某個CJSON對象value的數據類型則是CJSON對象的type變量，其取值範圍與CJSON對象的value集是一一對應的，如：cJSON_False對應FALSE。
cJSON Types:
#define cJSON_False 0
#define cJSON_True 1
#define cJSON_NULL 2
#define cJSON_Number 3
#define cJSON_String 4
#define cJSON_Array 5
#define cJSON_Object 6
cJSON 結構體:
typedef struct cJSON
{
struct cJSON *next,*prev; //指向上一項/下一項
struct cJSON *child; //指向下一級，也就是當type爲cJSON_Object或cJSON_Array時，此指針不爲空。
int type;
char *valuestring; // 當type爲cJSON_String時
int valueint; // 當 type爲cJSON_Number時
double valuedouble; //當type爲cJSON_Number時
char *string; // 當前項的名稱，也就是key-value鍵值對的key
} cJSON;
在解析JSON過程中，從JSON格式描述的value數據到CJSON對象中存放的變量的一個映射關係如圖七：
對CJSON格式的解析是使用cJSON_Parse()方法，其傳入的參數是一個CJSON的Object/Array結構的字串，解析成功則返回一個cJSON結構體變量的指針，在使用完成後需要調用cJSON_Delete()將該指針銷燬。CJSON是以樹狀結構來組織內部的各個cJSON結構體變量的，一般地，要使用某個cJSON結構體變量，需要調用cJSON_GetObjectItem()方法並根據其父節點的cJSON結構體變量指針與該項的名稱來獲取其指針，舉個例子：
bool bResult;
char jsonString[] = “{result:true}”;
//獲取result的值true
cJSON* pItem = NULL;
cJSON* pRoot = cJSON_Parse ( jsonString );
if ( pRoot )
{
pItem = cJSON_GetObjectItem ( pRoot, “result” );
if ( pItem )
{
bResult = pItem->valueint; //由於result的值type爲cJSON_False或cJSON_True，所以其值被存放在valueint變量中
}
cJSON_Delete ( pRoot );
}
在上例中，不管result的值type爲何類型，都是通過調用cJSON_GetObjectItem()方法獲取其對應的cJSON結構體變量的指針，只是在處理其對應的值時會有所不同。如果result的值type爲cJSON_Object，則需要通過調用cJSON_GetObjectItem( pItem, “subItemKey”)來獲取其子Item的指針。在處理值type爲cJSON_Array的Item時，就需要再用到另外兩個API：cJSON_GetArraySize ()和cJSON_GetArrayItem()。我們舉個獲取一個數組成員值的例子：
char* out;
char jsonString[] = “{colors:[\“red\”, \“green\”,\ “blue\”, \“yellow\”, \“white\”]}”;
cJSON* pArray = NULL;
cJSON* pRoot = cJSON_Parse ( jsonString );
if ( pRoot )
{
pArray = cJSON_GetObjectItem ( pRoot, “colors” );
if ( pArray )
{
cJSON* pArrayItem = NULL;
int nCount = cJSON_GetArraySize ( pArray ); //獲取pArray數組的大小
for( int i = 0; i < nCount; i++)
{
pArrayItem = cJSON_GetArrayItem(pArray, i);
out = cJSON_Print( pArrayItem ); //將pArrayItem的值以字串的形式打印到char型buffer上，cJSON_Print()會自動分配內存空間，用完需要釋放內存。
SS_printf( “array item %d: %s\n”, i, out);
Free( out );
}
}
cJSON_Delete ( pRoot );
}
在提取一個複雜的JSON格式的數據時，也只是將以上兩個例子使用到的方法進行組合調用罷了。所以對CJSON提供的API的使用是很簡單有效的。有了以上知識的瞭解，我們就可以編寫一些代碼將例一中的JSON解析並提取其中的數據，還是貼點代碼纔是硬道理，代碼如下：
TChannelsData.h:
/** 子頻道信息結構體
*
*/
struct SUBCHNL_DATA
{
SUBCHNL_DATA();
void clear();
TUChar * m_title;
char * m_link;
TUChar * m_desc;
};
/** 大頻道信息結構體
*
*/
struct CHANNEL_DATA
{
CHANNEL_DATA();
TUChar* m_pszTitle;
vector m_aSubChnlList;
};
//………….
// TChannelsData 類成員變量：RSSReaderConfig 版本號
char m_pszVersion[32];
// TChannelsData 類成員變量：頻道信息列表
vector m_aChnlsList;
//………….
TChannelsData.cpp:
/** 解析JSON格式的內容
*
* \param pszJsonText 解析的JSON格式內容字串
*
* \return true:有更新數據; false:沒有更新數據
*/
Boolean TChannelsData::ParseJson(char* pszJsonText)
{
//char* out;
cJSON* objJson;
objJson= cJSON_Parse(pszJsonText);
if (objJson)
{
//out=cJSON_Print(objJson);
cJSON* objRootItem = NULL;
//判斷是否需要更新
objRootItem = cJSON_GetObjectItem(objJson, "result");
if (objRootItem)
{
if (!objRootItem->valueint)
{
return FALSE;
}
}
else
{
return FALSE;
}
//獲取更新數據，根節點root
objRootItem = cJSON_GetObjectItem(objJson, "root");
if (objRootItem)
{
cJSON* objJsonItem = NULL;
//獲取版本號
objJsonItem = cJSON_GetObjectItem(objRootItem, "version");
if (objJsonItem)
{
Int32 nLen = strlen(objJsonItem->valuestring);
strncpy(m_pszVersion, objJsonItem->valuestring, (nLen < 32)? nLen : 31);
}
//解析出大頻道
_ParseChannels(objRootItem);
}
//SS_printf("=======[parse json]%s\n",out);
cJSON_Delete(objJson);
//free(out);
}
return TRUE;
}
/** 解析出大頻道
*
* \param pCJson cJSON對象指針
*
* \return void
*/
void TChannelsData::_ParseChannels(cJSON* pCJson)
{
cJSON* pJsonArray = NULL;
if (!pCJson)
{
return;
}
pJsonArray = cJSON_GetObjectItem(pCJson, "channels");
if(pJsonArray)
{
cJSON* pArrayItem = NULL;
cJSON* pJsonTemp = NULL;
Int32 nSize = cJSON_GetArraySize(pJsonArray);
for (Int32 i = 0; i < nSize; i++)
{
pArrayItem = cJSON_GetArrayItem(pJsonArray, i);
if (pArrayItem)
{
CHANNEL_DATA tChannelData;
Int32 nLen = 0;
//獲取大頻道名稱
tChannelData.m_pszTitle = _JsonGetTUString(pArrayItem, "name");
//解析出子頻道
_ParseSubChnls(tChannelData.m_aSubChnlList, pArrayItem);
//將大頻道信息對象壓入列表中
m_aChnlsList.push_back(tChannelData);
}
else
{
continue;
}
}
}
}
/** 解析子頻道
*
* \param aSubChnlList 存放子頻道數據的vector對象
* \param pCJson cJSON對象指針
*
* \return void
*/
void TChannelsData::_ParseSubChnls(vector& aSubChnlList, cJSON* pCJson)
{
cJSON* pJsonArray = NULL;
if (!pCJson)
{
return;
}
pJsonArray = cJSON_GetObjectItem(pCJson, "subchnls");
if (pJsonArray)
{
cJSON* pArrayItem = NULL;
//cJSON* pJsonTemp = NULL;
Int32 nSize = cJSON_GetArraySize(pJsonArray);
for (Int32 i = 0; i < nSize; i++)
{
pArrayItem = cJSON_GetArrayItem(pJsonArray, i);
if (pArrayItem)
{
SUBCHNL_DATA tSubChnlData;
Int32 nLen = 0;
//get title
tSubChnlData.m_title = _JsonGetTUString(pArrayItem, "title");
//get link
tSubChnlData.m_link = _JsonGetString(pArrayItem, "link");
//get desc
tSubChnlData.m_desc = _JsonGetTUString(pArrayItem, "desc");
aSubChnlList.push_back(tSubChnlData);
}
}
}
}
/** 獲取指定的cJSON對象的指定屬性值
*
* \param pJsonItem cJSON對象指針
* \param pszKey cJSON對象屬性
*
* \return 返回JSON對象的值，以TUChar字串形式返回
*/
TUChar* TChannelsData::_JsonGetTUString(cJSON* pJsonItem, char* pszKey)
{
TUChar* pszValue = NULL;
Int32 nLen;
cJSON* pJsonTemp = NULL;
pJsonTemp = cJSON_GetObjectItem(pJsonItem, pszKey);
if (pJsonTemp)
{
nLen = strlen(pJsonTemp->valuestring) + 1;
pszValue = new TUChar[nLen];
if(pszValue)
{
MemSet(pszValue, 0, nLen * sizeof(TUChar));
TUString::StrUtf8ToStrUnicode(pszValue, (const Char*)pJsonTemp->valuestring);
}
}
return pszValue;
}
/** 獲取指定的cJSON對象的指定屬性值
*
* \param pJsonItem cJSON對象指針
* \param pszKey cJSON對象屬性
*
* \return 返回JSON對象的值，以char字串形式返回
*/
char* TChannelsData::_JsonGetString(cJSON* pJsonItem, char* pszKey)
{
char* pszValue = NULL;
Int32 nLen;
cJSON* pJsonTemp = NULL;
pJsonTemp = cJSON_GetObjectItem(pJsonItem, pszKey);
if (pJsonTemp)
{
nLen = strlen(pJsonTemp->valuestring) + 1;
pszValue = new char[nLen];
if(pszValue)
{
MemSet(pszValue, 0, nLen);
strncpy(pszValue, pJsonTemp->valuestring, nLen - 1);
}
}
return pszValue;
}
/** 獲取指定的cJSON對象的指定屬性值
*
* \param pJsonItem cJSON對象指針
* \param pszKey cJSON對象屬性
*
* \return 返回JSON對象的值，以int32形式返回
*/
Int32 TChannelsData::_JsonGetInt(cJSON* pJsonItem, char* pszKey)
{
Int32 nValue = 0;
cJSON* pJsonTemp = NULL;
pJsonTemp = cJSON_GetObjectItem(pJsonItem, pszKey);
if (pJsonTemp)
{
nValue = pJsonTemp->valueint;
}
return nValue;
}
/** 獲取指定的cJSON對象的指定屬性值
*
* \param pJsonItem cJSON對象指針
* \param pszKey cJSON對象屬性
*
* \return 返回JSON對象的值，以Boolean形式返回
*/
Boolean TChannelsData::_JsonGetBoolean(cJSON* pJsonItem, char* pszKey)
{
Boolean bValue = FALSE;
cJSON* pJsonTemp = NULL;
pJsonTemp = cJSON_GetObjectItem(pJsonItem, pszKey);
if (pJsonTemp)
{
if(pJsonTemp->valueint)
{
bValue = TRUE;
}
}
return bValue;
}
JSON的結構簡約，所以使得JSON的文檔的數據量比較小，比較適合用於網絡數據的交換，而且對JSON文檔的解析和數據提取的方法也很簡單，方便程序員的使用，當然也正是因爲JSON的結構簡約，使得JSON的可讀性與可編輯性會稍差於XML，所以JSON比較適合在較少有人工閱讀和編輯的情況下使用期。
備註：經驗證名稱需加“ 比如char jsonString[] = "{\"result\":true}";
