天天看點

Jackson 架構,輕易轉換JSON

Jackson 架構,輕易轉換JSON

Jackson可以輕松的将Java對象轉換成json對象和xml文檔,同樣也可以将json、xml轉換成Java對象。

相比json-lib架構,Jackson所依賴的jar包較少,簡單易用并且性能也要相對高些。而且Jackson社群相對比較活躍,更新速度也比較快。

一、準備工作

1、 下載下傳依賴庫jar包

然後在工程中導入這個jar包即可開始工作

因為下面的程式是用junit測試用例運作的,是以還得添加junit的jar包。版本是junit-4.2.8

如果你需要轉換xml,那麼還需要stax2-api.jar

2、 測試類基本代碼如下

package com.hoo.test;

import java.io.IOException;

import java.io.StringWriter;

import java.util.ArrayList;

import java.util.HashMap;

import java.util.Iterator;

import java.util.LinkedHashMap;

import java.util.List;

import java.util.Map;

import java.util.Set;

import org.codehaus.jackson.JsonEncoding;

import org.codehaus.jackson.JsonGenerationException;

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.codehaus.jackson.xml.XmlMapper;

import org.junit.After;

import org.junit.Before;

import org.junit.Test;

import com.hoo.entity.AccountBean;

/**

* <b>function:</b>Jackson 将java對象轉換成JSON字元串,也可以将JSON字元串轉換成java對象

* jar-lib-version: jackson-all-1.6.2

* jettison-1.0.1

* @author hoojo

* @createDate 2010-11-23 下午04:54:53

* @file JacksonTest.java

* @package com.hoo.test

* @project Spring3

* @email [email protected]

* @version 1.0

*/

@SuppressWarnings("unchecked")

public class JacksonTest {

    private JsonGenerator jsonGenerator = null;

    private ObjectMapper objectMapper = null;

    private AccountBean bean = null;

    @Before

    public void init() {

        bean = new AccountBean();

        bean.setAddress("china-Guangzhou");

        bean.setEmail("[email protected]");

        bean.setId(1);

        bean.setName("hoojo");

        objectMapper = new ObjectMapper();

        try {

            jsonGenerator = objectMapper.getJsonFactory().createJsonGenerator(System.out, JsonEncoding.UTF8);

        } catch (IOException e) {

            e.printStackTrace();

        }

    }

    @After

    public void destory() {

            if (jsonGenerator != null) {

                jsonGenerator.flush();

            }

            if (!jsonGenerator.isClosed()) {

                jsonGenerator.close();

            jsonGenerator = null;

            objectMapper = null;

            bean = null;

            System.gc();

}

3、 所需要的JavaEntity

package com.hoo.entity;

public class AccountBean {

    private int id;

    private String name;

    private String email;

    private String address;

    private Birthday birthday;

    //getter、setter

    @Override

    public String toString() {

        return this.name + "#" + this.id + "#" + this.address + "#" + this.birthday + "#" + this.email;

Birthday

public class Birthday {

    private String birthday;

    public Birthday(String birthday) {

        super();

        this.birthday = birthday;

    public Birthday() {}

        return this.birthday;

二、Java對象轉換成JSON

1、 JavaBean(Entity/Model)轉換成JSON

* <b>function:</b>将java對象轉換成json字元串

* @createDate 2010-11-23 下午06:01:10

@Test

public void writeEntityJSON() {

    try {

        System.out.println("jsonGenerator");

        //writeObject可以轉換java對象,eg:JavaBean/Map/List/Array等

        jsonGenerator.writeObject(bean);   

        System.out.println();

        System.out.println("ObjectMapper");

        //writeValue具有和writeObject相同的功能

        objectMapper.writeValue(System.out, bean);

    } catch (IOException e) {

        e.printStackTrace();

運作後結果如下:

jsonGenerator

{"address":"china-Guangzhou","name":"hoojo","id":1,"birthday":null,"email":"[email protected]"}

ObjectMapper

上面分别利用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字元串

* <b>function:</b>将map轉換成json字元串

* @createDate 2010-11-23 下午06:05:26

public void writeMapJSON() {

        Map<String, Object> map = new HashMap<String, Object>();

        map.put("name", bean.getName());

        map.put("account", bean);

        bean.setAddress("china-Beijin");

        bean.setEmail("[email protected]");

        map.put("account2", bean);

        jsonGenerator.writeObject(map);

        System.out.println("");

        System.out.println("objectMapper");

        objectMapper.writeValue(System.out, map);

轉換後結果如下:

{"account2":{"address":"china-Beijin","name":null,"id":0,"birthday":null,"email":"[email protected]"},"name":"hoojo",

"account":{"address":"china-Guangzhou","name":"hoojo","id":1,"birthday":null,"email":"[email protected]"}}

objectMapper

3、 将List集合轉換成json

* <b>function:</b>将list集合轉換成json字元串

* @createDate 2010-11-23 下午06:05:59

public void writeListJSON() {

        List<AccountBean> list = new ArrayList<AccountBean>();

        list.add(bean);

        bean.setId(2);

        bean.setAddress("address2");

        bean.setEmail("email2");

        bean.setName("haha2");

        //list轉換成JSON字元串

        jsonGenerator.writeObject(list);

        //用objectMapper直接傳回list轉換成的JSON字元串

        System.out.println("1###" + objectMapper.writeValueAsString(list));

        System.out.print("2###");

        //objectMapper list轉換成JSON字元串

        objectMapper.writeValue(System.out, list);

結果如下:

[{"address":"china-Guangzhou","name":"hoojo","id":1,"birthday":null,"email":"[email protected]"},

{"address":"address2","name":"haha2","id":2,"birthday":null,"email":"email2"}]

1###[{"address":"china-Guangzhou","name":"hoojo","id":1,"birthday":null,"email":"[email protected]"},

2###[{"address":"china-Guangzhou","name":"hoojo","id":1,"birthday":null,"email":"[email protected]"},

外面就是多了個[]中括号;同樣Array也可以轉換,轉換的JSON和上面的結果是一樣的,這裡就不再轉換了。~.~

4、下面來看看jackson提供的一些類型,用這些類型完成json轉換;如果你使用這些類型轉換JSON的話,那麼你即使沒有JavaBean(Entity)也可以完成複雜的Java類型的JSON轉換。下面用到這些類型建構一個複雜的Java對象,并完成JSON轉換。

public void writeOthersJSON() {

        String[] arr = { "a", "b", "c" };

        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);

        jsonGenerator.writeRawValue(str, 5, 5);

        jsonGenerator.writeString(str);

        jsonGenerator.writeTree(JsonNodeFactory.instance.POJONode(str));

        //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();//]

        AccountBean bean = new AccountBean();

        bean.setAddress("address");

        bean.setEmail("email");

        bean.setName("haha");

        //complex Object

        jsonGenerator.writeObjectField("user", bean);//user:{bean}

        jsonGenerator.writeObjectField("infos", arr);//infos:[array]

    } catch (Exception e) {

運作後,結果如下:

"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":{"address":"address","name":"haha","id":1,"birthday":null,"email":"email"},"infos":["a","b","c"]}

怎麼樣?構造的json字元串和輸出的結果是一緻的吧。關鍵看懂用JSONGenerator提供的方法,完成一個Object的建構。

三、JSON轉換成Java對象

1、 将json字元串轉換成JavaBean對象

public void readJson2Entity() {

    String json = "{\"address\":\"address\",\"name\":\"haha\",\"id\":1,\"email\":\"email\"}";

        AccountBean acc = objectMapper.readValue(json, AccountBean.class);

        System.out.println(acc.getName());

        System.out.println(acc);

    } catch (JsonParseException e) {

    } catch (JsonMappingException e) {

很簡單,用到了ObjectMapper這個對象的readValue這個方法,這個方法需要提供2個參數。第一個參數就是解析的JSON字元串,第二個參數是即将将這個JSON解析吃什麼Java對象,Java對象的類型。當然,還有其他相同簽名方法,如果你有興趣可以一一嘗試使用方法,當然使用的方法和目前使用的方法大同小異。運作後,結果如下:

haha

haha#1#address#null#email

2、 将json字元串轉換成List<Map>集合

* <b>function:</b>json字元串轉換成list<map>

* @createDate 2010-11-23 下午06:12:01

public void readJson2List() {

    String json = "[{\"address\": \"address2\",\"name\":\"haha2\",\"id\":2,\"email\":\"email2\"},"+

                "{\"address\":\"address\",\"name\":\"haha\",\"id\":1,\"email\":\"email\"}]";

        List<LinkedHashMap<String, Object>> list = objectMapper.readValue(json, List.class);

        System.out.println(list.size());

        for (int i = 0; i < list.size(); i++) {

            Map<String, Object> map = list.get(i);

            Set<String> set = map.keySet();

            for (Iterator<String> it = set.iterator();it.hasNext();) {

                String key = it.next();

                System.out.println(key + ":" + map.get(key));

嘗試過将上面的JSON轉換成List,然後List中存放AccountBean,但結果失敗了。但是支援Map集合。因為你轉成List.class,但是不知道List存放何種類型。隻好默然Map類型。因為所有的對象都可以轉換成Map結合,運作後結果如下:

2

address:address2

name:haha2

id:2

email:email2

address:address

name:haha

id:1

email:email

3、 Json字元串轉換成Array數組,由于上面的泛型轉換不能識别到集合中的對象類型。所有這裡用對象數組,可以解決這個問題。隻不過它不再是集合,而是一個數組。當然這個不重要,你可以用Arrays.asList将其轉換成List即可。

* <b>function:</b>json字元串轉換成Array

* @createDate 2010-11-23 下午06:14:01

public void readJson2Array() {

            "{\"address\":\"address\",\"name\":\"haha\",\"id\":1,\"email\":\"email\"}]";

        AccountBean[] arr = objectMapper.readValue(json, AccountBean[].class);

        System.out.println(arr.length);

        for (int i = 0; i < arr.length; i++) {

            System.out.println(arr[i]);

運作後的結果:

haha2#2#address2#null#email2

4、 Json字元串轉換成Map集合

* <b>function:</b>json字元串轉換Map集合

* @createDate Nov 27, 2010 3:00:06 PM

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\"}}";

        Map<String, Map<String, Object>> maps = objectMapper.readValue(json, Map.class);

        System.out.println(maps.size());

        Set<String> key = maps.keySet();

        Iterator<String> iter = key.iterator();

        while (iter.hasNext()) {

            String field = iter.next();

            System.out.println(field + ":" + maps.get(field));

3

success:true

A:{address=address2, name=haha2, id=2, email=email2}

B:{address=address, name=haha, id=1, email=email}

四、Jackson對XML的支援

Jackson也可以完成java對象到xml的轉換,轉換後的結果要比json-lib更直覺,不過它依賴于stax2-api.jar這個jar包。

* <b>function:</b>java對象轉換成xml文檔

* 需要額外的jar包 stax2-api.jar

* @createDate 2010-11-23 下午06:11:21

public void writeObject2Xml() {

    //stax2-api-3.0.2.jar

    System.out.println("XmlMapper");

    XmlMapper xml = new XmlMapper();

        //javaBean轉換成xml

        //xml.writeValue(System.out, bean);

        StringWriter sw = new StringWriter();

        xml.writeValue(sw, bean);

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

        //List轉換成xml

        System.out.println(xml.writeValueAsString(list));

        //Map轉換xml文檔

        Map<String, AccountBean> map = new HashMap<String, AccountBean>();

        map.put("A", bean);

        map.put("B", bean);

        System.out.println(xml.writeValueAsString(map));

    } catch (JsonGenerationException e) {

運作上面的方法,結果如下:

XmlMapper

<unknown><address>china-Guangzhou</address><name>hoojo</name><id>1</id><birthday/><email>[email protected]</email></unknown>

<unknown><unknown><address>china-Guangzhou</address><name>hoojo</name><id>1</id><birthday/><email>[email protected]</email></unknown>

<email><address>china-Guangzhou</address><name>hoojo</name><id>1</id><birthday/><email>[email protected]</email></email></unknown>

<unknown><A><address>china-Guangzhou</address><name>hoojo</name><id>1</id><birthday/><email>[email protected]</email></A>

<B><address>china-Guangzhou</address><name>hoojo</name><id>1</id><birthday/><email>[email protected]</email></B></unknown>

看結果,根節點都是unknown 這個問題還沒有解決,由于根節點沒有轉換出來,所有導緻解析xml到Java對象,也無法完成。

若轉載請注明出處!若有疑問,請回複交流!