设为首页收藏本站
开启辅助访问

在路上

 找回密码
 立即注册
在路上 › 站点首页 ›学习 › 查看内容

对Json进行处理的Google Gson API教程

2016-12-20 13:13| 发布者: zhangjf| 查看: 475| 评论: 0

摘要: 在上一篇文章中，我们已经接触了针对JSON处理的Java API，你很容易就会发现，它并不容易使用，无论你是否必须将JSON转换为Java对象，或者其他需求，你都需要写上很多与目标JSON结构高度耦合的代码。 这也是为什么我 ...

在上一篇文章中，我们已经接触了针对JSON处理的Java API，你很容易就会发现，它并不容易使用，无论你是否必须将JSON转换为Java对象，或者其他需求，你都需要写上很多与目标JSON结构高度耦合的代码。

这也是为什么我开始留意其他能做到自行转换格式的API，Gson映入了我的眼帘。Gson是开源的，并已被广泛应用于JSON和Java中，Gson使用Java反射API，提供了诸多易于使用的方式将JSON转换为Java，反之亦然。

你可以从google的代码站点下载到Gson的jar文件，或者如果你正在使用maven，那么你所需要做的所有事情仅仅是添加以下依赖。

  1. <dependencies>
  2. <!-- Gson dependency -->
  3. <dependency>
  4. <groupId>com.google.code.gson</groupId>
  5. <artifactId>gson</artifactId>
  6. <version>2.2.4</version>
  7. </dependency>
  8. </dependencies>
复制代码

Gson是非常强大的API，它支持Java泛型，支持现成的JSON与Java对象的转换，只要对象的成员名称与JSON中的一致即可。如果针对Java bean和JSON要使用不同的名称，那么可以使用@SerializedName注解来映射JSON和Java类中的变量。

我们来看一个复杂示例，在JSON中含有嵌套对象以及数组，我们要将其映射到Java bean的属性（List、Map、Array类型等）中。

  1. {
  2. "empID": 100,
  3. "name": "David",
  4. "permanent": false,
  5. "address": {
  6. "street": "BTM 1st Stage",
  7. "city": "Bangalore",
  8. "zipcode": 560100
  9. },
  10. "phoneNumbers": [
  11. 123456,
  12. 987654
  13. ],
  14. "role": "Manager",
  15. "cities": [
  16. "Los Angeles",
  17. "New York"
  18. ],
  19. "properties": {
  20. "age": "28 years",
  21. "salary": "1000 Rs"
  22. }
  23. }
复制代码

建立Java bean类，将JSON转换为Java对象。

Employee.java

  1. package com.journaldev.json.model;
  3. import java.util.Arrays;
  4. import java.util.List;
  5. import java.util.Map;
  7. import com.google.gson.annotations.SerializedName;
  9. public class Employee {
  11. @SerializedName("empID")
  12. private int id;
  13. private String name;
  14. private boolean permanent;
  15. private Address address;
  16. private long[] phoneNumbers;
  17. private String role;
  18. private List<String> cities;
  19. private Map<String, String> properties;
  21. public int getId() {
  22. return id;
  23. }
  24. public void setId(int id) {
  25. this.id = id;
  26. }
  27. public String getName() {
  28. return name;
  29. }
  30. public void setName(String name) {
  31. this.name = name;
  32. }
  33. public boolean isPermanent() {
  34. return permanent;
  35. }
  36. public void setPermanent(boolean permanent) {
  37. this.permanent = permanent;
  38. }
  39. public Address getAddress() {
  40. return address;
  41. }
  42. public void setAddress(Address address) {
  43. this.address = address;
  44. }
  45. public long[] getPhoneNumbers() {
  46. return phoneNumbers;
  47. }
  48. public void setPhoneNumbers(long[] phoneNumbers) {
  49. this.phoneNumbers = phoneNumbers;
  50. }
  51. public String getRole() {
  52. return role;
  53. }
  54. public void setRole(String role) {
  55. this.role = role;
  56. }
  58. @Override
  59. public String toString(){
  60. StringBuilder sb = new StringBuilder();
  61. sb.append("***** Employee Details *****n");
  62. sb.append("ID="+getId()+"n");
  63. sb.append("Name="+getName()+"n");
  64. sb.append("Permanent="+isPermanent()+"n");
  65. sb.append("Role="+getRole()+"n");
  66. sb.append("Phone Numbers="+Arrays.toString(getPhoneNumbers())+"n");
  67. sb.append("Address="+getAddress()+"n");
  68. sb.append("Cities="+Arrays.toString(getCities().toArray())+"n");
  69. sb.append("Properties="+getProperties()+"n");
  70. sb.append("*****************************");
  72. return sb.toString();
  73. }
  74. public List<String> getCities() {
  75. return cities;
  76. }
  77. public void setCities(List<String> cities) {
  78. this.cities = cities;
  79. }
  80. public Map<String, String> getProperties() {
  81. return properties;
  82. }
  83. public void setProperties(Map<String, String> properties) {
  84. this.properties = properties;
  85. }
  86. }
复制代码

Address.java

  1. package com.journaldev.json.model;
  3. public class Address {
  5. private String street;
  6. private String city;
  7. private int zipcode;
  9. public String getStreet() {
  10. return street;
  11. }
  12. public void setStreet(String street) {
  13. this.street = street;
  14. }
  15. public String getCity() {
  16. return city;
  17. }
  18. public void setCity(String city) {
  19. this.city = city;
  20. }
  21. public int getZipcode() {
  22. return zipcode;
  23. }
  24. public void setZipcode(int zipcode) {
  25. this.zipcode = zipcode;
  26. }
  28. @Override
  29. public String toString(){
  30. return getStreet() + ", "+getCity()+", "+getZipcode();
  31. }
  32. }
复制代码

下面是java程序，展示了如何将JSON转换为Java对象，反之亦然。

EmployeeGsonExample.java

  1. package com.journaldev.json.gson;
  3. import java.io.IOException;
  4. import java.nio.file.Files;
  5. import java.nio.file.Paths;
  6. import java.util.ArrayList;
  7. import java.util.HashMap;
  8. import java.util.List;
  9. import java.util.Map;
  11. import com.google.gson.Gson;
  12. import com.google.gson.GsonBuilder;
  13. import com.journaldev.json.model.Address;
  14. import com.journaldev.json.model.Employee;
  16. public class EmployeeGsonExample {
  18. public static void main(String[] args) throws IOException {
  19. Employee emp = createEmployee();
  21. // Get Gson object
  22. Gson gson = new GsonBuilder().setPrettyPrinting().create();
  24. // read JSON file data as String
  25. String fileData = new String(Files.readAllBytes(Paths
  26. .get("employee.txt")));
  28. // parse json string to object
  29. Employee emp1 = gson.fromJson(fileData, Employee.class);
  31. // print object data
  32. System.out.println("nnEmployee Objectnn" + emp1);
  34. // create JSON String from Object
  35. String jsonEmp = gson.toJson(emp);
  36. System.out.print(jsonEmp);
  38. }
  40. public static Employee createEmployee() {
  42. Employee emp = new Employee();
  43. emp.setId(100);
  44. emp.setName("David");
  45. emp.setPermanent(false);
  46. emp.setPhoneNumbers(new long[] { 123456, 987654 });
  47. emp.setRole("Manager");
  49. Address add = new Address();
  50. add.setCity("Bangalore");
  51. add.setStreet("BTM 1st Stage");
  52. add.setZipcode(560100);
  53. emp.setAddress(add);
  55. List<String> cities = new ArrayList<String>();
  56. cities.add("Los Angeles");
  57. cities.add("New York");
  58. emp.setCities(cities);
  60. Map<String, String> props = new HashMap<String, String>();
  61. props.put("salary", "1000 Rs");
  62. props.put("age", "28 years");
  63. emp.setProperties(props);
  65. return emp;
  66. }
  67. }
复制代码

Gson是主类，它暴露出fromJson()和toJson()方法进行转换工作，对于默认实现，可以直接创建对象，也可以使用GsonBuilder类提供的实用选项进行转换，比如整齐打印，字段命名转换，排除字段，日期格式化，等等。

当运行以上程序时，可以看到以下Java对象的输出。

  1. Employee Object
  3. ***** Employee Details *****
  4. ID=100
  5. Name=David
  6. Permanent=false
  7. Role=Manager
  8. Phone Numbers=[123456, 987654]
  9. Address=BTM 1st Stage, Bangalore, 560100
  10. Cities=[Los Angeles, New York]
  11. Properties={age=28 years, salary=1000 Rs}
  12. *****************************
复制代码

你可以看到，使用Gson是多么的容易，这就是为什么它在JSON处理方面如此风靡。

以上的JSON处理方式是我们所熟知的对象模型，因为整个JSON被一次性的转换为对象了，在大多数情况下这足够了，然而如果JSON确实非常庞大，我们不想将其全部一次性置入内存，Gson也提供了Streaming API。

我们来看一个例子，它展示了如何使用Streaming API进行JSON到Java对象的转换。

EmployeeGsonReader.java
  1. package com.journaldev.json.gson;
  3. import java.io.FileInputStream;
  4. import java.io.IOException;
  5. import java.io.InputStream;
  6. import java.io.InputStreamReader;
  7. import java.util.ArrayList;
  8. import java.util.HashMap;
  9. import java.util.List;
  11. import com.google.gson.stream.JsonReader;
  12. import com.google.gson.stream.JsonToken;
  13. import com.journaldev.json.model.Address;
  14. import com.journaldev.json.model.Employee;
  16. public class EmployeeGsonReader {
  18. public static void main(String[] args) throws IOException {
  19. InputStream is = new FileInputStream("employee.txt");
  20. InputStreamReader isr = new InputStreamReader(is);
  22. //create JsonReader object
  23. JsonReader reader = new JsonReader(isr);
  25. //create objects
  26. Employee emp = new Employee();
  27. Address add = new Address();
  28. emp.setAddress(add);
  29. List<Long> phoneNums = new ArrayList<Long>();
  30. emp.setCities(new ArrayList<String>());
  31. emp.setProperties(new HashMap<String, String>());
  32. String key = null;
  33. boolean insidePropertiesObj=false;
  35. key = parseJSON(reader, emp, phoneNums, key, insidePropertiesObj);
  37. long[] nums = new long[phoneNums.size()];
  38. int index = 0;
  39. for(Long l :phoneNums){
  40. nums[index++] = l;
  41. }
  42. emp.setPhoneNumbers(nums);
  44. reader.close();
  45. //print employee object
  46. System.out.println("Employee Objectnn"+emp);
  47. }
  49. private static String parseJSON(JsonReader reader, Employee emp,
  50. List<Long> phoneNums, String key, boolean insidePropertiesObj) throws IOException {
  52. //loop to read all tokens
  53. while(reader.hasNext()){
  54. //get next token
  55. JsonToken token = reader.peek();
  57. switch(token){
  58. case BEGIN_OBJECT:
  59. reader.beginObject();
  60. if("address".equals(key) || "properties".equals(key)){
  61. while(reader.hasNext()){
  62. parseJSON(reader, emp,phoneNums, key, insidePropertiesObj);
  63. }
  64. reader.endObject();
  65. }
  66. break;
  67. case END_OBJECT:
  68. reader.endObject();
  69. if(insidePropertiesObj) insidePropertiesObj=false;
  70. break;
  71. case BEGIN_ARRAY:
  72. reader.beginArray();
  73. if("phoneNumbers".equals(key) || "cities".equals(key)){
  74. while(reader.hasNext()){
  75. parseJSON(reader, emp,phoneNums, key, insidePropertiesObj);
  76. }
  77. reader.endArray();
  78. }
  79. break;
  80. case END_ARRAY:
  81. reader.endArray();
  82. break;
  83. case NAME:
  84. key = reader.nextName();
  85. if("properties".equals(key)) insidePropertiesObj=true;
  86. break;
  87. case BOOLEAN:
  88. if("permanent".equals(key)) emp.setPermanent(reader.nextBoolean());
  89. else{
  90. System.out.println("Unknown item found with key="+key);
  91. //skip value to ignore it
  92. reader.skipValue();
  93. }
  94. break;
  95. case NUMBER:
  96. if("empID".equals(key)) emp.setId(reader.nextInt());
  97. else if("phoneNumbers".equals(key)) phoneNums.add(reader.nextLong());
  98. else if("zipcode".equals(key)) emp.getAddress().setZipcode(reader.nextInt());
  99. else {
  100. System.out.println("Unknown item found with key="+key);
  101. //skip value to ignore it
  102. reader.skipValue();
  103. }
  104. break;
  105. case STRING:
  106. setStringValues(emp, key, reader.nextString(), insidePropertiesObj);
  107. break;
  108. case NULL:
  109. System.out.println("Null value for key"+key);
  110. reader.nextNull();
  111. break;
  112. case END_DOCUMENT:
  113. System.out.println("End of Document Reached");
  114. break;
  115. default:
  116. System.out.println("This part will never execute");
  117. break;
  119. }
  120. }
  121. return key;
  122. }
  124. private static void setStringValues(Employee emp, String key,
  125. String value, boolean insidePropertiesObj) {
  126. if("name".equals(key)) emp.setName(value);
  127. else if("role".equals(key)) emp.setRole(value);
  128. else if("cities".equals(key)) emp.getCities().add(value);
  129. else if ("street".equals(key)) emp.getAddress().setStreet(value);
  130. else if("city".equals(key)) emp.getAddress().setCity(value);
  131. else{
  132. //add to emp properties map
  133. if(insidePropertiesObj){
  134. emp.getProperties().put(key, value);
  135. }else{
  136. System.out.println("Unknown data found with key="+key+" value="+value);
  137. }
  139. }
  140. }
  142. }
复制代码

由于JSON是一个递归语言（译注：JSON本身并不是“语言”，而是一种表示方法），我们也需要针对数组和嵌套对象递归地调用解析方法。JsonToken是JsonReader中next()方法所返回的Java枚举类型，我们可以用其配合条件逻辑或switch case语句进行转换工作。根据以上代码，你应该能够理解这不是一个简单的实现，如果JSON确实非常复杂，那么代码将会变得极难维护，所以要避免使用这种方式，除非没有其他出路。

我们来看一下如何使用Gson Streaming API写出Employee对象。

EmployeeGsonWriter.java
  1. package com.journaldev.json.gson;
  3. import java.io.IOException;
  4. import java.io.OutputStreamWriter;
  5. import java.util.Set;
  7. import com.google.gson.stream.JsonWriter;
  8. import com.journaldev.json.model.Employee;
  10. public class EmployeeGsonWriter {
  12. public static void main(String[] args) throws IOException {
  13. Employee emp = EmployeeGsonExample.createEmployee();
  15. //writing on console, we can initialize with FileOutputStream to write to file
  16. OutputStreamWriter out = new OutputStreamWriter(System.out);
  17. JsonWriter writer = new JsonWriter(out);
  18. //set indentation for pretty print
  19. writer.setIndent("t");
  20. //start writing
  21. writer.beginObject(); //{
  22. writer.name("id").value(emp.getId()); // "id": 123
  23. writer.name("name").value(emp.getName()); // "name": "David"
  24. writer.name("permanent").value(emp.isPermanent()); // "permanent": false
  25. writer.name("address").beginObject(); // "address": {
  26. writer.name("street").value(emp.getAddress().getStreet()); // "street": "BTM 1st Stage"
  27. writer.name("city").value(emp.getAddress().getCity()); // "city": "Bangalore"
  28. writer.name("zipcode").value(emp.getAddress().getZipcode()); // "zipcode": 560100
  29. writer.endObject(); // }
  30. writer.name("phoneNumbers").beginArray(); // "phoneNumbers": [
  31. for(long num : emp.getPhoneNumbers()) writer.value(num); //123456,987654
  32. writer.endArray(); // ]
  33. writer.name("role").value(emp.getRole()); // "role": "Manager"
  34. writer.name("cities").beginArray(); // "cities": [
  35. for(String c : emp.getCities()) writer.value(c); //"Los Angeles","New York"
  36. writer.endArray(); // ]
  37. writer.name("properties").beginObject(); //"properties": {
  38. Set<String> keySet = emp.getProperties().keySet();
  39. for(String key : keySet) writer.name("key").value(emp.getProperties().get(key));//"age": "28 years","salary": "1000 Rs"
  40. writer.endObject(); // }
  41. writer.endObject(); // }
  43. writer.flush();
  45. //close writer
  46. writer.close();
  48. }
  50. }
复制代码

从Java对象到JSON的转换，与使用streaming API解析相比，相对容易一些，默认情况下JsonWriter会以一种紧凑的格式写入JSON，但也可以设置缩进进行整齐打印。

这就是Gson API演示教程的所有内容，如果你遇到任何问题，请告诉我。以下链接可以下载项目，你可以玩一玩Gson提供的多种选项。

http://www.journaldev.com/?wpdmact=process&did=MzAuaG90bGluaw== 原文链接： Pankaj Kumar 翻译： ImportNew.com - Justin Wu
译文链接： http://www.importnew.com/14509.html
收藏 邀请
上一篇：Java内存模型深度解析：总结下一篇：Java内存模型深度解析：final

最新评论

相关分类

小黑屋|在路上 ( 蜀ICP备15035742号-1 )  

;

GMT+8, 2025-7-8 00:51

Copyright 2015-2025 djqfx

返回顶部