Jackson之jackson-core

江鹏飞

2023-12-01

原文链接：http://www.dubby.cn/detail.html?id=9069

我们在这里使用jackson-core提供的JsonParser和JsonGenerator来实现基本的序列化和反序列化。

1.数据和实体类

我们先定义出JSON字符串:

{
  "id":123456789,
  "text":"我是杨正，我在http://www.dubby.cn",
  "fromUserId":123456, 
  "toUserId":789,
  "languageCode":"zh"
}

给出我们等会解析出来后承载数据的POJO:

public class TwitterEntry {
    long _id;
    String _text;
    int _fromUserId, _toUserId;
    String _languageCode;

    public TwitterEntry() {
    }

    public void setId(long id) {
        _id = id;
    }

    public void setText(String text) {
        _text = text;
    }

    public void setFromUserId(int id) {
        _fromUserId = id;
    }

    public void setToUserId(int id) {
        _toUserId = id;
    }

    public void setLanguageCode(String languageCode) {
        _languageCode = languageCode;
    }

    public long getId() {
        return _id;
    }

    public String getText() {
        return _text;
    }

    public int getFromUserId() {
        return _fromUserId;
    }

    public int getToUserId() {
        return _toUserId;
    }

    public String getLanguageCode() {
        return _languageCode;
    }

    public String toString() {
        return "[Tweet, id: " + _id + ", text: " + _text + "', from: " + _fromUserId + ", to: " + _toUserId + ", lang: " + _languageCode + "]";
    }
}

2.反序列化Unmarshalling(JSON->POJO)

private static TwitterEntry read(JsonParser jp) throws IOException {
        // 检查是否是JSON
        if (jp.nextToken() != JsonToken.START_OBJECT) {
            throw new IOException("Expected data to start with an Object");
        }
        TwitterEntry result = new TwitterEntry();
        // 遍历属性，并一个一个的赋值
        while (jp.nextToken() != JsonToken.END_OBJECT) {
            String fieldName = jp.getCurrentName();
            jp.nextToken();
            switch (fieldName) {
                case "id":
                    result.setId(jp.getLongValue());
                    break;
                case "text":
                    result.setText(jp.getText());
                    break;
                case "fromUserId":
                    result.setFromUserId(jp.getIntValue());
                    break;
                case "toUserId":
                    result.setToUserId(jp.getIntValue());
                    break;
                case "languageCode":
                    result.setLanguageCode(jp.getText());
                    break;
                default:
                    throw new IOException("Unrecognized field '" + fieldName + "'");
            }
        }
        //关闭 parser
        jp.close();
        return result;
    }

调用地方如下:

JsonFactory jsonF = new JsonFactory();

        String jsonStr = "{\n" +
                "  \"id\":123456789,\n" + 
                "  \"text\":\"我是杨正，我在http://www.dubby.cn\",\n" +
                "  \"fromUserId\":123456, \n" +
                "  \"toUserId\":789,\n" +
                "  \"languageCode\":\"zh\"\n" +
                "}";
        System.out.println(jsonStr);

        JsonParser jp = jsonF.createParser(jsonStr);
        TwitterEntry entry = read(jp);
        System.out.println(entry.toString());

3.序列化Marshalling(POJO -> JSON)

private static void write(JsonGenerator jg, TwitterEntry entry) throws IOException {
        jg.writeStartObject();
        jg.writeNumberField("id", entry.getId());
        jg.writeStringField("text", entry.getText());
        jg.writeNumberField("fromUserId", entry.getFromUserId());
        jg.writeNumberField("toUserId", entry.getToUserId());
        jg.writeStringField("langugeCode", entry.getLanguageCode());
        jg.writeEndObject();
        jg.close();
    }

调用如下:

ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
        JsonGenerator jg = jsonF.createGenerator(byteArrayOutputStream, JsonEncoding.UTF8);
        jg.useDefaultPrettyPrinter();
        write(jg, entry);
        System.out.println(byteArrayOutputStream.toString());

4.更多的选项

4.1 JsonFactory的选项（命名规范化）

只针对属性名

JsonFactory f = new JsonFactory();
f.disable(JsonFactory.Feature.CANONICALIZE_FIELD_NAMES);

选项名	默认值	意义
CANONICALIZE_FIELD_NAMES	true	意思是一旦名字字符串从输入（字节或字符流）被解码，它将被添加到一个符号表中，以减少在下次看到同一名字时被解码的开销（由同一工厂构造的任何解析器）
INTERN_FIELD_NAMES	true	1、如果canonicalization被启用，这个特性决定了是否被解码的字符串是否会使用String.intern（）——这个在很多时候可以提高反序列化的性能。这样做可以进一步提高反序列化的性能，因为可以使用标识比较。2、如果字符串不会重复，或者不同的字符串数量太多（成千上万），那可能要考虑关闭这个选项，不然会占用太多的内存。
FAIL_ON_SYMBOL_HASH_OVERFLOW(2.4支持)	true	由于规范化使用基于散列的方法将字节/字符序列解析为名称，所以理论上可以构造具有非常高的冲突率的名称集合。如果是这样，哈希查找的性能可能会严重降低。为了防止这种可能性，符号表使用启发式来基于异常高的碰撞次数来检测可能的攻击。
USE_THREAD_LOCAL_FOR_BUFFER_RECYCLING(2.6支持)	true	由于分配char []和byte []缓冲区用于内容读取/写入具有显着的影响，尤其是在处理相对较小的文档时，默认情况下JsonFactory使用SoftReference的ThreadLocal来引用BufferRecycler：这允许在多个读取/写操作。一般情况下这个选项打开对性能室友帮助的，但是在Android平台上，SoftReferences的处理是次要的，导致回收没有帮助，甚至可能只是增加了一些开销，所以可以考虑关闭。但是在关闭前请保证(a)你知道你在干什么，(b)获得可测量的性能提升。

4.2 JsonGenerator的选项

JsonFactory f = new JsonFactory();
f.enable(JsonGenerator.Feature.ESCAPE_NON_ASCII);
f.disable(JsonGenerator.Feature.AUTO_CLOSE_TARGET);
JsonGenerator g = f.createGenerator(destination);
g.enable(JsonGenerator.Feature.STRICT_DUPLICATE_DETECTION);

选项名	默认值	意义
AUTO_CLOSE_TARGET	true	当generator.close()调用，决定目标资源(OutputStream, Writer)是否会被自动关闭(就算这个资源不是generator创建的)
FLUSH_PASSED_TO_STREAM	true	确定对JsonGenerator.flush()的调用是否也将调用基础目标上的flush(); 如果禁用，flush()将仅写入未刷新的内容; 如果启用，也会调用flush()。
AUTO_CLOSE_JSON_CONTENT	true
QUOTE_FIELD_NAMES	true
QUOTE_NON_NUMERIC_NUMBERS	true
WRITE_NUMBERS_AS_STRINGS	false
WRITE_BIGDECIMAL_AS_PLAIN(2.3支持)	false
ESCAPE_NON_ASCII	false
STRICT_DUPLICATE_DETECTION(2.3支持)	false
IGNORE_UNKNOWN(2.5支持)	false

4.3 JsonParser的选项

JsonFactory f = new JsonFactory();
f.enable(JsonParser.Feature.ALLOW_COMMENTS);
f.disable(JsonParser.Feature.ALLOW_SINGLE_QUOTES);
JsonParser p = f.createParser(jsonSource);
p.enable(JsonParser.Feature.STRICT_DUPLICATE_DETECTION);

选项名	默认值	意义
AUTO_CLOSE_SOURCE	true
ALLOW_COMMENTS	false	对于JSON来说，支持`\\`和`\**\`风格的注释
ALLOW_YAML_COMMENTS	false
ALLOW_UNQUOTED_FIELD_NAMES	false
ALLOW_SINGLE_QUOTES	false
ALLOW_UNQUOTED_CONTROL_CHARS	false
ALLOW_BACKSLASH_ESCAPING_ANY_CHARACTER	false
ALLOW_NUMERIC_LEADING_ZEROS	false
ALLOW_NON_NUMERIC_NUMBERS	false
ALLOW_MISSING_VALUES(2.8支持)	false
STRICT_DUPLICATE_DETECTION(2.3支持)	false
IGNORE_UNDEFINED2.6支持	false

这里给出一个示例:

JsonFactory jsonF = new JsonFactory();

        String jsonStr = "{\n" +
                "  \"id\":123456789,\n" + "//注释1\n" + "/*注释1*/\n" +
                "  \"text\":\"我是杨正，我在http://www.dubby.cn\",\n" +
                "  \"fromUserId\":123456, \n" +
                "  \"toUserId\":789,\n" +
                "  \"languageCode\":\"zh\"\n" +
                "}";
        System.out.println(jsonStr);

        JsonParser jp = jsonF.createParser(jsonStr);
        //特意在上面的JSON字符串种加入一些注释，如果在此处不开启允许注释，会报错
        jp.enable(JsonParser.Feature.ALLOW_COMMENTS);
        TwitterEntry entry = read(jp);
        System.out.println(entry.toString());

结果:

{
  "id":123456789,
//注释1
/*注释1*/
  "text":"我是杨正，我在http://www.dubby.cn",
  "fromUserId":123456, 
  "toUserId":789,
  "languageCode":"zh"
}
[Tweet, id: 123456789, text: 我是杨正，我在http://www.dubby.cn', from: 123456, to: 789, lang: zh]

Jackson之jackson-core

1.数据和实体类

2.反序列化Unmarshalling(JSON->POJO)

3.序列化Marshalling(POJO -> JSON)

4.更多的选项

4.1 JsonFactory的选项（命名规范化）

4.2 JsonGenerator的选项

4.3 JsonParser的选项

相关阅读

相关文章

相关问答

相关文档