Android json

浏览数：24 / 时间：2015年06月11日

JSON的定义：

一种轻量级的数据交换格式，具有良好的可读和便于快速编写的特性。业内主流技术为其提供了完整的解决方案（有点类似于正则表达式，获得了当今大部分语言的支持），从而可以在不同平台间进行数据交换。JSON采用兼容性很高的文本格式，同时也具备类似于C语言体系的行为。 – Json.org

JSON Vs XML

1.JSON和XML的数据可读性基本相同

2.JSON和XML同样拥有丰富的解析手段

3.JSON相对于XML来讲，数据的体积小

4.JSON与JavaScript的交互更加方便

5.JSON对数据的描述性比XML较差

6.JSON的速度要远远快于XML

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文本

// 假设现在要创建这样一个json文本
// {
// "phone" : ["12345678", "87654321"], // 数组
// "name" : "yuanzhifei89", // 字符串
// "age" : 100, // 数值
// "address" : { "country" : "china", "province" : "jiangsu" }, // 对象
// "married" : false // 布尔值
// }
try {
// 首先最外层是{}，是创建一个对象
JSONObject person = new JSONObject();
// 第一个键phone的值是数组，所以需要创建数组对象
JSONArray phone = new JSONArray();
phone.put("12345678").put("87654321");
person.put("phone", phone);
person.put("name", "yuanzhifei89");
person.put("age", 100);
// 键address的值是对象，所以又要创建一个对象
JSONObject address = new JSONObject();
address.put("country", "china");
address.put("province", "jiangsu");
person.put("address", address);
person.put("married", false);
} catch (JSONException ex) {
// 键为null或使用json不支持的数字格式(NaN, infinities)
throw new RuntimeException(ex);
}

getType和optType api的使用

getType可以将要获取的键的值转换为指定的类型，如果无法转换或没有值则抛出JSONException
optType也是将要获取的键的值转换为指定的类型，无法转换或没有值时返回用户提供或这默认提供的值

try {
// 所有使用的对象都是用上面创建的对象
// 将第一个电话号码转换为数值和将名字转换为数值
phone.getLong(0);
person.getLong("name"); // 会抛异常，因为名字无法转换为long
phone.optLong(0); // 代码内置的默认值
phone.optLong(0, 1000); // 用户提供的默认值
person.optLong("name");
person.optLong("name", 1000); // 不像上面那样抛异常，而是返回1000
} catch (JSONException ex) {
// 异常处理代码
}

除了上面的两个类，还可以使用JSONStringer来构建json文本

try {
JSONStringer jsonText = new JSONStringer();
// 首先是{，对象开始。object和endObject必须配对使用
jsonText.object();
jsonText.key("phone");
// 键phone的值是数组。array和endArray必须配对使用
jsonText.array();
jsonText.value("12345678").value("87654321");
jsonText.endArray();
jsonText.key("name");
jsonText.value("yuanzhifei89");
jsonText.key("age");
jsonText.value(100);
jsonText.key("address");
// 键address的值是对象
jsonText.object();
jsonText.key("country");
jsonText.value("china");
jsonText.key("province");
jsonText.value("jiangsu");
jsonText.endObject();
jsonText.key("married");
jsonText.value(false);
// }，对象结束
jsonText.endObject();
} catch (JSONException ex) {
throw new RuntimeException(ex);
}

json文本解析类JSONTokener
按照RFC4627规范将json文本解析为相应的对象。

对于将json文本解析为对象，只需要用到该类的两个api：
构造函数
public Object nextValue();

// {
// "phone" : ["12345678", "87654321"], // 数组
// "name" : "yuanzhifei89", // 字符串
// "age" : 100, // 数值
// "address" : { "country" : "china", "province" : "jiangsu" }, // 对象
// "married" : false // 布尔值
// }
private static final String JSON =
"{" +
" \"phone\" : [\"12345678\", \"87654321\"]," +
" \"name\" : \"yuanzhifei89\"," +
" \"age\" : 100," +
" \"address\" : { \"country\" : \"china\", \"province\" : \"jiangsu\" }," +
" \"married\" : false," +
"}";
try {
JSONTokener jsonParser = new JSONTokener(JSON);
// 此时还未读取任何json文本，直接读取就是一个JSONObject对象。
// 如果此时的读取位置在"name" : 了，那么nextValue就是"yuanzhifei89"（String）
JSONObject person = (JSONObject) jsonParser.nextValue();
// 接下来的就是JSON对象的操作了
person.getJSONArray("phone");
person.getString("name");
person.getInt("age");
person.getJSONObject("address");
person.getBoolean("married");
} catch (JSONException ex) {
// 异常处理代码
}

其它的api基本就是用来查看json文本中的文本的

try {
JSONTokener jsonParser = new JSONTokener(JSON);
// 继续向下读8个json文本中的字符。此时刚开始，即在{处
jsonParser.next(8); //{ "phone。tab算一个字符
// 继续向下读1个json文本中的字符
jsonParser.next(); //"
// 继续向下读取一个json文本中的字符。该字符不是空白、同时也不是注视中的字符
jsonParser.nextClean(); //:
// 返回当前的读取位置到第一次遇到‘a‘之间的字符串（不包括a）。
jsonParser.nextString(‘a‘); // ["12345678", "87654321"], "n（前面有两个空格）
// 返回当前读取位置到第一次遇到字符串中(如"0089")任意字符之间的字符串，同时该字符是trimmed的。（此处就是第一次遇到了89）
jsonParser.nextTo("0089"); //me" : "yuanzhifei
// 读取位置撤销一个
jsonParser.back();
jsonParser.next(); //i
// 读取位置前进到指定字符串处（包括字符串）
jsonParser.skipPast("address");
jsonParser.next(8); //" : { "c
// 读取位置前进到执行字符处（不包括字符）
jsonParser.skipTo(‘m‘);
jsonParser.next(8); //married"
} catch (JSONException ex) {
// 异常处理代码
}

以下是一个标准的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) { 

59
        try { 

60
            JSONObject jsonObj = new JSONObject(strResult).getJSONObject("singer"); 

61
            int id = jsonObj.getInt("id"); 

62
            String name = jsonObj.getString("name"); 

63
            String gender = jsonObj.getString("gender"); 

64
            tvJson.setText("ID号"+id + ", 姓名：" + name + ",性别：" + gender); 

65
        } catch (JSONException e) { 

66
            System.out.println("Json parse error"); 

67
            e.printStackTrace(); 

68
        } 

69
    } 

70
    //解析多个数据的Json

71
    private void parseJsonMulti(String strResult) { 

72
        try { 

73
            JSONArray jsonObjs = new JSONObject(strResult).getJSONArray("singers"); 

74
            String s = ""; 

75
            for(int i = 0; i < jsonObjs.length() ; i++){ 

76
                JSONObject jsonObj = ((JSONObject)jsonObjs.opt(i)) 

77
                .getJSONObject("singer"); 

78
                int id = jsonObj.getInt("id"); 

79
                String name = jsonObj.getString("name"); 

80
                String gender = jsonObj.getString("gender"); 

81
                s +=  "ID号"+id + ", 姓名：" + name + ",性别：" + gender+ "\n" ; 

82
            } 

83
            tvJson.setText(s); 

84
        } catch (JSONException e) { 

85
            System.out.println("Jsons parse error !"); 

86
            e.printStackTrace(); 

87
        } 

88
    } 

89
}