Сериализация JSON с использованием источников ввода-вывода

Сериализация JSON в выходные потоки JVM

Используйте функцию расширения .encodeToStream(), чтобы сериализовать JSON непосредственно в OutputStream JVM:

// Imports declarations from the serialization library
import kotlinx.serialization.*
import kotlinx.serialization.json.*
import java.io.FileOutputStream

@Serializable
data class Project(val name: String, val stars: Int)

fun main() {
    val project = Project("kotlinx.serialization", 9000)
    
    // Creates an OutputStream for the project.json file
    FileOutputStream("project.json").use { output ->
        
        // Serializes the project instance into the OutputStream
        Json.encodeToStream(project, output)
    }
}

В этом примере представление Project в формате JSON сериализуется в файл project.json.

Десериализация JSON из входных потоков JVM

Чтобы десериализовать JSON непосредственно из InputStream JVM, используйте функцию расширения .decodeFromStream():

// Imports declarations from the serialization library
import kotlinx.serialization.*
import kotlinx.serialization.json.*
import java.io.FileInputStream

@Serializable
data class Project(val name: String, val stars: Int)

fun main() {
    // Opens an InputStream
    FileInputStream("project.json").use { input ->

        // Deserializes the JSON contents of the InputStream into a Project instance
        val project = Json.decodeFromStream<Project>(input)

        // Prints the deserialized Project instance
        println(project)
    }
}

В этом примере содержимое JSON из входного потока десериализуется в один экземпляр Project.

Если входные данные содержат несколько объектов JSON в массиве верхнего уровня или объекты, разделенные пробельными символами, можно использовать .decodeToSequence() для ленивой обработки элементов. Это позволяет обрабатывать каждое значение по мере его разбора, например:

// Imports declarations from the serialization library
import kotlinx.serialization.*
import kotlinx.serialization.json.*
import java.io.FileInputStream

@Serializable
data class Project(val name: String, val stars: Int)

fun main() {
    // Opens an InputStream for the projects.json file containing a JSON array of Project objects
    FileInputStream("projects.json").use { input ->

        // Lazily deserializes each Project from the InputStream
        val projects = Json.decodeToSequence<Project>(input)

        // Processes elements one by one
        for (project in projects) {
            println(project)
        }
    }
}

Сериализация JSON с kotlinx-io и Okio

Помимо потоков JVM, можно работать с JSON, используя типы ввода-вывода, например kotlinx.io.Sink и kotlinx.io.Source из библиотеки kotlinx-io (в настоящее время находится на уровне стабильности Alpha), а также okio.BufferedSink и okio.BufferedSource из библиотеки Okio.

Для чтения и записи JSON напрямую с помощью этих типов ввода-вывода можно использовать следующие функции расширения Json:

• .encodeToSink() и .encodeToBufferedSink() — для записи JSON в kotlinx.io.Sink или okio.BufferedSink.

• .decodeFromSource() и .decodeFromBufferedSource() — для чтения одного значения JSON из kotlinx.io.Source или okio.BufferedSource.

• .decodeSourceToSequence() и .decodeBufferedSourceToSequence() — для ленивого декодирования нескольких значений JSON в виде Sequence<T>.

В следующих разделах приведены примеры использования типов kotlinx-io с этими API.
Типы Okio можно использовать аналогичным образом с соответствующими API okio.BufferedSink и okio.BufferedSource.

// build.gradle(.kts)
dependencies {
    implementation("org.jetbrains.kotlinx:kotlinx-serialization-json-io:1.11.0")
    implementation("org.jetbrains.kotlinx:kotlinx-io-core:0.9.1")
}

<!-- pom.xml -->
<dependencies>
    <dependency>
        <groupId>org.jetbrains.kotlinx</groupId>
        <artifactId>kotlinx-serialization-json-io</artifactId>
        <version>1.11.0</version>
    </dependency>
    <dependency>
        <groupId>org.jetbrains.kotlinx</groupId>
        <artifactId>kotlinx-io-core</artifactId>
        <version>0.9.1</version>
    </dependency>
</dependencies>

// build.gradle(.kts)
dependencies {
    implementation("org.jetbrains.kotlinx:kotlinx-serialization-json-okio:1.11.0")
    implementation("com.squareup.okio:okio:3.16.2")
}

<!-- pom.xml -->
<dependencies>
    <dependency>
        <groupId>org.jetbrains.kotlinx</groupId>
        <artifactId>kotlinx-serialization-json-okio</artifactId>
        <version>1.11.0</version>
    </dependency>
    <dependency>
        <groupId>com.squareup.okio</groupId>
        <artifactId>okio</artifactId>
        <version>3.16.2</version>
    </dependency>
</dependencies>

// Imports declarations from the serialization library
import kotlinx.serialization.*
import kotlinx.serialization.json.*

// Imports declarations for kotlinx-io types and JSON I/O support
import kotlinx.serialization.json.io.*
import kotlinx.io.*
import kotlinx.io.files.*

@Serializable
data class Project(val name: String, val stars: Int)

@OptIn(ExperimentalSerializationApi::class)
fun main() {
    val project = Project("kotlinx.serialization", 9000)

    // Creates a Sink for the project.json file
    val path = Path("project.json")
    SystemFileSystem.sink(path).buffered().use { sink: Sink ->

        // Serializes the Project instance directly into a Sink
        Json.encodeToSink(project, sink)
    }
}

// Imports declarations from the serialization library
import kotlinx.serialization.*
import kotlinx.serialization.json.*

// Imports declarations for kotlinx-io types and JSON I/O support
import kotlinx.serialization.json.io.*
import kotlinx.io.*
import kotlinx.io.files.*

@Serializable
data class Project(val name: String, val stars: Int)

@OptIn(ExperimentalSerializationApi::class)
fun main() {
    // Opens a Source for the project.json file
    val path = Path("project.json")
    SystemFileSystem.source(path).buffered().use { source: Source ->

        // Deserializes a Project instance directly from a Source
        val project = Json.decodeFromSource<Project>(source)

        println(project)
    }
}

// Imports declarations from the serialization library
import kotlinx.serialization.*
import kotlinx.serialization.json.*

// Imports declarations for kotlinx-io types and JSON I/O support
import kotlinx.serialization.json.io.*
import kotlinx.io.*
import kotlinx.io.files.*

@Serializable
data class Project(val name: String, val stars: Int)

@OptIn(ExperimentalSerializationApi::class)
fun main() {
    // Opens a Source for the projects.json file containing multiple JSON objects
    val path = Path("projects.json")
    SystemFileSystem.source(path).buffered().use { source: Source ->

        // Lazily deserializes each Project as it is read from the Source
        val projects: Sequence<Project> = Json.decodeSourceToSequence(source)

        for (project in projects) {
            println(project)
        }
    }
}

Что дальше

• Узнайте, как настраивать экземпляры Json для различных сценариев сериализации и десериализации.

• Изучите расширенную обработку элементов JSON, чтобы манипулировать данными JSON и работать с ними до их разбора или сериализации.

• Узнайте, как преобразовывать JSON при сериализации и десериализации, чтобы получить больше контроля над данными.