Kotlin/kotlinx.serialization
Kotlinx.serialization
kotlinx.serialization is an official Kotlin library that provides a multiplatform serialization framework for converting Kotlin objects to and from multiple data formats. It uses a Kotlin compiler plugin to generate serializer and deserializer code at compile time, avoiding runtime reflection and preserving type safety through annotations like @Serializable. The library supports JVM, JS, and Native targets with platform-specific runtime libraries, enabling consistent serialization across all Kotlin environments.
The library distinguishes itself through its multi-format encoder-decoder abstraction, allowing the same serializable class to work with JSON, CBOR, ProtoBuf, and other formats without code changes. It supports polymorphic serialization for sealed classes and interfaces via a registry of subclass serializers, and allows custom serializer registration for types not covered by automatic generation. Additional capabilities include transient property exclusion to reduce payload size, and built-in JSON serialization for converting objects to and from JSON strings.
The project integrates with Gradle, Maven, and Bazel build systems for configuring the compiler plugin, and provides ProGuard and R8 rules to retain serializers during Android code shrinking.
Features
- Multiplatform Serialization Libraries - Provides a multiplatform serialization framework that works consistently across JVM, JS, and Native targets.
- Multi-Format Encoder-Decoder Abstractions - Defines a common encoder and decoder interface that allows the same serializable class to be used with JSON, CBOR, ProtoBuf, and other formats.
- Cross-Platform Serialization - Provides a serialization solution that works consistently across Kotlin/JS, Kotlin/Native, and Kotlin/JVM targets.
- Polymorphic Type Serializers - Enables serialization of sealed classes and interfaces through a registry of subclass serializers.
- JSON Data Exchange - Converts Kotlin data classes to and from JSON strings for APIs, configuration files, or data storage.
- Multi-Format Serializers - Offers a unified API for encoding and decoding Kotlin objects into JSON, CBOR, ProtoBuf, and other formats.
- JSON Serialization - Converts Kotlin objects annotated with @Serializable into JSON strings using a built-in encoder.
- Kotlin Compiler Plugin Serializers - Ships a Kotlin compiler plugin that generates serializer code at compile time for annotated classes.
- Serializer Registrations - Allows users to define and register custom serializers for types not covered by automatic generation.
- JSON Serialization - Provides a built-in JSON encoder and decoder for converting Kotlin objects to and from JSON strings.
- Serialization - Serializes and deserializes Kotlin objects across JVM, JS, and Native targets using a unified API.
- Serialization Annotations - Uses @Serializable and related annotations to mark classes for automatic serializer generation.
- Kotlin Object Deserializers - Parse a JSON string back into a typed Kotlin object annotated with @Serializable using a built-in decoder.
- Compiler Plugin Serializers - Generates serializer and deserializer implementations at compile time via a Kotlin compiler plugin, avoiding runtime reflection.
- Platform-Specific Runtimes - Provides separate runtime artifacts for JVM, JS, and Native targets, each optimized for the respective platform.
- Property Exclusion - Marks properties with @Transient to exclude them from serialization, reducing payload size.
