关于云计算:jackson学习之二jacksoncore

https://github.com/zq2599/blog_demos

内容：所有原创文章分类汇总及配套源码，波及 Java、Docker、Kubernetes、DevOPS 等；

这里分类和汇总了欣宸的全副原创(含配套源码)：https://github.com/zq2599/blog_demos

jackson 学习之一：根本信息
jackson 学习之二：jackson-core
jackson 学习之三：罕用 API 操作
jackson 学习之四：WRAP_ROOT_VALUE（root 对象）
jackson 学习之五：JsonInclude 注解
jackson 学习之六：罕用类注解
jackson 学习之七：罕用 Field 注解
jackson 学习之八：罕用办法注解
jackson 学习之九：springboot 整合(配置文件)
jackson 学习之十(终篇)：springboot 整合(配置类)

本文次要内容是 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/blo…：

名称	链接	备注
我的项目主页	https://github.com/zq2599/blo…	该我的项目在 GitHub 上的主页
git 仓库地址(https)	https://github.com/zq2599/blo…	该我的项目源码的仓库地址，https 协定
git 仓库地址(ssh)	git@github.com: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>

在父工程 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: zq2599@gmail.com
 * @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 是否是线程平安的，这是编码前要弄清楚的问题，因为 JsonParser 和 JsonGenerator 的创立都离不开 JsonFactory；
如下图红框所示，jackson 官网文档中明确指出 JsonFactory 是线程平安的 ，能够释怀的作为全局变量给多线程同时应用：

官网文档地址：http://fasterxml.github.io/ja…

新建子工程 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: zq2599@gmail.com
 * @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 系列
Spring 系列
Docker 系列
kubernetes 系列
数据库 + 中间件系列
DevOps 系列

微信搜寻「程序员欣宸」，我是欣宸，期待与您一起畅游 Java 世界 …
https://github.com/zq2599/blog_demos

关于云计算:jackson学习之二jacksoncore

欢送拜访我的 GitHub

欢送拜访我的 GitHub

系列文章汇总

对于 jackson-core

源码下载

创立父子工程

新增子工程 beans

JsonFactory 线程平安吗?

jackson-core 实战

你不孤独，欣宸原创一路相伴

欢送关注公众号：程序员欣宸

Just My Socks（注册教程内含优惠码）

关于云计算:jackson学习之二jacksoncore

欢送拜访我的 GitHub

欢送拜访我的 GitHub

系列文章汇总

对于 jackson-core

源码下载

创立父子工程

新增子工程 beans

JsonFactory 线程平安吗?

jackson-core 实战

你不孤独，欣宸原创一路相伴

欢送关注公众号：程序员欣宸

Just My Socks（注册教程 内含优惠码）

Just My Socks（注册教程内含优惠码）