json详细介绍（for Java）

一、JSON介绍

JSON（JavaScript Object Notation），类似于XML，是一种数据交换格式，比如JAVA产生了一个数据想要给JavaScript，则除了利用XML外，还可以利用JSON;

JSON相比XML的优势是表达起来很简单；

官网：http://www.json.org/

JSON是AJAX中的X（就是可以取代XML）;          ------出自JSON创始人;

注意：JSON并不是一个文档格式，没有*.json的文档，一般JSON格式的文档存在txt中，而XML可以是一个标准；

在线校验JSON结构的网站：http://www.bejson.com/go.html?u=http://www.bejson.com/jsonview2/

二、JSON数据结构

JSON有两种数据结构：

(1)Map，也称为对象；｛....｝

(2)Array；[......]

也就是说所有的JSON对象都是要以这些形式表示；

1.Map

简单的说就是Java中的Map，名称-值对的形式给出，名称和值之间用“：”隔开，两个Map之间用“，”隔开，一般表示形式如下：

{'key1':'value1','key2':'value2'}

以下为官网的图：

2.Array

就是普通意义上的数组，一般形式如下：

['arr1','arr2','arr3'];

以下为官网的图：

图中的value可以是：

总结：

(1)JSON的数据结构只有两种；

(2)可以嵌套表示，比如Array中可以嵌套Object等；

(3)记住：Object是以｛｝表示，Array是以[  ]表示；

 

三、JSON与XML互转示例

前面提到任何的XML都能够转换成JSON包；

1.简单XML

XML格式：

[html] view plaincopy

1. <person>  
2.     <name>xiazdong</name>  
3.     <age>20</age>  
4. </person>  

JSON格式：

[html] view plaincopy

1. {  
2.     "name":"xiazdong",  
3.     "age":20  
4. }  

2.复杂XML

XML格式：

[html] view plaincopy

1. <section>  
2.     <title>BOOK</title>  
3.     <signing>  
4.         <author name="author-1"/>  
5.         <book title="book1" price="$11"/>  
6.     </signing>  
7.     <signing>  
8.         <author name="author-2"/>  
9.         <book title="book2" price="$22"/>  
10.     </signing>  
11. </section>  

JSON格式：

[html] view plaincopy

1. "section":{  
2.         "title":"BOOK",  
3.         "signing":[  
4.         {  
5.     <span style="white-space:pre">  </span> "author":  
6.             {  
7.                 "name":"author-1"  
8.             },  
9.             "book":  
10.             {  
11.                 "title":"book1",  
12.                 "price":"$11"  
13.             }  
14.         },  
15.         {  
16.             "author":  
17.             {  
18.                 "name":"author-2"  
19.             },  
20.             "book":  
21.             {  
22.                 "title":"book2",  
23.                 "price":"$22"  
24.             }  
25.         }     
26. <span style="white-space:pre">  </span> ]}  
27.     }  

注意：XML中的属性也是通过JSON的Map表示；

在JAVA中构造和解析JSON我用的是org.json，附件为相应的org.json.jar.

下面是两个函数，一个是创建JSON，一个是从文本构造JSON并解析之。

创建json

Java代码  

1. //construct json and output it    
2. public String jsonTest() throws JSONException{  
3.     JSONObject json=new JSONObject();  
4.     JSONArray jsonMembers = new JSONArray();  
5.     JSONObject member1 = new JSONObject();  
6.     member1.put("loginname", "zhangfan");  
7.     member1.put("password", "userpass");  
8.     member1.put("email","[e-mail]");  
9.     member1.put("sign_date", "2007-06-12");  
10.     jsonMembers.put(member1);  
11.   
12.     JSONObject member2 = new JSONObject();  
13.     member2.put("loginname", "zf");  
14.     member2.put("password", "userpass");  
15.     member2.put("email","[e-mail]");  
16.     member2.put("sign_date", "2008-07-16");  
17.     jsonMembers.put(member2);  
18.     json.put("users", jsonMembers);  
19.   
20.     return json.toString();  
21. }  

 解析json 

Java代码  

1. //construct json from String and resolve it.  
2. public String jsonTest2() throws JSONException{  
3.     String jsonString="{\"users\":[{\"loginname\":\"zhangfan\",\"password\":\"userpass\",\"email\":\"[e-mail]\"},{\"loginname\":\"zf\",\"password\":\"userpass\",\"email\":\"[e-mail]\"}]}";  
4.     JSONObject json= new JSONObject(jsonString);  
5.     JSONArray jsonArray=json.getJSONArray("users");  
6.     String loginNames="loginname list:";  
7.     for(int i=0;i<jsonArray.length();i++){  
8.         JSONObject user=(JSONObject) jsonArray.get(i);  
9.         String userName=(String) user.get("loginname");  
10.         if(i==jsonArray.length()-1){  
11.             loginNames+=userName;  
12.         }else{  
13.             loginNames+=userName+",";  
14.         }  
15.     }  
16.     return loginNames;  
17. }  

 JAVA中处理JSON还是相当方便的。

四、JSON包

如果我们想要使用JSON包，则可以下载JSON包的源代码，并将这些代码添加进Eclipse工程中，即可调用；

如果想要看API文档，可以参见：http://www.JSON.org/java/index.html

JSON包中最常用的两个类就是JSONObject和JSONArray，分别表示两种数据结构；

1.JSONObject代码实例

[java] view plaincopy

1. package com.xiazdong.json;  
2.   
3. import weibo4j.org.json.JSONArray;  
4. import weibo4j.org.json.JSONObject;  
5.   
6. public class Test {  
7.   
8.     public static void main(String[] args) throws Exception{  
9.         JSONObject jsonobj = new JSONObject("{'name':'xiazdong','age':20}");  
10.         String name = jsonobj.getString("name");  
11.         int age = jsonobj.getInt("age");  
12.         System.out.println(name+":"+age);     
13.           
14.     }  
15. }  

2.JSONArray代码实例

JSONArray array = new JSONArray(String str); //将String转为JSONArray

int length = array.length();//返回Array的长度；

[java] view plaincopy

1. package com.xiazdong.json;  
2.   
3. import weibo4j.org.json.JSONArray;  
4. import weibo4j.org.json.JSONObject;  
5.   
6. public class Test {  
7.   
8.     public static void main(String[] args) throws Exception{  
9.               
10.         JSONArray jsonarray = new JSONArray("[{'name':'xiazdong','age':20},{'name':'xzdong','age':15}]");  
11.         for(int i=0;i<jsonarray.length();i++){  
12.             String name = jsonarray.getJSONObject(i).getString("name");  
13.             int age = jsonarray.getJSONObject(i).getInt("age");  
14.             System.out.println("name="+name);  
15.             System.out.println("age="+age);  
16.         }  
17.           
18.     }  
19. }  

3.嵌套JSONObject和JSONArray代码实例

[java] view plaincopy

1. package com.xiazdong.json;  
2.   
3. import weibo4j.org.json.JSONArray;  
4. import weibo4j.org.json.JSONObject;  
5.   
6. public class Test {  
7.   
8.     public static void main(String[] args) throws Exception{  
9.   
10.         String str = "{'name':'xiazdong','age':20,'book':['book1','book2']";  
11.         JSONObject obj = new JSONObject(str);  
12.         System.out.println(obj.getJSONArray("book").getString(0));  
13.     }  
14. }  

4.JSONStringer代码示例

JSONStringer可以用来快速构建一个JSON格式的文本，并转换成String，可以写入文件；

JSONStringer是JSONWriter的子类;

JSONStringer一般通过object().key().value().key().value().endObject()进行构造;

object()表明开始一个对象，即添加｛  ;

endObject()表明结束一个对象，即添加 ｝ ;

array()表明开始一个数组,即添加一个 [ ;

endArray()表明结束一个数组，即添加一个 ] ;

key()表示添加一个key;

value()表示添加一个value;

[java] view plaincopy

1. package com.xiazdong.json;  
2.   
3. import weibo4j.org.json.JSONStringer;  
4.   
5. public class JsonStringerDemo {  
6.   
7.     public static void main(String[] args) throws Exception{  
8.         JSONStringer stringer = new JSONStringer();  
9.         String str = stringer.object().key("name").value("xiazdong").key("age").value(20).endObject().toString();  
10.         System.out.println(str);  
11.     }  
12.   
13. }  

复杂JSON格式写入

[java] view plaincopy

1. package com.xiazdong.json;  
2.   
3. import java.io.File;  
4. import java.io.FileReader;  
5.   
6. import weibo4j.org.json.JSONArray;  
7. import weibo4j.org.json.JSONObject;  
8. import weibo4j.org.json.JSONStringer;  
9. import weibo4j.org.json.JSONTokener;  
10.   
11. public class JsonStringerDemo {  
12.   
13.     public static void main(String[] args) throws Exception{  
14.           
15.         JSONStringer js = new JSONStringer();  
16.         JSONObject obj2 = new JSONObject();  
17.         JSONObject obj3 = new JSONObject();  
18.         JSONObject obj4 = new JSONObject();  
19.         obj4.put("title", "book1").put("price", "$11");  
20.         obj3.put("book", obj4);  
21.         obj3.put("author", new JSONObject().put("name", "author-1"));  
22.           
23.         JSONObject obj5 = new JSONObject();  
24.         JSONObject obj6 = new JSONObject();  
25.         obj6.put("title", "book2").put("price", "$22");  
26.         obj5.put("book", obj6);  
27.         obj5.put("author", new JSONObject().put("name", "author-2"));  
28.           
29.         JSONArray obj7 = new JSONArray();  
30.         obj7.put(obj3).put(obj5);  
31.           
32.           
33.           
34.         obj2.put("title","BOOK");  
35.         obj2.put("signing", obj7);  
36.           
37.         js.object().key("session").value(obj2).endObject();  
38.           
39.         System.out.println(js.toString());  
40.           
41.         PrintWriter out = new PrintWriter(new FileOutputStream(1.txt));  
42.         out.println(js.toString());  
43.           
44.       
45.     }  
46.   
47. }  

以上代码生成了如下JSON格式：

[java] view plaincopy

1. {"section":{  
2.         "title":"BOOK",  
3.         "signing":[  
4.         {  
5.             "author":  
6.             {  
7.                 "name":"author-1"  
8.             },  
9.             "book":  
10.             {  
11.                 "title":"book1",  
12.                 "price":"$11"  
13.             }  
14.         },  
15.         {  
16.             "author":  
17.             {  
18.                 "name":"author-2"  
19.             },  
20.             "book":  
21.             {  
22.                 "title":"book2",  
23.                 "price":"$22"  
24.             }  
25.         }     
26.         ]}  
27.     }  
28. }  

5.JSONTokener代码示例

JSONTokener是用来读取JSON格式的文件;

JSONObject obj = new JSONObject( new JSONTokener(java.io.Reader));可以从文件中读取一个JSONObject;

JSONArray obj = new JSONArray( new JSONTokener(java.io.Reader)); 可以从文件中读取一个JSONArray;

1.txt

[java] view plaincopy

1. {  
2.     'name':'xiazdong',  
3.     'book':['book1','book2']  
4. }  

[java] view plaincopy

1. package com.xiazdong.json;  
2.   
3. import java.io.File;  
4. import java.io.FileReader;  
5.   
6. import weibo4j.org.json.JSONObject;  
7. import weibo4j.org.json.JSONTokener;  
8.   
9. public class JsonStringerDemo {  
10.   
11.     public static void main(String[] args) throws Exception{  
12.         JSONObject obj = new JSONObject(new JSONTokener(new FileReader(new File("1.txt"))));  
13.         System.out.println(obj.getJSONArray("book").getString(1)); //可以读取book2  
14.     }  
15.   
16. }  

复杂JSON格式的读取代码：

1.txt

[java] view plaincopy

1. {"section":{  
2.         "title":"BOOK",  
3.         "signing":[  
4.         {  
5.             "author":  
6.             {  
7.                 "name":"author-1"  
8.             },  
9.             "book":  
10.             {  
11.                 "title":"book1",  
12.                 "price":"$11"  
13.             }  
14.         },  
15.         {  
16.             "author":  
17.             {  
18.                 "name":"author-2"  
19.             },  
20.             "book":  
21.             {  
22.                 "title":"book2",  
23.                 "price":"$22"  
24.             }  
25.         }     
26.         ]}  
27.     }  
28. }  

[java] view plaincopy

1. package com.xiazdong.json;  
2.   
3. import java.io.File;  
4. import java.io.FileReader;  
5.   
6. import weibo4j.org.json.JSONObject;  
7. import weibo4j.org.json.JSONTokener;  
8.   
9. public class JsonStringerDemo {  
10.   
11.     public static void main(String[] args) throws Exception{  
12.         JSONObject obj = new JSONObject(new JSONTokener(new FileReader(new File("1.txt"))));  
13.         System.out.println(obj.getJSONObject("section").getJSONArray("signing").getJSONObject(0).getJSONObject("author").getString("name")); <span style="white-space:pre">     </span>//获取author-1  
14.     }  
15.   
16. }  

总结：

1在Java中JSON格式的String最好用单引号表示;

2.利用JSONObject+JSONTokener能够读取JSON格式文件对象;

3.利用PrintWriter+JSONStringer可以写入JSON文件;

注：由于原本想要试图用JSONWriter写入，但是没有成功；所以只能利用JSONStringer+PrintWriter写入;

json（1）-使用json所要用到的jar包下载

json是个非常重要的数据结构，在web开发中应用十分广泛。我觉得每个人都应该好好的去研究一下json的底层实现，基于这样的认识，金丝燕网推出了一个关于json的系列教程，分析一下json的相关内容，希望大家能有所收获。首先给大家说一下使用json前的准备工作，需要准备下面的六个jar包：
commons-lang-1.0.4.jar 
commons-collections-2.1.jar 
commons-beanutils-1.8.0.jar 
json-lib-2.4.jar 
ezmorph-1.0.6.jar 
commons-logging-1.1.jar
需要说明几点：
（1）json-lib最新版本可以从这个地方下载：http://sourceforge.net/projects/json-lib/files/json-lib/
（2）ezmorph是一个简单的java类库，用于将一种bean转换成另外一种bean。其动态bean的实现依赖于commons-beanutils包。ezmorph可以在这个地方下载源码：http://sourceforge.net/projects/ezmorph/files/ezmorph/
（3）commons-beanutils是操作Java Bean的类库，依赖于commons-collections。
（4）commons-collections类库是各种集合类和集合工具类的封装。

json（2）-生成JSONObject的方法

生成JSONObject一般有两种方式，通过javabean或者map类型来生成。如下面的例子：

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

publicclassUser

{

    publicStringusername;

    publicStringpassword;

    publicStringgetUsername()

    {

      returnusername;

    }

    publicvoidsetUsername(Stringusername)

    {

      this.username=username;

    }

    publicStringgetPassword()

    {

      returnpassword;

    }

    publicvoidsetPassword(Stringpassword)

    {

      this.password=password;

    }

}

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

importjava.util.HashMap;

importnet.sf.json.JSONObject;

publicclassTest{

 

publicstaticvoidmain(Stringargs[]){

    

    Useruser=newUser();

    user.setUsername("root");

    user.setPassword("1234");

    JSONObjectjson1=JSONObject.fromObject(user);

    System.out.println(json1.toString());

    HashMap<Object,Object>userMap=newHashMap<Object,Object>();

    userMap.put("username","root");

    userMap.put("password","1234");

    JSONObjectjson2=JSONObject.fromObject(userMap);

    System.out.println(json2.toString());

    

}

}

下面从源码层次分析一下JSONObject.fromObject()方法：

1

2

3

4

publicstaticJSONObjectfromObject(Objectobject)

{

    returnfromObject(object,newJsonConfig());

}

此函数可以接受的参数类型为：JSON formatted strings，Maps，DynaBeans and JavaBeans。
【注意】DynaBeans是commons-beanutils定义的动态bean。DynaBean并不是Java中所定义的Bean，而是一种"假"的Bean。因为它并不是通过getXXX和setXXX方法，对XXX属性进行取值和设值的。
如果object是其他类型的参数呢？比如说数字，逻辑值，非json格式的字符串，那么将生产空的JSONObject对象。

1

2

3

4

if(JSONUtils.isNumber(object)||JSONUtils.isBoolean(object)||JSONUtils.isString(object))

{

    returnnewJSONObject();

}

JSONObject的构造函数有两个：

1

2

3

4

5

6

7

8

9

publicJSONObject()

{

        this.properties=newListOrderedMap();

}

publicJSONObject(booleanisNull)

{

        this();

        this.nullObject=isNull;

}

不过，说实话，第二个构造函数使用情况很少。

json（3）-JSONObject的过滤设置

我们通常对一个json串和java对象进行互转时，经常会有选择性的过滤掉一些属性值。例如下面的类：

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

publicclassPerson

{

    privateStringname;

    privateStringaddress;

    privateStringsex;

 

    publicStringgetAddress()

    {

        returnaddress;

    }

 

    publicvoidsetAddress(Stringaddress)

    {

        this.address=address;

    }

 

    publicStringgetName()

    {

        returnname;

    }

 

    publicvoidsetName(Stringname)

    {

        this.name=name;

    }

 

    publicStringgetSex()

    {

        returnsex;

    }

 

    publicvoidsetSex(Stringsex)

    {

        this.sex=sex;

    }

}

如果我想过滤address属性怎么办？

方法一：实现JSONString接口

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

importnet.sf.json.JSONString;

publicclassPersonimplementsJSONString

{

    privateStringname;

    privateStringsex;

    privateStringaddress;

    publicStringtoJSONString()

    {

        return"{\"name\":\""+name+"\",\"sex\":\""+sex+"\"}";

    }

    publicStringgetAddress()

    {

        returnaddress;

    }

    publicvoidsetAddress(Stringaddress)

    {

        this.address=address;

    }

    publicStringgetName()

    {

        returnname;

    }

    publicvoidsetName(Stringname)

    {

        this.name=name;

    }

    publicStringgetSex()

    {

        returnsex;

    }

    publicvoidsetSex(Stringsex)

    {

        this.sex=sex;

    }

}

importnet.sf.json.JSONObject;

publicclassTest{

publicstaticvoidmain(Stringargs[]){

      Personperson=newPerson();

        person.setName("swiftlet");

        person.setSex("men");

        person.setAddress("china");

        JSONObjectjson=JSONObject.fromObject(person);

        System.out.println(json.toString());

    }

}

方法二：设置jsonconfig实例，对包含和需要排除的属性进行添加或删除。

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

importnet.sf.json.JSONObject;

importnet.sf.json.JsonConfig;

publicclassTest

{

    publicstaticvoidmain(Stringargs[])

    {

        Personperson=newPerson();

        person.setName("swiftlet");

        person.setSex("men");

        person.setAddress("china");

        JsonConfigjsonConfig=newJsonConfig();

        jsonConfig.setExcludes(newString[]

        {"address"});

        JSONObjectjson=JSONObject.fromObject(person,jsonConfig);

        System.out.println(json.toString());

    }

}

方法三：使用propertyFilter实例过滤属性。

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

importnet.sf.json.JSONObject;

importnet.sf.json.JsonConfig;

importnet.sf.json.util.PropertyFilter;

publicclassTest

{

    publicstaticvoidmain(Stringargs[])

    {

        Personperson=newPerson();

        person.setName("swiftlet");

        person.setSex("men");

        person.setAddress("china");

        JsonConfigjsonConfig=newJsonConfig();

        jsonConfig.setJsonPropertyFilter(newPropertyFilter(){

            publicbooleanapply(Objectsource,Stringname,Objectvalue)

            {

                returnsourceinstanceofPerson&&name.equals("address");

            }

        });

        JSONObjectjson=JSONObject.fromObject(person,jsonConfig);

        System.out.println(json.toString());

    }

}

json（4）-optXXX方法的使用

在JSONObject获取value有多种方法，如果key不存在的话，这些方法无一例外的都会抛出异常。如果在线环境抛出异常，就会使出现error页面，影响用户体验，针对这种情况最好是使用optXXX方法。
getString方法会抛出异常，如下所示：

1

2

3

4

5

6

7

8

9

10

publicStringgetString(Stringkey)

    {

        verifyIsNull();

        Objecto=get(key);

        if(o!=null)

        {

            returno.toString();

        }

        thrownewJSONException("JSONObject["+JSONUtils.quote(key)+"] not found.");

    }

getInt方法会抛出异常，如下所示：

1

2

3

4

5

6

7

8

9

10

publicintgetInt(Stringkey)

    {

        verifyIsNull();

        Objecto=get(key);

        if(o!=null)

        {

            returnoinstanceofNumber?((Number)o).intValue():(int)getDouble(key);

        }

        thrownewJSONException("JSONObject["+JSONUtils.quote(key)+"] is not a number.");

    }

getDouble方法会抛出异常，如下所示：    

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

publicdoublegetDouble(Stringkey)

    {

        verifyIsNull();

        Objecto=get(key);

        if(o!=null)

        {

            try

            {

                returnoinstanceofNumber?((Number)o).doubleValue():Double.parseDouble((String)o);

            }

            catch(Exceptione)

            {

                thrownewJSONException("JSONObject["+JSONUtils.quote(key)+"] is not a number.");

            }

        }

        thrownewJSONException("JSONObject["+JSONUtils.quote(key)+"] is not a number.");

 

    }

getBoolean方法会抛出异常，如下所示：   

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

publicbooleangetBoolean(Stringkey)

    {

        verifyIsNull();

        Objecto=get(key);

        if(o!=null)

        {

            if(o.equals(Boolean.FALSE)||(oinstanceofString&&((String)o).equalsIgnoreCase("false")))

            {

                returnfalse;

            }

            elseif(o.equals(Boolean.TRUE)||(oinstanceofString&&((String)o).equalsIgnoreCase("true")))

            {

                returntrue;

            }

        }

        thrownewJSONException("JSONObject["+JSONUtils.quote(key)+"] is not a Boolean.");

    }

JSONObject有很多optXXX方法，比如optBoolean，optString，optInt。它们的意思是，如果JsonObject有这个属性，则返回这个属性，否则返回一个默认值。下面以optString方法为例说明一下其底层实现过程：

1

2

3

4

5

    publicStringoptString(Stringkey)

    {

        verifyIsNull();

        returnoptString(key,"");

    }

1

2

3

4

5

6

    publicStringoptString(Stringkey,StringdefaultValue)

    {

        verifyIsNull();

        Objecto=opt(key);

        returno!=null?o.toString():defaultValue;

    }