What’s New in kotlinx.serialization 1.3
In this article, we will learn about the major new features that kotlinx.serialization 1.3 brings for developers to manage JSON parsing more efficiently.
Java IO stream-based JSON serialization
We can now read and write JSON directly to network streams or files.
IO stream serialization is currently available only on the JVM platform and for the JSON format.
API includes two main methods:
- Json.decodeFromStream()
- Json.encodeToStream()
Property-level control over default value encoding
We can force the library to encode the default values by setting the encodeDefaults property of a Json instance to true:
val format = Json { encodeDefaults = true } // false by default- In
1.3.0we can control it at the property level by using the experimental@EncodeDefaultannotation. - It has a higher priority level than the
encodeDefaultsproperty.
It has two possible values:
The default value is ALWAYS
- ALWAYS: encodes a property’s default value.
- NEVER: doesn’t
encode the default valueregardless of theJsonconfiguration.
Excluding null values from serialization
explicitNulls: Another way to reduce the size of the generatedJSON Stringsis by omittingnullvalues.- It defines whether
null property valuesshould be included in theSerialized JSON String. - It’s
trueby default, so allnullsare stored as the values of their corresponding properties.
- Missing field exception 🥵
To deserialize objects from JSON with omitted nulls, we need to make sure that
Json instancewithexplicitNulls == falseis used.It sets all omitted nullable properties to
nullunless they havedefault values.
- Try to decode a
JSON stringwith omitted nulls withexplicitNulls == true (default)it willthrowa MissingFieldException
Custom polymorphic class discriminators
- In hierarchy serialization, a useful attribute comes into play — class discriminator.
- It stores the exact class of the object that was encoded.
- By default, it has the name
typeand contains a fully qualified class name of theobjectbeingserialized.
In 1.3.0, By using @JsonClassDiscriminator’s
discriminatorproperty we can set a custom discriminator name for each class hierarchy.
