Skip to content

JSTEP 3

Jump to bottom
Tatu Saloranta edited this page Dec 21, 2024 · 55 revisions

(Back to JSTEP page)

JSTEP-3: JsonNode improvements (some for Jackson 3.0, some in 2.x)

Related change issues: [fill me in]

Author

Tatu Saloranta (@cowtowncoder)

Version history

  • 2024-12-21: Further refinement
  • 2024-12-19: Minor additions
  • 2024-06-02: Remove details of JsonNodeFeature
  • 2022-01-16: Add links to JSTEP-7 (new JsonNodeFeature as one of DataTypeFeatures)
  • 2022-01-04: Add ALLOW_ARRAY_MERGE, OBJECT_MERGE JsonNodeFeatures.
  • 2019-01-26: first skeletal revision

Background

Although "Tree Model" -- operating on json content via JsonNode-based object model which represents content exactly as-is, without transformations -- has been around since Jackson 1.0, it has not been worked on as extensively as full databinding to/from POJOs. But it is extensively used and valued by users due to its flexibility. Over time some of original design choices have proven problematic (for example methods not being able to throw JsonProcessingException for invalid coercions; or returning of JsonNode for methods in contaner nodes, preventing chaining of many calls), and in a way that can not be changed without breaking backwards compatibility.

With 3.0 we have a perfect opportunity to further improve JsonNode API, as well as fix problems in return type declarations. We can also benefit from other changes, in particular JSTEP-4 which will make it possible for all methods to throw properly typed exceptions.

Changes: Configurability

As of Jackson 2.x, only some of DeserializationFeatures (and few if any SerializationFeatures) affect handling of JsonNode. This is due to most of them being POJO-centric, as JsonNode is meant to be faithful representation of JSON that was read, or is to be written out, with few changes.

But users do have legitimate need/desire to make some changes. It's just that these changes are not necessarily aligned with changes to POJO handling. For this reason, Jackson 2.14 added JsonNodeFeature for configurability. More details in JSTEP-7.

Changes: Exception reporting

With 3.0, JacksonException becomes unchecked (see JSTEP-4)

This is relevant for JsonNode, too, since we can start throwing formal Jackson exceptions, without having to declare them separately for all (or just some) accessors. This is relevant for a few entries here:

  • JsonNode.toString() can pass any exceptions from real serialization as-is, with no additional wrapping

However: I think it also makes sense to introduce at least one new Jackson exception type, like:

  • ValueCoercionException (similar to new Streaming API exception, InputCoercionException)

which can then be used by methods that attempt coercion (like JsonNode.asIntValue()), but fail due to incompatible types (or perhaps parsing error, from String to number). This exception type should retain and expose information like:

  • Source token type (JsonToken.VALUE_STRING)
  • Target shape (as token, like JsonToken.VALUE_NUMBER_INT)
  • If available, target Java type (java.lang.Integer#type for int, for example)
  • We do not necessarily have information on path, but possibly exception catch/rethrow could re-create this

Changes: Renaming (3.0)

"Text" -> "String"

Rename methods with "text" to use "string", similarly types ("TextNode" -> "StringNode"): deprecate old methods in cases where significant usage exists (textValue(), asText())

Changes: Additional accessors

Additional optional/default getter(s) (2.19)

  • Optional<JsonNode> getOpt(String): for ObjectNode, counterpart to get() / path() (Optional.empty() by non-ObjectNode, or missing entry)
  • Optional<JsonNode> getOpt(int): for ArryNode, counterpart to get() / path() (Optional.empty() by non-ArrayNode, or index out-of-bounds)
    • Alternative names: opt(), getOptional() (shorter, longer)?
  • getOrDefault(String, JsonNode defaultValue): for ObjectNode`; returns "defaultValue" if no such entry, or non-ObjectNode
  • getOrDefault(int, JsonNode defaultValue): for ArrayNode`; returns "defaultValue" if no such element (index-out-of-bounds), or non-ArrayNode
    • Alternative name: getOr() (shorter)

Changes: Additional traversal

Stream access (2.19)

To support Java 8+ Stream traversal, we propose additions of following methods in JsonNode, with actual implementations in ArrayNode and/or ObjectNode (and for other placeholder default):

  • Stream<JsonNode> valueStream() for ArrayNode elements and ObjectNode values; empty Stream for other node types
  • Stream<Map.Entry<String, JsonNode>> for ObjectNode entries; empty Stream for other node types
  • forEachEntry(BiConsumer<? super String, ? super JsonNode>) for iterating over ObjectNode entries; NOP for other node types

In future we could also consider "parallel" variants for streams, and "spliterator". But probably no immediate need.

These can be added in 2.19, no need to wait for 3.0.

Changes: Additional mutation

Removal from Containers (2.19)

  • For ContainerNode (ObjectNode, ArrayNode):
    • removeIf(Predicate<? super JsonNode>): general purpose
    • removeNulls() (short-cut for removeIf(JsonNode::isNullNode))
    • removeEmpty() (short-cut for removeIf(JsonNode::isEmpty))
    • clear() (remove all entries): named similar to Collection operation

These can be added in 2.19, no need to wait for 3.0.

We could consider alternative names:

  • Longer names: removeNullValues(), removeEmptyValues()?
  • Alternate of removeAll() instead of clear()?

Changes: Transformations

Additional asXxx() method(s) (2.19)

  • JsonNode.asArray() to mean "if ArrayNode return as-is -- if not, wrap as 1-element ArrayNode"...
    • What would become of MissingNode? Empty array?
  • JsonNode.asOptional() which would give non-empty Optional<JsonNode> for all nodes EXCEPT for MissingNode for which Optional.empty() would be returned

Changes: Extended set of scalar value accessors

As of 2.x, there are a few accessors for type like, say, int:

  • intValue(): return int if (and only if!) we got numeric integer node (JsonToken.VALUE_NUMBER_INT) -- but won't throw exception, returns default value (0) otherwise
  • asInt(): same as asInt(0)
  • asInt(int defaultValue): return int value from JsonToken.VALUE_NUMBER_INT (if within value range) OR if coercible (from double or String); otherwise return defaultValue

But none actually throws exception: partly due to historical reasons (was not done initially), and also since methods do not expose JacksonException (or IOException). So, due to backwards compatibility.

So there are couple of things to improve:

  1. Should allow throwing exceptions, for case where no default is specified. We can now do this more easily as we throw unchecked exception -- meaning accessors are still safe with Java 8 streaming
  2. Should allow use of Java 8 Optional, as that is useful for stream() operations

This would leave to bigger set of methods, once again for int:

  1. intValue() as before, return value if JsonToken.VALUE_NUMBER_INT, within Java int range -- but if not, throw exception
  2. intValue(int defaultValue) as intValue() except returns defaultValue instead of exception
  3. optIntValue() similar to intValue() but returns OptionalInt, either present (as per intValue()) or absent (instead of exception)
  4. asInt() (or asIntValue()?) similar to intValue() but allows coercion from double and String (and possible with config, from true/false). But if not, throw exception
  5. asInt(int defaultValue) like asInt() but instead of exception, return defaultValue() for case of no valid value
  6. asOptInt() (maybe?): similar to asInt() but instead of exception, return "absent" value

Now: set of operations may be smaller for other more esoteric types.

Changes: Misc added in 2.10

  • JsonNode.toString() will guarantee valid JSON output (assuming default vanilla ObjectMapper settings)
    • JsonNode.isEmpty() works as alias for idiom size() == 0

Changes: "required" methods (added in 2.10)

(note: these were added via databind#2237)

  • required(String / int) for basically "get, throw exception if no node with name/index)
  • requiredAt(JsonPointer): same as above, but with JsonPointer
  • require() -- returns JsonNode (or subtype, co-variant) unless MissingNode; if MissingNode, throw exception (unchecked, Jackson-specific)
  • requireNonNull() -- same as require(), but fail both for MissingNode and NullNode
Clone this wiki locally