Java序列化篇之Json解析工具Jackson

json 的解析包:

<!--核心類 -->
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-core</artifactId>
    <version>2.9.6</version>
</dependency>
<!--注解-->
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-annotations</artifactId>
    <version>2.9.6</version>
</dependency>
<!--數(shù)據(jù)綁定-->
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.9.6</version>
</dependency>

Jackson的基本應(yīng)用:

JsonNode 類是 Jackson 的一個(gè)將 Json 內(nèi)容反序列到內(nèi)存的一種內(nèi)存數(shù)據(jù)結(jié)構(gòu)表達(dá)方式。
例如對(duì)于一個(gè)測(cè)試的Json內(nèi)容:

{
  "name" : "test",
  "value" : 20,
  "address" : [
    {
     "addressId" : "0001" 
    },
    {
    "addressId" : "0002"
    }
  ]
}

當(dāng)我們把json內(nèi)容反序列化到內(nèi)存中的時(shí)候，便可以如同操作一個(gè)樹結(jié)構(gòu)讀取json內(nèi)容:

String name = node.get("name").asText();
Integer value = node.get("value").asInt();
Iterator<JsonNode> addressNodes = node.get("address").elements();
String address = addressNodes.next().get("addressId").asText();

從上我們可以發(fā)現(xiàn)， jackson 可以方便的進(jìn)行節(jié)點(diǎn)定位跟類型轉(zhuǎn)換。

如何才能將json內(nèi)容轉(zhuǎn)換成 JsonNode 呢 ？

  • 文件字符串解析
public static JsonNode str2JsonNode(String str) throws IOException {
    ObjectMapper objectMapper = new ObjectMapper();
    return objectMapper.readTree(str);
}
  • stream 解析
public static JsonNode str2JsonNode(InputStream stream) throws IOException {
    ObjectMapper objectMapper = new ObjectMapper();
    return objectMapper.readTree(stream);
}
  • file 解析
public static JsonNode str2JsonNode(File file) throws IOException {
    ObjectMapper objectMapper = new ObjectMapper();
    return objectMapper.readTree(file);
}
  • reader 解析
public static JsonNode str2JsonNode(Reader reader) throws IOException {
    ObjectMapper objectMapper = new ObjectMapper();
    return objectMapper.readTree(reader);
}
  • bytes 解析
public static JsonNode str2JsonNode(byte[] datas) throws IOException {
    ObjectMapper objectMapper = new ObjectMapper();
    return objectMapper.readTree(datas);
}

Json 與 基本類型的相互轉(zhuǎn)化:

readValue 方法能夠幫助我們將字符串序列化成指定的

 public static Object json2Object(String str) throws IOException {
    ObjectMapper objectMapper = new ObjectMapper();
    JsonNode node = objectMapper.readTree(str);
    if(node.isObject()){
        return objectMapper.readValue(str, Map.class);
    }else if(node.isArray()){
        return objectMapper.readValue(str, List.class);
    }else{
        if (node.isInt()) {
            return node.asInt();
        } else if (node.isLong()) {
            return node.asLong();
        } else if (node.isDouble()) {
            return node.asDouble();
        } else if(node.isTextual()) {
            return node.asText();
        } else if (node.isNull()){
            return null;
        }
        else {
            throw new IOException("Json node exception type :  " + node.numberType());
        }
    }
}

例如上面的字符串我們將其解析為 常見的Map結(jié)構(gòu):

Map map = JsonUtil.json2Bean(str, Map.class);
System.out.println(map.get("address"));
List<Map<String, String>> list = (List<Map<String, String>>)map.get("address");
System.out.println(list.get(1).get("addressId"));

當(dāng)然我們也可以通過 writeValue的方式將普通類型轉(zhuǎn)換成 String 打印出來:

public static String object2Str(Object object, boolean prettyPrint) throws IOException {
    ObjectMapper objectMapper = new ObjectMapper();

    // 美化方式打印
    if(prettyPrint){
        ObjectWriter write = objectMapper.writerWithDefaultPrettyPrinter();
        return write.writeValueAsString(object);
    }
    // 單行打印
    return objectMapper.writeValueAsString(object);
}

String 與 Bean 的相互轉(zhuǎn)化

  • 轉(zhuǎn)換工具方法為:
public static <T> T str2Bean(String str, Class<T> beanClass) throws IOException {
    ObjectMapper mapper = new ObjectMapper();
    return mapper.readValue(str, beanClass);
}

要將 string -> bean , 對(duì)于每一個(gè) jsonStr, 我們都需要?jiǎng)?chuàng)建一個(gè)與之對(duì)應(yīng)的 bean class.

例如 :

{
  "name" : "test",
  "value" : 20
}

對(duì)應(yīng)的 Bean 為 :

public class Persion {
    private String name;
    private int value;

    public void setName(String name) {
        this.name = name;
    }

    public void setValue(int value) {
        this.value = value;
    }
    
}

我們通過 Persion persion = JsonUtil.str2Bean(str, Persion.class); 這時(shí)候會(huì)通過 setter 方法將json內(nèi)容注入到 Persion類的對(duì)應(yīng)字段中。

如果 json 中的 key 與 Bean 中的字段名稱不對(duì)應(yīng)，我們可以通過 @JsonProperty 注解為其聲明對(duì)應(yīng)關(guān)系。
@JsonProperty 注解可以用于 getter,setter,或者構(gòu)造函數(shù)參數(shù)中。
例如 :

public class Persion {
    private String name;
    private int value;

    @JsonProperty("v-name")
    public void setName(String name) {
        this.name = name;
    }

    @JsonProperty("v-value")
    public void setValue(int value) {
        this.value = value;
    }
}
  • 排除未知的字段@JsonIgnoreProperties(ignoreUnknown = true)

有時(shí)候json中出了具有bean聲明的字段以外，有時(shí)候還會(huì)有其他信息，但這些信息并不是我們所關(guān)系的，我們這時(shí)候就需要舍棄這部分內(nèi)容， 我們可以在類開始處使用 @JsonIgnoreProperties(ignoreUnknown = true) 注解，忽略掉不匹配或者轉(zhuǎn)換失敗的字段。

@JsonIgnoreProperties(ignoreUnknown = true)
public class Persion {
    private String name;
    private int value;

    @JsonProperty("v-name")
    public void setName(String name) {
        this.name = name;
    }

    @JsonProperty("v-value")
    public void setValue(int value) {
        this.value = value;
    }
}
  • 自定義序列號(hào)與反序列化方式:

有時(shí)候 json 與 bean 并不是簡單的對(duì)應(yīng)關(guān)系， 反序列化過程往往存在困難， 例如對(duì)于開始處這個(gè) json 內(nèi)容 :

{
  "name" : "test",
  "value" : 20,
  "address" : [
    {
     "addressId" : "0001" 
    },
    {
    "addressId" : "0002"
    }
  ]
}

我們的對(duì)應(yīng) bean 為：

public class Persion {
    private String name;
    private int value;
    private List<Address> address;
}

public class Address {
    private String addressId;

    public void setAddressId(String addressId) {
        this.addressId = addressId;
    }
}

正常情況下， 對(duì)于 address 字段會(huì)映射為 List<Map> 類型, 但是此處我們需要讓他自動(dòng)轉(zhuǎn)換為 List<Address>
這時(shí)候就需要我們自定義反序列化過程:

反序列化類需要繼承 JsonDeserializer<T> 泛型對(duì)應(yīng)反序列化的返回類型 ：

反序列化工具類

public class AddressDeserde extends JsonDeserializer<List> {
    public List deserialize(JsonParser jsonParser, DeserializationContext deserializationContext) throws IOException, JsonProcessingException {
        ObjectMapper mapper = new ObjectMapper();
        JsonNode nodes = mapper.readTree(jsonParser);

        List<Address> addresses = new LinkedList<Address>();

        for(JsonNode node :  Lists.newArrayList(nodes.elements())){
            System.out.println(node.toString());
            addresses.add(JsonUtil.str2Bean(node.toString(), Address.class));
        }
        return addresses;
    }
}

然后便可以再 bean 中字段指名反序列化工具：

@JsonIgnoreProperties(ignoreUnknown = true)
public class Persion {
    private String name;
    private int value;
    private List<Address> address;

    @JsonProperty("v-name")
    public void setName(String name) {
        this.name = name;
    }

    @JsonProperty("v-value")
    public void setValue(int value) {
        this.value = value;
    }


    @JsonProperty("address")
    @JsonDeserialize(using = bean.AddressDeserde.class)
    public void setAddress(List<Address> address) {
        this.address = address;
    }

    @Override
    public String toString() {
        return "Persion{" +
                "name='" + name + '\'' +
                ", value=" + value +
                ", addresses=" + address +
                '}';
    }
}

這時(shí)候便可以用了。

同樣的，我們要自定義序列化方式需要繼承 JsonSerializer<T> 抽象方法

例如對(duì)于 address 的字段，的序列化過程:

public class AddressSerde extends JsonSerializer<List<Address>> {
    @Override
    public void serialize(List<Address> addresses, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {

        jsonGenerator.writeStartArray();
        for(Address address : addresses){
            jsonGenerator.writeObject(address);
        }
        jsonGenerator.writeEndArray();


    }
}

我們可以在 getter 方法中加入序列化方式:

@JsonProperty("v-address")
@JsonSerialize(using = bean.AddressSerde.class)
public List<Address> getAddress() {
    return address;
}

然后便能夠成功的解析出 List<Address>

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡書系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具（例如配置管理，服務(wù)發(fā)現(xiàn)，斷路器，智...
    卡卡羅2017閱讀 136,502評(píng)論 19贊 139
  • Spring Web MVC Spring Web MVC 是包含在 Spring 框架中的 Web 框架，建立于...
    Hsinwong閱讀 22,931評(píng)論 1贊 92
  • Spring Boot 參考指南 介紹 轉(zhuǎn)載自:https://www.gitbook.com/book/qbgb...
    毛宇鵬閱讀 47,253評(píng)論 6贊 342
  • 1.1 spring IoC容器和beans的簡介 Spring 框架的最核心基礎(chǔ)的功能是IoC（控制反轉(zhuǎn)）容器，...
    simoscode閱讀 6,844評(píng)論 2贊 22
  • 感恩陳斯載我去工地見客戶，還請(qǐng)吃飯、下午茶哈哈，還學(xué)到很多東西 感恩東莞的秋天還是夏天～短袖好舒服 感恩朋友請(qǐng)吃玉...
    愛眉小札夏大寶閱讀 185評(píng)論 0贊 0

友情鏈接更多精彩內(nèi)容