Android中的JSON詳細總結

轉自http://shazhuzhu1.iteye.com/blog/974758

1、JSON(JavaScript Object Notation) 定義：

 

一種輕量級的數據交換格式，具有良好的可讀和便於快速編寫的特性。業內主流技術爲其提供了完整的解決方案（有點類似於正則表達式，獲得了當今大部分語言的支持），從而可以在不同平臺間進行數據交換。JSON採用兼容性很高的文本格式，同時也具備類似於C語言體系的行爲。 – Json.org

 

2、JSON的結構：

(1) Name/Value Pairs（無序的）：類似所熟知的Keyed list、 Hash table、Disctionary和Associative array。在Android平臺中同時存在另外一個類 "Bundle"，某種程度上具有相似的行爲。

(2) Array（有序的）：一組有序的數據列表。

 

對象

對象是一個無序的Name/Value Pairs集合。{ name:value , name:value , name:value ....  }

例子：{ "name":"小豬","age":20 }

 

Array

　　Array是值（value）的有序集合。[ value , value , value ...... ]

　　值（value）可以是雙引號括起來的字符串（string）、數值(number)、true、false、 null、對象（object）或者數組（array）。這些結構可以嵌套。

 

 

 

 

 

　　字符串（string）是由雙引號包圍的任意數量Unicode字符的集合，使用反斜線轉義。一個字符（character）即一個單獨的字符串（character string）。 例如：\ + " \ / b f n r t u 進行轉義。

 

 

例子1： Array裏面包含對象(object)

[ {"id":1,"name":"小豬" ,"age”:22} , {"id":2,"name":"小貓","age”:23} ,  .......]

 

例子2：同樣對象(object)中可以包含Array

（1）一個對象包含1個數組，2個子對象

{"root":[{"id":"001","name":"小豬"},{"id":"002","name":"小貓"},{"id":"003","name":"小狗"}],
 "total":3,
 "success":true
}

 

（2）也可以對象嵌套子對象，子對象再嵌套數組

{"calendar": 
    {"calendarlist": 
            [ 
            {"id":"001","name":"小豬"}, 
            {"id":"002","name":"小貓"} 
            ] 
    } 
}

 

總之，格式多種多樣，可以互相嵌套

 

--------------------------------------------------------------------------------------------

在Android中包含四個與JSON相關的類和一個Exceptions：

JSONArray

JSONObject

JSONStringer

JSONTokener

JSONException

 

（1）JSONObject:

這是系統中有關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。

有兩個不同的取值方法：

get(): 在確定數值存在的條件下使用，否則當無法檢索到相關Key時，將會拋出一個Exception信息。

opt(): 這個方法相對比較靈活，當無法獲取所指定數值時，將會返回一個默認數值，並不會拋出異常。

 

 

（2）JSONArray:

它代表一組有序的數值。將其轉換爲String輸出(toString)所表現的形式是用方括號包裹，數值以逗號”,”分隔（例如：[value1,value2,value3]，大家可以親自利用簡短的代碼更加直觀的瞭解其格式）。這個類的內部同樣具有查詢行爲，get()和opt()兩種方法都可以通過index索引返回指定的數值，put()方法用來添加或者替換數值。

同樣這個類的value類型可以包括：Boolean、JSONArray、JSONObject、Number、String或者默認值JSONObject.NULL object。

 

（3）JSONStringer:

根據官方的解釋，這個類可以幫助快速和便捷的創建JSONtext。其最大的優點在於可以減少由於格式的錯誤導致程序異常，引用這個類可以自動嚴格按照JSON語法規則（syntaxrules）創建JSON text。每個JSONStringer實體只能對應創建一個JSON text。

根據下邊的實例來了解其它相關信息：

String myString = new JSONStringer().object()
.key("name")
.value("小豬")
.endObject()
.toString();

 

 

 

結果是一組標準格式的JSON text：{"name" : "小豬"}

其中的.object()和.endObject()必須同時使用，是爲了按照Object標準給數值添加邊界。同樣，針對數組也有一組標準的方法來生成邊界.array()和.endArray()。

 

 

（4）JSONTokener:

這個是系統爲JSONObject和JSONArray構造器解析JSON source string的類，它可以從source string中提取數值信息。

JSONException:

是JSON.org類拋出的異常信息。

下面引用一個完整的應用實例：

應用JSONObject存儲Map類型數值：

 

 

public static JSONObject getJSON(Map map) {
    Iterator iter = map.entrySet().iterator();
    JSONObject holder = new JSONObject();
    while (iter.hasNext()) {
        Map.Entry pairs = (Map.Entry) iter.next();
        String key = (String) pairs.getKey();
        Map m = (Map) pairs.getValue();
        JSONObject data = new JSONObject();
        try {
            Iterator iter2 = m.entrySet().iterator();
            while (iter2.hasNext()) {
                Map.Entry pairs2 = (Map.Entry) iter2.next();
                data.put((String) pairs2.getKey(), (String) pairs2
                        .getValue());
            }
            holder.put(key, data);
        } catch (JSONException e) {
            Log.e("Transforming", "There was an error packaging JSON", e);
        }
    }
    return holder;
}

 

 

 

下面是詳細的例子：

import java.io.ByteArrayOutputStream;
import java.io.InputStream;
import java.net.*;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.json.JSONArray;
import org.json.JSONObject;
import android.util.Log;

public class JSON {


    /**
     * 獲取"數組形式"的JSON數據，
     * 數據形式：[{"id":1,"name":"小豬"},{"id":2,"name":"小貓"}]
     * @param path  網頁路徑
     * @return  返回List
     * @throws Exception
     */
    public static List<Map<String, String>> getJSONArray(String path) throws Exception {
        String json = null;
        List<Map<String, String>> list = new ArrayList<Map<String, String>>();
        Map<String, String> map = null;
        URL url = new URL(path);
        HttpURLConnection conn = (HttpURLConnection) url.openConnection();// 利用HttpURLConnection對象,我們可以從網絡中獲取網頁數據.
        conn.setConnectTimeout(5 * 1000);   // 單位是毫秒，設置超時時間爲5秒
        conn.setRequestMethod("GET");       // HttpURLConnection是通過HTTP協議請求path路徑的，所以需要設置請求方式,可以不設置，因爲默認爲GET
        if (conn.getResponseCode() == 200) {// 判斷請求碼是否是200碼，否則失敗
            InputStream is = conn.getInputStream(); // 獲取輸入流
            byte[] data = readStream(is);   // 把輸入流轉換成字符數組
            json = new String(data);        // 把字符數組轉換成字符串

            //數據形式：[{"id":1,"name":"小豬","age":22},{"id":2,"name":"小貓","age":23}]
            JSONArray jsonArray = new JSONArray(json); //數據直接爲一個數組形式，所以可以直接 用android提供的框架JSONArray讀取JSON數據，轉換成Array

            for (int i = 0; i < jsonArray.length(); i++) {
                JSONObject item = jsonArray.getJSONObject(i); //每條記錄又由幾個Object對象組成
                int id = item.getInt("id");     // 獲取對象對應的值
                String name = item.getString("name");

                map = new HashMap<String, String>(); // 存放到MAP裏面
                map.put("id", id + "");
                map.put("name", name);
                list.add(map);
            }
        }

        // ***********測試數據******************
        for (Map<String, String> list2 : list) {
            String id = list2.get("id");
            String name = list2.get("name");
            Log.i("abc", "id:" + id + " | name:" + name);
        }

        return list;
    }

    /**
     * 獲取"對象形式"的JSON數據，
     * 數據形式：{"total":2,"success":true,"arrayData":[{"id":1,"name":"小豬"},{"id":2,"name":"小貓"}]}
     * @param path  網頁路徑
     * @return  返回List
     * @throws Exception
     */
    public static List<Map<String, String>> getJSONObject(String path) throws Exception {
        List<Map<String, String>> list = new ArrayList<Map<String, String>>();
        Map<String, String> map = null;
        URL url = new URL(path);
        HttpURLConnection conn = (HttpURLConnection) url.openConnection();// 利用HttpURLConnection對象,我們可以從網絡中獲取網頁數據.
        conn.setConnectTimeout(5 * 1000);   // 單位是毫秒，設置超時時間爲5秒
        conn.setRequestMethod("GET");       // HttpURLConnection是通過HTTP協議請求path路徑的，所以需要設置請求方式,可以不設置，因爲默認爲GET
        if (conn.getResponseCode() == 200) {// 判斷請求碼是否是200碼，否則失敗
            InputStream is = conn.getInputStream(); // 獲取輸入流
            byte[] data = readStream(is);   // 把輸入流轉換成字符數組
            String json = new String(data); // 把字符數組轉換成字符串


            //數據形式：{"total":2,"success":true,"arrayData":[{"id":1,"name":"小豬"},{"id":2,"name":"小貓"}]}
            JSONObject jsonObject=new JSONObject(json);     //返回的數據形式是一個Object類型，所以可以直接轉換成一個Object
            int total=jsonObject.getInt("total");
            Boolean success=jsonObject.getBoolean("success");
            Log.i("abc", "total:" + total + " | success:" + success);   //測試數據

            JSONArray jsonArray = jsonObject.getJSONArray("arrayData");//裏面有一個數組數據，可以用getJSONArray獲取數組
            for (int i = 0; i < jsonArray.length(); i++) {
                JSONObject item = jsonArray.getJSONObject(i); // 得到每個對象
                int id = item.getInt("id");     // 獲取對象對應的值
                String name = item.getString("name");

                map = new HashMap<String, String>(); // 存放到MAP裏面
                map.put("id", id + "");
                map.put("name", name);
                list.add(map);
            }
        }

        // ***********測試數據******************

        for (Map<String, String> list2 : list) {
            String id = list2.get("id");
            String name = list2.get("name");
            Log.i("abc", "id:" + id + " | name:" + name);
        }

        return list;
    }


    /**
     * 獲取類型複雜的JSON數據
     *數據形式：
        {"name":"小豬",
         "age":23,
         "content":{"questionsTotal":2,
                    "questions": [ { "question": "what's your name?", "answer": "小豬"},{"question": "what's your age", "answer": "23"}]
                   }
        }
     * @param path  網頁路徑
     * @return  返回List
     * @throws Exception
     */
    public static List<Map<String, String>> getJSON(String path) throws Exception {
        List<Map<String, String>> list = new ArrayList<Map<String, String>>();
        Map<String, String> map = null;
        URL url = new URL(path);
        HttpURLConnection conn = (HttpURLConnection) url.openConnection();// 利用HttpURLConnection對象,我們可以從網絡中獲取網頁數據.
        conn.setConnectTimeout(5 * 1000);   // 單位是毫秒，設置超時時間爲5秒
        conn.setRequestMethod("GET");       // HttpURLConnection是通過HTTP協議請求path路徑的，所以需要設置請求方式,可以不設置，因爲默認爲GET
        if (conn.getResponseCode() == 200) {// 判斷請求碼是否是200碼，否則失敗
            InputStream is = conn.getInputStream(); // 獲取輸入流
            byte[] data = readStream(is);   // 把輸入流轉換成字符數組
            String json = new String(data); // 把字符數組轉換成字符串


            /*數據形式：
                {"name":"小豬",
                 "age":23,
                 "content":{"questionsTotal":2,
                            "questions": [ { "question": "what's your name?", "answer": "小豬"},{"question": "what's your age", "answer": "23"}]
                           }
                }
            */
            JSONObject jsonObject=new JSONObject(json);     //返回的數據形式是一個Object類型，所以可以直接轉換成一個Object
            String name=jsonObject.getString("name");
            int age=jsonObject.getInt("age");
            Log.i("abc", "name:" + name + " | age:" + age); //測試數據

            JSONObject contentObject=jsonObject.getJSONObject("content");       //獲取對象中的對象
            String questionsTotal=contentObject.getString("questionsTotal");    //獲取對象中的一個值
            Log.i("abc", "questionsTotal:" + questionsTotal);   //測試數據

            JSONArray contentArray=contentObject.getJSONArray("questions");     //獲取對象中的數組
            for (int i = 0; i < contentArray.length(); i++) {
                JSONObject item = contentArray.getJSONObject(i); // 得到每個對象
                String question = item.getString("question");   // 獲取對象對應的值
                String answer = item.getString("answer");

                map = new HashMap<String, String>(); // 存放到MAP裏面
                map.put("question", question);
                map.put("answer", answer);
                list.add(map);
            }
        }

        // ***********測試數據******************

        for (Map<String, String> list2 : list) {
            String question = list2.get("question");
            String answer = list2.get("answer");
            Log.i("abc", "question:" + question + " | answer:" + answer);
        }

        return list;
    }




    /**
     * 把輸入流轉換成字符數組
     * @param inputStream   輸入流
     * @return  字符數組
     * @throws Exception
     */
    public static byte[] readStream(InputStream inputStream) throws Exception {
        ByteArrayOutputStream bout = new ByteArrayOutputStream();
        byte[] buffer = new byte[1024];
        int len = 0;
        while ((len = inputStream.read(buffer)) != -1) {
            bout.write(buffer, 0, len);
        }
        bout.close();
        inputStream.close();

        return bout.toByteArray();
    }

}