Jackson 框架，轻易转换JSON

曾经终败给现在 2022-08-05 07:47 237阅读 0赞

Jackson 框架，轻易转换JSON

Jackson可以轻松的将Java对象转换成json对象和xml文档，同样也可以将json、xml转换成Java对象。

前面有介绍过json-lib这个框架，在线博文：http://www.cnblogs.com/hoojo/archive/2011/04/21/2023805.html

相比json-lib框架，Jackson所依赖的jar包较少，简单易用并且性能也要相对高些。而且Jackson社区相对比较活跃，更新速度也比较快。

一、准备工作

1、 下载依赖库jar包

Jackson的jar all下载地址：http://jackson.codehaus.org/1.7.6/jackson-all-1.7.6.jar

然后在工程中导入这个jar包即可开始工作

官方示例：http://wiki.fasterxml.com/JacksonInFiveMinutes

因为下面的程序是用junit测试用例运行的，所以还得添加junit的jar包。版本是junit-4.2.8

如果你需要转换xml，那么还需要stax2-api.jar

2、 测试类基本代码如下

  1. package com.hoo.test;
  5. import java.io.IOException;
  7. import java.io.StringWriter;
  9. import java.util.ArrayList;
  11. import java.util.HashMap;
  13. import java.util.Iterator;
  15. import java.util.LinkedHashMap;
  17. import java.util.List;
  19. import java.util.Map;
  21. import java.util.Set;
  23. import org.codehaus.jackson.JsonEncoding;
  25. import org.codehaus.jackson.JsonGenerationException;
  27. import org.codehaus.jackson.JsonGenerator;
  29. import org.codehaus.jackson.JsonParseException;
  31. import org.codehaus.jackson.map.JsonMappingException;
  33. import org.codehaus.jackson.map.ObjectMapper;
  35. import org.codehaus.jackson.node.JsonNodeFactory;
  37. import org.codehaus.jackson.xml.XmlMapper;
  39. import org.junit.After;
  41. import org.junit.Before;
  43. import org.junit.Test;
  45. import com.hoo.entity.AccountBean;
  49. /**
  51. * <b>function:</b>Jackson 将java对象转换成JSON字符串，也可以将JSON字符串转换成java对象
  53. * jar-lib-version: jackson-all-1.6.2
  55. * jettison-1.0.1
  57. * @author hoojo
  59. * @createDate 2010-11-23 下午04:54:53
  61. * @file JacksonTest.java
  63. * @package com.hoo.test
  65. * @project Spring3
  67. * @blog http://blog.csdn.net/IBM_hoojo
  69. * @email hoojo_@126.com
  71. * @version 1.0
  73. */
  75. @SuppressWarnings("unchecked")
  77. public class JacksonTest {
  79. private JsonGenerator jsonGenerator = null;
  81. private ObjectMapper objectMapper = null;
  83. private AccountBean bean = null;
  85. @Before
  87. public void init() {
  89. bean = new AccountBean();
  91. bean.setAddress("china-Guangzhou");
  93. bean.setEmail("hoojo_@126.com");
  95. bean.setId(1);
  97. bean.setName("hoojo");
  99. objectMapper = new ObjectMapper();
  101. try {
  103. jsonGenerator = objectMapper.getJsonFactory().createJsonGenerator(System.out, JsonEncoding.UTF8);
  105. } catch (IOException e) {
  107. e.printStackTrace();
  109. }
  111. }
  113. @After
  115. public void destory() {
  117. try {
  119. if (jsonGenerator != null) {
  121. jsonGenerator.flush();
  123. }
  125. if (!jsonGenerator.isClosed()) {
  127. jsonGenerator.close();
  129. }
  131. jsonGenerator = null;
  133. objectMapper = null;
  135. bean = null;
  137. System.gc();
  139. } catch (IOException e) {
  141. e.printStackTrace();
  143. }
  145. }
  147. }

3、 所需要的JavaEntity

  1. package com.hoo.entity;
  5. public class AccountBean {
  7. private int id;
  9. private String name;
  11. private String email;
  13. private String address;
  15. private Birthday birthday;
  17. //getter、setter
  19. @Override
  21. public String toString() {
  23. return this.name + "#" + this.id + "#" + this.address + "#" + this.birthday + "#" + this.email;
  25. }
  27. }

Birthday

  1. package com.hoo.entity;
  5. public class Birthday {
  7. private String birthday;
  9. public Birthday(String birthday) {
  11. super();
  13. this.birthday = birthday;
  15. }
  19. //getter、setter
  23. public Birthday() {}
  25. @Override
  27. public String toString() {
  29. return this.birthday;
  31. }
  33. }

二、Java对象转换成JSON

1、 JavaBean(Entity/Model)转换成JSON

  1. /**
  3. * <b>function:</b>将java对象转换成json字符串
  5. * @author hoojo
  7. * @createDate 2010-11-23 下午06:01:10
  9. */
  11. @Test
  13. public void writeEntityJSON() {
  15. try {
  17. System.out.println("jsonGenerator");
  19. //writeObject可以转换java对象，eg:JavaBean/Map/List/Array等
  21. jsonGenerator.writeObject(bean);
  23. System.out.println();
  25. System.out.println("ObjectMapper");
  27. //writeValue具有和writeObject相同的功能
  29. objectMapper.writeValue(System.out, bean);
  31. } catch (IOException e) {
  33. e.printStackTrace();
  35. }
  37. }

运行后结果如下：

  1. jsonGenerator
  3. {
  4.      "address":"china-Guangzhou","name":"hoojo","id":1,"birthday":null,"email":"hoojo_@126.com"}
  6. ObjectMapper
  8. {
  9.      "address":"china-Guangzhou","name":"hoojo","id":1,"birthday":null,"email":"hoojo_@126.com"}

上面分别利用JsonGenerator的writeObject方法和ObjectMapper的writeValue方法完成对Java对象的转换，二者传递的参数及构造的方式不同；JsonGenerator的创建依赖于ObjectMapper对象。也就是说如果你要使用JsonGenerator来转换JSON，那么你必须创建一个ObjectMapper。但是你用ObjectMapper来转换JSON，则不需要JSONGenerator。

objectMapper的writeValue方法可以将一个Java对象转换成JSON。这个方法的参数一，需要提供一个输出流，转换后可以通过这个流来输出转换后的内容。或是提供一个File，将转换后的内容写入到File中。当然，这个参数也可以接收一个JSONGenerator，然后通过JSONGenerator来输出转换后的信息。第二个参数是将要被转换的Java对象。如果用三个参数的方法，那么是一个Config。这个config可以提供一些转换时的规则，过指定的Java对象的某些属性进行过滤或转换等。

2、 将Map集合转换成Json字符串

  1. /**
  3. * <b>function:</b>将map转换成json字符串
  5. * @author hoojo
  7. * @createDate 2010-11-23 下午06:05:26
  9. */
  11. @Test
  13. public void writeMapJSON() {
  15. try {
  17. Map<String, Object> map = new HashMap<String, Object>();
  19. map.put("name", bean.getName());
  21. map.put("account", bean);
  23. bean = new AccountBean();
  25. bean.setAddress("china-Beijin");
  27. bean.setEmail("hoojo@qq.com");
  29. map.put("account2", bean);
  31. System.out.println("jsonGenerator");
  33. jsonGenerator.writeObject(map);
  35. System.out.println("");
  37. System.out.println("objectMapper");
  39. objectMapper.writeValue(System.out, map);
  41. } catch (IOException e) {
  43. e.printStackTrace();
  45. }
  47. }

转换后结果如下：

  1. jsonGenerator
  3. {
  4.      "account2":{
  5.      "address":"china-Beijin","name":null,"id":0,"birthday":null,"email":"hoojo@qq.com"},"name":"hoojo",
  7. "account":{
  8.      "address":"china-Guangzhou","name":"hoojo","id":1,"birthday":null,"email":"hoojo_@126.com"}}
  10. objectMapper
  12. {
  13.      "account2":{
  14.      "address":"china-Beijin","name":null,"id":0,"birthday":null,"email":"hoojo@qq.com"},"name":"hoojo",
  16. "account":{
  17.      "address":"china-Guangzhou","name":"hoojo","id":1,"birthday":null,"email":"hoojo_@126.com"}}

3、 将List集合转换成json

  1. /**
  3. * <b>function:</b>将list集合转换成json字符串
  5. * @author hoojo
  7. * @createDate 2010-11-23 下午06:05:59
  9. */
  11. @Test
  13. public void writeListJSON() {
  15. try {
  17. List<AccountBean> list = new ArrayList<AccountBean>();
  19. list.add(bean);
  21. bean = new AccountBean();
  23. bean.setId(2);
  25. bean.setAddress("address2");
  27. bean.setEmail("email2");
  29. bean.setName("haha2");
  31. list.add(bean);
  33. System.out.println("jsonGenerator");
  35. //list转换成JSON字符串
  37. jsonGenerator.writeObject(list);
  39. System.out.println();
  41. System.out.println("ObjectMapper");
  43. //用objectMapper直接返回list转换成的JSON字符串
  45. System.out.println("1###" + objectMapper.writeValueAsString(list));
  47. System.out.print("2###");
  49. //objectMapper list转换成JSON字符串
  51. objectMapper.writeValue(System.out, list);
  53. } catch (IOException e) {
  55. e.printStackTrace();
  57. }
  59. }

结果如下：

  1. jsonGenerator
  3. [{
  4.      "address":"china-Guangzhou","name":"hoojo","id":1,"birthday":null,"email":"hoojo_@126.com"},
  6. {
  7.      "address":"address2","name":"haha2","id":2,"birthday":null,"email":"email2"}]
  9. ObjectMapper
  11. 1###[{
  12.      "address":"china-Guangzhou","name":"hoojo","id":1,"birthday":null,"email":"hoojo_@126.com"},
  14. {
  15.      "address":"address2","name":"haha2","id":2,"birthday":null,"email":"email2"}]
  17. 2###[{
  18.      "address":"china-Guangzhou","name":"hoojo","id":1,"birthday":null,"email":"hoojo_@126.com"},
  20. {
  21.      "address":"address2","name":"haha2","id":2,"birthday":null,"email":"email2"}]

外面就是多了个[]中括号；同样Array也可以转换，转换的JSON和上面的结果是一样的，这里就不再转换了。~.~

4、下面来看看jackson提供的一些类型，用这些类型完成json转换；如果你使用这些类型转换JSON的话，那么你即使没有JavaBean(Entity)也可以完成复杂的Java类型的JSON转换。下面用到这些类型构建一个复杂的Java对象，并完成JSON转换。

  1. @Test
  3. public void writeOthersJSON() {
  5. try {
  7. String[] arr = { "a", "b", "c" };
  9. System.out.println("jsonGenerator");
  11. String str = "hello world jackson!";
  13. //byte
  15. jsonGenerator.writeBinary(str.getBytes());
  17. //boolean
  19. jsonGenerator.writeBoolean(true);
  21. //null
  23. jsonGenerator.writeNull();
  25. //float
  27. jsonGenerator.writeNumber(2.2f);
  29. //char
  31. jsonGenerator.writeRaw("c");
  33. //String
  35. jsonGenerator.writeRaw(str, 5, 10);
  37. //String
  39. jsonGenerator.writeRawValue(str, 5, 5);
  41. //String
  43. jsonGenerator.writeString(str);
  45. jsonGenerator.writeTree(JsonNodeFactory.instance.POJONode(str));
  47. System.out.println();
  49. //Object
  51. jsonGenerator.writeStartObject();//{
  53. jsonGenerator.writeObjectFieldStart("user");//user:{
  55. jsonGenerator.writeStringField("name", "jackson");//name:jackson
  57. jsonGenerator.writeBooleanField("sex", true);//sex:true
  59. jsonGenerator.writeNumberField("age", 22);//age:22
  61. jsonGenerator.writeEndObject();//}
  63. jsonGenerator.writeArrayFieldStart("infos");//infos:[
  65. jsonGenerator.writeNumber(22);//22
  67. jsonGenerator.writeString("this is array");//this is array
  69. jsonGenerator.writeEndArray();//]
  71. jsonGenerator.writeEndObject();//}
  73. AccountBean bean = new AccountBean();
  75. bean.setAddress("address");
  77. bean.setEmail("email");
  79. bean.setId(1);
  81. bean.setName("haha");
  83. //complex Object
  85. jsonGenerator.writeStartObject();//{
  87. jsonGenerator.writeObjectField("user", bean);//user:{bean}
  89. jsonGenerator.writeObjectField("infos", arr);//infos:[array]
  91. jsonGenerator.writeEndObject();//}
  93. } catch (Exception e) {
  95. e.printStackTrace();
  97. }
  99. }

运行后，结果如下：

  1. jsonGenerator
  3. "aGVsbG8gd29ybGQgamFja3NvbiE=" true null 2.2c world jac  worl "hello world jackson!" "hello world jackson!"
  5. {
  6.      "user":{
  7.      "name":"jackson","sex":true,"age":22},"infos":[22,"this is array"]}
  9. {
  10.      "user":{
  11.      "address":"address","name":"haha","id":1,"birthday":null,"email":"email"},"infos":["a","b","c"]}

怎么样？构造的json字符串和输出的结果是一致的吧。关键看懂用JSONGenerator提供的方法，完成一个Object的构建。

三、JSON转换成Java对象

1、 将json字符串转换成JavaBean对象

  1. @Test
  3. public void readJson2Entity() {
  5. String json = "{\"address\":\"address\",\"name\":\"haha\",\"id\":1,\"email\":\"email\"}";
  7. try {
  9. AccountBean acc = objectMapper.readValue(json, AccountBean.class);
  11. System.out.println(acc.getName());
  13. System.out.println(acc);
  15. } catch (JsonParseException e) {
  17. e.printStackTrace();
  19. } catch (JsonMappingException e) {
  21. e.printStackTrace();
  23. } catch (IOException e) {
  25. e.printStackTrace();
  27. }
  29. }

很简单，用到了ObjectMapper这个对象的readValue这个方法，这个方法需要提供2个参数。第一个参数就是解析的JSON字符串，第二个参数是即将将这个JSON解析吃什么Java对象，Java对象的类型。当然，还有其他相同签名方法，如果你有兴趣可以一一尝试使用方法，当然使用的方法和当前使用的方法大同小异。运行后，结果如下：

  1. haha
  3. haha#1#address#null#email

2、 将json字符串转换成List集合

  1. /**
  3. * <b>function:</b>json字符串转换成list<map>
  5. * @author hoojo
  7. * @createDate 2010-11-23 下午06:12:01
  9. */
  11. @Test
  13. public void readJson2List() {
  15. String json = "[{\"address\": \"address2\",\"name\":\"haha2\",\"id\":2,\"email\":\"email2\"},"+
  17. "{\"address\":\"address\",\"name\":\"haha\",\"id\":1,\"email\":\"email\"}]";
  19. try {
  21. List<LinkedHashMap<String, Object>> list = objectMapper.readValue(json, List.class);
  23. System.out.println(list.size());
  25. for (int i = 0; i < list.size(); i++) {
  27. Map<String, Object> map = list.get(i);
  29. Set<String> set = map.keySet();
  31. for (Iterator<String> it = set.iterator();it.hasNext();) {
  33. String key = it.next();
  35. System.out.println(key + ":" + map.get(key));
  37. }
  39. }
  41. } catch (JsonParseException e) {
  43. e.printStackTrace();
  45. } catch (JsonMappingException e) {
  47. e.printStackTrace();
  49. } catch (IOException e) {
  51. e.printStackTrace();
  53. }
  55. }

尝试过将上面的JSON转换成List，然后List中存放AccountBean，但结果失败了。但是支持Map集合。因为你转成List.class，但是不知道List存放何种类型。只好默然Map类型。因为所有的对象都可以转换成Map结合，运行后结果如下：

  1. 2
  3. address:address2
  5. name:haha2
  7. id:2
  9. email:email2
  11. address:address
  13. name:haha
  15. id:1
  17. email:email

3、 Json字符串转换成Array数组，由于上面的泛型转换不能识别到集合中的对象类型。所有这里用对象数组，可以解决这个问题。只不过它不再是集合，而是一个数组。当然这个不重要，你可以用Arrays.asList将其转换成List即可。

  1. /**
  3. * <b>function:</b>json字符串转换成Array
  5. * @author hoojo
  7. * @createDate 2010-11-23 下午06:14:01
  9. */
  11. @Test
  13. public void readJson2Array() {
  15. String json = "[{\"address\": \"address2\",\"name\":\"haha2\",\"id\":2,\"email\":\"email2\"},"+
  17. "{\"address\":\"address\",\"name\":\"haha\",\"id\":1,\"email\":\"email\"}]";
  19. try {
  21. AccountBean[] arr = objectMapper.readValue(json, AccountBean[].class);
  23. System.out.println(arr.length);
  25. for (int i = 0; i < arr.length; i++) {
  27. System.out.println(arr[i]);
  29. }
  31. } catch (JsonParseException e) {
  33. e.printStackTrace();
  35. } catch (JsonMappingException e) {
  37. e.printStackTrace();
  39. } catch (IOException e) {
  41. e.printStackTrace();
  43. }
  45. }

运行后的结果：

  1. 2
  3. haha2#2#address2#null#email2
  5. haha#1#address#null#email

4、 Json字符串转换成Map集合

  1. /**
  3. * <b>function:</b>json字符串转换Map集合
  5. * @author hoojo
  7. * @createDate Nov 27, 2010 3:00:06 PM
  9. */
  11. @Test
  13. public void readJson2Map() {
  15. String json = "{\"success\":true,\"A\":{\"address\": \"address2\",\"name\":\"haha2\",\"id\":2,\"email\":\"email2\"},"+
  17. "\"B\":{\"address\":\"address\",\"name\":\"haha\",\"id\":1,\"email\":\"email\"}}";
  19. try {
  21. Map<String, Map<String, Object>> maps = objectMapper.readValue(json, Map.class);
  23. System.out.println(maps.size());
  25. Set<String> key = maps.keySet();
  27. Iterator<String> iter = key.iterator();
  29. while (iter.hasNext()) {
  31. String field = iter.next();
  33. System.out.println(field + ":" + maps.get(field));
  35. }
  37. } catch (JsonParseException e) {
  39. e.printStackTrace();
  41. } catch (JsonMappingException e) {
  43. e.printStackTrace();
  45. } catch (IOException e) {
  47. e.printStackTrace();
  49. }
  51. }

运行后结果如下：

  1. 3
  3. success:true
  5. A:{address=address2, name=haha2, id=2, email=email2}
  7. B:{address=address, name=haha, id=1, email=email}

四、Jackson对XML的支持

Jackson也可以完成java对象到xml的转换，转换后的结果要比json-lib更直观，不过它依赖于stax2-api.jar这个jar包。

  1. /**
  3. * <b>function:</b>java对象转换成xml文档
  5. * 需要额外的jar包 stax2-api.jar
  7. * @author hoojo
  9. * @createDate 2010-11-23 下午06:11:21
  11. */
  13. @Test
  15. public void writeObject2Xml() {
  17. //stax2-api-3.0.2.jar
  19. System.out.println("XmlMapper");
  21. XmlMapper xml = new XmlMapper();
  23. try {
  25. //javaBean转换成xml
  27. //xml.writeValue(System.out, bean);
  29. StringWriter sw = new StringWriter();
  31. xml.writeValue(sw, bean);
  33. System.out.println(sw.toString());
  35. //List转换成xml
  37. List<AccountBean> list = new ArrayList<AccountBean>();
  39. list.add(bean);
  41. list.add(bean);
  43. System.out.println(xml.writeValueAsString(list));
  45. //Map转换xml文档
  47. Map<String, AccountBean> map = new HashMap<String, AccountBean>();
  49. map.put("A", bean);
  51. map.put("B", bean);
  53. System.out.println(xml.writeValueAsString(map));
  55. } catch (JsonGenerationException e) {
  57. e.printStackTrace();
  59. } catch (JsonMappingException e) {
  61. e.printStackTrace();
  63. } catch (IOException e) {
  65. e.printStackTrace();
  67. }
  69. }

运行上面的方法，结果如下：

  1. XmlMapper
  3. <unknown><address>china-Guangzhou</address><name>hoojo</name><id>1</id><birthday/><email>hoojo_@126.com</email></unknown>
  5. <unknown><unknown><address>china-Guangzhou</address><name>hoojo</name><id>1</id><birthday/><email>hoojo_@126.com</email></unknown>
  7. <email><address>china-Guangzhou</address><name>hoojo</name><id>1</id><birthday/><email>hoojo_@126.com</email></email></unknown>
  9. <unknown><A><address>china-Guangzhou</address><name>hoojo</name><id>1</id><birthday/><email>hoojo_@126.com</email></A>
  11. <B><address>china-Guangzhou</address><name>hoojo</name><id>1</id><birthday/><email>hoojo_@126.com</email></B></unknown>

看结果，根节点都是unknown 这个问题还没有解决，由于根节点没有转换出来，所有导致解析xml到Java对象，也无法完成。

发表评论

表情：
评论列表 （有 0 条评论，237人围观）

还没有评论，来说两句吧...

相关阅读