Java 的 JSON lib: json-simple

似乎 Java guy 偏好 XML 的做法, JSON 相關說明好像比較少, 像 Python 2.6 後直接內建 json, 2.5 前也有公認的 simplejson。找了一會兒, 看起來 json-simple 最好用, 輕巧簡單。官網還有搜集一些 blog 提到 json-simple 的文章, 其中這篇 A Review of 5 Java JSON Libraries 還不錯, 列了表格說明作者重視的項目, json-simple 看起來的確不錯。我試用後也覺得頗滿意的, JSON 的 object 直接對到 Map-like 的 JSONObject, list 對到 List。和 Python 用起來的差別, 就是取出資料後自己要轉型成對應的型別, 不過對 Java 來說, 似乎也是理所當然的事。

制作簡單的 API: 在 Django 中回傳 JSON

將 HttpResponse 的 mimetype 設為 json 即可, 程式如下:

# views.py
def myapi(request):
    data = {
       'name': 'Alice',
        ...
    }
    return HttpResponse(simplejson.dumps(data), mimetype='application/json')

設好 urls.py 後 (/myapi/), 就能用 jQuery 的 $.ajax 輕鬆地 call /myapi/ 取得 JSON ( callback function 的參數會是 JavaScript object, 不用再呼叫 JSON.parse )。為了減少出錯的機會, 我將 ajax 的參數 aysnc 設為 false。

回傳值是 JSON 有許多好處, 除方便用 AJAX 拿資料外, 也方便寫 unit test:

class MyApiTest(django.test.TestCase):
    data = { ... }
    response = self.client.post('/myapi/', data)
    self.assertEqual(200, response.status_code)
    expected = { ... }
    self.assertEqual(expected, simplejson.loads(response.content))

附帶一提, 有人寫了個 decorator 將一般的 view 轉成回傳 json, 目前沒這需求, 留著備忘。