org.json包的使用
1.簡介
工具包org.json.jar,是一個輕量級的,JAVA下的json構造和解析工具包,它還包含JSON與XML, HTTP headers, Cookies, CDL的轉換。
這篇學習筆記,主要介紹常用的一些類如:JSONObject、JSONArray、JSONStringer等的一些用法;介紹了如何將Map、Collection、Java Bean等對象轉化為json數據;介紹了如何使用org.json包解析json數據等。
3.構造json的示例用法
3.1 JSONObject.java
官網給出的JSONObject的構造函數如下:


比較常用就是傳入String、map或者bean來構造JSON對象,代碼例子如下:
首先定義一個java bean類:
- package orgjson;
- /**
- * 包含getter和setter的java bean類
- * @author Zen9
- */
- public class Student {
- private String name;
- private String sex;
- private int age;
- public String getName() {
- return name;
- }
- public void setName(String name) {
- this.name = name;
- }
- public String getSex() {
- return sex;
- }
- public void setSex(String sex) {
- this.sex = sex;
- }
- public int getAge() {
- return age;
- }
- public void setAge(int age) {
- this.age = age;
- }
- }
然后測試構造方法;也可以用put方法來向JSON對象中添加key/value對,當用put方法時候,value值可以是int、double、String、、boolean、collection、Map等等,但不可以為bean類型,代碼如下:
- package orgjson;
- import java.util.ArrayList;
- import java.util.HashMap;
- import java.util.List;
- import java.util.Map;
- import org.json.*;
- public class JsonTest {
- public static void constructorTest() {
- String jsonStr = "{'name':'JTZen9','age':21}";
- JSONObject strJson = new JSONObject(jsonStr); // 傳入字符串
- System.out.println("構造參數為String類:" + strJson);
- Map<string object> map = new HashMap<string object>();
- map.put("age", 21);
- map.put("sex", "male");
- map.put("name", "JTZen9");
- JSONObject mapJson = new JSONObject(map); // 傳入Map類型
- System.out.println("構造參數為Map類:" + mapJson);
- Student student = new Student();
- student.setAge(21);
- student.setName("JTZen9");
- student.setSex("male");
- JSONObject beanJson = new JSONObject(student); // 傳入Bean類型
- System.out.println("構造參數為Bean類:" + beanJson);
- }
- public static void putMethodTest() {
- JSONObject jsonObject1 = new JSONObject();
- jsonObject1.put("bookName", "JTZen9");
- jsonObject1.put("age", 21);
- System.out.println(jsonObject1);
- JSONObject jsonObject2 = new JSONObject();
- List<object> list = new ArrayList</object><object>();
- for (int i = 1; i < 3; i++) {
- Map<string object=""> map = new HashMap<string object="">();
- map.put("title", "java程序設計 第" + i + "版");
- map.put("price", i*20);
- list.add(map);
- }
- jsonObject2.put("book", list);
- System.out.println(jsonObject2);
- Student student = new Student();
- student.setAge(21);
- student.setName("JTZen9");
- student.setSex("male");
- jsonObject2 = new JSONObject(student);
- JSONObject jsonObject3 = new JSONObject();
- jsonObject3.put("people", jsonObject2); //不可以直接傳bean類對象put("people",student)
- System.out.println(jsonObject3);
- }
- public static void main(String[] args) throws Exception {
- constructorTest();
- System.out.println("---------------------------------------------------------");
- putMethodTest();
- }
- }
輸出結果:


3.2 JSONArray.java
1.構造函數
官網上的JSONObject的構造函數如下:

這里用Collection、String和Object型的array作為參數,給出例子如下:
- package orgjson;
- import java.util.ArrayList;
- import java.util.HashMap;
- import java.util.List;
- import java.util.Map;
- import org.json.*;
- public class JsonArrayTest {
- public static void constructorTest() {
- String jsonStr = "[{'name':'JTZen9','age':21}]";
- JSONArray strJson = new JSONArray(jsonStr); // 傳入字符串
- System.out.println("構造參數為String類:" + strJson);
- List<Object> list = new ArrayList<Object>();
- for (int i = 1; i < 3; i++) {
- Map<string object=""> map = new HashMap<string object="">();
- map.put("title", "java程序設計 第" + i + "版");
- map.put("price", i*20);
- list.add(map);
- }
- JSONArray mapJson = new JSONArray(list); // 傳入Collection類型
- System.out.println("構造參數為Collection類:" + mapJson);
- int[] numlist = new int[10];
- for (int i = 0; i < numlist.length; i++) {
- numlist[i] = i;
- }
- JSONArray arrayJson = new JSONArray(numlist); // 傳入Array類型,實例1
- System.out.println(arrayJson);
- Student[] student = {new Student(),new Student()};
- student[0].setAge(21);
- student[0].setName("JTZen9");
- student[0].setSex("male");
- student[1].setAge(21);
- student[1].setName("heiheihei");
- student[1].setSex("female");
- JSONArray beanJson = new JSONArray(student); // 傳入Array類型,實例2
- System.out.println("構造參數為Array類:" + beanJson);
- }
- public static void main(String[] args) {
- constructorTest();
- }
- }
輸出結果如下:


2.put方法創建
put方法中可以直接將int、double、Collection、Map等加進去,也可以添加下標來指定添加的位置:put(int index, java.util.Map value) ,使用put方法構造的JSON數組,如果傳入的是數組,都會自動加一對中括號[ ],那么出來的結果就會有兩層的中括號[ ],代碼例子如下:- package orgjson;
- import java.util.HashMap;
- import java.util.Map;
- import org.json.*;
- public class JSONArrayTest {
- public static void putMethodTest() {
- JSONArray jsonArray1 = new JSONArray();
- jsonArray1.put("JTZen9");
- jsonArray1.put(21);
- jsonArray1.put("male");
- System.out.println(jsonArray1);
- JSONArray jsonArray2 = new JSONArray();
- Map<string object=""> map = new HashMap<string object="">();
- map.put("title", "java程序設計 第2版");
- map.put("price", 20);
- jsonArray2.put(map); //傳入一個map
- System.out.println("傳入一個Map:" + jsonArray2);
- map.clear();
- map.put("title", "java程序設計 第3版");
- map.put("price", 30);
- jsonArray2.put(map); //沒有下標的直接在結果后面添加
- System.out.println("沒有指定下標:" + jsonArray2);
- map.clear();
- map.put("title", "java程序設計 第1版");
- map.put("price", 10);
- jsonArray2.put(0,map); //使用下標可以添加到自定義的位置
- System.out.println("添加到第一個位置:" + jsonArray2);
- Student[] student = { new Student(), new Student() };
- student[0].setAge(21);
- student[0].setName("JTZen9");
- student[0].setSex("male");
- student[1].setAge(21);
- student[1].setName("heiheihei");
- student[1].setSex("female");
- JSONArray jsonArray3 = new JSONArray();
- jsonArray3.put(student);
- System.out.println("注意輸出結果:" + jsonArray3);
- }
- public static void main(String[] args) {
- putMethodTest();
- }
- }
輸出的結果如下:


3.3 JSONStringer.java & JSONWriter.java
①JSONWriter可以用來構建一個JSON格式的文本,並轉換成String,可以寫入文件,便於傳輸和存儲。只有一個構造函數:JSONWriter(java.io.Writer w)
②常用幾個函數和說明:
②常用幾個函數和說明:

③JSONStringer是JSONWriter的子類;用法跟JSONWriter幾乎一樣,區別是可以直接new JSONStringer()創建對象,不用傳入構造參數。JSONStringer也可以通過object().key().value().key().value().endObject()進行構造;
下面是簡單的寫入代碼例子:(可以嘗試寫入更復雜數據)
- package orgjson;
- import java.io.PrintWriter;
- import java.util.HashMap;
- import java.util.Map;
- import org.json.*;
- public class JSONWriterStringerTest {
- public static void JSONStringerTest() throws Exception {
- PrintWriter writer = new PrintWriter("test.txt");
- JSONWriter jsonWriter = new JSONWriter(writer);
- jsonWriter.object().key("name").value("JTZen9").key("age").value(21).key("sex").value("male").endObject();
- writer.flush();
- writer.close();
- Map<string object=""> map1 = new HashMap<string object="">();
- map1.put("age", 21);
- map1.put("sex", "male");
- map1.put("name", "jtzen9");
- Map<string object=""> map2 = new HashMap<string object="">();
- map2.put("age", 21);
- map2.put("sex", "female");
- map2.put("name", "heiheihei");
- JSONStringer jsonStringer = new JSONStringer();
- jsonStringer.array().value(map1).value(map2).endArray();
- System.out.println(jsonStringer);
- }
- public static void main(String[] args) throws Exception {
- JSONStringerTest();
- }
- }
輸出結果,上面為test.txt文件,下面為控制台:

3.4 JSONTokener.java
JSONTokener讀取包含json格式數據的文件,然后可以將JSONTokener對象作為參數來構造JSONObject或JSONArray,然后再進行相應的解析。
以上面的test.txt為例,簡單代碼示例如下:
- package orgjson;
- import java.io.File;
- import java.io.FileReader;
- import org.json.*;
- public class JSONTokenerTest {
- public static void readJsonFile() throws Exception{
- JSONTokener jsonTokener = new JSONTokener(new FileReader(new File("test.txt")));
- JSONObject jsonObject = new JSONObject(jsonTokener);
- System.out.println(jsonObject);
- System.out.println("姓名:" + jsonObject.getString("name"));
- System.out.println("年齡:" + jsonObject.getInt("age"));
- }
- public static void main(String[] args) throws Exception {
- readJsonFile();
- }
- }
輸出結果如下:

這里給出一個相對復雜的json數據:
json.txt
- [
- {
- "institute":{
- "name":"Software Institute",
- "grade":[
- {
- "name":"freshman",
- "class":[
- {
- "no.":1,
- "students":61
- },
- {
- "no.":2,
- "students":62
- },
- {
- "no.":3,
- "students":63
- }
- ]
- },
- {
- "name":"sophomore",
- "class":[
- {
- "no.":1,
- "students":51
- },
- {
- "no.":2,
- "students":52
- },
- {
- "no.":3,
- "students":53
- }
- ]
- },
- {
- "name":"junior",
- "class":[
- {
- "no.":1,
- "students":41
- },
- {
- "no.":2,
- "students":42
- },
- {
- "no.":3,
- "students":43
- }
- ]
- }
- ]
- }
- }
- ]
然后,如果我要獲取grade為sophomore的no.等於3的students數量,那么代碼如下:
- package orgjson;
- import java.io.File;
- import java.io.FileReader;
- import org.json.JSONArray;
- import org.json.JSONObject;
- import org.json.JSONTokener;
- public class JSONTest {
- public static void main(String[] args) throws Exception {
- JSONTokener jsonTokener = new JSONTokener(new FileReader(new File("json.txt")));
- JSONArray jsonArray = new JSONArray(jsonTokener);//獲取整個json文件的內容,因為最外層是數組,所以用JSONArray來構造
- System.out.println(jsonArray);
- //這個JSONArray數組只包含一個JSONObject對象,標為jsonObject1
- JSONObject jsonObject1 = jsonArray.getJSONObject(0);
- System.out.println(jsonObject1);
- //jsonObject1只包含一個institute字段,這里獲取這個字段內容賦給jsonObject2
- JSONObject jsonObject2 = jsonObject1.getJSONObject("institute");
- System.out.println(jsonObject2);
- //jsonObject2包含name字段和grade字段,grade字段對應的是一個JSONArray數組
- String valueOfname = jsonObject2.getString("name");
- System.out.println(valueOfname);
- JSONArray jsonArray2 = jsonObject2.getJSONArray("grade");
- System.out.println(jsonArray2);
- //jsonArray2數組包含3個對象,每個對象里面有name字段和class字段,這里獲取第二個對象
- JSONObject jsonObject3 = jsonArray2.getJSONObject(1);
- System.out.println(jsonObject3);
- //然后從jsonObject3對象里獲取class字段對應的JSONArray數組
- JSONArray jsonArray3 = jsonObject3.getJSONArray("class");
- System.out.println(jsonArray3);
- //下面直接獲取no.等於3的students數量,過程都一樣
- int num = jsonArray3.getJSONObject(2).getInt("students");
- System.out.println("最后獲取的結果為:" + num);
- }
- }
輸出的結果如下,這里只截取控制台輸出的前半部分結果:

5.結束語
之前解析json數據都是一直百度百度,別人怎么用就怎么用,做大作業時有時候會org.json包也導入,Gson包也導入,然后各用一點功能。現在想想其實只用一個org.json包就可以完全解決我的需求,只是之前一直沒有總結各種用法,所以這兩天看了下官網源碼,總結了下學習筆記,還是收獲蠻大的。
其實看官網api文檔,然后自己動手實踐各種方法才是最好的學習方式。百度別人的教程,有時候只能得到小部分的說明。
org.json包還有很多的api方法並沒有用過,所以就不做筆記了。以后用到再繼續完善。