jackson學習之二：jackson-core-有解無憂

歡迎訪問我的GitHub

https://github.com/zq2599/blog_demos

內容：所有原創文章分類匯總及配套原始碼，涉及Java、Docker、Kubernetes、DevOPS等；

系列文章匯總

jackson學習之一：基本資訊
jackson學習之二：jackson-core
jackson學習之三：常用API操作
jackson學習之四：WRAP_ROOT_VALUE（root物件）
jackson學習之五：JsonInclude注解
jackson學習之六：常用類注解
jackson學習之七：常用Field注解
jackson學習之八：常用方法注解
jackson學習之九：springboot整合(組態檔)
jackson學習之十(終篇)：springboot整合(配置類)

關于jackson-core

本文主要內容是jackson-core庫，這是個低階API庫，提供流式決議工具JsonParser，流式生成工具JsonGenerator；
在日常的序列化和反序列化處理中，最常用的是jackson-annotations和jackson-databind，而jackson-core由于它提供的API過于基礎，我們大多數情況下是用不上的；
盡管jackson-databind負責序列化和反序列化處理，但它的底層實作是呼叫了jackson-core的API；
本著萬丈高樓平地起的原則，本文咱們通過實戰了解神秘的jackson-core，了解整個jackson的序列化和反序列化基本原理；

原始碼下載

如果您不想編碼，可以在GitHub下載所有原始碼，地址和鏈接資訊如下表所示(https://github.com/zq2599/blog_demos)：

名稱	鏈接	備注
專案主頁	https://github.com/zq2599/blog_demos	該專案在GitHub上的主頁
git倉庫地址(https)	https://github.com/zq2599/blog_demos.git	該專案原始碼的倉庫地址，https協議
git倉庫地址(ssh)	[email protected]:zq2599/blog_demos.git	該專案原始碼的倉庫地址，ssh協議

這個git專案中有多個檔案夾，本章的應用在jacksondemo檔案夾下，如下圖紅框所示：

在這里插入圖片描述

創建父子工程

創建名為jacksondemo的maven工程，這是個父子結構的工程，其pom.xml內容如下：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <groupId>com.bolingcavalry</groupId>
    <artifactId>jacksondemo</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>pom</packaging>
    <modules>
        <module>core</module>
        <module>beans</module>
        <module>databind</module>
    </modules>
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>com.fasterxml.jackson.core</groupId>
                <artifactId>jackson-databind</artifactId>
                <version>2.11.0</version>
                <scope>compile</scope>
            </dependency>
            <dependency>
                <groupId>org.slf4j</groupId>
                <artifactId>slf4j-log4j12</artifactId>
                <version>1.7.25</version>
                <scope>compile</scope>
            </dependency>
            <dependency>
                <groupId>commons-io</groupId>
                <artifactId>commons-io</artifactId>
                <version>2.7</version>
                <scope>compile</scope>
            </dependency>
            <dependency>
                <groupId>org.apache.commons</groupId>
                <artifactId>commons-lang3</artifactId>
                <version>3.10</version>
                <scope>compile</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>
</project>

新增子工程beans

在父工程jscksondemo下新增名為beans的子工程，這里面是一些常量和Pojo類；
增加定義常量的類Constant.java：

package com.bolingcavalry.jacksondemo.beans;

public class Constant {
    /**
     * 該字串的值是個網路地址，該地址對應的內容是個JSON
     */
    public final static String TEST_JSON_DATA_URL = "https://raw.githubusercontent.com/zq2599/blog_demos/master/files/twitteer_message.json";
    /**
     * 用來驗證反序列化的JSON字串
     */
    public final static String TEST_JSON_STR = "{\n" +
            "  \"id\":1125687077,\n" +
            "  \"text\":\"@stroughtonsmith You need to add a \\\"Favourites\\\" tab to TC/iPhone. Like what TwitterFon did. I can't WAIT for your Twitter App!! :) Any ETA?\",\n" +
            "  \"fromUserId\":855523, \n" +
            "  \"toUserId\":815309,\n" +
            "  \"languageCode\":\"en\"\n" +
            "}";
    /**
     * 用來驗證序列化的TwitterEntry實體
     */
    public final static TwitterEntry TEST_OBJECT = new TwitterEntry();
    /**
     * 準備好TEST_OBJECT物件的各個引數
     */
    static {
        TEST_OBJECT.setId(123456L);
        TEST_OBJECT.setFromUserId(101);
        TEST_OBJECT.setToUserId(102);
        TEST_OBJECT.setText("this is a message for serializer test");
        TEST_OBJECT.setLanguageCode("zh");
    }}

增加一個Pojo，對應的是一條推特訊息：

package com.bolingcavalry.jacksondemo.beans;
/**
 * @Description: 推特訊息bean
 * @author: willzhao E-mail: [email protected]
 * @date: 2020/7/4 16:24
 */
public class TwitterEntry {
    /**
     * 推特訊息id
     */
    long id;
    /**
     * 訊息內容
     */
    String text;    /**
     * 訊息創建者
     */
    int fromUserId;
    /**
     * 訊息接收者
     */
    int toUserId;
    /**
     * 語言型別
     */
    String languageCode;    public long getId() {
        return id;
    }    public void setId(long id) {
        this.id = id;
    }    public String getText() {
        return text;
    }    public void setText(String text) {
        this.text = text;
    }    public int getFromUserId() {
        return fromUserId;
    }    public void setFromUserId(int fromUserId) {
        this.fromUserId = fromUserId;
    }    public int getToUserId() {
        return toUserId;
    }    public void setToUserId(int toUserId) {
        this.toUserId = toUserId;
    }    public String getLanguageCode() {
        return languageCode;
    }    public void setLanguageCode(String languageCode) {
        this.languageCode = languageCode;
    }    public TwitterEntry() {
    }    public String toString() {
        return "[Tweet, id: "+id+", text='"+text+"', from: "+fromUserId+", to: "+toUserId+", lang: "+languageCode+"]";
    }}

以上就是準備作業了，接下來開始實戰jackson-core；

JsonFactory執行緒安全嗎?

JsonFactory是否是執行緒安全的，這是編碼前要弄清楚的問題，因為JsonParser和JsonGenerator的創建都離不開JsonFactory；
如下圖紅框所示，jackson官方檔案中明確指出JsonFactory是執行緒安全的，可以放心的作為全域變數給多執行緒同時使用：

在這里插入圖片描述
3. 官方檔案地址：http://fasterxml.github.io/jackson-core/javadoc/2.11/

jackson-core實戰

新建子工程core，pom.xml如下：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>jacksondemo</artifactId>
        <groupId>com.bolingcavalry</groupId>
        <version>1.0-SNAPSHOT</version>
        <relativePath>../pom.xml</relativePath>
    </parent>
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.bolingcavalry</groupId>
    <artifactId>core</artifactId>
    <name>core</name>
    <description>Demo project for jackson core use</description>
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>8</source>
                    <target>8</target>
                </configuration>
            </plugin>
        </plugins>
    </build>
    <dependencies>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
        </dependency>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-log4j12</artifactId>
        </dependency>
        <dependency>
            <groupId>commons-io</groupId>
            <artifactId>commons-io</artifactId>
        </dependency>
        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-lang3</artifactId>
        </dependency>
        <dependency>
            <groupId>com.bolingcavalry</groupId>
            <artifactId>beans</artifactId>
            <version>${project.version}</version>
        </dependency>
    </dependencies>
</project>

新建StreamingDemo類，這里面是呼叫jackson-core的API進行序列化和反序列化的所有demo，如下：

package com.bolingcavalry.jacksondemo.core;

import com.bolingcavalry.jacksondemo.beans.TwitterEntry;
import com.fasterxml.jackson.core.*;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.commons.io.IOUtils;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.net.URL;

/**
 * @Description: jackson低階方法的使用
 * @author: willzhao E-mail: [email protected]
 * @date: 2020/7/4 15:50
 */
public class StreamingDemo {

    private static final Logger logger = LoggerFactory.getLogger(StreamingDemo.class);

    JsonFactory jsonFactory = new JsonFactory();

    /**
     * 該字串的值是個網路地址，該地址對應的內容是個JSON
     */
    final static String TEST_JSON_DATA_URL = "https://raw.githubusercontent.com/zq2599/blog_demos/master/files/twitteer_message.json";

    /**
     * 用來驗證反序列化的JSON字串
     */
    final static String TEST_JSON_STR = "{\n" +
            "  \"id\":1125687077,\n" +
            "  \"text\":\"@stroughtonsmith You need to add a \\\"Favourites\\\" tab to TC/iPhone. Like what TwitterFon did. I can't WAIT for your Twitter App!! :) Any ETA?\",\n" +
            "  \"fromUserId\":855523, \n" +
            "  \"toUserId\":815309,\n" +
            "  \"languageCode\":\"en\"\n" +
            "}";

    /**
     * 用來驗證序列化的TwitterEntry實體
     */
    final static TwitterEntry TEST_OBJECT = new TwitterEntry();

    /**
     * 準備好TEST_OBJECT物件的各個引數
     */
    static {
        TEST_OBJECT.setId(123456L);
        TEST_OBJECT.setFromUserId(101);
        TEST_OBJECT.setToUserId(102);
        TEST_OBJECT.setText("this is a message for serializer test");
        TEST_OBJECT.setLanguageCode("zh");
    }


    /**
     * 反序列化測驗(JSON -> Object)，入參是JSON字串
     * @param json JSON字串
     * @return
     * @throws IOException
     */
    public TwitterEntry deserializeJSONStr(String json) throws IOException {

        JsonParser jsonParser = jsonFactory.createParser(json);

        if (jsonParser.nextToken() != JsonToken.START_OBJECT) {
            jsonParser.close();
            logger.error("起始位置沒有大括號");
            throw new IOException("起始位置沒有大括號");
        }

        TwitterEntry result = new TwitterEntry();

        try {
            // Iterate over object fields:
            while (jsonParser.nextToken() != JsonToken.END_OBJECT) {

                String fieldName = jsonParser.getCurrentName();

                logger.info("正在決議欄位 [{}]", jsonParser.getCurrentName());

                // 決議下一個
                jsonParser.nextToken();

                switch (fieldName) {
                    case "id":
                        result.setId(jsonParser.getLongValue());
                        break;
                    case "text":
                        result.setText(jsonParser.getText());
                        break;
                    case "fromUserId":
                        result.setFromUserId(jsonParser.getIntValue());
                        break;
                    case "toUserId":
                        result.setToUserId(jsonParser.getIntValue());
                        break;
                    case "languageCode":
                        result.setLanguageCode(jsonParser.getText());
                        break;
                    default:
                        logger.error("未知欄位 '" + fieldName + "'");
                        throw new IOException("未知欄位 '" + fieldName + "'");
                }
            }
        } catch (IOException e) {
            logger.error("反序列化出現例外 :", e);
        } finally {
            jsonParser.close(); // important to close both parser and underlying File reader
        }

        return result;
    }

    /**
     * 反序列化測驗(JSON -> Object)，入參是JSON字串
     * @param url JSON字串的網路地址
     * @return
     * @throws IOException
     */
    public TwitterEntry deserializeJSONFromUrl(String url) throws IOException {
        // 從網路上取得JSON字串
        String json = IOUtils.toString(new URL(TEST_JSON_DATA_URL), JsonEncoding.UTF8.name());

        logger.info("從網路取得JSON資料 :\n{}", json);

        if(StringUtils.isNotBlank(json)) {
            return deserializeJSONStr(json);
        } else {
            logger.error("從網路獲取JSON資料失敗");
            return null;
        }
    }


    /**
     * 序列化測驗(Object -> JSON)
     * @param twitterEntry
     * @return 由物件序列化得到的JSON字串
     */
    public String serialize(TwitterEntry twitterEntry) throws IOException{
        String rlt = null;
        ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
        JsonGenerator jsonGenerator = jsonFactory.createGenerator(byteArrayOutputStream, JsonEncoding.UTF8);

        try {
            jsonGenerator.useDefaultPrettyPrinter();

            jsonGenerator.writeStartObject();
            jsonGenerator.writeNumberField("id", twitterEntry.getId());
            jsonGenerator.writeStringField("text", twitterEntry.getText());
            jsonGenerator.writeNumberField("fromUserId", twitterEntry.getFromUserId());
            jsonGenerator.writeNumberField("toUserId", twitterEntry.getToUserId());
            jsonGenerator.writeStringField("languageCode", twitterEntry.getLanguageCode());
            jsonGenerator.writeEndObject();
        } catch (IOException e) {
            logger.error("序列化出現例外 :", e);
        } finally {
            jsonGenerator.close();
        }

        // 一定要在
        rlt = byteArrayOutputStream.toString();

        return rlt;
    }


    public static void main(String[] args) throws Exception {

        StreamingDemo streamingDemo = new StreamingDemo();

        // 執行一次物件轉JSON操作
        logger.info("********************執行一次物件轉JSON操作********************");
        String serializeResult = streamingDemo.serialize(TEST_OBJECT);
        logger.info("序列化結果是JSON字串 : \n{}\n\n", serializeResult);

        // 用本地字串執行一次JSON轉物件操作
        logger.info("********************執行一次本地JSON反序列化操作********************");
        TwitterEntry deserializeResult = streamingDemo.deserializeJSONStr(TEST_JSON_STR);
        logger.info("\n本地JSON反序列化結果是個java實體 : \n{}\n\n", deserializeResult);

        // 用網路地址執行一次JSON轉物件操作
        logger.info("********************執行一次網路JSON反序列化操作********************");
        deserializeResult = streamingDemo.deserializeJSONFromUrl(TEST_JSON_DATA_URL);
        logger.info("\n網路JSON反序列化結果是個java實體 : \n{}", deserializeResult);

        ObjectMapper a;
    }
}

上述代碼可見JsonParser負責將JSON決議成物件的變數值，核心是回圈處理JSON中的所有內容；
JsonGenerator負責將物件的變數寫入JSON的各個屬性，這里是開發者自行決定要處理哪些欄位；
不論是JsonParser還是JsonGenerator，大家都可以感覺到作業量很大，需要開發者自己動手實作物件和JSON欄位的關系映射，實際應用中不需要咱們這樣辛苦的編碼，jackson的另外兩個庫(annonation的databind)已經幫我們完成了大量作業，上述代碼只是揭示最基礎的jackson執行原理；
執行StreamingDemo類，得到結果如下，序列化和反序列化都成功了：

在這里插入圖片描述

以上就是jackson-core的基本功能，咱們了解了jackson最底層的作業原理，接下來的文章會繼續實踐更多操作；

歡迎關注公眾號：程式員欣宸

微信搜索「程式員欣宸」，我是欣宸，期待與您一同暢游Java世界...

你不孤單，欣宸原創一路相伴

Java系列
Spring系列
Docker系列
kubernetes系列
資料庫+中間件系列
DevOps系列

歡迎關注公眾號：程式員欣宸

微信搜索「程式員欣宸」，我是欣宸，期待與您一同暢游Java世界...
https://github.com/zq2599/blog_demos

轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/252995.html

標籤：Java

上一篇：一個小案例精通lamda運算式與函式式介面

下一篇：jackson學習之二：jackson-core