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.10
如果你需要转换xml,那么还需要stax2-api.jar
2、 测试类基本代码如下
package com.zhuc.javalibtest.jackson;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import org.codehaus.jackson.JsonEncoding;
import org.codehaus.jackson.JsonGenerator;
import org.codehaus.jackson.JsonParseException;
import org.codehaus.jackson.map.JsonMappingException;
import org.codehaus.jackson.map.ObjectMapper;
import org.codehaus.jackson.node.JsonNodeFactory;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
/**
* @author zhuc
* @version 2012-5-25 上午10:33:48
*/
public class JacksonTest {
private JsonGenerator jsonGenerator = null;
private ObjectMapper objectMapper = null;
/**
*
*/
@Before
public void init() {
objectMapper = new ObjectMapper();
try {
jsonGenerator = objectMapper.getJsonFactory().createJsonGenerator(
System.out, JsonEncoding.UTF8);
} catch (IOException e) {
e.printStackTrace();
}
}
/**
*
*/
@After
public void destory() {
try {
if (jsonGenerator != null) {
jsonGenerator.flush();
if (!jsonGenerator.isClosed()) {
jsonGenerator.close();
}
}
jsonGenerator = null;
objectMapper = null;
System.gc();
} catch (IOException e) {
e.printStackTrace();
}
}
}
package com.zhuc.javalibtest.jackson;
/**
* @author zhuc
* @version 2012-5-25 上午11:14:52
*/
public class Car {
private String name;
private Integer capacity;
/**
* @return the name
*/
public String getName() {
return name;
}
/**
* @param name
* the name to set
*/
public void setName(String name) {
this.name = name;
}
/**
* @return the capacity
*/
public Integer getCapacity() {
return capacity;
}
/**
* @param capacity
* the capacity to set
*/
public void setCapacity(Integer capacity) {
this.capacity = capacity;
}
}
二、 Java 对象转换成 JSON
1、 JavaBean(Entity/Model)转换成JSON
/**
* 将javaBean对象转换成json字符串
*/
@Test
public void writeEntityJSON() {
try {
System.out.println("jsonGenerator");
// writeObject可以转换java对象,eg:JavaBean/Map/List/Array等
Car c = new Car();
c.setName("zhuc-jackson-car");
c.setCapacity(100);
jsonGenerator.writeObject(c);
System.out.println();
System.out.println("ObjectMapper");
// writeValue具有和writeObject相同的功能
objectMapper.writeValue(System.out, c);
} catch (IOException e) {
e.printStackTrace();
}
}
运行后结果如下:
jsonGenerator
{"name":"zhuc-jackson-car","capacity":100}
ObjectMapper
{"name":"zhuc-jackson-car","capacity":100}
上面分别利用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对象的某些属性进行过滤或转换等。
(注:objectMapper的writeValue方法默认使用编码为JsonEncoding.UTF-8,而JsonGenerator的writeObject方法可以手动指定编码,如init方法中所示。)
2、 将Map集合转换成Json字符串
/**
* 将map转换成json字符串
*/
@Test
public void writeMapJSON() {
try {
Map<String, Object> map = new HashMap<String, Object>();
Car c1 = new Car();
c1.setName("zhuc-jackson-car1");
c1.setCapacity(100);
map.put("name", "hello"); //需要注意,此name与car1、car2同级
map.put("car1", c1);
Car c2 = new Car();
c2.setName("zhuc-jackson-car2");
c2.setCapacity(200);
map.put("car2", c2);
System.out.println("jsonGenerator");
jsonGenerator.writeObject(map);
System.out.println();
System.out.println("objectMapper");
objectMapper.writeValue(System.out, map);
} catch (IOException e) {
e.printStackTrace();
}
}
输出结果如下:
jsonGenerator
{"name":"hello","car2":{"name":"zhuc-jackson-car2","capacity":200},"car1":{"name":"zhuc-jackson-car1","capacity":100}}
objectMapper
{"name":"hello","car2":{"name":"zhuc-jackson-car2","capacity":200},"car1":{"name":"zhuc-jackson-car1","capacity":100}}
3、 将List集合转换成json
/**
* 将list集合转换成json字符串
*/
@Test
public void writeListJSON() {
try {
List<Car> list = new ArrayList<Car>();
Car c1 = new Car();
c1.setName("zhuc-jackson-car1");
c1.setCapacity(100);
Car c2 = new Car();
c2.setName("zhuc-jackson-car2");
c2.setCapacity(200);
list.add(c1);
list.add(c2);
System.out.println("jsonGenerator");
// list转换成JSON字符串
jsonGenerator.writeObject(list);
System.out.println();
System.out.println("ObjectMapper");
// 用objectMapper直接返回list转换成的JSON字符串
System.out.println("1###" + objectMapper.writeValueAsString(list));
System.out.print("2###");
// objectMapper list转换成JSON字符串
objectMapper.writeValue(System.out, list);
} catch (IOException e) {
e.printStackTrace();
}
}
输出结果如下:
jsonGenerator
[{"name":"zhuc-jackson-car1","capacity":100},{"name":"zhuc-jackson-car2","capacity":200}]
ObjectMapper
1###[{"name":"zhuc-jackson-car1","capacity":100},{"name":"zhuc-jackson-car2","capacity":200}]
2###[{"name":"zhuc-jackson-car1","capacity":100},{"name":"zhuc-jackson-car2","capacity":200}]
4、下面来看看jackson提供的一些类型,用这些类型完成json转换;如果你使用这些类型转换JSON的话,那么你即使没有 JavaBean(Entity)也可以完成复杂的Java类型的JSON转换。下面用到这些类型构建一个复杂的Java对象,并完成JSON转换。
/**
* json字符串转换成其他
*/
@Test
public void writeOthersJSON() {
try {
String[] arr = { "a", "b", "c" };
System.out.println("jsonGenerator");
String str = "hello world jackson!";
// byte
jsonGenerator.writeBinary(str.getBytes());
// boolean
jsonGenerator.writeBoolean(true);
// null
jsonGenerator.writeNull();
// float
jsonGenerator.writeNumber(2.2f);
// char
jsonGenerator.writeRaw("c");
// String
jsonGenerator.writeRaw(str, 5, 10);
// String
jsonGenerator.writeRawValue(str, 5, 5);
// String
jsonGenerator.writeString(str);
jsonGenerator.writeTree(JsonNodeFactory.instance.POJONode(str));
System.out.println();
// Object
jsonGenerator.writeStartObject();// {
jsonGenerator.writeObjectFieldStart("user");// user:{
jsonGenerator.writeStringField("name", "jackson");// name:jackson
jsonGenerator.writeBooleanField("sex", true);// sex:true
jsonGenerator.writeNumberField("age", 22);// age:22
jsonGenerator.writeEndObject();// }
jsonGenerator.writeArrayFieldStart("infos");// infos:[
jsonGenerator.writeNumber(22);// 22
jsonGenerator.writeString("this is array");// this is array
jsonGenerator.writeEndArray();// ]
jsonGenerator.writeEndObject();// }
Car bean = new Car();
bean.setCapacity(110);
bean.setName("zhuc-car");
// complex Object
jsonGenerator.writeStartObject();// {
jsonGenerator.writeObjectField("user", bean);// user:{bean}
jsonGenerator.writeObjectField("infos", arr);// infos:[array]
jsonGenerator.writeEndObject();// }
} catch (Exception e) {
e.printStackTrace();
}
}
输出结果如下:
jsonGenerator
"aGVsbG8gd29ybGQgamFja3NvbiE=" true null 2.2c world jac worl "hello world jackson!" "hello world jackson!"
{"user":{"name":"jackson","sex":true,"age":22},"infos":[22,"this is array"]} {"user":{"name":"zhuc-car","capacity":110},"infos":["a","b","c"]}
三、 JSON 转换成 Java 对象
1、 将json字符串转换成JavaBean对象
/**
* json字符串转换成JavaBean对象
*/
@Test
public void readJson2Entity() {
String json = "{\"capacity\":\"300\",\"name\":\"zhuc-car\"}";
try {
Car c = objectMapper.readValue(json, Car.class);
System.out.println(c.getName());
System.out.println(c.getCapacity());
} catch (JsonParseException e) {
e.printStackTrace();
} catch (JsonMappingException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
输出结果如下:
zhuc-car
300
用到了ObjectMapper这个对象的readValue这个方法,这个方法需要提供2个参数。第一个参数就是解析的JSON字符串,第二个参数是即 将将这个JSON解析吃什么Java对象,Java对象的类型。当然,还有其他相同签名方法,如果你有兴趣可以一一尝试使用方法,当然使用的方法和当前使 用的方法大同小异。
2、 将json字符串转换成List<Map>集合
/**
* json字符串转换成List
*/
@SuppressWarnings({ "unchecked", "rawtypes" })
@Test
public void readJson2List() {
String json = "[{\"capacity\": \"300\",\"name\":\"car1\"},"
+ "{\"capacity\":\"400\",\"name\":\"car2\"}]";
try {
List<Object> list = objectMapper.readValue(json, List.class);
// 此处readValue方法返回的其实是一个List<LinkedHashMap> 集合,可以debug观察
System.out.println(list.size());
for (Object o : list) {
LinkedHashMap map = (LinkedHashMap) o;
System.out.println(map.get("name") + "," + map.get("capacity"));
}
} catch (JsonParseException e) {
e.printStackTrace();
} catch (JsonMappingException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
输出结果如下:
2
car1,300
car2,400
返回的其实是一个List<LinkedHashMap>
3、 Json字符串转换成Array数组,由于上面的泛型转换不能识别到集合中的对象类型。所有这里用对象数组,可以解决这个问题。只不过它不再是集合,而是一个数组。当然这个不重要,你可以用Arrays.asList将其转换成List即可。
/**
* json字符串转换成Array
*/
@Test
public void readJson2Array() {
String json = "[{\"capacity\": \"10\",\"name\":\"car2\"},"
+ "{\"capacity\":\"20\",\"name\":\"car1\"}]";
try {
Car[] arr = objectMapper.readValue(json, Car[].class);
System.out.println(arr.length);
for (int i = 0; i < arr.length; i++) {
System.out.println(arr[i].getName() + ","
+ arr[i].getCapacity());
}
} catch (JsonParseException e) {
e.printStackTrace();
} catch (JsonMappingException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
输出结果如下:
2
car2,10
car1,20
4、 Json字符串转换成Map集合
/**
* json字符串转换Map集合
*/
@SuppressWarnings("unchecked")
@Test
public void readJson2Map() {
String json = "{\"success\":true,\"A\":{\"address\": \"address2\",\"name\":\"haha2\",\"id\":2,\"email\":\"email2\"},"
+ "\"B\":{\"address\":\"address\",\"name\":\"haha\",\"id\":1,\"email\":\"email\"}}";
try {
Map<String, Object> maps = objectMapper.readValue(json, Map.class);
System.out.println(maps.size());
for (Map.Entry<String, Object> entry : maps.entrySet()) {
System.out.println(entry.getKey() + "," + entry.getValue());
System.out.println(entry.getValue() instanceof Map);
}
} catch (JsonParseException e) {
e.printStackTrace();
} catch (JsonMappingException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
输出结果如下:
3
success,true
false
A,{address=address2, name=haha2, id=2, email=email2}
true
B,{address=address, name=haha, id=1, email=email}
true
可以看到,json值还是一个Map,jackson会自动检查并封装
文章转自http://www.cnblogs.com/hoojo/archive/2011/04/22/2024628.html