使用JSON进行网络数据交换

1、使用JSON进行网络数据交换网络编程, 2009-12-18 17:29:44 标签 : 在开发客户端与服务端的应用当中，数据交换接口通常都是通过XML格式来进行数据交换的。近年来，随着AJAX技术的兴起，JSON作为一种轻量级的数据交换格式，以其易于阅读和编写的优点，也越来越多的被使用到各个项目中。在Android SDK中，也提供了JSON的类库方便对JSON格式的数据进行处理。本文将快速讲解 JSON 格式，并通过代码示例演示如何分别在客户端和服务器端进行 JSON 格式数据的处理。什么是JSON JSON（JavaScript Object Notation）是一种轻量级的数据交换格式

2、，易于阅读和编写，同时也易于机器解析和生成，非常适合于服务器与客户端的交互。JSON采用与编程语言无关的文本格式，但是也使用了类C语言的习惯，这些特性使JSON成为理想的数据交换格式。和 XML 一样，JSON 也是基于纯文本的数据格式。由于 JSON 天生是为 JavaScript 准备的，因此，JSON 的数据格式非常简单，您可以用 JSON 传输一个简单的 String，Number，Boolean，也可以传输一个数组，或者一个复杂的 Object 对象。 String，Number 和 Boolean 用 JSON 表示非常简单。例如，用 JSON 表示一个简单的字符串 “ abc ”

3、，其格式为：abc。 除了字符 ，/ 和一些控制符（b，f，n，r，t）需要编码外，其他 Unicode 字符可以直接输出。下图是一个 String 的完整表示结构：图1.String的完整表示结构 一个 Number 可以根据整型或浮点数表示如下：图2.Number 的表示结构 这与绝大多数编程语言的表示方法一致，例如： 12345（整数）-3.9e10（浮点数） Boolean 类型表示为 true 或 false 。此外，JavaScript 中的 null 被表示为 null，注意，true、false 和 null 都没有双引号，否则将被视为一个 String 。 JSON 还可以表

4、示一个数组对象，使用 包含所有元素，每个元素用逗号分隔，元素可以是任意的 Value，例如，以下数组包含了一个 String，Number，Boolean 和一个 null：view plaincopy to clipboardprint?1. abc,12345,false,nullabc,12345,false,null Object 对象在 JSON 中是用 包含一系列无序的 Key-Value 键值对表示的，实际上此处的 Object 相当于 Java 中的 Map，而不是 Java 的 Class 。注意 Key 只能用 String 表示。例如，一个 Address 对象包含如下

5、Key-Value：city:Beijing street:Chaoyang Road postcode:100025（整数）用JSON 表示如下：view plaincopy to clipboardprint?1. city:Beijing,street:ChaoyangRoad,postcode:100025city:Beijing,street: Chaoyang Road ,postcode:100025 其中 Value 也可以是另一个 Object 或者数组，因此，复杂的 Object 可以嵌套表示，例如，一个 Person 对象包含 name 和 address 对象，可以表示

6、如下：view plaincopy to clipboardprint?1. name:Michael,address: 2. city:Beijing,street:ChaoyangRoad,postcode:100025 3. name:Michael,address: city:Beijing,street: Chaoyang Road ,postcode:100025 一个实际例子 接下来，我会通过一个例子来详细说明Android客户端程序如何访问服务端的接口程序读取用户列表数据，并在模拟器上显示用户列表数据。1、服务端接口程序 首先，我们创建一个名为User的JavaBean作为用户

7、对象类，用来保存演示数据。view plaincopy to clipboardprint?1. publicclassUser 2. privateintid; 3. privateStringname; 4. privateStringemail; 5. privateStringgender; 6. 7. publicintgetId() 8. returnid; 9. 10. publicvoidsetId(intid) 11. this.id=id; 12. 13. publicStringgetName() 14. returnname; 15. 16. publicvoidset

8、Name(Stringname) 17. =name; 18. 19. publicStringgetEmail() 20. returnemail; 21. 22. publicvoidsetEmail(Stringemail) 23. this.email=email; 24. 25. publicStringgetGender() 26. returngender; 27. 28. publicvoidsetGender(Stringgender) 29. this.gender=gender; 30. 31. 32. public class User private

9、 int id; private String name; private String email; private String gender; public int getId() return id; public void setId(int id) this.id = id; public String getName() return name; public void setName(String name) = name; public String getEmail() return email; public void setEmail(String

10、email) this.email = email; public String getGender() return gender; public void setGender(String gender) this.gender = gender; 接下来，我们创建一个名为JSONDemoServlet的Servlet类来作为服务端的接口程序。在这个程序里，定义了一个List对象用来保存用户列表。view plaincopy to clipboardprint?1. privateListlist;private List list; 客户端程序访问服务器端接口时，接口通过prepareD

11、ata方法为用户列表初始化数据，添加用户数据到List对象中。view plaincopy to clipboardprint?1. privatevoidprepareData() 2. list=newArrayList(); 3. Userbean1=newUser(); 4. bean1.setId(1001); 5. bean1.setName(Tony); 6. bean1.setEmail(tony); 7. bean1.setGender(male); 8. list.add(bean1); 9. 10. private void prepareData() list = ne

12、w ArrayList(); User bean1 = new User(); bean1.setId(1001); bean1.setName(Tony); bean1.setEmail(tony); bean1.setGender(male); list.add(bean1); 接着遍历用户列表，把列表中的每个Java用户对象转换为JSONObject对象，再加入到JSONArray中去。view plaincopy to clipboardprint?1. JSONArrayarray=newJSONArray(); 2. for(Userbean:list) 3. /单个用户JSON对

13、象4. JSONObjectobj=newJSONObject(); 5. 6. try 7. obj.put(id,bean.getId(); 8. obj.put(name,bean.getName(); 9. obj.put(email,bean.getEmail(); 10. obj.put(gender,bean.getGender(); 11. catch(Exceptione) 12. 13. array.put(obj); 14. JSONArray array = new JSONArray(); for(User bean:list) /单个用户JSON对象 JSONObj

14、ect obj = new JSONObject(); try obj.put(id, bean.getId(); obj.put(name, bean.getName(); obj.put(email, bean.getEmail(); obj.put(gender, bean.getGender(); catch (Exception e) array.put(obj); 最后，通过 Servlet输出 JSON 时，需要设置正确的 MIME 类型和字符编码。假定服务器使用 UTF-8 编码，则可以使用以下代码输出编码后的 JSON 文本：view plaincopy to clipboa

15、rdprint?1. response.setContentType(text/plain); 2. response.setCharacterEncoding(UTF-8); 3. PrintWriterout=response.getWriter(); 4. out.write(array.toString(); 5. out.flush(); 6. out.close(); 7. 8. JSONDemoServlet.java的完整代码如下： 9. importjava.io.IOException; 10. importjava.io.PrintWriter; 11. importja

16、va.util.ArrayList; 12. importjava.util.List; 13. 14. importjavax.servlet.ServletException; 15. importjavax.servlet.http.HttpServlet; 16. importjavax.servlet.http.HttpServletRequest; 17. importjavax.servlet.http.HttpServletResponse; 18. 19. importorg.json.JSONArray; 20. importorg.json.JSONObject; 21.

17、 22. publicclassJSONDemoServletextendsHttpServlet 23. privatestaticfinallongserialVersionUID=-7368225680407826408L; 24. privateListlist; 25. 26. /* 27. *处理post方式提交的数据28. */29. publicvoiddoPost(HttpServletRequestrequest,HttpServletResponseresponse)throwsServletException,IOException 30. doGet(request,

18、response); 31. 32. /* 33. *出来get方式提交的数据34. */35. publicvoiddoGet(HttpServletRequestrequest,HttpServletResponseresponse)throwsServletException,IOException 36. response.setContentType(text/plain); 37. response.setCharacterEncoding(UTF-8); 38. PrintWriterout=response.getWriter(); 39. 40. /准备用户数据41. pre

19、pareData(); 42. 43. /JSON数组44. JSONArrayarray=newJSONArray(); 45. for(Userbean:list) 46. /单个用户JSON对象47. JSONObjectobj=newJSONObject(); 48. 49. try 50. obj.put(id,bean.getId(); 51. obj.put(name,bean.getName(); 52. obj.put(email,bean.getEmail(); 53. obj.put(gender,bean.getGender(); 54. catch(Exception

20、e) 55. 56. array.put(obj); 57. 58. 59. /输出60. out.write(array.toString(); 61. out.flush(); 62. out.close(); 63. 64. privatevoidprepareData() 65. list=newArrayList(); 66. Userbean1=newUser(); 67. bean1.setId(1001); 68. bean1.setName(Tony); 69. bean1.setEmail(tony); 70. bean1.setGender(male); 71. list

21、.add(bean1); 72. 73. Userbean2=newUser(); 74. bean2.setId(1002); 75. bean2.setName(Jack); 76. bean2.setEmail(jack); 77. bean2.setGender(male); 78. list.add(bean2); 79. 80. Userbean3=newUser(); 81. bean3.setId(1003); 82. bean3.setName(Marry); 83. bean3.setEmail(marry); 84. bean3.setGender(female); 85

22、. list.add(bean3); 86. 87. Userbean4=newUser(); 88. bean4.setId(1004); 89. bean4.setName(Linda); 90. bean4.setEmail(linda); 91. bean4.setGender(female); 92. list.add(bean4); 93. 94. response.setContentType(text/plain); response.setCharacterEncoding(UTF-8); PrintWriter out = response.getWriter(); out

23、.write(array.toString(); out.flush(); out.close(); JSONDemoServlet.java的完整代码如下： import java.io.IOException; import java.io.PrintWriter; import java.util.ArrayList; import java.util.List; import javax.servlet.ServletException; import javax.servlet.http.HttpServlet; import javax.servlet.http.HttpServl

24、etRequest; import javax.servlet.http.HttpServletResponse; import org.json.JSONArray; import org.json.JSONObject; public class JSONDemoServlet extends HttpServlet private static final long serialVersionUID = -7368225680407826408L; private List list; /* * 处理post方式提交的数据 */ public void doPost(HttpServle

25、tRequest request, HttpServletResponse response)throws ServletException, IOException doGet(request,response); /* * 出来get方式提交的数据 */ public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException response.setContentType(text/plain); response.setCharacte

26、rEncoding(UTF-8); PrintWriter out = response.getWriter(); /准备用户数据 prepareData(); /JSON数组 JSONArray array = new JSONArray(); for(User bean:list) /单个用户JSON对象 JSONObject obj = new JSONObject(); try obj.put(id, bean.getId(); obj.put(name, bean.getName(); obj.put(email, bean.getEmail(); obj.put(gender, b

27、ean.getGender(); catch (Exception e) array.put(obj); /输出 out.write(array.toString(); out.flush(); out.close(); private void prepareData() list = new ArrayList(); User bean1 = new User(); bean1.setId(1001); bean1.setName(Tony); bean1.setEmail(tony); bean1.setGender(male); list.add(bean1); User bean2

28、= new User(); bean2.setId(1002); bean2.setName(Jack); bean2.setEmail(jack); bean2.setGender(male); list.add(bean2); User bean3 = new User(); bean3.setId(1003); bean3.setName(Marry); bean3.setEmail(marry); bean3.setGender(female); list.add(bean3); User bean4 = new User(); bean4.setId(1004); bean4.set

29、Name(Linda); bean4.setEmail(linda); bean4.setGender(female); list.add(bean4); 把该Servlet部署到Tomcat下，在浏览器输入接口地址http:/localhost:8080/article/JSONDemoServlet，输出结果如下：id:1001,email:tony,name:Tony,gender:male,id:1002,email:jack,name:Jack,gender:male,id:1003,email:marry,name:Marry,gender:female,id:1004,email

30、:linda,name:Linda,gender:female2、手机客户端程序 准备好服务端的接口后，接下来就是准备写客户端的程序了。打开Eclipse新建一个Android项目。我们创建一个名为MainActivity的Activity类，如下图所示： 因为要访问外部网络，所以要在AndroidManifest.xml文件里增加一行安全许可： 这样我们的应用程序就可以访问网络了。 接着修改布局文件reslayoutmain.xml，增加一个TextView对象，用来显示解析后的用户数据。view plaincopy to clipboardprint?1. 2. 6. 9. Android

31、 SDK提供了Apache的HttpClient类处理网络访问，相信很多读者朋友都在其他项目当中用到过HttpClient。我写了一个方法，获取某一网址的网页内容，代码如下：view plaincopy to clipboardprint?1. /* 2. *获取网址内容3. *paramurl 4. *return 5. *throwsException 6. */7. privateStringgetContent(Stringurl)throwsException 8. StringBuildersb=newStringBuilder(); 9. 10. HttpClientclient

32、=newDefaultHttpClient(); 11. HttpParamshttpParams=client.getParams(); 12. /设置网络超时参数13. HttpConnectionParams.setConnectionTimeout(httpParams,3000); 14. HttpConnectionParams.setSoTimeout(httpParams,5000); 15. HttpResponseresponse=client.execute(newHttpGet(url); 16. HttpEntityentity=response.getEntity(

33、); 17. if(entity!=null) 18. BufferedReaderreader=newBufferedReader(newInputStreamReader(entity.getContent(),UTF-8),8192); 19. 20. Stringline=null; 21. while(line=reader.readLine()!=null) 22. sb.append(line+n); 23. 24. reader.close(); 25. 26. returnsb.toString(); 27. /* * 获取网址内容 * param url * return

34、* throws Exception */ private String getContent(String url) throws Exception StringBuilder sb = new StringBuilder(); HttpClient client = new DefaultHttpClient(); HttpParams httpParams = client.getParams(); /设置网络超时参数 HttpConnectionParams.setConnectionTimeout(httpParams, 3000); HttpConnectionParams.se

35、tSoTimeout(httpParams, 5000); HttpResponse response = client.execute(new HttpGet(url); HttpEntity entity = response.getEntity(); if (entity != null) BufferedReader reader = new BufferedReader(new InputStreamReader(entity.getContent(), UTF-8), 8192); String line = null; while (line = reader.readLine(

36、)!= null) sb.append(line + n); reader.close(); return sb.toString(); 修改MainActivity.java，在onCreate方法里增加解析服务端接口内容的代码，如下所示：view plaincopy to clipboardprint?1. Override2. publicvoidonCreate(BundlesavedInstanceState) 3. super.onCreate(savedInstanceState); 4. setContentView(R.layout.main); 5. 6. try 7. S

37、tringBuffersb=newStringBuffer(); 8. /在测试过程中，经常是用本机做测试服务器，访问本机的IP地址要设置为 9. Stringurl=:8080/article/JSONDemoServlet; 10. Stringbody=getContent(url); 11. JSONArrayarray=newJSONArray(body); 12. for(inti=0;iarray.length();i+) 13. JSONObjectobj=array.getJSONObject(i); 14. sb.append(id:).append(obj.getInt(id).append