android2.3 提供的 json 解析类
android 的 json 解析部分都在包 org.json 下,主要有以下几个类:
JSONObject:可以看作是一个 json 对象,这是系统中有关 JSON 定义的基本单元,其包含一
对儿(Key/Value)数值。它对外部(External: 应用 toString()方法输出的数值)调用的响应体现
为一个标准的字符串(例如:{"JSON": "Hello, World"},最外被大括号包裹,其中的 Key 和
Value 被冒号":"分隔)。其对于内部(Internal)行为的操作格式略微,例如:初始化一个
JSONObject 实例,引用内部的 put()方法添加数值:new JSONObject().put("JSON", "Hello,
World!"),在 Key 和 Value 之间是以逗号","分隔。Value 的类型包括:Boolean、JSONArray、
JSONObject、Number、String 或者默认值 JSONObject.NULL object 。
JSONStringer:json 文本构建类 ,根据官方的解释,这个类可以帮助快速和便捷的创建
JSON text。其最大的优点在于可以减少由于 格式的错误导致程序异常,引用这个类可以
自动严格按照 JSON 语法规则(syntax rules)创建 JSON text。每个 JSONStringer 实体只
能对应创建一个 JSON text。。其最大的优点在于可以减少由于格式的错误导致程序异常,
引用这个类可以自动严格按照 JSON 语法规则(syntax rules)创建 JSON text。每个
JSONStringer 实体只能对应创建一个 JSON text。
JSONArray:它代表一组有序的数值。将其转换为 String 输出(toString)所表现的形式是用
方括号包裹,数值以逗号”,”分隔(例如: [value1,value2,value3],大家可以亲自利用简短
的代码更加直观的了解其格式)。这个类的内部同样具有查询行为, get()和 opt()两种方法
都可以通过 index 索引返回指定的数值,put()方法用来添加或者替换数值。同样这个类的
value 类型可以包括:Boolean、JSONArray、JSONObject、Number、String 或者默认值
JSONObject.NULL object。
JSONTokener:json 解析类
JSONException:json 中用到的异常
JSONObject, JSONArray 来构建 json 文本
代码
1. // 假设现在要创建这样一个 json 文本
2. // {
3. // "phone" : ["12345678", "87654321"], // 数组
4. // "name" : "yuanzhifei89", // 字符串
5. // "age" : 100, // 数值
6. // "address" : { "country" : "china", "province" : "jiangsu" }, // 对象
7. // "married" : false // 布尔值
8. // }
9.
10. try {
11. // 首先最外层是{},是创建一个对象
12. JSONObject person = new JSONObject();
13. // 第一个键 phone 的值是数组,所以需要创建数组对象
14. JSONArray phone = new JSONArray();
15. phone.put("12345678").put("87654321");
16. person.put("phone", phone);
17.
18. person.put("name", "yuanzhifei89");
19. person.put("age", 100);
20. // 键 address 的值是对象,所以又要创建一个对象
21. JSONObject address = new JSONObject();
22. address.put("country", "china");
23. address.put("province", "jiangsu");
24. person.put("address", address);
25. person.put("married", false);
26. } catch (JSONException ex) {
27. // 键为 null 或使用 json 不支持的数字格式(NaN, infinities)
28. throw new RuntimeException(ex);
29. }
getType 和 optType api 的使用
getType 可以将要获取的键的值转换为指定的类型,如果无法转换或没有值则抛出 JSONException
optType 也是将要获取的键的值转换为指定的类型,无法转换或没有值时返回用户提供或这默认提供的值
代码
1. try {
2. // 所有使用的对象都是用上面创建的对象
3. // 将第一个电话号码转换为数值和将名字转换为数值
4. phone.getLong(0);
5. person.getLong("name"); // 会抛异常,因为名字无法转换为 long
6. phone.optLong(0); // 代码内置的默认值
7. phone.optLong(0, 1000); // 用户提供的默认值
8. person.optLong("name");
9. person.optLong("name", 1000); // 不像上面那样抛异常,而是返回 1000
10. } catch (JSONException ex) {
11. // 异常处理代码
12. }
除了上面的两个类,还可以使用 JSONStringer 来构建 json 文本
Java 代码
1. try {
2. JSONStringer jsonText = new JSONStringer();
3. // 首先是{,对象开始。object 和 endObject 必须配对使用
4. jsonText.object();
5.
6. jsonText.key("phone");
7. // 键 phone 的值是数组。array 和 endArray 必须配对使用
8. jsonText.array();
9. jsonText.value("12345678").value("87654321");
10. jsonText.endArray();
11.
12. jsonText.key("name");
13. jsonText.value("yuanzhifei89");
14. jsonText.key("age");
15. jsonText.value(100);
16.
17. jsonText.key("address");
18. // 键 address 的值是对象
19. jsonText.object();
20. jsonText.key("country");
21. jsonText.value("china");
22. jsonText.key("province");
23. jsonText.value("jiangsu");
24. jsonText.endObject();
25.
26. jsonText.key("married");
27. jsonText.value(false);
28.
29. // },对象结束
30. jsonText.endObject();
31. } catch (JSONException ex) {
32. throw new RuntimeException(ex);
33. }
json 文本解析类 JSONTokener
按照 RFC4627 规范将 json 文本解析为相应的对象。
对于将 json 文本解析为对象,只需要用到该类的两个 api:
构造函数
public Object nextValue();
代码
1. // {
2. // "phone" : ["12345678", "87654321"], // 数组
3. // "name" : "yuanzhifei89", // 字符串
4. // "age" : 100, // 数值
5. // "address" : { "country" : "china", "province" : "jiangsu" }, // 对象
6. // "married" : false // 布尔值
7. // }
8.
9. private static final String JSON =
10. "{" +
11. " \"phone\" : [\"12345678\", \"87654321\"]," +
12. " \"name\" : \"yuanzhifei89\"," +
13. " \"age\" : 100," +
14. " \"address\" : { \"country\" : \"china\", \"province\" : \"jiangsu\" }," +
15. " \"married\" : false," +
16. "}";
17.
18. try {
19. JSONTokener jsonParser = new JSONTokener(JSON);
20. // 此时还未读取任何 json 文本,直接读取就是一个 JSONObject 对象。
21. // 如果此时的读取位置在"name" : 了,那么 nextValue 就是"yuanzhifei89"(String)
22. JSONObject person = (JSONObject) jsonParser.nextValue();
23. // 接下来的就是 JSON 对象的操作了
24. person.getJSONArray("phone");
25. person.getString("name");
26. person.getInt("age");
27. person.getJSONObject("address");
28. person.getBoolean("married");
29. } catch (JSONException ex) {
30. // 异常处理代码
31. }
其它的 api 基本就是用来查看 json 文本中的文本的
代码
1. try {
2. JSONTokener jsonParser = new JSONTokener(JSON);
3. // 继续向下读 8 个 json 文本中的字符。此时刚开始,即在{处
4. jsonParser.next(8); //{ "phone。tab 算一个字符
5.
6. // 继续向下读 1 个 json 文本中的字符
7. jsonParser.next(); //"
8.
9. // 继续向下读取一个 json 文本中的字符。该字符不是空白、同时也不是注视中的字符
10. jsonParser.nextClean(); //:
11.
12. // 返回当前的读取位置到第一次遇到'a'之间的字符串(不包括 a)。
13. jsonParser.nextString('a'); // ["12345678", "87654321"], "n(前面有两个空格)
14.
15. // 返回当前读取位置到第一次遇到字符串中(如"0089")任意字符之间的字符串,同时该字符是
trimmed 的。(此处就是第一次遇到了 89)
16. jsonParser.nextTo("0089"); //me" : "yuanzhifei
17.
18. // 读取位置撤销一个
19. jsonParser.back();
20. jsonParser.next(); //i
21.
22. // 读取位置前进到指定字符串处(包括字符串)
23. jsonParser.skipPast("address");
24. jsonParser.next(8); //" : { "c
25.
26. // 读取位置前进到执行字符处(不包括字符)
27. jsonParser.skipTo('m');
28. jsonParser.next(8); //married"
29. } catch (JSONException ex) {
30. // 异常处理代码
31. }
以下是一个标准的 JSON 请求实现过程:
查看源码
打印?
01 HttpPost request = new HttpPost(url);
02 // 先封装一个 JSON 对象
03 JSONObject param = new JSONObject();
04 param.put("name", "rarnu");
05 param.put("password", "123456");
06 // 绑定到请求 Entry
07 StringEntity se = new StringEntity(param.toString());
08 request.setEntity(se);
09 // 发送请求
10
HttpResponse httpResponse = new
DefaultHttpClient().execute(request);
11 // 得到应答的字符串,这也是一个 JSON 格式保存的数据
12 String retSrc = EntityUtils.toString(httpResponse.getEntity());
13 // 生成 JSON 对象
14 JSONObject result = new JSONObject( retSrc);
15 String token = result.get("token");
下面这个是自己修改别人的小例子,主要是加一些注释和讲解,这个例子主要是使用 android
进行 json 解析。
查看源码
打印?
1 单数据{'singer':{'id':01,'name':'tom','gender':'男'}}
2 多个数据{"singers":[
3 {'id':02,'name':'tom','gender':'男'},
4 {'id':03,'name':'jerry,'gender':'男'},
5 {'id':04,'name':'jim,'gender':'男'},
6 {'id':05,'name':'lily,'gender':'女'}]}
下面的类主要是解析单个数据 parseJson()和多个数据的方法 parseJsonMulti():
查看源码
打印?
01 public class JsonActivity extends Activity {
02 /** Called when the activity is first created. */
03 private TextView tvJson;
04 private Button btnJson;
05 private Button btnJsonMulti;
06 @Override
07 public void onCreate(Bundle savedInstanceState) {
08 super.onCreate(savedInstanceState);
09 setContentView(R.layout.main);
10 tvJson = (TextView) this.findViewById(R.id.tvJson);
11 btnJson = (Button) this.findViewById(R.id.btnJson);
12 btnJsonMulti = (Button) this.findViewById(R.id.btnJsonMulti);
13 btnJson.setOnClickListener(new View.OnClickListener() {
14 @Override
15 public void onClick(View v) {
16 // url
17
// String strUrl =
"http://10.158.166.110:8080/AndroidServer/JsonServlet";
18 String strUrl = ServerPageUtil.getStrUrl(UrlsOfServer.JSON_SINGER);
19 //获得返回的 Json 字符串
20 String strResult = connServerForResult(strUrl);
21 //解析 Json 字符串
22 parseJson(strResult);
23 }
24 });
25 btnJsonMulti.setOnClickListener(new View.OnClickListener() {
26 @Override
27 public void onClick(View v) {
28 String strUrl = ServerPageUtil.getStrUrl(UrlsOfServer.JSON_SINGERS);
29 String strResult = connServerForResult(strUrl);
30 //获得多个 Singer
31 parseJsonMulti(strResult);
32 }
33 });
34 }
35 private String connServerForResult(String strUrl) {
36 // HttpGet 对象
37 HttpGet httpRequest = new HttpGet(strUrl);
38 String strResult = "";
39 try {
40 // HttpClient 对象
41 HttpClient httpClient = new DefaultHttpClient();
42 // 获得 HttpResponse 对象
43 HttpResponse httpResponse = httpClient.execute(httpRequest);
44
if (httpResponse.getStatusLine().getStatusCode() ==
HttpStatus.SC_OK) {
45 // 取得返回的数据
46 strResult = EntityUtils.toString(httpResponse.getEntity());
47 }
48 } catch (ClientProtocolException e) {
49 tvJson.setText("protocol error");
50 e.printStackTrace();
51 } catch (IOException e) {
52 tvJson.setText("IO error");
53 e.printStackTrace();
54 }
55 return strResult;
56 }
57 // 普通 Json 数据解析
58 private void parseJson(String strResult) {