SBJson 的安裝方式請參考上一篇文章。這篇要說明的是:如何用 NSDictionary 的鍵值對來組出 JSON 資料,包含多層嵌套的處理。
不要用字串拼接去組 JSON。手動接字串看起來直接,但只要資料裡出現引號、反斜線或換行,就會產生非法 JSON,而且除錯時完全看不出問題在哪。
正確做法是先在前後建好完整的 dictionary 結構,最後再一次序列化。這樣做有兩個好處:結構一目了然,且跳脫字元由程式庫負責處理。
// 開始拼接 JSON 字串
NSDictionary *dataDictionary = [NSDictionary dictionaryWithObjectsAndKeys:
@"mac", @"mac",
@"game", @"game",
@"devicetoken", @"devicetoken",
@"device", @"device",
@"gv", @"gv",
@"lang", @"lang",
@"os", @"os",
nil];
NSDictionary *parmDictionary = [NSDictionary dictionaryWithObjectsAndKeys:
@"getSession", @"act",
dataDictionary, @"data",
nil];
NSDictionary *jsonDictionary = [NSDictionary dictionaryWithObjectsAndKeys:
@"pv", @"pv",
parmDictionary, @"param",
nil];
SBJsonWriter *writer = [[SBJsonWriter alloc] init];
NSString *jsonString = [writer stringWithObject:jsonDictionary];
NSLog(@"%@", jsonString);
上面用了三層嵌套。要特別注意 dictionaryWithObjectsAndKeys: 的參數順序:前面的是 value,後面的才是 key——這與其名稱的字面順序相反,是新手最常寫錯的地方。另外結尾必須以 nil 收尾,少寫會導致陣列讀取越界。
{"pv":"pv","param":{"act":"getSession","data":{"os":"os","mac":"mac","game":"game","gv":"gv","lang":"lang","devicetoken":"devicetoken","device":"device"}}}
丟進線上的 JSON 校驗工具格式化之後,結構會更清楚:
{
"pv": "pv",
"param": {
"act": "getSession",
"data": {
"os": "os",
"mac": "mac",
"game": "game",
"gv": "gv",
"lang": "lang",
"devicetoken": "devicetoken",
"device": "device"
}
}
}
先驗證再送出。開發階段把組好的字串 NSLog 出來,貼到線上校驗工具跑一次,比事後猜「後端為什麼說格式錯誤」快得多。
注意 NSDictionary 的無序性。字典不保證 key 的輸出順序,所以不要依賴欄位先後。若後端要求特定順序(例如簽名計算),就必須改用能保序的結構,或自行排序後組字串。
新專案請直接用 NSJSONSerialization。SBJson 是 NSJSONSerialization 出現之前的主流方案,如今系統內建的 API 已能勝任同樣的工作,且不必引入額外相依性:
NSData *data = [NSJSONSerialization dataWithJSONObject:jsonDictionary
options:0
error:&error];
NSString *jsonString = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];
若專案裡已經有 SBJson 則無妨繼續使用,但新案子沒有理由再引入它。