JsonNode中asText和toString的区别

最新推荐文章于 2023-11-21 15:48:09 发布

原创最新推荐文章于 2023-11-21 15:48:09 发布 · 2.7k 阅读

3 ·

CC 4.0 BY-SA版权

文章标签：

#json

新手小白技术专栏收录该内容

23 篇文章

订阅专栏

在处理JsonNode时，发现使用`toString()`输出字段包含额外引号，原因是`toString()`方法由子类（如TextNode）实现，可能添加引号。而`asText()`方法则直接返回字段值，不添加额外字符。使用`asText()`可以避免此问题。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

在工作中遇到了一个问题，在对比两个JSON的时候，使用到了JsonNode。但是在内容输出的时候遇到了问题。

问题

原始的json举例如下：

{
  "strKey":"value",
  "intKey":1
}

当我们使用JsonNode输出strKey的时候，结果竟然不是**“value"而是”“value”"**

String jsonStr = "{\"strKey\":\"value\",\"intKey\":1}";
ObjectMapper mapper = new ObjectMapper();
JsonNode source = mapper.readTree(jsonStr);
source.get("strKey").toString();

原因

toString()方法的原因

// JsonNode是一个抽象类
public abstract class JsonNode
    extends JsonSerializable.Base // i.e. implements JsonSerializable
    implements TreeNode, Iterable<JsonNode>
{
  ...

  @Override
  public abstract String toString();
}

如上代码所见，JsonNode是一个抽象类，其中的toString()方法是交给他的子类去实现的。那么我们在进行toString的时候，去调用了什么子类去实现呢？ 去使用了JsonNode的TextNode子类，用了它的toString()方法

我们查询源码会发现：

mapper.readTree() 的源码主要如下

public JsonNode readTree(String content)
    throws IOException, JsonProcessingException
{
    JsonNode n = (JsonNode) _readMapAndClose(_jsonFactory.createParser(content), JSON_NODE_TYPE);
    return (n == null) ? NullNode.instance : n;
}

其中关键是执行了_readMapAndClose方法，这个方法中关键源码如下：

 protected Object _readMapAndClose(JsonParser p0, JavaType valueType)
        throws IOException
 {
   ...
 	 JsonDeserializer<Object> deser = _findRootDeserializer(ctxt, valueType);
   if (cfg.useRootWrapping()) {
        result = _unwrapAndDeserialize(p, ctxt, cfg, valueType, deser);
   } else {
       // 主要的步骤 
        result = deser.deserialize(p, ctxt);
   }
   ...
 }

找到JsonNodeDeserializer下的deserialize方法

public JsonNode deserialize(JsonParser p, DeserializationContext ctxt) throws IOException
{
    switch (p.getCurrentTokenId()) {
    case JsonTokenId.ID_START_OBJECT: // 执行此步骤
        return deserializeObject(p, ctxt, ctxt.getNodeFactory());
    case JsonTokenId.ID_START_ARRAY:
        return deserializeArray(p, ctxt, ctxt.getNodeFactory());
    default:
        return deserializeAny(p, ctxt, ctxt.getNodeFactory());
    }
}

本文中的例子，会调用deserializeObject方法，这个方法中我们看到，

首先会生成一个ObjectNode；
根据JsonParser中的id信息，将对应的field信息生成出对应的具体JsonNode实现，如TextNode、IntNode等；
将对应的node，按照fieldName，Node，放入在ObjectNode中的类成员变量_children中，protected final Map<String, JsonNode> _children;

protected final ObjectNode deserializeObject(JsonParser p, DeserializationContext ctxt,
        final JsonNodeFactory nodeFactory) throws IOException
{
		// 生成一个ObjectNode
    ObjectNode node = nodeFactory.objectNode();
    String key;
    if (p.isExpectedStartObjectToken()) {
        key = p.nextFieldName();
    } else {
        JsonToken t = p.getCurrentToken();
        if (t == JsonToken.END_OBJECT) {
            return node;
        }
        if (t != JsonToken.FIELD_NAME) {
            return (ObjectNode) ctxt.handleUnexpectedToken(handledType(), p);
        }
        key = p.getCurrentName();
    }
    for (; key != null; key = p.nextFieldName()) {
        JsonNode value;
        JsonToken t = p.nextToken();
        if (t == null) {
            throw ctxt.mappingException("Unexpected end-of-input when binding data into ObjectNode");
        }
        switch (t.id()) {
        case JsonTokenId.ID_START_OBJECT:
            value = deserializeObject(p, ctxt, nodeFactory);
            break;
        case JsonTokenId.ID_START_ARRAY:
            value = deserializeArray(p, ctxt, nodeFactory);
            break;
        case JsonTokenId.ID_EMBEDDED_OBJECT:
            value = _fromEmbedded(p, ctxt, nodeFactory);
            break;
        case JsonTokenId.ID_STRING: // 根据JsonParser中的id信息，利用nodeFactory生成对应的node
            value = nodeFactory.textNode(p.getText());
            break;
        case JsonTokenId.ID_NUMBER_INT:
            value = _fromInt(p, ctxt, nodeFactory);
            break;
        case JsonTokenId.ID_TRUE:
            value = nodeFactory.booleanNode(true);
            break;
        case JsonTokenId.ID_FALSE:
            value = nodeFactory.booleanNode(false);
            break;
        case JsonTokenId.ID_NULL:
            value = nodeFactory.nullNode();
            break;
        default:
            value = deserializeAny(p, ctxt, nodeFactory);
        }
        JsonNode old = node.replace(key, value);
        if (old != null) {
            _handleDuplicateField(p, ctxt, nodeFactory,
                    key, node, old, value);
        }
    }
    return node;
}

结论

ObjectMapper 在readTree的时候，会将文本信息转化为一个JsonParser；
JsonParser中会将每个关键的field信息存放，如名称、内容、类别（开始结束符号？字符串？数字？对象）；
ObjectMapper._readMapAndClose方法，会生成一个ObjectNode，并根据JsonParser中的信息，将每个field按照类别生成出对应的Node实例，以Map<String, JsonNode>放在 _children中；
我们在使用ObjectNode.get(“strKey”)方法时候，会取出对应的实例，然后执行其中的方法；这就造成了，我们执行get(“strKey”).toString()代码时候，执行了TextNode中的toString()方法；输出了额外的引号；

toString()方法

然后 TextNode继承实现了ValueNode

public class TextNode
    extends ValueNode
{
  ...
	/**
    * Different from other values, Strings need quoting
  */
   @Override
  public String toString()
    {
      int len = _value.length();
      len = len + 2 + (len >> 4);
      StringBuilder sb = new StringBuilder(len);
      appendQuoted(sb, _value);
      return sb.toString();
    }

  protected static void appendQuoted(StringBuilder sb, String content)
  {
    sb.append('"');
    CharTypes.appendQuoted(sb, content);
    sb.append('"');
  }
}

我们发现在TextNode中，实现toString()方法的时候，对值进行了"的包裹，所以导致了上述问题的产生；

如何避免这个问题呢？

asText()方法

@Override
public String asText() {
    return _value;
}

使用asText方法即可，这个方法会直接返回value的值，不会对其进行任何的包裹。