-
Notifications
You must be signed in to change notification settings - Fork 666
feat: adding JSON overview and Json configuration docs #3102
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
daniCsorbaJB
wants to merge
2
commits into
doc-restructuring-master
Choose a base branch
from
doc-restructuring-update-5
base: doc-restructuring-master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+862
−0
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| [//]: # (title: JSON serialization overview) | ||
|
|
||
| The Kotlin serialization library allows you to easily convert Kotlin objects to JSON and back. | ||
| The [`Json`](https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-json/kotlinx.serialization.json/-json/) class is the primary tool for this, offering flexibility in how JSON is generated and parsed. | ||
| You can configure `Json` instances to handle specific JSON behaviors or use its default instance for basic tasks. | ||
|
|
||
| With the `Json` class, you can: | ||
|
|
||
| * Serialize Kotlin objects to JSON strings using the [`encodeToString()`](https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-json/kotlinx.serialization.json/-json/encode-to-string.html) function. | ||
| * Deserialize JSON strings back to Kotlin objects with the [`decodeFromString()`](https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-json/kotlinx.serialization.json/-json/decode-from-string.html) function. | ||
| * [Work directly with the `JsonElement`](serialization-json-elements.md) when handling complex JSON structures using the [`encodeToJsonElement()`](https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-json/kotlinx.serialization.json/encode-to-json-element.html) and the [`decodeFromJsonElement()`](https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-json/kotlinx.serialization.json/decode-from-json-element.html) functions. | ||
| * Use JVM streams with the [`encodeToStream()`](https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-json/kotlinx.serialization.json/encode-to-stream.html) [`.decodeFromStream()`](https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-json/kotlinx.serialization.json/decode-from-stream.html), and [`.decodeToSequence()`](https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-json/kotlinx.serialization.json/decode-to-sequence.html) functions to work with JSON directly from input and output streams. | ||
|
|
||
| Before you start, import the following declarations from the serialization library: | ||
|
|
||
| ```kotlin | ||
| import kotlinx.serialization.* | ||
| import kotlinx.serialization.json.* | ||
| ``` | ||
|
|
||
| Here's a simple example that uses the default `Json` instance to show how JSON serialization works in Kotlin: | ||
|
|
||
| ```kotlin | ||
| // Imports declarations from the serialization library | ||
| import kotlinx.serialization.* | ||
| import kotlinx.serialization.json.* | ||
|
|
||
| //sampleStart | ||
| @Serializable | ||
| data class User(val name: String, val age: Int) | ||
|
|
||
| fun main() { | ||
| // Uses the default Json instance | ||
| val json = Json | ||
|
|
||
| // Creates a User object | ||
| val user = User("Alice", 30) | ||
|
|
||
| // Converts the User object to a JSON string | ||
| val jsonString = json.encodeToString(user) | ||
| println(jsonString) | ||
| // {"name":"Alice","age":30} | ||
|
|
||
| // Converts the JSON string back to a User object | ||
| val deserializedUser = json.decodeFromString<User>(jsonString) | ||
| println(deserializedUser) | ||
| // User(name=Alice, age=30) | ||
| //sampleEnd | ||
| } | ||
| ``` | ||
| {kotlin-runnable="true"} | ||
|
|
||
| In addition to using the default configuration, you can [customize the `Json` instance](serialization-json-configuration.md) for specific different use cases, | ||
| such as ignoring unknown keys: | ||
|
|
||
| ```kotlin | ||
| // Imports declarations from the serialization library | ||
| import kotlinx.serialization.* | ||
| import kotlinx.serialization.json.* | ||
|
|
||
| @Serializable | ||
| data class Project(val name: String) | ||
|
|
||
| //sampleStart | ||
| // Configures a Json instance to ignore unknown keys | ||
| val customJson = Json { | ||
| ignoreUnknownKeys = true | ||
| } | ||
|
|
||
| fun main() { | ||
| val data = customJson.decodeFromString<Project>(""" | ||
| {"name":"kotlinx.serialization","language":"Kotlin"} | ||
| """) | ||
| println(data) | ||
| // Project(name=kotlinx.serialization) | ||
| } | ||
| //sampleEnd | ||
| ``` | ||
| {kotlin-runnable="true"} | ||
|
|
||
| ## What's next | ||
|
|
||
| * Learn how to [customize `Json` instances](serialization-json-configuration.md) to address different use cases for serialization and deserialization. | ||
| * Explore [advanced JSON element handling](serialization-json-elements.md) to manipulate and work with JSON data before it is parsed or serialized. | ||
| * Discover how to [transform JSON during serialization and deserialization](serialization-transform-json.md) for more control over your data. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this snippet be here? It feels incomplete. You can remove it or add
customJson.decodeFromString()to show what it doesThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it should be.. 🤔 It's probably not too much information for the user learning about it for the first time, so let's just make it a complete example 👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You have one at the beginning of
serialization-json-configuration.mdpage, maybe you can reuse it here